This is run to test integration tests which test Unlock as a whole. Other tests (unit tests for smart contracts or for react app) belong in their respective folders.
This is useful to ensure that all blocks work "together" if they already work in isolation. We do not expect developers to necessarily run these tests for nost feature work but they will be run on every pull request as part of the CI/CD process.
We use Puppeteer and jest.
We should test each "core" feature of the application. The approach is to write files in /test
which perform these tests.
In CI, running these tests requires 3 docker images:
- One with ganache, the local development ethereum node
- One with the whole next.js application (connected to the ganache node)
- One which actually runs puppeteer and executes the test suite.
It is possible to run the tests locally, without docker running. Additionally, running the test locally allows for a little more flexibility to debug. For example, even if the tests are running in a headless way by default, they can be run in an actual web browser which lets the developer see what is being rendered on screen.
- start a docker dev cluster (at the root): see instruction in the main README.md
- run the dashboard application (in
/unlock-app):UNLOCK_ENV=test npm run start(you may need to build the application first:npm run build) - run the dashboard application without an injected provider (required to test unlock accounts) (in
/unlock-app):PORT=9000 UNLOCK_ENV=unlock-provider-integration npm run start - run the locksmith application (in
/locksmith):UNLOCK_ENV=test npm run start - run the paywall application (in
/paywall):UNLOCK_ENV=test USER_IFRAME_URL=http://localhost:9000/account npm run start(you may need to build the application first:npm run build) - execute the tests (in
/tests):npm run test
There are a few interesting and useful debugging options on this page including
the ability to 'slow down' execution via slowMo...