bundled-portable-ci

This project is a simple JavaEE project, which comes with a bundled, portable continuous integration environment.

Goals for this project

• description of the CI environment as code (that it can be created automatically)
• bundled together with the actual project (to have everything in one place)
• portability (that it can run in different environments)
• execution of a CI pipeline that includes the following steps
  • compilation of the project
  • create a disposable test environment including database and application server
  • execute tests
    • unit tests
    • integration tests
    • system tests
  • code quality analysis
  • report including code quality, test results and code coverage

Basically I used this project to get myself familiar with different technologies. Since it was not so easy to get everything working together, I share this project here and hope it can help someone. Suggestions and improvements are welcome!

Sample project

The sample project is a very simple JavaEE project, which exposes greeting messages from the database via REST (JAX-RS).

Technology stack

• Vagrant (portability of the CI)
• Docker (disposable testbed containers)
• Jenkins (continuous integration environment)
• Maven (build and dependency management)
• JaCoCo (record code coverage for unit and integration tests)
• SonarQube (code quality analysis and report)

Testbed

• Payara
• MariaDB

Usage

Install Vagrant / VirtualBox with the following PlugIns

• vagrant plugin install vagrant-vbguest
• vagrant plugin install vagrant-docker-compose

After that execute vagrant up inside the ci directory, which will bring up all services.

• Jenkins: http://localhost:18080
• SonarQube: http://localhost:19000

When Jenkins is ready the GIT credentials must be set for the existing job. That's it! Hit 'Build Project' and view the results at SonarQube.

Change database

• Forward database port in vagrant file for inspection (optional)
• Replace database containers in docker-compose.yml
• Replace JDBC driver in application server dockerfile
• Change database port in prepare_testbed.sh

MariaDB has some additional steps, which can be removed when changing the database

• Upload of a custom configuration file through Vagrant
• Processing of the custom configuration file during bootstrap
• Installation of mariadb-client in Jenkins container

Notes

• During installation the scripts automatically agree to the license agreement for Oracle JDK. Do not use this project, if you do not agree with this license agreement.

Future extensions

• Add stress tests with Gatling
• Support parallel builds in Jenkins