npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@windyroad/quick-containers-js

v2.0.0

Published

Utility methods for quickly starting up containers. Useful for when you're testing code that depends on databases, kafka, elasticsearch or similar.

Downloads

8

Readme

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