jeff/umap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[docs] Add some testing information

Browse source
This commit is contained in:
Alexis Métaireau 2023-12-15 17:43:13 +01:00
parent 7bcf751d46
commit f3c67b54b6
3 changed files with 41 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Makefile
View file

@ -73,10 +73,8 @@ vendors:
npm run vendors npm run vendors
installjs: installjs:
npm install npm install
testjsfx:
firefox umap/static/umap/test/index.html
testjs: node_modules testjs: node_modules
@./node_modules/mocha-phantomjs/bin/mocha-phantomjs --view 1024x768 umap/static/umap/test/index.html @echo "See the tests at http://localhost:8001/umap/static/umap/test/" && python -m http.server 8001
tx_push: tx_push:
tx push -s tx push -s
tx_pull: tx_pull:

45
docs/contributing.md
View file

@ -29,19 +29,52 @@ To be sure to install all the dev dependencies, and have everything working loca
make develop make develop
``` ```
#### JavaScript
For JavaScript, here is the tooling we use:
- Format your code with [Prettier](https://prettier.io/)
- Be sure to configure your editor to insert new lines at the end of files.
### Hack! ### Hack!
You can now do your changes in a specific branch, and when you're ready you can open a pull-request for us to review. You can now do your changes in a specific branch, and when you're ready you can open a pull-request for us to review.
### Run tests ### Running tests
Multiple tests suites are in use in the project. Multiple tests suites are in use in the project.
| Test suite | Location | Command |
| ---------- | -------- | ------- | #### Python unit tests
| Python unit tests | `umap/tests/` | `pytest . --ignore umap/tests/integration` |
| Javascript unit tests | `umap/static/test` | `make testjs`| ```bash
| Integration tests | `umap/tests/integration` | `pytest umap/tests/integration` | pytest . --ignore umap/tests/integration
```
By default, the tests are run in parallel to reduce the time taken to run them. You can run them in serial mode by using the `-n1` option.
If you only want to run one test, you can add `-k specific-test-name` to the command line.
#### Integration tests
```bash
pytest umap/tests/integration
```
The tests are using [Playwright](https://playwright.dev), which spawns a headless browser and runs the tests on it.
If the tests are failing, it might be useful to step trough the tests in the browser. This will let you go step by step with a debugger, so you can see what is happening on a real browser.
```bash
PWDEBUG=1 pytest --headed -n1 -k specific-test-name
```
#### JS tests
```bash
make testjs
```
These tests are located in `umap/static/test`, and we are currently using a mocha test runner.
All the tests are run when you're creating a pull request, to avoid regressions. All the tests are run when you're creating a pull request, to avoid regressions.