Skip to content

Commit 19646d4

Browse files
majorgreysmergify[bot]Julien Danjou
authored
fix(docs): update testing with ddtest and riot (#2575)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Julien Danjou <[email protected]>
1 parent 6d81403 commit 19646d4

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -62,24 +62,26 @@ launch them through:
6262

6363
#### Running Tests in docker
6464

65-
Once your docker-compose environment is running, you can run the test runner image:
66-
67-
$ docker-compose run --rm testrunner
68-
69-
Now you are in a bash shell. You can now run tests as you would do in your local environment:
70-
71-
$ tox -e '{py35,py36}-redis{210}'
72-
73-
We also provide a shell script to execute commands in the provided container.
74-
75-
For example to run the tests for `redis-py` 2.10 on Python 3.5 and 3.6:
76-
77-
$ ./scripts/ddtest tox -e '{py35,py36}-redis{210}'
78-
79-
If you want to run a list of tox environment (as CircleCI does) based on a
80-
pattern, you can use the following command:
81-
82-
$ scripts/ddtest scripts/run-tox-scenario '^futures_contrib-'
65+
Once your docker-compose environment is running, you can use the shell script to
66+
execute tests within a Docker image. You can start the container with a bash shell:
67+
68+
$ scripts/ddtest
69+
70+
You can now run tests as you would do in your local environment. We use
71+
[tox][tox] as well as [riot][riot], a new tool that we developed for addressing
72+
our specific needs with an ever growing matrix of tests. You can list the tests
73+
managed by each:
74+
75+
$ tox -l
76+
$ riot list
77+
78+
You can run multiple tests by using regular expressions:
79+
80+
$ scripts/run-tox-scenario '^futures_contrib-'
81+
$ riot run psycopg
82+
83+
[tox]: https://github.com/tox-dev/tox/
84+
[riot]: https://github.com/DataDog/riot/
8385

8486
### Continuous Integration
8587

0 commit comments

Comments
 (0)