zonemaster-gui/docs/Testing.md
[Thomas Green] 95a4d135e0 Update unit testing documentation
- Remove disclaimer
- Match Playwright version with the one in `package.json`
- Remove outdated "Test server" section
2026-02-19 17:33:43 +01:00

1.5 KiB

Unit testing of Zonemaster-GUI

Setup

This part assumed that you have a working NodeJS environment on Ubuntu. See the build environment document for further instructions.

The tests for Zonemaster GUI are implemented using playwright, to install the tests dependencies run the following.

npm run e2e:install-deps
npm run e2e:install

This will install system dependencies as well as the browsers used to tests the GUI.

Running the tests

To run the tests run the following command.

npm run e2e

If the appearance of the GUI changes some tests might fail as the baseline for visual comparison is no longer up to date. In this case it is required to update the snapshots. The following commands updates the snapshots while ensuring a similar environment than the one the CI runs in is used (Ubuntu 22.04 and UTC time).

docker run --rm --network host -v $(pwd):/work/ -w /work/ -it mcr.microsoft.com/playwright:v1.57.0-jammy /bin/bash
npm run e2e:install
npm run e2e:update
exit

Note that this method may not always work: it could happen that the generated snapshots are incorrect and have slight differences (e.g. appears zoomed in/out, etc). In that case, repeat the above steps but outside of the Docker environment, and preferably on a machine that uses a similar OS/environment as the CI.