Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.9 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.9 KB
Raw

polis-cypress

End-To-End Tests written with cypress.io

To run these tests:

  1. Enter the subdir of the cloned repository cd e2e

  2. Install npm dependencies npm install

  3. Open up the Cypress App: npm run cypress

    • By default, we run tests against http://localhost
    • See note below about overriding the base URL.

  4. Click on tests to run

    • Alternatively, you can run all tests automatically: npm test

Debugging

  • We use cypress-terminal-report to ensure that logs display not only in Cypress's Test Runner browser UI, but also in the console.
    • These only print when a test has failed, to reduce noise.
    • Logs of failed tests can be seen on CI server (GitHub Actions).

Notes

  • We keep some helper scripts in package.json.
  • The default base url for running tests against, is https://localhost
    • You may override any cypress-related command this like so: CYPRESS_BASE_URL=http://123.45.67.89.sslip.io npm test
  • cypress/integration/polis/: where we store our tests
  • cypress/integration/examples: where we store boilerplate examples (ignored by test runner)
  • cypress/support/commands.js: where we keep oft-used commands, e.g., for logging in, creating conversations, etc.
  • cypress/support/index.js: where we keep code we wish to run during initial setup, e.g., to ensure default users present.
  • For tests against features that require third-party credentials when self-hosted, we use filenames like *.secrets.spec.js.
    • This allows someone to easily exclude them from test runs.
  • These tests are run automatically on pull requests and mainline branch.