DevOps Guide for PlanNUS

Table of contents

• DevOps Guide for PlanNUS
  • Table of contents
  • Build Automation
  • Continuous Integration (CI)
  • I/O Testing
  • Making a release
  • Useful Links

Build Automation

PlanNUS uses Gradle for build automation and dependency management.

Below shows how Gradle is being used in PlanNUS for important project tasks

• test: Runs all available test
  • Command: ./gradlew clean test: Cleans the project before running the test
  • Command: ./gradlew test: Runs all the test
• shadowJar: ShadowJar plugin is responsible for packaging PlanNUS into a fat JAR file, which is located under build/lib folder. If applicable, ShadowJar will replace previous versions of PlanNUS.jar with the latest version.
  • Command: ./gradlew shadowJar
• clean: Deletes the files created during the previous build (i.e. files and folders that are in the build folder)
  • Command: ./gradlew clean
• checkstyle: Checks for styling compliance across the whole project
  • Command: ./gradlew checkstyleMain: Checks for styling compliance in the main package of PlanNUS
  • Command: ./gradlew checkstyleTest: Checks for styling compliance in the test package of PlanNUS
• build: Runs all available tests and checkstyle before packaging PlanNUS with ShadowJar if project passed all test cases and style check without issue.
  • Command: ./gradlew build

Continuous Integration (CI)

PlanNUS uses GitHub Actions for continuous integration. The necessary GitHub Actions configuration files exist as .github/workflows/gradle.yml. This file does not require further set up.

I/O Testing

PlanNUS uses automated scripts located in the ./text-ui-test folder to test for the correct output given a sequence of inputs.

To test for the input/output of PlanNUS

1. Change needed input in input.txt located in ./text-ui-test folder
2. Change the expected output in EXPECTED.TXT located in ./text-ui-test folder
3. Run the scripts for testing
   • On windows, run runtest.bat
   • On UNIX systems, run runtest.sh
4. The scripts will run and throws a warning message if the actual output differs from the expected output
5. The actual output will be stored in ACTUAL.TXT located in ./text-ui-test folder

Making a release

Here are the steps to create a new release.

1. Generate a fat JAR file using Gradle with the commandgradlew build.
2. Tag the repo with the version number. e.g. V2.0
3. Create a new release using GitHub. Upload the JAR file you created.

Useful Links

• About Us
• Configuration guide
• Developer guide
• Documentation guide
• Logging guide
• Testing guide
• User guide