cypress.md

Using bktec with Cypress

To integrate bktec with Cypress, set the BUILDKITE_TEST_ENGINE_TEST_RUNNER environment variable to cypress.

export BUILDKITE_TEST_ENGINE_TEST_RUNNER=cypress

Configure test command

By default, bktec runs Cypress with the following command:

npx cypress run --spec {{testExamples}}

In this command, {{testExamples}} is replaced by bktec with the list of test files to run. You can customize this command using the BUILDKITE_TEST_ENGINE_TEST_CMD environment variable.

To customize the test command, set the following environment variable:

export BUILDKITE_TEST_ENGINE_TEST_CMD="yarn cypress:run --spec {{testExamples}}"

Filter test files

By default, bktec runs test files that match the **/*.cy.{js,jsx,ts,tsx} pattern. You can customize this pattern using the BUILDKITE_TEST_ENGINE_TEST_FILE_PATTERN environment variable. For instance, to configure bktec to only run Cypress test files inside a cypress/e2e directory, use:

export BUILDKITE_TEST_ENGINE_TEST_FILE_PATTERN=cypress/e2e/**/*.cy.js

Additionally, you can exclude specific files or directories that match a certain pattern using the BUILDKITE_TEST_ENGINE_TEST_FILE_EXCLUDE_PATTERN environment variable. For example, to exclude test files inside the cypress/component directory, use:

export BUILDKITE_TEST_ENGINE_TEST_FILE_EXCLUDE_PATTERN=cypress/component

You can also use both BUILDKITE_TEST_ENGINE_TEST_FILE_PATTERN and BUILDKITE_TEST_ENGINE_TEST_FILE_EXCLUDE_PATTERN simultaneously. For example, to run all Cypress test files with cy.js, except those in the cypress/e2e directory, use:

export BUILDKITE_TEST_ENGINE_TEST_FILE_PATTERN=**/*.cy.js
export BUILDKITE_TEST_ENGINE_TEST_FILE_EXCLUDE_PATTERN=cypress/e2e

Tip

This option accepts the pattern syntax supported by the zzglob library.