cypress-example-kitchensink

Kitchen Sink

This is an example app used to showcase Cypress.io End-to-End (E2E) testing. The application demonstrates the use of most Cypress API commands. Additionally this example app is configured to run E2E tests in various CI platforms. Several workflows demonstrate the CI use of Cypress Docker images which provide convenient, pre-configured compatible environments for Cypress. The tests are also heavily commented.

To see the kitchen sink application, and to view the Cypress API commands demonstrated by the app, visit example.cypress.io.

For a full reference of our documentation, go to docs.cypress.io.

For an example payment application demonstrating real-world usage of Cypress.io End-to-End (E2E) testing, go to the cypress-io/cypress-realworld-app repository.

CI Status

The following table lists the live workflows which each independently test the contents of this example repository. They run and record using Cypress Cloud with their results displaying centrally under Cypress Cloud ProjectId 4b7344:

CI Provider	Workflow	Build Status
cypress-io/github-action	using-action.yml
GitHub Actions	single.yml
GitHub Actions	parallel.yml
GitHub Actions	browsers.yml

You can find all CI results recorded on the Cypress Cloud

CI Workflow Examples

This table shows additional examples of CI workflows. With the exception of GitHub Actions workflows, these are not live examples as in the table above and they may require modification before use. The GitHub Actions workflows are live and they run without recording to Cypress Cloud.

CI Provider	Basic Config	Full Parallel Config	Docker example
AWS Amplify	amplify.yml
AWS CodeBuild	basic/buildspec.yml	buildspec.yml
Azure Pipelines	basic/azure-ci.yml	azure-ci.yml
Buddy.works	buddy.yml		:white_check_mark:
Buildkite	.buildkite/pipeline.yml
CircleCI	basic/.circleci/config.yml
GitHub Actions	chrome.yml
GitHub Actions	chrome-docker.yml		:white_check_mark:
GitLab	basic/.gitlab-ci.yml	.gitlab-ci.yml	:white_check_mark:
Jenkins	basic/Jenkinsfile	Jenkinsfile	:white_check_mark:
Semaphore 2.0	basic/.semaphore.yml	.semaphore/semaphore.yml
Travis CI	basic/.travis.yml	.travis.yml

The Cypress documentation page CI Provider Examples provides some more examples with extensive guides for using Cypress with some of the most popular CI providers.

Run Tests

Local testing

To run the tests from this repo on your local machine, first make sure your machine meets the Cypress System Requirements, including the installation of Node.js according to the version specified in the file .node-version.

Executing the following instructions will clone the repository, install dependencies and run Cypress:

git clone https://github.com/cypress-io/cypress-example-kitchensink.git
cd cypress-example-kitchensink
npm ci # install dependencies
npm run local:run # run Cypress headlessly

local:run is a package.json script that starts a local webserver and then uses cypress run to run Cypress headlessly. If you would like to run Cypress tests interactively, then run the following command which uses cypress open to run Cypress in headed mode. You can pick individual tests to run.

npm run local:open

As an alternative to using the local:open and local:run scripts, you can also start the server in one step and then run Cypress in a second step.

npm start # start server on port 8080

You can check that the server is running if you open a web browser and navigate to http://localhost:8080.

Then in a separate terminal window execute either

npx cypress run # for headless mode

or

npx cypress open # for headed interactive mode

Script and server structure

The scripts local:run and local:open use the start-test alias of the npm module start-server-and-test to run ./scripts/start.js, which starts the webserver, waits for it to become ready, and then launches Cypress.

The start script spawns a webserver using the npm module serve and displays the Kitchen Sink App on port 8080.

Docker testing

If you have Docker installed locally, for instance using Docker Desktop, you can run the tests from this repo interactively in a Docker container. Use Cypress Docker images, which are built with all the prerequisites for running Cypress. They are available as base, browsers and included options from Docker Hub and the Amazon ECR (Elastic Container Registry) Public Gallery.

As above, start by cloning the repo and installing dependencies:

git clone https://github.com/cypress-io/cypress-example-kitchensink
cd cypress-example-kitchensink
npm ci

NOTE: For simplicity, the Docker examples below use a repository reference such as cypress/base with the latest version tag. To select an earlier version, replace latest with an explicit tag, for example cypress/base:20.15.1. Explicit version tags are recommended for production. Usage is further explained in the Tags section of the Cypress Docker Images - README.

cypress/base

The following example uses a cypress/base image which itself contains no browsers. You will use the Electron browser bundled with Cypress instead. To run the Docker container, execute the following:

docker run -it --rm -v .:/app -w /app cypress/base:latest

When the container prompt appears, enter:

npx cypress install     # install Cypress binary
npm run test:ci         # start server and run tests in Electron browser
exit

cypress/browsers

With a cypress/browsers image you have the additional choice of Chrome, Edge and Firefox browsers. Execute the following:

docker run -it --rm -v .:/app -w /app cypress/browsers:latest

When the container prompt appears, enter:

npx cypress install     # install Cypress binary
npm run test:ci         # start server and run tests in Electron browser
npm run test:ci:chrome  # start server and run tests in Chrome browser
npm run test:ci:edge    # start server and run tests in Edge browser
npm run test:ci:firefox # start server and run tests in Firefox browser
exit

cypress/included

The cypress/included images add a full Cypress installation compared to cypress/browsers. Execute the following to run the container with a one-line command, testing with the Chrome browser:

docker run -it --rm -v .:/app -w /app --entrypoint bash cypress/included:latest -c 'npm run test:ci:chrome' # use for matching Cypress versions

Replace the latest tag in the above command using the Cypress version from the repo’s package.json, if this repository has not yet been updated to the latest released Cypress version. Note that mismatched versions will cause errors.

NOTE: Additional browsers Chrome, Edge and Firefox are installed in linux/amd64 architecture images cypress/browsers and cypress/included. Firefox is available pre-installed for linux/arm64 architecture images based on Firefox >=136.0.2. Refer to the Cypress Docker images README for details. The Electron browser, which is built-in to Cypress, is available in all images and architectures.

CI Testing

If you would like to try out running tests in a Continuous Integration (CI) provider then you need to first fork the repository so that you have your own copy. Refer to the GitHub documentation to set up aliases for remote upstream (to this repo) and remote origin (to your fork) correctly. You will also need to have an account with the CI provider you want to test with.

Documentation

• Use the Cypress Documentation for instructions on how to use Cypress
• Read the Command Line Guide for run options
• Refer to the API documents to understand the Cypress API calls tested in this repo
• Read Installing Cypress for step-by-step information on installing Cypress in your own project

Support

• For “how-to” questions and discussions, go to the Cypress Discord Chat and be part of the worldwide user community!

Contributing

Check out the Contributing Guideline.

Changelog

See Releases.