GitLab CI template for Cypress¶

This project implements a GitLab CI/CD template to run your automated (web) tests with Cypress.

Usage¶

This template can be used both as a CI/CD component or using the legacy include:project syntax.

Use as a CI/CD component¶

Add the following to your .gitlab-ci.yml:

include:
  # 1: include the component
  - component: $CI_SERVER_FQDN/to-be-continuous/cypress/gitlab-ci-cypress@3.8.0
    # 2: set/override component inputs
    inputs:
      review-enabled: true # ⚠ this is only an example

Use as a CI/CD template (legacy)¶

Add the following to your .gitlab-ci.yml:

include:
  # 1: include the template
  - project: 'to-be-continuous/cypress'
    ref: '3.8.0'
    file: '/templates/gitlab-ci-cypress.yml'

variables:
  # 2: set/override template variables
  REVIEW_ENABLED: "true" # ⚠ this is only an example

`cypress` job¶

This job starts Cypress (functional) tests.

It uses the following variable:

Input / Variable	Description	Default value
`image` / `CYPRESS_IMAGE`	The Docker image used to run Cypress (use included images only).	`registry.hub.docker.com/cypress/included:13.13.3`
`project-dir` / `CYPRESS_PROJECT_DIR`	The Cypress project directory (containing `cypress.config.js` or `cypress.config.ts`)	`.`
`extra-args` / `CYPRESS_EXTRA_ARGS`	Cypress extra run options (to select a different browser, configuration or spec files for e.g.)	none
`review-enabled` / `REVIEW_ENABLED`	Set to `true` to enable Cypress tests on review environments (dynamic environments instantiated on development branches)	none (disabled)

In addition to a textual report in the console, this job produces the following reports, kept for one day:

Report	Format	Usage
`$CYPRESS_PROJECT_DIR/reports/cypress-*.xunit.xml`	xUnit test report(s)	GitLab integration

Cypress `baseUrl` auto evaluation¶

By default, the Cypress template tries to auto-evaluate the baseUrl setting (i.e. the variable pointing at server under test) by looking either for a $environment_url variable or for an environment_url.txt file.

Therefore if an upstream job in the pipeline deployed your code to a server and propagated the deployed server url, either through a dotenv variable $environment_url or through a basic environment_url.txt file, then the Cypress test will automatically be run on this server.

all our deployment templates implement this design. Therefore even purely dynamic environments (such as review environments) will automatically be propagated to your Cypress tests.

If you're not using a smart deployment job, you may still explicitly declare the CYPRESS_BASE_URL variable (but that will be unfortunately hardcoded to a single server).

Hook scripts¶

The Cypress template supports optional hook scripts from your project, located in the $CYPRESS_PROJECT_DIR directory to perform additional project-specific logic:

pre-cypress.sh is executed before running Cypress,
post-cypress.sh is executed after running Cypress (whichever the tests status).