backend-blueprint

A Java Maven template project to use as a starting point in standing up a new OLI Microservice backend project

This includes and sets up:

• Maven for build system
• JUnit for unit testing
• Arquillian for Integration Testing
• Dockerized development and testing
• Automated Jenkins testing and distribution building

Dependencies

• Maven
• Docker
• Docker Compose (Linux).

How to Install

First, clone this repository:

$ git clone https://github.com/Simon-Initiative/backend-blueprint

Then delete the local git repo.

$ rm -rf backend-blueprint/.git

Next, customize the pom.xml, replacing blueprint project specific values (project name, descriptions, java package names etc) with corresponding values from your project.

Also customize the file docker-compose.yaml to specify the exact container_name and image tag that you wish to use. That setting would typically just match the project name. Other items such as port numbers and environment variables may also need changing.

Next change the values in the .envs file (database names, passwords, ports etc). Note that the values for ports and names should be unique to this project, otherwise there is a chance of name collision with other docker projects in you system.

How to Run

First, to build the docker images, you will need to run the following at least once.

$ docker-compose build

Then, launch the docker containers

$ docker-compose up

This will run a containerized remote wildfly application server and corresponding support support services (databases, distributed cache etc).

Note that this being a typical JEE maven project, you may build and debug your web application (via IDE or command line) without interacting with the remote application server.

$ mvn clean package

You also have, with proper setup, the option of deploying and testing the web application in a local managed, wildfly application server.

$ mvn clean test -Parq-wildfly-managed

To deploy the web application to the remote docker containerized AS issue the command.

$ mvn clean install

Note that this command will run your JUnit tests before deploying the .war file to the application server.

For tests beyond unit tests (integration tests), run the following maven command

$ mvn clean test -Parq-wildfly-remote

Updating variables

If you edit .envs, Dockerfile or docker-compose.yml files, stop, rebuild and restart the container:

$ docker-compose down

$ docker-compose up --build