Add section about tests to CONTRIBUTING.md

pull/6294/head
Jeremy Tuloup 5 years ago
parent 21c9ea3912
commit caa2d6b912

@ -56,3 +56,32 @@ Then start JupyterLab Classic with:
```bash
jupyter classic
```
## Running Tests
To run the tests:
```bash
jlpm run build:test
jlpm run test
```
There are also end to end tests to cover higher level user interactions, located in the `app/test` folder. To run these tests:
```bash
# start a new Jupyter server in a terminal
npm start
# run the end to end tests
jlpm run test:e2e
# to run in headful mode
PWDEBUG=1 jlpm run test:e2e
# to run with firefox as the browser
BROWSER=firefox jlpm run test:e2e
```
Running the end to end tests in headful mode will trigger something like the following:
![end-to-end-smoke](https://user-images.githubusercontent.com/591645/106299215-34a67b00-6255-11eb-854c-756a8790246b.gif)

@ -33,7 +33,8 @@
"release:patch": "node ./buildutils/lib/release-patch.js",
"start": "jupyter classic --config ./app/test/jupyter_server_config.py --no-browser",
"test": "lerna run test",
"test:ci": "(jlpm run start&) && lerna run test:e2e",
"test:e2e": "lerna run test:e2e --stream",
"test:ci": "(jlpm run start&) && jlpm run test:e2e",
"update:dependency": "node ./node_modules/@jupyterlab/buildutils/lib/update-dependency.js --lerna"
},
"husky": {

Loading…
Cancel
Save