e2ed

E2E utils

Usage no npm install needed!

<script type="module">
  import e2ed from 'https://cdn.skypack.dev/e2ed';
</script>

README

e2ed logo

e2ed

NPM version code style: prettier TypeScript Conventional Commits License MIT

E2E utils for TestCafe.

Install

Requires node@16 or higher:

npm install e2ed --save-dev

Usage

CLI

First create the necessary initial structure of directories and files in the project, with a sample test and pageObject (all the code related to e2ed will be in the e2ed directory in the root of the project):

npx e2ed-init

Then run tests locally for https://google.com:

E2ED_ORIGIN=https://google.com npx e2ed

And run tests for https://google.com in docker:

E2ED_ORIGIN=https://google.com ./e2ed/bin/runDocker.sh

Environment variables

E2ED_ORIGIN: origin-part of the url (protocol + host) on which the tests will be run. For example, https://google.com.

E2ED_API_ORIGIN: origin-part of the backend API url that can be used by tests to create and delete test entities.

E2ED_CONCURRENCY: the number of browser windows in which tests will run in parallel (maximum value 50, 5 by default for run in docker and 1 by default for local run).

E2ED_DEBUG: run e2ed in nodejs-debug mode (--inspect-brk=0.0.0.0) if this variable is not empty.

E2ED_DOCKER_DEBUG_PORT: debug port when run in docker (9229 by default).

E2ED_DOCKER_DO_AFTER_TESTS: the name of the executable file from the e2ed/bin directory that will be run (into container) after running the tests.

E2ED_DOCKER_DO_BEFORE_TESTS: the name of the executable file from the e2ed/bin directory that will be run (into container) before running the tests.

E2ED_DOCKER_IMAGE: the name of the docker image used to run tests with the your-project/e2ed/bin/runDocker.sh command (e2ed by default).

E2ED_DOCKER_RETRIES: the maximum number of retries to run a failing test with the your-project/e2ed/bin/runDocker.sh command (maximum value 10, 5 by default). For example, if it is equal to three, the test will be run no more than three times.

E2ED_REPORT_NAME: the name of HTML report (without extension .html). This name is used as the title of the report page, and as the name of the file to save the report.

E2ED_HIDE_LOGS: hides detailed logs of test runs if this variable is not empty.

E2ED_IS_DOCKER_RUN: when run in docker the e2ed sets this variable to "true".

E2ED_IS_LOCAL_RUN: when run local the e2ed sets this variable to "true".

E2ED_NAVIGATE_STABILIZATION_INTERVAL: after navigating to the page, e2ed will wait until the page is stable for the specified time in milliseconds (maximum value 60000, 2000 by default).

License

MIT