This repo - forked from here will serve as a base for Project Group P 17's ECSE 429 - Software Validation Project.
In particular, we will replace the original test cases with our own - but follow the paradigm set out by the original repository.
-
Make sure you have all the dependencies needed to build this project. In particular, immediately after git clone, you should be able to successfully build and execute tests from the working directory via:
mvn clean install -U
-
We should all plan on using IntelliJ to keep consistent. Additionally, it would be very useful for everyone to install the checkstyle plugin, download the Google Code Style XML, and configure this as the default for IntelliJ. Ideally, if we are all using this plugin, we can ensure consistent formatting by running the plugin in IntelliJ to make sure our code conforms. It should actually also format our code to this by default.
-
Most importantly, before making a pull request, we should make sure the build is passing by running:
mvn clean install -U test surefire-report:report.
In addition to compiling and executing our test cases, this will also generate an HTML test report under target/site/surefire-report.html . The test report will likely be a useful reference for compiling official documentation on the tests we've executed.