oreilly-docker-java-shopping

This repo contains code samples from my O'Reilly minibook "Containerizing Continuous Delivery in Java: Docker Integration for Build Pipelines and Application Architecture".

This README is intended to provide high-level guidance of the project, and detailed instructions can be found in the accompanying book.

Project Structure

• ci-vagrant
• Installation files that build a Jenkins instance that is ready for experimenting with the examples contained within the book.
• Currently the installation is undertaken using Vagrant and Oracle's VirtualBox
• Once Vagrant and VirtualBox are installed locally, the Jenkins box can be built from this directory using the vagrant up command
• functional-e2e-tests
• Simple examples of functional end-to-end tests that use JUnit and REST-assured to test the DJShopping application
• performance-e2e-tests
• Simple examples of performance/load end-to-end tests that use Gatling with SBT and Scala
• shopfront
• The 'shopfront' microservice of the DJShopping example application that provides the primary entry point for the end-user (both Web UI and API-driven)
• productcatalogue
  • The 'product catalogue' microservice of the DJShopping example application, which provides product details like name and price
• stockmanager
  • The 'stock manager' microservice of the DJShopping example application, which provides stock information, such as SKU and quantity
• build_all.sh
  • Convenience shell script for triggering Maven builds of all of the application microservices. This script does not build the associated Docker images, but the minibook contains instructions for doing so, alongside the suggestion that the resulting Docker images are pushed to your own DockerHub account
• build_all_and_publish_dockerhub.yml
  • Convenience build and publish shell script for triggering Maven builds of all of the application microservices, building an associated Docker image, and (if successful) a push of the image to DockerHub. If you wish to use this script you will have to create a DockerHub account and substitute the existing account details ('apetrovya') with your own.
• docker-compose.yml
• Docker Compose file that starts all of the DJShopping application microservice containers. Note that if you push your own version of the Docker images to your DockerHub account you will have to change the image names details within this file to run these (i.e. remove the 'apetrovya' account name)
• Run the file via the command docker-compose up
• docker-compose-build.yml
  • Docker Compose file that contains the build configuration of the DJShopping application microservices.
  • Build the Docker images via the command docker-compose -f docker-compose-build.yml build
  • Build and run the Docker images via the command docker-compose -f docker-compose-build.yml up --build

Example Jenkins Pipelines

Once the Jenkins instance has been built and configured as specified in the accompanying minibook, and the DJShopping build items have been configured and run, it will be possible to create Jenkins Pipeline examples for running end-to-end tests. The examples contained within the book are included here for reference:

Single Service Initialisation Test

node {
    stage ('Successful startup check') {
        docker.image('apetrovya/djshopfront').withRun('-p 8010:8010') {
            timeout(time: 30, unit: 'SECONDS') {
                waitUntil {
                    def r = sh script: 'curl -s http://localhost:8010/health | grep "UP"', returnStatus: true
                    return (r == 0);
                }
            }
        }
    }
}

End-to-end Initialisation Test

node {
    stage ('build') {
        git url: 'https://github.com/apetrovya/oreilly-docker-java-shopping.git'
        // conduct other build tasks
    }

    stage ('end-to-end tests') {
        timeout(time: 60, unit: 'SECONDS') {
            try {
                sh 'docker-compose up -d'
                waitUntil { // application is up
                    def r = sh script: 'curl -s http://localhost:8010/health | grep "UP"', returnStatus: true
                    return (r == 0);
                }

                // conduct main test here
                sh 'curl http://localhost:8010 | grep "Docker Java"'

            } finally {
                sh 'docker-compose stop'
            }
        }
    }

    stage ('deploy') {
        // deploy the containers/application here
    }
}

End-to-end Functional Tests

node {
    stage ('build') {
        git url: 'https://github.com/apetrovya/oreilly-docker-java-shopping.git'
        // conduct other build tasks
    }

    stage ('end-to-end tests') {
        timeout(time: 60, unit: 'SECONDS') {
            try {
                sh 'docker-compose up -d'
                waitUntil { // application is up
                    def r = sh script: 'curl -s http://localhost:8010/health | grep "UP"', returnStatus: true
                    return (r == 0);
                }

                // conduct main test here
                sh 'cd functional-e2e-tests && mvn clean verify'

            } finally {
                sh 'docker-compose stop'
            }
        }
    }

    stage ('deploy') {
        // deploy the containers/application here
    }
}