Skip to content

Commit

Permalink
Add Integration / E2E testing section to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-i committed Sep 6, 2023
1 parent 91b604a commit 17aa265
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/source/contributors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,33 @@ To uninstall your Jupyter AI development environment, deactivate and remove the
conda deactivate
conda env remove -n jupyter-ai
```

## Testing

### Integration / E2E tests

This extension uses Playwright for the integration / E2E tests (user-level tests).
More precisely, the JupyterLab helper
[Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to
test the extension in JupyterLab.

Install test dependencies (needed only once):

```sh
cd ./packages/jupyter-ai/ui-tests/
jlpm install
jlpm playwright install
cd ../../../
```

To execute them, run:

```sh
cd ./packages/jupyter-ai/ui-tests/
jlpm playwright test
cd ../../../
```

You can find more information in the
[ui-tests](https://github.com/jupyterlab/jupyter-ai/tree/main/packages/jupyter-ai/ui-tests)
README.

0 comments on commit 17aa265

Please sign in to comment.