This folder contains the integration tests of the extension.
They are defined using Playwright test runner and Galata helper.
The Playwright configuration is defined in playwright.config.js.
The JupyterLab server configuration to use for the integration test is defined in jupyter_server_test_config.py.
The default configuration will produce video for failing tests and an HTML report.
There is a UI mode that you may like; see this resource.
You can run all tests through pixi.
This will setup all required dependencies, including browsers downloads.
You can control the location of the download with the environment variable PLAYWRIGHT_BROWSERS_PATH.
pixi run test-uiTest results will be shown in the terminal. In case of any test failures, the test report will be opened in your browser at the end of the tests execution; see Playwright documentation for configuring that behavior.
All commands are assumed to be executed from the root directory
If you are comparing snapshots to validate your tests, you may need to update the reference snapshots stored in the repository. To do that, you need to:
pixi run test-ui -uSome discrepancy may occurs between the snapshots generated on your computer and the one generated on the CI. To ease updating the snapshots on a PR, you can type
please update playwright snapshotsto trigger the update by a bot on the CI. Once the bot has computed new snapshots, it will commit them to the PR branch.
To create tests, the easiest way is to use the code generator tool of playwright:
Start the server with pixi
pixi run jlpm-ui start- Execute the Playwright code generator in another terminal:
pixi run playwright codegen localhost:53729To debug tests, a good way is to use the inspector tool of playwright. Execute the Playwright tests in debug mode:
pixi run test-ui --debugTo update the web browser versions, you must update the package @playwright/test:
pixi run jlpm-ui up "@playwright/test"
pixi run playwright install