Gym Administration System

The final project for the course of Advanced Programming Techniques taught by professor Bettini at the Università degli Studi di Firenze.

It is a simplified adiministration system for a gym, developed in Java using TDD, AssertJ, PIT, JaCoCo, Coveralls, Docker and GitHub Actions. The system allows to manage gym courses, gym members and member subscriptions to courses.

Features and compatibility

The project provides a GUI application that can connect to two different types of databases: MongoDB and MySQL. See sections Build replication and Usage for instruction of how build and run the desired version.

(*) The project was developed and tested locally on a MacOS 11 system. However when building remotely on a MacOS 11 virtual system with GitHub Actions the integration tests were not able to connect to the MySQL Docker container. After some research, we decided to exclude MacOS from the CI build.

(**) The MongoDB Docker image required by the application is not available for Windows. MongoDB transactions require a cluster with at least 3 nodes that support replicas. Manually creating such a cluster was beyond the scope of the project, hence we used an already-built Docker image available only for Unix. The image works fine on Windows system where WSL2 is installed and Docker is configured to use it. Windows environments in GitHub Actions do not support WSL2, so the CI process does not include builds on this OS. However, the project has been successfully tested on a local Windows machine.

Build replication

The project can be completely tested and built by running the following Maven commands from the aggregator directory:

mvn clean verify -Pjacoco,pit

jacoco and pit profiles are optional. When activated will generate the code coverage and mutation testing reports inside each module folder. With the jacoco profile activated an aggregated report about code coverage will be generated inside the report module.

The above command will also generate the executable FatJARs for the two versions of the application, respectively inside the app-mysql/target and app-mongo/target folders.

Usage

app-mongo-1.0-jar-with-dependencies.jar

Located inside app-mongo/target, it is the version that connects to a MongoDB database.

For a quick demo execution you can start and set up the MongoDB Docker container by running the following command inside the app-mongo folder:

mvn docker:start

Then if you simply run the jar the application will start and connect to the MongoDB container.

If you already have your MongoDB database you can tell the application to connect to it by specifying additional arguments from the command line. A complete view of the available arguments is provided specifying --help at the moment of execution:

Keep in mind that the application uses Mongo transactions. In case of custom databases, they must be configured with a Mongo cluster with replicas to support transactions, otherwise the application will raise errors.

app-mysql-1.0-jar-with-dependencies.jar

Located inside app-mysql/target, it is the version that connects to a MySQL database.

For a quick demo execution you can start and set up the MySQL Docker container by running the following command inside the app-mysql folder:

mvn docker:start

Then if you simply run the jar the application will start and connect to the MySQL container.

If you already have your MySQL database you can tell the application to connect to it by specifying additional arguments from the command line. A complete view of the available arguments is provided specifying --help at the moment of execution:

The database to connect to must already have the schema required the application. The required schema can be found inside the docker/mysql-scripts/mysql-db-schema.sql.