CI Server

This is a Continuous Integration server that automatically compile and run tests on code that are pushed to GitHub.

The server is unit tested using jUnit and uses javadoc for documentation. The documentation is automatically updated and deployed to GitHub Pages on every commit or merge to master.

When the server is notified of a push-event. We clone the repository in question into a temporary folder and then tries to execute a bash file called executes.sh which should contain the steps for compiling and testing the project. We then run the bash instructions on the file. The bash file contains all the instructions necessary to run the tests. After we've run the file, we save the exit code to see if the tests failed or succeeded. The commit status of a commit gets updated to Success or Failure depending on the exit on the bash process.

The project is a Maven project using Java 13 and contains a jUnit test suite. Documentation is generated from the javadoc in the master branch and is published in the gh-pages branch in this repository.

Documentation

Our documentation can be found at the following URL: https://soffan20.github.io/CI/

Status

Running the tests

# Runs all the jUnit tests
$ mvn test

Building the application

# The jar will be in target/CI-VERSION.jar
$ mvn package

Running the server

# Running the server
$ mvn compile exec:java

Generating the documentation

# This generates HTML from the Javadoc in target/site/apidocs
$ mvn javadoc:javadoc

Contributions

The whole group contributed equally.

Louise worked with JSON, the GitHub requests and updating the commit status.

Daniel worked with documentation and handling server.

Andreas worked with repository handling in the server.

Mikael worked with the executor stitching together the whole flow and JSON.

Emil worked with GitHub Actions to automate compilation, testing, documentation generation and automatic deployment of documentation to GitHub pages.

Everyone created tests for their parts.