This project is the starting point the practical HW in Introduction to Formal Verification Methods class. This document explains how the homework system is built, how to submit your tasks and how they will be tested. So please read carefully.
During the practical parts of the class, you will implement a transition system library using Java 8. Your implementation will be based on a provided interface, and on other supporting classes. It will be tested using a set of unit tests.
In order to achieve good modularity, the system is composed of three different code bases:
- HW-Definitions - Code containing the definitions of the interfaces and classes. It also contains many utility classes that can be used to write transition systems. Do not make any changes to this code.
- HW-Implementation - This project. Write your code here. You can do whatever you like, as long as you:
- Keep all the code and resources in package
il.ac.bgu.cs.fvm.impl. - Keep the class
il.ac.bgu.cs.fvm.impl.FvmFacadeImpl, and make sure it implementsFvmFacade. For your convenience, the class' skeleton is provided. This class will be used as a starting point by the code atHW-Definitionsfor creating transition systems. - Don't create any dependencies in external resources or 3rd-party libraries (in particular, don't add any
.jarfiles to your code). The automated test system will not be aware of them, and the compilation would fail.
- Keep all the code and resources in package
- HW-Tests - Where the tests live. The test suite in this project will be used to examine (and grade) your implementation. The source folder contains some examples to help you understand how your implementation is used.
For this project, use Java 8 (a.k.a. JDK-1.8). Do not use Java 9.
-
git cloneall the above projects. If you don't like Git, you can also download a zip file (look for the "clone or download" button in the project's page). -
Using your favorite IDE, setup each cloned repository as a project. Then, setup the projects dependencies like so:
Note: The repos already contain NetBeans projects. If you prefer IntelliJ IDEA, you can easily setup the projects using
File Menu -> New -> Project from Existing Source.... If you are using Eclipse, we've made a guide. -
Write your code in
HW-Implementation. -
Test your code by running the unit tests of
HW-Tests. You may add more tests if you want (we might add more tests too!). -
Whatever you do, don't change
HW-Definitions, or your code might not compile with our copy of it. This is a software engineering class, points will be deducted on being too smart for your own good (e.g. breaking the automated testing process due to compile errors).
- Update file
students.txtwith your id number, email and name. - Zip the
HW-Implementationproject folder. - Submit the zip file through the usual system.
No. You will be able to use the test results to fix your code, if we find any bugs.
Creating 2 projects - i.e. merging HW-Test and HW-Definitions - would create a circular dependency between the unified project and your
implementation. We could overcome this using a 2-pass build process, but that would be error-prone (not to mention ugly). We could use a single project,
but that would allow you to accidentally change our code and inadvertently create compile issues.
No, you can download the zip files and do everything manually. But note that:
- Using Git will make it easier for you to update your copies if we make changes to the central code.
- You'll have to start using a versioning system at some point, and if you haven't done so already, 4th year of software engineering degree is about time. Thank us later.
Give it another go, ask other students, or try to identify the problem and search for a solution on-line.
Please contact Michael, or come to his receptions hours. Or set up a meeting by email.