mirror of https://github.com/peter4431/rq.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
---
|
|
title: "Testing"
|
|
layout: contrib
|
|
---
|
|
|
|
### Testing RQ locally
|
|
|
|
To run tests locally you can use `tox`, which will run the tests with all supported Python versions (3.6 - 3.11)
|
|
|
|
```
|
|
tox
|
|
```
|
|
|
|
Bear in mind that you need to have all those versions installed in your local environment for that to work.
|
|
|
|
### Testing with Pytest directly
|
|
|
|
For a faster and simpler testing alternative you can just run `pytest` directly.
|
|
|
|
```sh
|
|
pytest .
|
|
```
|
|
|
|
It should automatically pickup the `tests` directory and run the test suite.
|
|
Bear in mind that some tests may be be skipped in your local environment - make sure to look at which tests are being skipped.
|
|
|
|
|
|
### Skipped Tests
|
|
|
|
Apart from skipped tests related to the interpreter (eg. `PyPy`) or operational systems, slow tests are also skipped by default, but are ran in the GitHub CI/CD workflow.
|
|
To include slow tests in your local environment, use the `RUN_SLOW_TESTS_TOO=1` environment variable:
|
|
|
|
```sh
|
|
RUN_SLOW_TESTS_TOO=1 pytest .
|
|
```
|
|
|
|
If you want to analyze the coverage reports, you can use the `--cov` argument to `pytest`. By adding `--cov-report`, you also have some flexibility in terms of the report output format:
|
|
|
|
```sh
|
|
RUN_SLOW_TESTS_TOO=1 pytest --cov=rq --cov-config=.coveragerc --cov-report={{report_format}} --durations=5
|
|
```
|
|
|
|
Where you replace the `report_format` by the desired format (`term` / `html` / `xml`).
|
|
|
|
### Using Vagrant
|
|
|
|
If you rather use Vagrant, see [these instructions][v].
|
|
|
|
[v]: {{site.baseurl}}contrib/vagrant/
|