Skip to content

Commit 404c56a

Browse files
author
Dana Powers
committed
Add a little more detail to test instructions in README
1 parent 31a4b1d commit 404c56a

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,21 @@ pip install python-snappy
217217
tox
218218
```
219219

220-
## Run a single unit test
220+
## Run a subset of unit tests
221221
```shell
222+
# run protocol tests only
223+
tox -- -v test.test_protocol
224+
```
225+
226+
```shell
227+
# test with pypy only
228+
tox -e pypy
229+
```
230+
231+
```shell
232+
# Run only 1 test, and use python 2.7
233+
tox -e py27 -- -v --with-id --collect-only
234+
# pick a test number from the list like #102
222235
tox -e py27 -- -v --with-id 102
223236
```
224237

@@ -239,11 +252,11 @@ and optionally set SCALA_VERSION (defaults to 2.8.0, but 2.10.1 is recommended)
239252
SCALA_VERSION=2.10.1 KAFKA_VERSION=trunk ./build_integration.sh
240253
```
241254

242-
Then run the tests against supported Kafka versions:
255+
Then run the tests against supported Kafka versions, simply set the `KAFKA_VERSION`
256+
env variable to the server build you want to use for testing:
243257
```shell
244258
KAFKA_VERSION=0.8.0 tox
245259
KAFKA_VERSION=0.8.1 tox
246260
KAFKA_VERSION=0.8.1.1 tox
247261
KAFKA_VERSION=trunk tox
248262
```
249-

0 commit comments

Comments
 (0)