gitlab-ci-test

GitLab CI Test

Testing GitLab CI pipelines using gitlab-ci-local.

Warning

This project will use your docker socket to run the pipeline. Using this tool on untrusted pipelines will lead to arbitrary code execution.

Prerequisites

• Docker
• Node.js
• npm install -g gitlab-ci-test

Setup

• Create a folder for your test project
• In the folder, create a .gitlab-ci.yml file with the pipeline
• If you want to test a template, it should be stored as templates/*.yml in your current working directory and referenced in the pipeline:

include:
  - local: templates/template.yml

Usage

Javascript file

• Create a js file describing your test:

// gitlab-ci-test and chai are imported globally
it("My project pipeline is successful", async () => {
  const jobs = await runPipeline("project-path", {
    variables: {
      KEY: "value",
    },
  })

  assert.ok(isSuccess(jobs))
})

• Run gitlab-ci-test <test-file.js>

See test/example.test.js for a complete example.

Yaml file

• Create a yaml file describing your test:

# test definition
description: My project pipeline is successful
project: project-path
asserts:
  - test: "success"
---
# template variables
KEY: VALUE

• In the template project root, run gitlab-ci-test <test-file.yml>

Result object

The context used for assertions has the following structure:

{
  success: boolean, // true if the pipeline succeeded
  run_jobs: ["node-build"], // list of jobs that ran
  jobs: { // list of all jobs in the pipeline
    "node-build": {
      stdout: "line\nline", // stdout of the job
      stderr: "line\nline", // stderr of the job
      artifacts: {
        exists: (path) => boolean, // check if an artifact exists
      },
      // many other properties provided by gitlab-ci-local
    },
    // ...
  }
}

See all yaml files in test folder for a complete example.