diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..5008ddfcf53c02e82d7eee2e57c38e5672ef89f6 Binary files /dev/null and b/.DS_Store differ diff --git a/.classpath b/.classpath new file mode 100644 index 0000000000000000000000000000000000000000..8d5e3d78a5611449dd6f3c3760557e7215a47fc3 --- /dev/null +++ b/.classpath @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" path="src"/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> + <classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/3.8.1"/> + <classpathentry kind="lib" path="C:/Users/ZFaci/Downloads/junit-3.8.1.jar"/> + <classpathentry kind="output" path="bin"/> +</classpath> diff --git a/.project b/.project new file mode 100644 index 0000000000000000000000000000000000000000..43bb68bc5440141484a5e866d07bb56065635173 --- /dev/null +++ b/.project @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>HW0</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.jdt.core.javanature</nature> + </natures> +</projectDescription> diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 0000000000000000000000000000000000000000..7ca950b0ce71d4206ab32c33afcc578675478e50 --- /dev/null +++ b/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,12 @@ +#Thu Sep 15 15:29:44 CDT 2011 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.debug.lineNumber=generate +org.eclipse.jdt.core.compiler.debug.localVariable=generate +org.eclipse.jdt.core.compiler.debug.sourceFile=generate +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/COPYING b/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..3912109b5cd65a68039d473c11c9f7ac2303e06d --- /dev/null +++ b/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/bin/lanSimulation/LANSimulation.class b/bin/lanSimulation/LANSimulation.class new file mode 100644 index 0000000000000000000000000000000000000000..dfbe4ac304af8bdbb15cecb59dba8fe267e14c69 Binary files /dev/null and b/bin/lanSimulation/LANSimulation.class differ diff --git a/bin/lanSimulation/Network.class b/bin/lanSimulation/Network.class new file mode 100644 index 0000000000000000000000000000000000000000..e8f403b0f4bd620de03b14aa573b5719f307099e Binary files /dev/null and b/bin/lanSimulation/Network.class differ diff --git a/bin/lanSimulation/internals/Node.class b/bin/lanSimulation/internals/Node.class new file mode 100644 index 0000000000000000000000000000000000000000..9959254fb1a326f5b3160063b591e1b75f948077 Binary files /dev/null and b/bin/lanSimulation/internals/Node.class differ diff --git a/bin/lanSimulation/internals/Packet.class b/bin/lanSimulation/internals/Packet.class new file mode 100644 index 0000000000000000000000000000000000000000..c39ccf841c60258f69f30e8a5d20f286af22479a Binary files /dev/null and b/bin/lanSimulation/internals/Packet.class differ diff --git a/bin/lanSimulation/tests/LANTests$PreconditionViolationTestCase.class b/bin/lanSimulation/tests/LANTests$PreconditionViolationTestCase.class new file mode 100644 index 0000000000000000000000000000000000000000..1d736730471a9e169382e25da9623c4c1a1d4846 Binary files /dev/null and b/bin/lanSimulation/tests/LANTests$PreconditionViolationTestCase.class differ diff --git a/bin/lanSimulation/tests/LANTests.class b/bin/lanSimulation/tests/LANTests.class new file mode 100644 index 0000000000000000000000000000000000000000..e967aa7ad4995f5bd7b0e7835cb49ee31e54589e Binary files /dev/null and b/bin/lanSimulation/tests/LANTests.class differ diff --git a/doc/LANSimulationDocument.pdf b/doc/LANSimulationDocument.pdf new file mode 100644 index 0000000000000000000000000000000000000000..6a0c51e7f197a94df764c59cb9294327801e7145 Binary files /dev/null and b/doc/LANSimulationDocument.pdf differ diff --git a/doc/README b/doc/README new file mode 100644 index 0000000000000000000000000000000000000000..54e8d5124ec7568c0f06ef4fe792afb715eccf25 --- /dev/null +++ b/doc/README @@ -0,0 +1,36 @@ +Original version created by Serge Demeyer, Matthias Rieger and Bart Van Rompaey +and Bart Du Bois. The original files are available from +http://www.lore.ua.ac.be/Research/Artefacts/refactoringLabSession/ + +Modified by Nicholas Chen and Maurice Rabb for use in CS 427 - Software +Engineering I at UIUC. + +------------------------------------------------------------------------------- + +This directory contains the ingredients for a computer lab session on +Refactoring. The session concerns the refactoring of a system which simulates a +Local Area Network. + +The directory contains + +/doc ==== + +* README The file your are reading right now. + +* RefactoringAssignment.pdf - The document that describes what steps you need to +perform for this assignment. + +* LANSimulationDocument.pdf - A few UML diagrams documenting the LAN simulation. + +* toDoList - A list of the use cases that have been implemented so far, and the +ones that are still left to be done + +/javadoc ======== + +This folder contains the generated javadoc for the system. Do *NOT* check this +into the repository. This is for your reference. + +/src ==== + +This folder contains the Java source files that are used for this assignment. +All your work should be done in this repository. diff --git a/doc/RefactoringAssignment.pdf b/doc/RefactoringAssignment.pdf new file mode 100644 index 0000000000000000000000000000000000000000..9f01465f54ed6e84968dfae2a63ddf23dcdbaddb Binary files /dev/null and b/doc/RefactoringAssignment.pdf differ diff --git a/doc/toDoList b/doc/toDoList new file mode 100644 index 0000000000000000000000000000000000000000..f4f4e0f08e5fc9707c1b34c6e99c5cfdc876edf7 --- /dev/null +++ b/doc/toDoList @@ -0,0 +1,23 @@ +FINISHED version 1.4: BROADCAST PACKET + +Subsequent versions: +* version 1.0: BASIC DOCUMENT PRINTING + Workstations request the token ring network to deliver a document to a node representing a printer. +* version 1.1: LOG PACKET SENDING + Each time a node sends a packet to the next one, it should be logged on a log file +* version 1.2: POSTSCRIPT PRINTING + A packet may start with "!PS" in which case printers should recognize it as postscript and invoke the postscript printing job +* version 1.3: PRINT ACCOUNTING + Printers should register the author and the title of the document that is being printed. For an ASCII document the author is in character position 10 to 30 and the title is "ASCII DOCUMENT". For postscript documents, the author and title of the document should be found by scanning characters in the document, looking for keyword "author:" up until "." +* VERSION 1.4: BROADCAST PACKET + Introduce a new type of packet "BROADCAST" which should be accepted by all nodes in the network + +* version 2.0: READ FROM FILE + Read the configuration of a network and the jobs to be printed from a file (in XML format) +* version 2.1: GATEWAY NODE + Introduce a new "gateway" node, which can recognize all addresses in its current subnetwork by looking at the first 3 characters of the adressee. If a packet passes trough the gateway and the addressee is not on the current subnetwork, the message is deferred trough the gateway. +* version 2.1: COMPILE LIST OF NODES + Using BROADCAST PACKET, the gateway periodically sends out a request to all nodes to reply with their name. As such the gateway can verify whether the nodes indeed have the right prefix. + +* version 3.0: GUI + The system should receive a GUI which is able to show an animation as the system is running. \ No newline at end of file diff --git a/expectedOutput.txt b/expectedOutput.txt new file mode 100644 index 0000000000000000000000000000000000000000..95a45d4450307d098d74a58e20595306220695bf --- /dev/null +++ b/expectedOutput.txt @@ -0,0 +1,98 @@ +---------------------------------ASCII------------------------------------------ +Workstation Filip [Workstation] -> Node n1 [Node] -> Workstation Hans [Workstation] -> Printer Andy [Printer] -> ... + +---------------------------------HTML------------------------------------------ +<HTML> +<HEAD> +<TITLE>LAN Simulation</TITLE> +</HEAD> +<BODY> +<H1>LAN SIMULATION</H1> + +<UL> + <LI> Workstation Filip [Workstation] </LI> + <LI> Node n1 [Node] </LI> + <LI> Workstation Hans [Workstation] </LI> + <LI> Printer Andy [Printer] </LI> + <LI>...</LI> +</UL> + +</BODY> +</HTML> + + +---------------------------------XML------------------------------------------ +<?xml version="1.0" encoding="UTF-8"?> + +<network> + <workstation>Filip</workstation> + <node>n1</node> + <workstation>Hans</workstation> + <printer>Andy</printer> +</network> + +---------------------------------SCENARIO: Print Success -------------------------- +'Filip' requests printing of 'Hello World' on 'Andy' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. + Node 'Hans' passes packet on. + Accounting -- author = 'Unknown' -- title = 'ASCII DOCUMENT' +>>> ASCII Print job delivered. + + + +---------------------------------SCENARIO: PrintFailure (UnkownPrinter) ------------ +'Filip' requests printing of 'Hello World' on 'UnknownPrinter' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. + Node 'Hans' passes packet on. + Node 'Andy' passes packet on. +>>> Destination not found, print job canceled. + + + +---------------------------------SCENARIO: PrintFailure (print on Workstation) ----- +'Filip' requests printing of 'Hello World' on 'Hans' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. +>>> Destination is not a printer, print job canceled. + + + +---------------------------------SCENARIO: PrintFailure (print on Node) ----- +'Filip' requests printing of 'Hello World' on 'n1' ... + Node 'Filip' passes packet on. +>>> Destination is not a printer, print job canceled. + + + +---------------------------------SCENARIO: Print Success Postscript----------------- +'Filip' requests printing of '!PS Hello World in postscript' on 'Andy' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. + Node 'Hans' passes packet on. + Accounting -- author = 'Unknown' -- title = 'Untitled' +>>> Postscript job delivered. + + + +---------------------------------SCENARIO: Print Failure Postscript----------------- +'Filip' requests printing of '!PS Hello World in postscript' on 'Hans' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. +>>> Destination is not a printer, print job canceled. + + + +---------------------------------SCENARIO: Broadcast Success ----------------- +Broadcast Request + Node 'Filip' accepts broadcast packet. + Node 'Filip' passes packet on. + Node 'n1' accepts broadcast packet. + Node 'n1' passes packet on. + Node 'Hans' accepts broadcast packet. + Node 'Hans' passes packet on. + Node 'Andy' accepts broadcast packet. + Node 'Andy' passes packet on. +>>> Broadcast traveled whole token ring. + diff --git a/javadoc.xml b/javadoc.xml new file mode 100644 index 0000000000000000000000000000000000000000..cfdae62384b9917bc1028c88f16e6f70323d7683 --- /dev/null +++ b/javadoc.xml @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project default="javadoc"> +<target name="javadoc"> +<javadoc access="package" author="true" destdir="javadoc" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" packagenames="lanSimulation,lanSimulation.internals" source="1.5" sourcepath="src" splitindex="true" use="true" version="true"/> +</target> +</project> diff --git a/src/lanSimulation/LANSimulation.java b/src/lanSimulation/LANSimulation.java new file mode 100644 index 0000000000000000000000000000000000000000..cb772729018c466bba5f311c98aede7011c45cec --- /dev/null +++ b/src/lanSimulation/LANSimulation.java @@ -0,0 +1,158 @@ +/* This file is part of lanSimulation. + * + * lanSimulation is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * lanSimulation is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with lanSimulation; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Copyright original Java version: 2004 Bart Du Bois, Serge Demeyer + * Copyright C++ version: 2006 Matthias Rieger, Bart Van Rompaey + */ +package lanSimulation; + +import lanSimulation.tests.*; +import java.lang.AssertionError; +import java.io.*; + +public class LANSimulation { + + public static void doRegressionTests() { + junit.textui.TestRunner.run(LANTests.suite()); + } + + public static void simulate() { + Network network = Network.DefaultExample(); + StringWriter report = new StringWriter(100); + StringBuffer buf = new StringBuffer(100); + + System.out.print("Simulate on Network: "); + System.out.println(network); + System.out.println(); + + network.printHTMLOn(buf); + System.out + .println("---------------------------------HTML------------------------------------------"); + System.out.println(buf.toString()); + System.out.println(); + + buf.setLength(0); + network.printXMLOn(buf); + System.out + .println("---------------------------------XML------------------------------------------"); + System.out.println(buf.toString()); + System.out.println(); + + System.out + .println("---------------------------------SCENARIOS------------------------------------------"); + String document = "author: FILIP Hello World"; + System.out.print("'Filip' prints '" + document + "' on 'Andy': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Andy", report)); + System.out.println(" (expects true);"); + + System.out.print("'Filip' prints '" + document + + "' on 'UnknownPrinter': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "UnknownPrinter", report)); + System.out.println(" (expects false);"); + + System.out.print("'Filip' prints '" + document + "' on 'Hans': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Hans", report)); + System.out.println(" (expects false);"); + + System.out.print("'Filip' prints '" + document + "' on 'n1': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "n1", report)); + System.out.println(" (expects false);"); + + document = "Hello World"; + System.out.print("'Filip' prints '" + document + "' on 'Andy': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Andy", report)); + System.out.println(" (expects true);"); + + document = "!PS Hello World in postscript.author:Filip.title:Hello."; + System.out.print("'Filip' prints '" + document + "' on 'Andy': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Andy", report)); + System.out.println(" (expects true);"); + + System.out.print("'Filip' prints '" + document + "' on 'Hans': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Hans", report)); + System.out.println(" (expects false);"); + + document = "!PS Hello World in postscript.Author:Filip.Title:Hello."; + System.out.print("'Filip' prints '" + document + "' on 'Andy': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Andy", report)); + System.out.println(" (expects true);"); + + document = "!PS Hello World in postscript.author:Filip;title:Hello;"; + System.out.print("'Filip' prints '" + document + "' on 'Andy': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Andy", report)); + System.out.println(" (expects true);"); + + document = "!PS Hello World in postscript.author:.title:."; + System.out.print("'Filip' prints '" + document + "' on 'Andy': "); + System.out.print(network.requestWorkstationPrintsDocument("Filip", + document, "Andy", report)); + System.out.println(" (expects true);"); + + try { + System.out + .print("'UnknownWorkstation' prints 'does not matter' on 'does not matter': "); + System.out.print(network.requestWorkstationPrintsDocument( + "UnknownWorkstation", "does not matter", "does not matter", + report)); + System.out.println(" (??? no exception);"); + } catch (AssertionError e1) { + System.out.println("exception (as expected);"); + } + ; + + System.out.print("BROADCAST REQUEST: "); + System.out.print(network.requestBroadcast(report)); + System.out.println(" (expects true);"); + + System.out.println(); + System.out.println(); + System.out.println(); + System.out + .println("---------------------------------REPORT------------------------------------------"); + System.out.println(report.toString()); + } + + public static void main(String args[]) { + + if (args.length <= 0) { + System.out.println("Usage: t(est) | s(imulate) nrOfIterations '"); + } else if (args[0].equals("t")) {// 'test' command + doRegressionTests(); + } else if (args[0].equals("s")) {// 'simulate' command + Integer nrOfIters = new Integer(1); + if (args.length > 1) { + nrOfIters = new Integer(args[1]); + } + + for (int i = 0; i < nrOfIters.intValue(); i++) { + simulate(); + } + } else {// unknown commaND + System.out.print("Unknown command to LANSimulation: '"); + System.out.print(args[0]); + System.out.println("'"); + } + } +} diff --git a/src/lanSimulation/Network.java b/src/lanSimulation/Network.java new file mode 100644 index 0000000000000000000000000000000000000000..ba4b6b888e82fcd275979ab9482683697689e994 --- /dev/null +++ b/src/lanSimulation/Network.java @@ -0,0 +1,428 @@ +/* This file is part of lanSimulation. + * + * lanSimulation is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * lanSimulation is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with lanSimulation; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Copyright original Java version: 2004 Bart Du Bois, Serge Demeyer + * Copyright C++ version: 2006 Matthias Rieger, Bart Van Rompaey + */ +package lanSimulation; + +import lanSimulation.internals.*; + +import java.util.Hashtable; +import java.util.Enumeration; +import java.io.*; + +/** + * A <em>Network</em> represents the basic data structure for simulating a Local + * Area Network (LAN). The LAN network architecture is a token ring, implying + * that packages will be passed from one node to another, until they reached + * their destination, or until they traveled the whole token ring. + */ +public class Network { + /** + * Holds a pointer to some "first" node in the token ring. Used to ensure + * that various printing operations return expected behaviour. + */ + private Node firstNode; + /** + * Maps the names of workstations on the actual workstations. Used to + * initiate the requests for the network. + */ + private Hashtable<String, Node> workstations; + + /** + * Construct a <em>Network</em> suitable for holding #size Workstations. + * <p> + * <strong>Postcondition:</strong>(result.isInitialized()) & (! + * result.consistentNetwork()); + * </p> + */ + public Network(int size) { + assert size > 0; + firstNode = null; + workstations = new Hashtable<String, Node>(size, 1.0f); + assert !consistentNetwork(); + } + + /** + * Return a <em>Network</em> that may serve as starting point for various + * experiments. Currently, the network looks as follows. + * + * <pre> + * Workstation Filip [Workstation] -> Node -> Workstation Hans [Workstation] + * -> Printer Andy [Printer] -> ... + * + * </pre> + * + * <p> + * <strong>Postcondition:</strong>result.isInitialized() & + * result.consistentNetwork(); + * </p> + */ + public static Network DefaultExample() { + Network network = new Network(2); + + Node wsFilip = new Node(Node.WORKSTATION, "Filip"); + Node n1 = new Node(Node.NODE, "n1"); + Node wsHans = new Node(Node.WORKSTATION, "Hans"); + Node prAndy = new Node(Node.PRINTER, "Andy"); + + wsFilip.nextNode = n1; + n1.nextNode = wsHans; + wsHans.nextNode = prAndy; + prAndy.nextNode = wsFilip; + + network.workstations.put(wsFilip.name, wsFilip); + network.workstations.put(wsHans.name, wsHans); + network.firstNode = wsFilip; + + assert network.consistentNetwork(); + return network; + } + + /** + * Answer whether #receiver contains a workstation with the given name. + */ + public boolean hasWorkstation(String ws) { + // return workstations_.containsKey(ws); + Node n; + + n = workstations.get(ws); + if (n == null) { + return false; + } else { + return n.type == Node.WORKSTATION; + } + } + + /** + * Answer whether #receiver is a consistent token ring network. A consistent + * token ring network - contains at least one workstation and one printer - + * is circular - all registered workstations are on the token ring - all + * workstations on the token ring are registered. + */ + public boolean consistentNetwork() { + Enumeration<Node> enumeration; + Node currentNode; + int printersFound = 0, workstationsFound = 0; + Hashtable<String, Node> encountered = new Hashtable<String, Node>(workstations.size() * 2, 1.0f); + + if (workstations.isEmpty()) { + return false; + } + ; + if (firstNode == null) { + return false; + } + ; + // verify whether all registered workstations are indeed workstations + enumeration = workstations.elements(); + while (enumeration.hasMoreElements()) { + currentNode = enumeration.nextElement(); + if (currentNode.type != Node.WORKSTATION) { + return false; + } + ; + } + // enumerate the token ring, verifying whether all workstations are + // registered + // also count the number of printers and see whether the ring is + // circular + currentNode = firstNode; + while (!encountered.containsKey(currentNode.name)) { + encountered.put(currentNode.name, currentNode); + if (currentNode.type == Node.WORKSTATION) { + workstationsFound++; + } + ; + if (currentNode.type == Node.PRINTER) { + printersFound++; + } + ; + currentNode = currentNode.nextNode; + } + if (currentNode != firstNode) { + return false; + } + ;// not circular + if (printersFound == 0) { + return false; + } + ;// does not contain a printer + if (workstationsFound != workstations.size()) { + return false; + } + ; // not all + // workstations + // are + // registered + // all verifications succeeded + return true; + } + + /** + * The #receiver is requested to broadcast a message to all nodes. Therefore + * #receiver sends a special broadcast packet across the token ring network, + * which should be treated by all nodes. + * <p> + * <strong>Precondition:</strong> consistentNetwork(); + * </p> + * + * @param report + * Stream that will hold a report about what happened when + * handling the request. + * @return Answer #true when the broadcast operation was successful and + * #false otherwise + */ + public boolean requestBroadcast(Writer report) { + assert consistentNetwork(); + + try { + report.write("Broadcast Request\n"); + } catch (IOException exc) { + // just ignore + } + + Node currentNode = firstNode; + Packet packet = new Packet("BROADCAST", firstNode.name, firstNode.name); + do { + try { + report.write("\tNode '"); + report.write(currentNode.name); + report.write("' accepts broadcast packet.\n"); + String node = currentNode.name; + firstNode.writePassPacketsOn(report, node); + } catch (IOException exc) { + // just ignore + } + + currentNode = currentNode.nextNode; + } while (!packet.destination.equals(currentNode.name)); + + try { + report.write(">>> Broadcast traveled whole token ring.\n\n"); + } catch (IOException exc) { + // just ignore + } + + return true; + } + + /** + * The #receiver is requested by #workstation to print #document on + * #printer. Therefore #receiver sends a packet across the token ring + * network, until either (1) #printer is reached or (2) the packet traveled + * complete token ring. + * <p> + * <strong>Precondition:</strong> consistentNetwork() & + * hasWorkstation(workstation); + * </p> + * + * @param workstation + * Name of the workstation requesting the service. + * @param document + * Contents that should be printed on the printer. + * @param printer + * Name of the printer that should receive the document. + * @param report + * Stream that will hold a report about what happened when + * handling the request. + * @return Answer #true when the print operation was successful and #false + * otherwise + */ + public boolean requestWorkstationPrintsDocument(String workstation, + String document, String printer, Writer report) { + assert consistentNetwork() & hasWorkstation(workstation); + + try { + report.write("'"); + report.write(workstation); + report.write("' requests printing of '"); + report.write(document); + report.write("' on '"); + report.write(printer); + report.write("' ...\n"); + } catch (IOException exc) { + // just ignore + } + + boolean result = false; + Node startNode, currentNode; + Packet packet = new Packet(document, workstation, printer); + + startNode = workstations.get(workstation); + + try { + String node = startNode.name; + firstNode.writePassPacketsOn(report, node); + } catch (IOException exc) { + // just ignore + } + + currentNode = startNode.nextNode; + while ((!packet.destination.equals(currentNode.name)) + & (!packet.origin.equals(currentNode.name))) { + try { + String node = currentNode.name; + firstNode.writePassPacketsOn(report, node); + } catch (IOException exc) { + // just ignore + } + + currentNode = currentNode.nextNode; + } + + if (packet.destination.equals(currentNode.name)) { + result = currentNode.printDocument(this, packet, report); + } else { + try { + report + .write(">>> Destination not found, print job canceled.\n\n"); + report.flush(); + } catch (IOException exc) { + // just ignore + } + + result = false; + } + + return result; + } + + public void writeAccountReport(Writer report, String author, String title, String jobType) throws IOException { + report.write("\tAccounting -- author = '"); + report.write(author); + report.write("' -- title = '"); + report.write(title); + report.write("'\n"); + report.write(">>> " + jobType + " job delivered.\n\n"); + report.flush(); + } + + /** + * Return a printable representation of #receiver. + */ + public String toString() { + StringBuffer buf = new StringBuffer(30 * workstations.size()); + printOn(buf); + return buf.toString(); + } + + /** + * Write a printable representation of #receiver on the given #buf. + */ + public void printOn(StringBuffer buf) { + Node currentNode = firstNode; + do { + switch (currentNode.type) { + case Node.NODE: + buf.append("Node "); + buf.append(currentNode.name); + buf.append(" [Node]"); + break; + case Node.WORKSTATION: + buf.append("Workstation "); + buf.append(currentNode.name); + buf.append(" [Workstation]"); + break; + case Node.PRINTER: + buf.append("Printer "); + buf.append(currentNode.name); + buf.append(" [Printer]"); + break; + default: + buf.append("(Unexpected)"); + ; + break; + } + ; + buf.append(" -> "); + currentNode = currentNode.nextNode; + } while (currentNode != firstNode); + buf.append(" ... "); + } + + /** + * Write a HTML representation of #receiver on the given #buf. + */ + public void printHTMLOn(StringBuffer buf) { + + buf.append("<HTML>\n<HEAD>\n<TITLE>LAN Simulation</TITLE>\n</HEAD>\n<BODY>\n<H1>LAN SIMULATION</H1>"); + Node currentNode = firstNode; + buf.append("\n\n<UL>"); + do { + buf.append("\n\t<LI> "); + switch (currentNode.type) { + case Node.NODE: + buf.append("Node "); + buf.append(currentNode.name); + buf.append(" [Node]"); + break; + case Node.WORKSTATION: + buf.append("Workstation "); + buf.append(currentNode.name); + buf.append(" [Workstation]"); + break; + case Node.PRINTER: + buf.append("Printer "); + buf.append(currentNode.name); + buf.append(" [Printer]"); + break; + default: + buf.append("(Unexpected)"); + break; + } + buf.append(" </LI>"); + currentNode = currentNode.nextNode; + } while (currentNode != firstNode); + buf.append("\n\t<LI>...</LI>\n</UL>\n\n</BODY>\n</HTML>\n"); + } + + /** + * Write an XML representation of #receiver on the given #buf. + */ + public void printXMLOn(StringBuffer buf) { + + Node currentNode = firstNode; + buf.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<network>"); + do { + buf.append("\n\t"); + switch (currentNode.type) { + case Node.NODE: + buf.append("<node>"); + buf.append(currentNode.name); + buf.append("</node>"); + break; + case Node.WORKSTATION: + buf.append("<workstation>"); + buf.append(currentNode.name); + buf.append("</workstation>"); + break; + case Node.PRINTER: + buf.append("<printer>"); + buf.append(currentNode.name); + buf.append("</printer>"); + break; + default: + buf.append("<unknown></unknown>"); + break; + } + currentNode = currentNode.nextNode; + } while (currentNode != firstNode); + buf.append("\n</network>"); + } + +} diff --git a/src/lanSimulation/internals/Node.java b/src/lanSimulation/internals/Node.java new file mode 100644 index 0000000000000000000000000000000000000000..9c33e8286c9070079e42ac7f7137696ce9510612 --- /dev/null +++ b/src/lanSimulation/internals/Node.java @@ -0,0 +1,152 @@ +/* This file is part of lanSimulation. + * + * lanSimulation is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * lanSimulation is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with lanSimulation; if not, write to the Free Software + * Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Copyright original Java version: 2004 Bart Du Bois, Serge Demeyer + * Copyright C++ version: 2006 Matthias Rieger, Bart Van Rompaey + */ +package lanSimulation.internals; + +import java.io.IOException; +import java.io.Writer; + +import lanSimulation.Network; + +/** + * A <em>Node</em> represents a single Node in a Local Area Network (LAN). + * Several types of Nodes exist. + */ +public class Node { + // enumeration constants specifying all legal node types + /** + * A node with type NODE has only basic functionality. + */ + public static final byte NODE = 0; + /** + * A node with type WORKSTATION may initiate requests on the LAN. + */ + public static final byte WORKSTATION = 1; + /** + * A node with type PRINTER may accept packages to be printed. + */ + public static final byte PRINTER = 2; + + /** + * Holds the type of the Node. + */ + public byte type; + /** + * Holds the name of the Node. + */ + public String name; + /** + * Holds the next Node in the token ring architecture. + * + * @see lanSimulation.internals.Node + */ + public Node nextNode; + + /** + * Construct a <em>Node</em> with given #type and #name. + * <p> + * <strong>Precondition:</strong> (type >= NODE) & (type <= PRINTER); + * </p> + */ + public Node(byte _type, String _name) { + assert (_type >= NODE) & (_type <= PRINTER); + type = _type; + name = _name; + nextNode = null; + } + + /** + * Construct a <em>Node</em> with given #type and #name, and which is linked + * to #nextNode. + * <p> + * <strong>Precondition:</strong> (type >= NODE) & (type <= PRINTER); + * </p> + */ + public Node(byte _type, String _name, Node _nextNode) { + assert (_type >= NODE) & (_type <= PRINTER); + type = _type; + name = _name; + nextNode = _nextNode; + } + + public boolean printDocument(Network network, Packet document, Writer report) { + String author = "Unknown"; + String title = "Untitled"; + int startPos = 0, endPos = 0; + + if (type == Node.PRINTER) { + try { + if (document.message.startsWith("!PS")) { + startPos = document.message.indexOf("author:"); + if (startPos >= 0) { + endPos = document.message.indexOf(".", startPos + 7); + if (endPos < 0) { + endPos = document.message.length(); + } + + author = document.message.substring(startPos + 7, + endPos); + } + + startPos = document.message.indexOf("title:"); + if (startPos >= 0) { + endPos = document.message.indexOf(".", startPos + 6); + if (endPos < 0) { + endPos = document.message.length(); + } + title = document.message + .substring(startPos + 6, endPos); + } + + String jobType = "Postscript"; + network.writeAccountReport(report, author, title, jobType); + } else { + title = "ASCII DOCUMENT"; + if (document.message.length() >= 16) { + author = document.message.substring(8, 16); + } + + String jobType = "ASCII Print"; + network.writeAccountReport(report, author, title, jobType); + } + + } catch (IOException exc) { + // just ignore + } + return true; + } else { + try { + report + .write(">>> Destination is not a printer, print job canceled.\n\n"); + report.flush(); + } catch (IOException exc) { + // just ignore + } + return false; + } + } + + public void writePassPacketsOn(Writer report, String node) throws IOException { + report.write("\tNode '"); + report.write(node); + report.write("' passes packet on.\n"); + report.flush(); + } + +} \ No newline at end of file diff --git a/src/lanSimulation/internals/Packet.java b/src/lanSimulation/internals/Packet.java new file mode 100644 index 0000000000000000000000000000000000000000..9e6b358788973cc17de4cd070eb97bd746ede796 --- /dev/null +++ b/src/lanSimulation/internals/Packet.java @@ -0,0 +1,58 @@ +/* This file is part of lanSimulation. + * + * lanSimulation is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * lanSimulation is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with lanSimulation; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Copyright original Java version: 2004 Bart Du Bois, Serge Demeyer + * Copyright C++ version: 2006 Matthias Rieger, Bart Van Rompaey + */ +package lanSimulation.internals; + +/** + * A <em>Packet</em> represents a unit of information to be sent over the Local + * Area Network (LAN). + */ +public class Packet { + /** + * Holds the actual message to be send over the network. + */ + public String message; + /** + * Holds the name of the Node which initiated the request. + */ + public String origin; + /** + * Holds the name of the Node which should receive the information. + */ + public String destination; + + /** + * Construct a <em>Packet</em> with given #message and #destination. + */ + public Packet(String _message, String _destination) { + message = _message; + origin = ""; + destination = _destination; + } + + /** + * Construct a <em>Packet</em> with given #message, #origin and #receiver. + */ + public Packet(String _message, String _origin, String _destination) { + message = _message; + origin = _origin; + destination = _destination; + } + +} \ No newline at end of file diff --git a/src/lanSimulation/tests/LANTests.java b/src/lanSimulation/tests/LANTests.java new file mode 100644 index 0000000000000000000000000000000000000000..1b925845d2a978ccd6b5bff9a4fd11bba5ebf9e1 --- /dev/null +++ b/src/lanSimulation/tests/LANTests.java @@ -0,0 +1,343 @@ +/* This file is part of lanSimulation. + * + * lanSimulation is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * lanSimulation is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with lanSimulation; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * + * Copyright original Java version: 2004 Bart Du Bois, Serge Demeyer + * Copyright C++ version: 2006 Matthias Rieger, Bart Van Rompaey + */ +package lanSimulation.tests; + +import lanSimulation.internals.*; +import lanSimulation.*; +import junit.framework.*; +import junit.extensions.*; +import java.lang.AssertionError; +import java.io.*; + +public class LANTests extends TestCase { + + public static Test suite() { + TestSuite testSuite = new TestSuite(LANTests.class); + return testSuite; + } + + public void testBasicPacket() { + Packet packet; + + packet = new Packet("c", "a"); + assertEquals("message", packet.message, "c"); + assertEquals("destination", packet.destination, "a"); + assertEquals("origin", packet.origin, ""); + packet.origin = "o"; + assertEquals("origin (after setting)", packet.origin, "o"); + } + + private boolean compareFiles(String filename1, String filename2) { + FileInputStream f1, f2; + int b1 = 0, b2 = 0; + + try { + f1 = new FileInputStream(filename1); + try { + f2 = new FileInputStream(filename2); + } catch (FileNotFoundException f2exc) { + try { + f1.close(); + } catch (IOException exc) { + } + + return false; // file 2 does not exist + } + } catch (FileNotFoundException f1exc) { + return false; // file 1 does not exist + } + + try { + if (f1.available() != f2.available()) { + return false; + } // length of files is different + while ((b1 != -1) & (b2 != -1)) { + b1 = f1.read(); + b2 = f2.read(); + if (b1 != b2) { + return false; + } // discovered one diferring character + } + + if ((b1 == -1) & (b2 == -1)) { + return true; // reached both end of files + } else { + return false; // one end of file not reached + } + } catch (IOException exc) { + return false; // read error, assume one file corrupted + } finally { + try { + f1.close(); + } catch (IOException exc) { + } + + try { + f2.close(); + } catch (IOException exc) { + } + + } + } + + private void YOUMAYWANTTOtestCompareFiles() { + String fName1 = "testCompare1.txt", fName2 = "testCompare2.txt", fName3 = "testCompare3.txt", fName4 = "testCompare4.txt"; + FileWriter f1, f2, f3, f4; + + try { + f1 = new FileWriter(fName1); + try { + f2 = new FileWriter(fName2); + try { + f3 = new FileWriter(fName3); + try { + f4 = new FileWriter(fName4); + } catch (IOException f3exc) { + try { + f1.close(); + } catch (IOException exc) { + } + + try { + f2.close(); + } catch (IOException exc) { + } + + try { + f3.close(); + } catch (IOException exc) { + } + + return; + } + } catch (IOException f3exc) { + try { + f1.close(); + } catch (IOException exc) { + } + + try { + f2.close(); + } catch (IOException exc) { + } + + return; + } + } catch (IOException f2exc) { + try { + f1.close(); + } catch (IOException exc) { + } + + return; + } + } catch (IOException f1exc) { + return; + } + + try { + f1.write("aaa"); + f2.write("aaa"); + f3.write("aa"); + f4.write("aab"); + } catch (IOException exc) { + } finally { + try { + f1.close(); + } catch (IOException exc) { + } + + try { + f2.close(); + } catch (IOException exc) { + } + + try { + f3.close(); + } catch (IOException exc) { + } + + try { + f4.close(); + } catch (IOException exc) { + } + + } + + assertTrue("equals fName1 to fName2 ", compareFiles(fName1, fName2)); + assertFalse("not equals fName1 to fName3 (fName 3 is shorter)", + compareFiles(fName1, fName3)); + assertFalse("not equals fName3 to fName1 (fName 3 is shorter)", + compareFiles(fName3, fName1)); + assertFalse("not equals fName1 to fName4 (last character differs)", + compareFiles(fName1, fName4)); + assertFalse("not equals fName1 to fName4 (last character differs)", + compareFiles(fName1, fName4)); + } + + public void testBasicNode() { + Node node; + + node = new Node(Node.NODE, "n"); + assertEquals("type", node.type, Node.NODE); + assertEquals("name", node.name, "n"); + assertEquals("nextNode", node.nextNode, null); + node.nextNode = node; + assertEquals("nextNode (after setting)", node.nextNode, node); + } + + public void testDefaultNetworkToString() { + Network network = Network.DefaultExample(); + + assertTrue("consistentNetwork ", network.consistentNetwork()); + assertEquals( + "DefaultNetwork.toString()", + network.toString(), + "Workstation Filip [Workstation] -> Node n1 [Node] -> Workstation Hans [Workstation] -> Printer Andy [Printer] -> ... "); + } + + public void testWorkstationPrintsDocument() { + Network network = Network.DefaultExample(); + StringWriter report = new StringWriter(500); + + assertTrue("PrintSuccess ", network.requestWorkstationPrintsDocument( + "Filip", "Hello World", "Andy", report)); + assertFalse("PrintFailure (UnkownPrinter) ", network + .requestWorkstationPrintsDocument("Filip", "Hello World", + "UnknownPrinter", report)); + assertFalse("PrintFailure (print on Workstation) ", network + .requestWorkstationPrintsDocument("Filip", "Hello World", + "Hans", report)); + assertFalse("PrintFailure (print on Node) ", network + .requestWorkstationPrintsDocument("Filip", "Hello World", "n1", + report)); + assertTrue("PrintSuccess Postscript", network + .requestWorkstationPrintsDocument("Filip", + "!PS Hello World in postscript", "Andy", report)); + assertFalse("PrintFailure Postscript", network + .requestWorkstationPrintsDocument("Filip", + "!PS Hello World in postscript", "Hans", report)); + } + + public void testBroadcast() { + Network network = Network.DefaultExample(); + StringWriter report = new StringWriter(500); + + assertTrue("Broadcast ", network.requestBroadcast(report)); + } + + /** + * Test whether output routines work as expected. This is done by comparing + * generating output on a file "useOutput.txt" and comparing it to a file + * "expectedOutput.txt". On a first run this test might break because the + * file "expectedOutput.txt" does not exist. Then just run the test, verify + * manually whether "useOutput.txt" conforms to the expected output and if + * it does rename "useOutput.txt" in "expectedOutput.txt". From then on the + * tests should work as expected. + */ + public void testOutput() { + Network network = Network.DefaultExample(); + String generateOutputFName = "useOutput.txt", expectedOutputFName = "expectedOutput.txt"; + FileWriter generateOutput; + StringBuffer buf = new StringBuffer(500); + StringWriter report = new StringWriter(500); + + try { + generateOutput = new FileWriter(generateOutputFName); + } catch (IOException f2exc) { + assertTrue("Could not create '" + generateOutputFName + "'", false); + return; + } + + try { + buf + .append("---------------------------------ASCII------------------------------------------\n"); + network.printOn(buf); + buf + .append("\n\n---------------------------------HTML------------------------------------------\n"); + network.printHTMLOn(buf); + buf + .append("\n\n---------------------------------XML------------------------------------------\n"); + network.printXMLOn(buf); + generateOutput.write(buf.toString()); + report + .write("\n\n---------------------------------SCENARIO: Print Success --------------------------\n"); + network.requestWorkstationPrintsDocument("Filip", "Hello World", + "Andy", report); + report + .write("\n\n---------------------------------SCENARIO: PrintFailure (UnkownPrinter) ------------\n"); + network.requestWorkstationPrintsDocument("Filip", "Hello World", + "UnknownPrinter", report); + report + .write("\n\n---------------------------------SCENARIO: PrintFailure (print on Workstation) -----\n"); + network.requestWorkstationPrintsDocument("Filip", "Hello World", + "Hans", report); + report + .write("\n\n---------------------------------SCENARIO: PrintFailure (print on Node) -----\n"); + network.requestWorkstationPrintsDocument("Filip", "Hello World", + "n1", report); + report + .write("\n\n---------------------------------SCENARIO: Print Success Postscript-----------------\n"); + network.requestWorkstationPrintsDocument("Filip", + "!PS Hello World in postscript", "Andy", report); + report + .write("\n\n---------------------------------SCENARIO: Print Failure Postscript-----------------\n"); + network.requestWorkstationPrintsDocument("Filip", + "!PS Hello World in postscript", "Hans", report); + report + .write("\n\n---------------------------------SCENARIO: Broadcast Success -----------------\n"); + network.requestBroadcast(report); + generateOutput.write(report.toString()); + } catch (IOException exc) { + } finally { + try { + generateOutput.close(); + } catch (IOException exc) { + } + + } + + assertTrue("Generated output is not as expected ", compareFiles( + generateOutputFName, expectedOutputFName)); + } + + static public class PreconditionViolationTestCase extends ExceptionTestCase { + public PreconditionViolationTestCase(String name, Class exception) { + super(name, exception); + } + + public void test() { + Network network = Network.DefaultExample(); + StringWriter report = new StringWriter(100); + network.requestWorkstationPrintsDocument("UnknownWorkstation", + "does not matter", "does not matter", report); + } + + } + + public void testPreconditionViolation() { + PreconditionViolationTestCase test = new PreconditionViolationTestCase( + "test", AssertionError.class); + TestResult result = test.run(); + assertEquals(1, result.runCount()); + assertEquals(1, result.errorCount()); + } + +} \ No newline at end of file diff --git a/useOutput.txt b/useOutput.txt new file mode 100644 index 0000000000000000000000000000000000000000..95a45d4450307d098d74a58e20595306220695bf --- /dev/null +++ b/useOutput.txt @@ -0,0 +1,98 @@ +---------------------------------ASCII------------------------------------------ +Workstation Filip [Workstation] -> Node n1 [Node] -> Workstation Hans [Workstation] -> Printer Andy [Printer] -> ... + +---------------------------------HTML------------------------------------------ +<HTML> +<HEAD> +<TITLE>LAN Simulation</TITLE> +</HEAD> +<BODY> +<H1>LAN SIMULATION</H1> + +<UL> + <LI> Workstation Filip [Workstation] </LI> + <LI> Node n1 [Node] </LI> + <LI> Workstation Hans [Workstation] </LI> + <LI> Printer Andy [Printer] </LI> + <LI>...</LI> +</UL> + +</BODY> +</HTML> + + +---------------------------------XML------------------------------------------ +<?xml version="1.0" encoding="UTF-8"?> + +<network> + <workstation>Filip</workstation> + <node>n1</node> + <workstation>Hans</workstation> + <printer>Andy</printer> +</network> + +---------------------------------SCENARIO: Print Success -------------------------- +'Filip' requests printing of 'Hello World' on 'Andy' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. + Node 'Hans' passes packet on. + Accounting -- author = 'Unknown' -- title = 'ASCII DOCUMENT' +>>> ASCII Print job delivered. + + + +---------------------------------SCENARIO: PrintFailure (UnkownPrinter) ------------ +'Filip' requests printing of 'Hello World' on 'UnknownPrinter' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. + Node 'Hans' passes packet on. + Node 'Andy' passes packet on. +>>> Destination not found, print job canceled. + + + +---------------------------------SCENARIO: PrintFailure (print on Workstation) ----- +'Filip' requests printing of 'Hello World' on 'Hans' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. +>>> Destination is not a printer, print job canceled. + + + +---------------------------------SCENARIO: PrintFailure (print on Node) ----- +'Filip' requests printing of 'Hello World' on 'n1' ... + Node 'Filip' passes packet on. +>>> Destination is not a printer, print job canceled. + + + +---------------------------------SCENARIO: Print Success Postscript----------------- +'Filip' requests printing of '!PS Hello World in postscript' on 'Andy' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. + Node 'Hans' passes packet on. + Accounting -- author = 'Unknown' -- title = 'Untitled' +>>> Postscript job delivered. + + + +---------------------------------SCENARIO: Print Failure Postscript----------------- +'Filip' requests printing of '!PS Hello World in postscript' on 'Hans' ... + Node 'Filip' passes packet on. + Node 'n1' passes packet on. +>>> Destination is not a printer, print job canceled. + + + +---------------------------------SCENARIO: Broadcast Success ----------------- +Broadcast Request + Node 'Filip' accepts broadcast packet. + Node 'Filip' passes packet on. + Node 'n1' accepts broadcast packet. + Node 'n1' passes packet on. + Node 'Hans' accepts broadcast packet. + Node 'Hans' passes packet on. + Node 'Andy' accepts broadcast packet. + Node 'Andy' passes packet on. +>>> Broadcast traveled whole token ring. +