How to run cypress tests using browsers in docker

Running Cypress tests with a browser in Docker primarily involves the following steps:

1. Prepare the Dockerfile

First, create a Dockerfile to define the environment for running Cypress. Here is a basic Dockerfile example using the official Cypress base image:

dockerfile
# Use the official Cypress base image that includes Node.js and all dependencies
FROM cypress/base:14.17.0

# Set the working directory
WORKDIR /app

# Copy project files to the working directory
COPY . /app

# Install project dependencies
RUN npm install

# Verify Cypress installation and cache binary files and dependencies to reduce installation time on subsequent runs
RUN npx cypress verify

# Launch the Cypress runner interface for debugging and development
# CMD ["npx", "cypress", "open"]

# Run Cypress tests from the command line
CMD ["npx", "cypress", "run"]

2. Build the Docker image

Use the following command to build the Docker image:

bash
docker build -t my-cypress-app .

This command creates a Docker image named my-cypress-app based on the Dockerfile.

3. Run the container

Execute the following command to start the container and run Cypress tests:

bash
docker run my-cypress-app

This command starts a new container based on the previously built image and executes the default command defined in the Dockerfile, which runs Cypress tests.

4. View test results

The results of Cypress tests will be displayed in the command line. You can also configure Cypress to generate videos or screenshots for further analysis.

Practical application example

Suppose you have a frontend project built with React and want to run Cypress tests in a Docker container. Ensure the project root directory has correctly configured cypress.json and the test folder (typically cypress/integration).

After creating the Dockerfile and building the image, you only need to rebuild the image and run the container after each code change to execute automated tests. This approach is well-suited for integration into CI/CD pipelines, such as using Jenkins, GitHub Actions, or GitLab CI.

This ensures tests run in a consistent environment, avoiding the 'it works on my machine' issue and quickly identifying environment-related problems.