Skip to content

Files

Latest commit

 

History

History
85 lines (52 loc) · 2.3 KB

how-to-add-cypress-tests.md

File metadata and controls

85 lines (52 loc) · 2.3 KB

How to add Cypress tests

When making changes to JavaScript, CSS, or HTML which could change the functionality or layout of a page, it's important to add corresponding Cypress integration tests.

To learn how to write Cypress tests, or 'specs', please see Cypress' official documentation.

Where to add a test

  • Cypress tests are in the ./cypress directory.

  • Cypress tests for a curriculum module are in the corresponding curriculum directory, i.e. cypress/integration/learn/responsive-web-design/basic-css/index.js.

How to run tests

Note

If using GitPod, please see Cypress-GitPod Setup

1. Ensure that MongoDB and client applications are running

2. Run the cypress tests

To run tests against production builds, replace dev with prd below.

  • To run all tests in the ./cypress directory:

    pnpm run cypress:dev:run
  • To run a single test:

    pnpm run cypress -- run --spec=cypress/<path_to_test_file>

    For example:

    pnpm run cypress -- run --spec=cypress/e2e/default/landing.js
  • To create a development build, start the development server, and run all existing cypress end-to-end tests:

    pnpm run e2e:dev:run

Cypress-GitPod Setup

1. Ensure Development Environment is Running

If starting the GitPod environment did not automatically develop the environment:

pnpm run create:config
  • Seed the database
pnpm run seed
  • Develop the server and client
pnpm run develop

2. Install Cypress Build Tools

pnpm run cypress:install-build-tools
  • When prompted in the terminal, select your keyboard layout by language/area

Now, Cypress can be run