cypress-included

packaged by Chainguard

Chainguard Container for cypress-included

Minimal image for cypress/included.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/cypress-included:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The cypress-included image is comparable to the upstream cypress/included image. Both run cypress run as the entrypoint and include Node.js, a virtual display, and Firefox. The Chainguard image differs in the following ways:

• The image runs as the nonroot user (UID 65532) by default. The upstream image runs as root. To write screenshots and videos into a mounted project, run the container as the owner of the project directory, as shown in Getting Started. The image has no node user, so use --user 1000 -e HOME=/tmp in place of upstream's -u node.
• Chromium stands in for Google Chrome and Microsoft Edge, which the upstream image also includes. Use --browser chromium instead of --browser chrome or --browser edge.
• The Cypress binary is built from source and lives at /usr/lib/cypress/Cypress/Cypress instead of the Cypress cache folder. CYPRESS_RUN_BINARY points to it, and CYPRESS_INSTALL_BINARY=0 stops a project's own cypress dependency from downloading a second binary.
• The global TypeScript, which compiles .ts specs when the project does not install its own, can be a newer major version than the one in the upstream image.
• GECKODRIVER_PATH is /usr/bin/geckodriver and NODE_PATH is /usr/lib/node_modules.

Getting Started

The following commands create a small Cypress project with one page and one spec:

mkdir -p e2e/cypress/e2e && cd e2e

cat > index.html <<EOF
<!doctype html>
<button id="b">go</button>
<div id="o"></div>
<script>
  document.getElementById('b').addEventListener('click', () => {
    document.getElementById('o').textContent = '42'
  })
</script>
EOF

cat > cypress.config.js <<EOF
module.exports = { e2e: { supportFile: false } }
EOF

cat > cypress/e2e/app.cy.js <<EOF
describe('app', () => {
  it('shows the answer', () => {
    cy.visit('index.html')
    cy.get('#b').click()
    cy.get('#o').should('have.text', '42')
    cy.screenshot('page')
  })
})
EOF

Run the spec headless in the bundled Electron browser. The --user flag lets Cypress write into the mounted directory, and HOME points to a writable directory because the user ID has no home directory in the image:

docker run --rm -v "$PWD":/e2e -w /e2e \
  --user "$(id -u):$(id -g)" -e HOME=/tmp \
  cgr.dev/ORGANIZATION/cypress-included:latest

The run ends with All specs passed!, and the screenshot is saved to cypress/screenshots/app.cy.js/page.png.

To run the same spec in Chromium or Firefox, pass the browser after the image name:

docker run --rm -v "$PWD":/e2e -w /e2e \
  --user "$(id -u):$(id -g)" -e HOME=/tmp \
  cgr.dev/ORGANIZATION/cypress-included:latest --browser firefox

To list the browsers that Cypress detects, run cypress info:

docker run --rm --entrypoint cypress cgr.dev/ORGANIZATION/cypress-included:latest info

Configuration

Any argument after the image name goes to cypress run, so the usual command-line options and CYPRESS_* environment variables work as they do with the upstream image. For example, the following command records a video of the run, which is off by default in Cypress:

docker run --rm -v "$PWD":/e2e -w /e2e \
  --user "$(id -u):$(id -g)" -e HOME=/tmp \
  cgr.dev/ORGANIZATION/cypress-included:latest --config video=true

A project that lists cypress in its package.json can run its own CLI with npx. Install the same Cypress version as the image, so that the CLI matches the packaged binary:

version=$(docker run --rm --entrypoint cypress cgr.dev/ORGANIZATION/cypress-included:latest version --component package)

docker run --rm -v "$PWD":/e2e -w /e2e \
  --user "$(id -u):$(id -g)" -e HOME=/tmp \
  --entrypoint npm cgr.dev/ORGANIZATION/cypress-included:latest \
  install --no-audit --no-fund --save-dev "cypress@${version}"

docker run --rm -v "$PWD":/e2e -w /e2e \
  --user "$(id -u):$(id -g)" -e HOME=/tmp \
  --entrypoint npx cgr.dev/ORGANIZATION/cypress-included:latest cypress run

Documentation and Resources

• Cypress documentation
• Running Cypress in Docker
• Upstream Cypress Docker images

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.