- Node.js and npm
- Java 17
- jq
- Docker Engine 19.03.0+
- Preferably the latest docker-compose
-
Clone the repo and go to its directory
-
Build ODD Platform's docker image locally:
./gradlew jibDockerBuild -x test --image odd-platform:e2e-latest-build
or use the following command if your environment is ARM based
./gradlew jibDockerBuild -x test --image odd-platform:e2e-latest-build -PcontainerBuildArm=true
-
Go to
tests
directory -
Install dependencies:
npm install
-
Install browsers:
npx playwright install --with-deps chromium
-
Configure and run ODD Platform (inside the docker containers):
npm run odd-up
Note: Check the instructions in Step 1 of this manual if you encounter any problems.
-
Run test suite:
-
in headful mode:
npm test
-
or in headless mode:
npm run test:ci
-
-
Tear down all parts of the ODD platform (i.e. stop and remove containers):
npm run odd-down
npm run lint
to run linternpm run format
to run code formatternpm run lint:fix
to fix fixable linter issues and run code formatter
-
Install the ESLint plugin to lint your code
- ESLint plugin for VSCode
- ESLint plugin for IntelliJ IDEA (Note: The plugin is available only in IntelliJ IDEA Ultimate)
- ESLint plugin for WebStorm
-
Install the Prettier plugin to automatically format your code on Save
- Prettier plugin for VSCode
- Prettier plugin for IntelliJ IDEA (Note: The plugin is available only in IntelliJ IDEA Ultimate)
- Prettier plugin for WebStorm
-
Open a project from the "tests" directory, so that the ESLint and Prettier plugins work correctly in the text editor
- Do the following if you want to run tests in CI to check your changes in your feature branch without creating a pull request:
- create a feature branch with a name that starts with "debug/" (for instance:
debug/my_wonderful_tests
)
- create a feature branch with a name that starts with "debug/" (for instance: