Create Testing Environment with Docker for Integration Testing

Solve your test environment woes with these simple steps.

Tools and frameworks that has been used for this tutorial

• Docker - Software containerization platform.
• Docker Compose - A tool for defining and running multi-container Docker applications.
• Spring Restful Service - Simple 'Hello World' web service with Spring
• REST-assured - Rest webservice testing framework
• Gradle Docker plugin - For managing Docker images and containers
• Gradle SSH Plugin - A Gradle plugin which provides SSH facilities for continuous delivery.
• wait-for-it - A pure bash script that will wait on the availability of a host and TCP port.

Building application and running tests without Docker

Starting hello world spring rest service:

./gradlew bootRun

Or you can create the jar file:

./gradlew build

And run the jar file:

java -jar build/libs/gs-rest-service-0.1.0.jar

Run integration test:

./gradlew rest-service-api-test:test

or

 ./gradlew rest-service-api-test:test -DBASE_URL=http://example.com:8080

Docker Commands

Building docker image:

docker build -t spring-rest-hello-world:0.1 .

Running docker image:

docker run -d -p 8080:8080 --name rest-hello  spring-rest-hello-world:0.1

Stopping docker container:

docker stop rest-hello

Removing docker container:

docker rm rest-hello

Removing docker image:

docker rmi spring-rest-hello-world:0.1

Docker Compose

Building environment:

docker-compose -f docker-compose.test.yml build

Spin up environment:

docker-compose -f docker-compose.test.yml up

Destroying environment:

docker-compose -f docker-compose.test.yml down

Removing all images:

docker-compose -f docker-compose.test.yml down --rmi all

Removing volumes:

docker-compose -f docker-compose.test.yml down -v

Gradle Docker Tasks

Building Image: It will build 'erolstt/spring-rest-demo:latest' image

./gradlew buildSpringBootRestImage

Creating Container: It will create 'spring-rest' container from 'erolstt/spring-rest-demo:latest' image.

./gradlew createRestAPIContainer

Starting Container: It will start 'spring-rest' container on 8080 port

./gradlew startRestAPIContainer

Stopping Container: It will stop 'spring-rest' container

./gradlew stopRestAPIContainer

Removing Container: It will remove 'spring-rest' container

./gradlew removeRestAPIContainer

Removing Image: It will remove 'erolstt/spring-rest-demo:latest'.

./gradlew removeSpringBootRestImage

There are dependencies between tasks. That means if you run ./gradlew startRestAPIContainer task, it will build the image and run the container. So, you do not need to run build image and create container tasks beforehand.

Gradle Shh Tasks

It will shh into the host machine and create spring-rest-hello-world:0.1 image in it.

./gradlew createSpringRestImage -PlinuxHost=my-linux-host-without-http -PlinuxUser=user -PlinuxPassword=password