@windyroad/quick-containers-js

quick-containers-js

Utility methods for quickly starting up containers. Useful for when you're testing code that depends on databases, Kafka, elastic-search or similar.

quick-containers-js uses dockerode and you need to install dockerode] as a peer dependency

Why

Sometimes I need a database or similar for the code I'm testing to connect to. The easiest way to make sure one is available is to pull the relevant Docker image and start up a container. This code tries to make that quick and easy.

Installation

npm install @windyroad/quick-containers-js dockerode --save-dev

Usage

ensurePulled(docker, image, log = console.log)

ensurePulled will pull the specified image. To make it as fast as possible, it will check if the image exists locally and if it's not found, only then will it pull from Docker Hub.

This means that if you are pulling an image with a latest tag or similar, then ensurePulled won't automatically pull the new images as they are released. 🤷‍♂️ It's a speed trade-off. If I'm rerunning my tests on every save, then I don't want it checking for a new image to pull every single time.

If you need new image, run docker pull image:tag from the command line.

import qc from '@windyroad/quick-containers-js'
import Docker from 'dockerode'

...

const docker = new Docker();
qc.ensurePulled(docker, 'ubuntu:latest', console.log).then(...).catch(...)

If you need to pass special options to the pull command, please let us know.

ensureStarted(docker, containerOptions, wait, log = console.log)

ensureStarted will start try to start to container specified by containerOptions. It will then call wait and wait for it to resolve. e.g.

import qc from '@windyroad/quick-containers-js'
import Docker from 'dockerode'
import waitport from 'wait-port'
...

qc.ensureStarted(docker, {
    Image: 'mysql:8.0.16',
    Tty: false,
    ExposedPorts: {
      '3306/tcp': {}
    },
    HostConfig: {
      PortBindings: { '3306/tcp': [{ HostPort: '3306' }] }
    },
    Env: [
      'MYSQL_ROOT_PASSWORD=my-secret-pw'
    ],
    name: 'qc-mysql-test'
  }, () => waitport({
    port: 3306,
    timeout: 60000
  }))

It's important (but not mandatory) to give your container a name, so that ensureStarted doesn't start a new container for each test run.

If the container is already running, ensureStarted will just call wait.

ensureStarted will not stop the container when you are done. This is so, you can reuse the same container over and over again for each test run. This does mean you'll need to cleanup any state, but again, this is a speed trade-off. Cleaning up typically orders of magnitude faster than restarting.

ensureMySqlStarted(docker, version = 'latest', port = '3306', timeout = 60000, password = 'my-secret-pw', env = [])

Moved to @windyroad/quick-mysql-js