postgres-pipeline-utils

postgres-pipeline-utils is a Jenkins shared pipeline library which makes it easier to run commands with a Postgres database in a Docker container. For information on using this library in your Jenkins pipeline scripts, please refer to the Jenkins shared library documentation.

Usage

Example usage of this library might look something like this:

@Library('postgres-pipeline-utils@x.y.z') _

stage('Test') {
  postgres.withDb('testdb', '9.6') {
    sh 'run-db-tests.sh'
  }
}

The above code snippet will pull the Postgres Docker image for version 9.6, and start the container. The commands in the closure body will be executed outside of the container on the node.

The library also makes sure that the container is fully started and ready to communicate with before executing the closure body. To do this, it calls pg_isready until it succeeds.

Building and Testing

The postgres-pipeline-utils library can be developed locally using the provided Gradle wrapper. Likewise, the Gradle project can be imported by an IDE like IntelliJ IDEA. For this, you'll need the Groovy plugin enabled in IDEA and to install Groovy SDK.

Maintainers

This project is maintained by the following GitHub users:

• @ala-ableton
• @nre-ableton