Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @knapsack-pro/jest with all npm packages installed. Try it out:

@knapsack-pro/jest lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("@knapsack-pro/jest/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@knapsack-pro/jest v2.5.0

Knapsack Pro Jest splits Jest tests across CI nodes and makes sure that tests will run in optimal time on each CI node.

@knapsack-pro/jest

CircleCI

@knapsack-pro/jest runs your tests with Jest test runner and does dynamic tests allocation across parallel CI nodes using KnapsackPro.com Queue Mode to provide the fastest CI build time (optimal test suite timing).

Learn about Knapsack Pro Queue Mode in the video how to run tests with dynamic test suite split and learn what CI problems can be solved thanks to it.

Installation

For npm users:

$ npm install --save-dev @knapsack-pro/jest

For yarn users:

$ yarn add --dev @knapsack-pro/jest

Whenever you see npm in below steps you can use yarn there as well.

How to use

Configuration steps

  1. To get API token just sign up at KnapsackPro.com. Please add to your CI environment variables KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST. You can generate API token in user dashboard.

  2. (optional) Do you want to use "retry single failed parallel CI node" feature for your CI? For instance some of CI providers like Travis CI, Buildkite or Codeship allows you to retry only one of failed parallel CI node instead of retrying the whole CI build with all parallel CI nodes. If you want to be able to retry only single failed parallel CI node then you need to tell Knapsack Pro API to remember the way how test files where allocated across parallel CI nodes by adding to your CI environment variables KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true.

    The default is KNAPSACK_PRO_FIXED_QUEUE_SPLIT=false which means when you want to retry the whole failed CI build then a new dynamic test suite split will happen across all retried parallel CI nodes thanks to Knapsack Pro Queue Mode. Some people may prefer to retry the whole failed CI build with test files allocated across parallel CI nodes in the same order as it happend for the failed CI build - in such case you should set KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true.

  3. (optional) @knapsack-pro/jest detects information about CI build from supported CI environment variables. When information like git branch name and git commit hash cannot be detect from CI environment variables then @knapsack-pro/jest will try to use git installed on CI machine to detect the infomation. If you don't have git installed then you should set the information using environment variables:

    • KNAPSACK_PRO_COMMIT_HASH - git commit hash (SHA1)
    • KNAPSACK_PRO_BRANCH - git branch name
    • KNAPSACK_PRO_CI_NODE_BUILD_ID - a unique ID for your CI build. All parallel CI nodes being part of single CI build must have the same node build ID. Example how to generate node build ID: KNAPSACK_PRO_CI_NODE_BUILD_ID=$(openssl rand - base64 32).
  4. (optional) If you have test files in a non-default directory you won't be able to run tests and you may see below error.

    Response body:
    { errors: [ { test_files: [ 'parameter is required' ] } ] }
    

    Please adjust KNAPSACK_PRO_TEST_FILE_PATTERN variable to match your test files directory structure to let Knapsack Pro detect all the test files you want to run in parallel.

  5. Please select your CI provider and follow instructions to run tests with @knapsack-pro/jest.

CI steps

CircleCI

Example configuration for CircleCI 2.0 platform.

# ~/.circleci/config.yml
version: 2
jobs:
  test:
    docker:
      - image: circleci/<language>:<version TAG>
    parallelism: 2 # run 2 parallel CI nodes

    steps:
      - checkout

      - run:
        name: Run Jest tests with @knapsack-pro/jest using Knapsack Pro Queue Mode
        command: $(npm bin)/knapsack-pro-jest

Please remember to add additional parallel containers for your project in CircleCI settings.

Travis CI

You can parallelize your CI build across virtual machines with travis matrix feature.

# .travis.yml
script:
  - "$(npm bin)/knapsack-pro-jest"

env:
  global:
    - KNAPSACK_PRO_CI_NODE_TOTAL=2
    # allows to be able to retry failed tests on one of parallel job (CI node)
    - KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true

  matrix:
    - KNAPSACK_PRO_CI_NODE_INDEX=0
    - KNAPSACK_PRO_CI_NODE_INDEX=1

The configuration will generate matrix with 2 parallel jobs (2 parallel CI nodes):

# first CI node (first parallel job)
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0

# second CI node (second parallel job)
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1

More info about global and matrix ENV configuration in travis docs.

Buildkite.com

The only thing you need to do is to configure the parallelism parameter (number of parallel agents) in your build step and run the below command in your build:

$(npm bin)/knapsack-pro-jest

If you want to use Buildkite retry single agent feature to retry just failed tests on particular agent (CI node) then you should set KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true.

Other useful resources:

Here you can find article how to set up a new pipeline for your project in Buildkite and configure Knapsack Pro and 2 example repositories for Ruby/Rails projects:

When using the docker-compose plugin on Buildkite, you have to tell it which environment variables to pass to the docker container. Thanks to it Knapsack Pro can detect info about CI build like commit, branch name, amount of parallel nodes.

steps:
  - label: "Test"
    parallelism: 2
    plugins:
      - docker-compose#3.0.3:
        run: app
        command: $(npm bin)/knapsack-pro-jest
        config: docker-compose.test.yml
        env:
          - BUILDKITE_PARALLEL_JOB_COUNT
          - BUILDKITE_PARALLEL_JOB
          - BUILDKITE_BUILD_NUMBER
          - BUILDKITE_COMMIT
          - BUILDKITE_BRANCH

Codeship.com

Codeship does not provide parallel jobs environment variables so you will have to define KNAPSACK_PRO_CI_NODE_TOTAL and KNAPSACK_PRO_CI_NODE_INDEX for each parallel test pipeline. Below is an example for 2 parallel test pipelines.

Configure test pipelines (1/2 used)

# first CI node running in parallel
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 $(npm bin)/knapsack-pro-jest

Configure test pipelines (2/2 used)

# second CI node running in parallel
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 $(npm bin)/knapsack-pro-jest

Remember to add API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST to Environment page of your project settings in Codeship.

CodeShip uses the same build number if you restart a build. Because of that you need to set KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true in order to be able to restart CI build.

Heroku CI

You can parallelize your tests on Heroku CI by configuring app.json for your project.

You can set how many parallel dynos with tests you want to run with quantity value. Use test key to run tests with @knapsack-pro/jest as shown in below example.

You need to specify also the environment variable KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST with API token for Knapsack Pro. For any sensitive environment variables (like Knapsack Pro API token) that you do not want commited in your app.json manifest, you can add them to your pipeline’s Heroku CI settings.

# app.json
{
  "environments": {
    "test": {
      "formation": {
        "test": {
          "quantity": 2
        }
      },
      "addons": [
        "heroku-postgresql"
      ],
      "scripts": {
        "test": "$(npm bin)/knapsack-pro-jest"
      },
      "env": {
        "KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST": "example"
      }
    }
  }
}

Note the Heroku CI Parallel Test Runs are in Beta and you may need to ask Heroku support to enable it for your project.

You can learn more about Heroku CI.

Solano CI

Solano CI does not provide parallel jobs environment variables so you will have to define KNAPSACK_PRO_CI_NODE_TOTAL and KNAPSACK_PRO_CI_NODE_INDEX for each parallel job running as part of the same CI build.

# Step for first CI node
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 $(npm bin)/knapsack-pro-jest

# Step for second CI node
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 $(npm bin)/knapsack-pro-jest

Please remember to set up API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST as global environment.

AppVeyor

AppVeyor does not provide parallel jobs environment variables so you will have to define KNAPSACK_PRO_CI_NODE_TOTAL and KNAPSACK_PRO_CI_NODE_INDEX for each parallel job running as part of the same CI build.

# Step for first CI node
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 $(npm bin)/knapsack-pro-jest

# Step for second CI node
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 $(npm bin)/knapsack-pro-jest

Please remember to set up API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST as global environment.

GitLab CI

Remember to add API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST to Secret Variables in Gitlab CI Settings -> CI/CD Pipelines -> Secret Variables.

GitLab CI >= 11.5
test:
  parallel: 2
  script: $(npm bin)/knapsack-pro-jest

Here you can find info how to configure the GitLab parallel CI nodes.

GitLab CI < 11.5 (old GitLab CI)

GitLab CI does not provide parallel jobs environment variables so you will have to define KNAPSACK_PRO_CI_NODE_TOTAL and KNAPSACK_PRO_CI_NODE_INDEX for each parallel job running as part of the same test stage. Below is relevant part of .gitlab-ci.yml configuration for 2 parallel jobs.

# .gitlab-ci.yml
stages:
  - test

variables:
  KNAPSACK_PRO_CI_NODE_TOTAL: 2

# first CI node running in parallel
test_ci_node_0:
  stage: test
  script:
    - export KNAPSACK_PRO_CI_NODE_INDEX=0
    - $(npm bin)/knapsack-pro-jest

# second CI node running in parallel
test_ci_node_1:
  stage: test
  script:
    - export KNAPSACK_PRO_CI_NODE_INDEX=1
    - $(npm bin)/knapsack-pro-jest

SemaphoreCI.com

Semaphore 2.0

@knapsack-pro/jest supports environment variables provided by Semaphore CI 2.0 to run your tests. You will have to define a few things in .semaphore/semaphore.yml config file.

  • You need to set KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST. If you don't want to commit secrets in yml file then you can follow this guide.
  • You should create as many parallel jobs as you need with parallelism property. If your test suite is slow you should use more parallel jobs.

Below you can find example part of Semaphore CI 2.0 config.

blocks:
  - name: Jest tests
    task:
      env_vars:
        - name: KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST
          value: your_api_token_here
      prologue:
        commands:
          - checkout
          - nvm install --lts carbon
          - sem-version node --lts carbon

      jobs:
        - name: Run tests with Knapsack Pro
          parallelism: 2
          commands:
            - $(npm bin)/knapsack-pro-jest
Semaphore 1.0

The only thing you need to do is set up @knapsack-pro/jest for as many parallel threads as you need. Here is an example:

# Thread 1
$(npm bin)/knapsack-pro-jest

# Thread 2
$(npm bin)/knapsack-pro-jest

Tests will be split across 2 parallel threads.

Please remember to set up API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST as global environment.

Cirrus-CI.org

The only thing you need to do is to configure number of parallel CI nodes for your project by using matrix modification. See example for 2 parallel CI nodes.

# .cirrus.yml
task:
  matrix:
    name: CI node 0
    name: CI node 1
  test_script: $(npm bin)/knapsack-pro-jest

Please remember to set up API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST as global environment.

Here is Ruby example for .cirrus.yml configuration file that you may find useful.

Jenkins

In order to run parallel jobs with Jenkins you should use Jenkins Pipeline. You can learn basics about it in the article Parallelism and Distributed Builds with Jenkins.

Here is example Jenkinsfile working with Jenkins Pipeline.

timeout(time: 60, unit: 'MINUTES') {
  node() {
    stage('Checkout') {
      checkout([/* checkout code from git */])

      // determine git commit hash because we need to pass it to Knapsack Pro
      COMMIT_HASH = sh(returnStdout: true, script: 'git rev-parse HEAD').trim()

      stash 'source'
    }
  }

  def num_nodes = 4; // define your total number of CI nodes (how many parallel jobs will be executed)
  def nodes = [:]

  for (int i = 0; i < num_nodes; i++) {
    def index = i;
    nodes["ci_node_${i}"] = {
      node() {
        stage('Setup') {
          unstash 'source'
          // other setup steps
        }

        def knapsack_options = """\
            KNAPSACK_PRO_CI_NODE_TOTAL=${num_nodes}\
            KNAPSACK_PRO_CI_NODE_INDEX=${index}\
            KNAPSACK_PRO_COMMIT_HASH=${COMMIT_HASH}\
            KNAPSACK_PRO_BRANCH=${env.BRANCH_NAME}\
            KNAPSACK_PRO_CI_NODE_BUILD_ID=${env.BUILD_TAG}\
        """

        // example how to run tests with Knapsack Pro
        stage('Run tests') {
          sh """${knapsack_options} $(npm bin)/knapsack-pro-jest"""
        }
      }
    }
  }

  parallel nodes // run CI nodes in parallel
}

Remember to set environment variable KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST in Jenkins configuration with your API token.

GitHub Actions

@knapsack-pro/jest supports environment variables provided by GitHub Actions to run your tests. You have to define a few things in .github/workflows/main.yaml config file.

  • You need to set KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST environment variable in GitHub repository Settings -> Secrets. See creating and using secrets in GitHub Actions.
  • You should create as many parallel jobs as you need with matrix.ci_node_total and matrix.ci_node_index properties. If your test suite is slow you should use more parallel jobs.

Below you can find config for GitHub Actions.

# .github/workflows/main.yaml
name: Main

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        node-version: [8.x]
        # Set N number of parallel jobs you want to run tests on.
        # Use higher number if you have slow tests to split them on more parallel jobs.
        # Remember to update ci_node_index below to 0..N-1
        ci_node_total: [2]
        # set N-1 indexes for parallel jobs
        # When you run 2 parallel jobs then first job will have index 0, the second job will have index 1 etc
        ci_node_index: [0, 1]

    steps:
      - uses: actions/checkout@v1

      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}

      - name: npm install and build
        run: |
          npm install
          npm run build --if-present

      - name: Run tests with Knapsack Pro
        env:
          KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST: ${{ secrets.KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST }}
          KNAPSACK_PRO_CI_NODE_TOTAL: ${{ matrix.ci_node_total }}
          KNAPSACK_PRO_CI_NODE_INDEX: ${{ matrix.ci_node_index }}
        run: |
          $(npm bin)/knapsack-pro-jest

Codefresh.io

@knapsack-pro/jest supports environment variables provided by Codefresh.io to run your tests. You have to define a few things in .codefresh/codefresh.yml config file.

  • You need to set an API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST in Codefresh dashboard, see left menu Pipelines -> settings (cog icon next to the pipeline) -> Variables tab (see a vertical menu on the right side).
  • Set where Codefresh YAML file can be found. In Codefresh dashboard, see left menu Pipelines -> settings (cog icon next to pipeline) -> Workflow tab (horizontal menu on the top) -> Path to YAML (set there ./.codefresh/codefresh.yml).
  • Set how many parallel jobs (parallel CI nodes) you want to run with KNAPSACK_PRO_CI_NODE_TOTAL environment variable in .codefresh/codefresh.yml file.
  • Ensure in the matrix section you listed all KNAPSACK_PRO_CI_NODE_INDEX environment variables with a value from 0 to KNAPSACK_PRO_CI_NODE_TOTAL-1. Codefresh will generate a matrix of parallel jobs where each job has a different value for KNAPSACK_PRO_CI_NODE_INDEX. Thanks to that Knapsack Pro knows what tests should be run on each parallel job.

Below you can find Codefresh YAML config and Test.Dockerfile used by Codefresh to run the project and Jest test suite inside of Docker container.

# .codefresh/codefresh.yml
version: "1.0"

stages:
  - "clone"
  - "build"
  - "tests"

steps:
  main_clone:
    type: "git-clone"
    description: "Cloning main repository..."
    repo: "${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}"
    revision: "${{CF_BRANCH}}"
    stage: "clone"
  BuildTestDockerImage:
    title: Building Test Docker image
    type: build
    arguments:
      image_name: "${{CF_ACCOUNT}}/${{CF_REPO_NAME}}-test"
      tag: "${{CF_BRANCH_TAG_NORMALIZED}}-${{CF_SHORT_REVISION}}"
      dockerfile: Test.Dockerfile
    stage: "build"

  run_tests:
    stage: "tests"
    image: "${{BuildTestDockerImage}}"
    working_directory: /src
    fail_fast: false
    environment:
      # set how many parallel jobs you want to run
      - KNAPSACK_PRO_CI_NODE_TOTAL=2
    matrix:
      environment:
        # please ensure you have here listed N-1 indexes
        # where N is KNAPSACK_PRO_CI_NODE_TOTAL
        - KNAPSACK_PRO_CI_NODE_INDEX=0
        - KNAPSACK_PRO_CI_NODE_INDEX=1
    commands:
      - $(npm bin)/knapsack-pro-jest

Add Test.Dockerfile to your project repository.

FROM node:10.13

RUN apt-get update && \
  apt-get install -y \
  python3-dev \
  python3-pip

# Install AWS CLI
RUN pip3 install awscli

# Install Codefresh CLI
RUN wget https://github.com/codefresh-io/cli/releases/download/v0.31.1/codefresh-v0.31.1-alpine-x64.tar.gz
RUN tar -xf codefresh-v0.31.1-alpine-x64.tar.gz -C /usr/local/bin/

COPY . /src

WORKDIR /src

RUN npm install

Other CI provider

You have to define KNAPSACK_PRO_CI_NODE_TOTAL and KNAPSACK_PRO_CI_NODE_INDEX for each parallel job running as part of the same CI build.

# Step for first CI node
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=0 $(npm bin)/knapsack-pro-jest

# Step for second CI node
KNAPSACK_PRO_CI_NODE_TOTAL=2 KNAPSACK_PRO_CI_NODE_INDEX=1 $(npm bin)/knapsack-pro-jest

Please remember to set up API token KNAPSACK_PRO_TEST_SUITE_TOKEN_JEST as global environment.

FAQ

Knapsack Pro Core features FAQ

This project depends on @knapsack-pro/core. Please check the FAQ for @knapsack-pro/core to learn more about core features available to you.

How to run tests only from specific directory?

You can set KNAPSACK_PRO_TEST_FILE_PATTERN="{**/__tests__/**/*.js?(x),**/?(*.)(spec|test).js?(x)}" and change pattern to match your directory with test files. You can use glob pattern.

@knapsack-pro/jest by default rejects tests inside of node_modules directory. If your pattern set by KNAPSACK_PRO_TEST_FILE_PATTERN matches test file paths within node_modules then those test file paths won't be run.

How to exclude tests to ignore them from running?

You can set KNAPSACK_PRO_TEST_FILE_EXCLUDE_PATTERN which define a glob pattern to exclude tests similar to Jest testPathIgnorePatterns parameter. Note testPathIgnorePatterns uses regexp pattern while KNAPSACK_PRO_TEST_FILE_EXCLUDE_PATTERN uses glob pattern.

How to pass command line options?

You can pass command line options to Jest by just passing them to @knapsack-pro/jest. See example:

$(npm bin)/knapsack-pro-jest --debug

You can find list of Jest CLI options here.

Development

Dependencies

Setup

  1. Setup @knapsack-pro/core project.

  2. Install dependencies:

    $ npm install
    
  3. In order to use local version of @knapsack-pro/core run:

    $ npm link @knapsack-pro/core
    
  4. Compile TypeScript code to lib directory by running:

    $ npm start
    
  5. Register @knapsack-pro/jest package globally in your local system. This way we will be able to develop other npm packages dependent on it:

    $ npm link
    
  6. Set up your IDE:

    • WebStorm / PhpStorm

      • Install the following plugins:

      • Go to File > Settings > Languages & Frameworks > JavaScript > Code Quality Tools > ESLint

        Turn on Enable checkbox.

      • Go to File > Settings > Languages & Frameworks > TypeScript > TSLint

        Turn on Enable checkbox.

      • Go to File > Settings > Tools > File Watchers

        Click Import button and select watchers.xml file from the repository.

    • Visual Studio Code

    From now on every change in code base will be automatically formatted by Prettier. ESLint and TSLint errors will be also automatically fixed on every file save.

  7. Write some code.

Publishing

  1. Sign in to npm registry with command:

    $ npm adduser
    
  2. Ensure you have the latest version of @knapsack-pro/core in package.json:

    {
      "dependencies": {
        "@knapsack-pro/core": "^x.x.x"
      }
    }
    

    Then run npm install. This way you will be able to test @knapsack-pro/core installed from npm registry instead of local one that was linked with npm link @knapsack-pro/core.

    Now commit updated package.json and package-lock.json.

    $ git commit -am "Update @knapsack-pro/core"
    
  3. Before releasing a new version of package please update CHANGELOG.md with github_changelog_generator:

    $ gem install github_changelog_generator
    
    # generate CHANGELOG.md
    $ github_changelog_generator KnapsackPro/knapsack-pro-jest
    $ git commit -am "Update CHANGELOG.md"
    $ git push origin master
    
  4. If you have added new files to the repository and they should be part of the released npm package then please ensure they are included in files array in package.json.

  5. If you have changed any headers in README.md please refresh table of contents with:

    $ npm run doctoc
    
  6. Compile project:

    # ensure you use local version of @knapsack-pro/core
    $ npm link @knapsack-pro/core
    
    $ npm run build
    
  7. In order to bump version of the package run below command. It will also create a version commit and tag for the release:

    # bump patch version 0.0.x
    $ npm version patch
    
    # bump minor version 0.x.0
    $ npm version minor
    
  8. Push to git repository created commit and tag:

    $ git push origin master --tags
    
  9. Now when git tag is on Github you can update CHANGELOG.md again.

    $ github_changelog_generator KnapsackPro/knapsack-pro-jest
    $ git commit -am "Update CHANGELOG.md"
    $ git push origin master
    
  10. Now you can publish package to npm registry:

    $ npm publish
    

Testing

CI

If your feature requires code change in @knapsack-pro/core then please push the @knapsack-pro/core to GitHub first. Then you can push changes for @knapsack-pro/jest to ensure the CI will use the latest @knapsack-pro/core.

Example Jest test suite

To test @knapsack-pro/jest against real test suite we use:

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free