1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
---
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.7 - 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/
|
