nandess/pactbroker repository overview

⁠Dockerised Pact Broker

This repository deploys Pact Broker⁠ using lightweight containers using Docker.

⁠Prerequisites

• A running postgresql database and the ability to connect to it (see POSTGRESQL.md⁠).
• If on Mac, you will need the timeout or gtimeout function. You can install gtimeout using brew install coreutils.

⁠Getting Started

1. Install Docker⁠

2. Prepare your environment if you are not running postgresql in a docker container. Setup the pact broker connection to the database through the use of the following environment variables. If you want to use a disposable postgres docker container just do export DISPOSABLE_PSQL=true before running the script/test.sh⁠.

   • PACT_BROKER_DATABASE_ADAPTER
   • PACT_BROKER_DATABASE_USERNAME
   • PACT_BROKER_DATABASE_PASSWORD
   • PACT_BROKER_DATABASE_HOST
   • PACT_BROKER_DATABASE_NAME

   Adapter can be 'mysql2' or 'postgres'

3. Test the pact broker environment by executing script/test.sh⁠

⁠Notes

• Use -p 80:80 to start the docker image, as some of the Rack middleware gets confused by receiving requests for other ports and will return a 404 otherwise (port forwarding does not rewrite headers).
• On OSX, use docker-machine ip $(docker-machine active) to get the IP of the VirtualBox, and connect on port 80.
• The application makes use of the phusion passenger application server.
• As the native dependencies for a postgres driver are baked into the docker container, you are limited to using postgres as a database.
• Apart from creating a postgres database no further preparation is required.

⁠Using basic auth

Run your container with PACT_BROKER_BASIC_AUTH_USERNAME and PACT_BROKER_BASIC_AUTH_PASSWORD set to enable basic auth for the pact broker application.

⁠Running with Docker Compose

For a quick start with the Pact Broker and Postgre, we have an example Docker Compose⁠ setup you can use:

1. Modify the docker-compose.yml file as required.
2. Run docker-compose up to get a running Pact Broker and a clean Postgres database

Now you can access your local broker:

# Get IP of your running Docker instance
DOCKER_HOST=$(docker-machine ip $(docker-machine active))
curl -v http://$DOCKER_HOST # you can visit in your browser too!

NOTE: this image should be modified before using in Production, in particular, the use of hard-coded credentials

⁠Publishing to Docker Hub

1. Login to docker hub from console

docker login

This will prompt for your docker hub credentials and email

1. Build the docker image for the dius account

docker login
./script/build_and_push.sh