Skip to content

Commit 4f4e4fb

Browse files
committed
Minor cleanup of testing doc
Removed some of the hardcoded values as they are now outdated, and just pointed to where to find the current value in the code. Also some minor wordsmithing.
1 parent 8791f05 commit 4f4e4fb

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

docs/tests.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,13 @@ fixtures for client / consumer / producer testing.
2323
Unit tests
2424
------------------
2525

26-
To run the tests locally, install tox -- `pip install tox`
27-
See https://tox.readthedocs.io/en/latest/install.html
26+
To run the tests locally, install tox:
27+
28+
.. code:: bash
29+
30+
pip install tox
31+
32+
For more details, see https://tox.readthedocs.io/en/latest/install.html
2833

2934
Then simply run tox, optionally setting the python environment.
3035
If unset, tox will loop through all environments.
@@ -49,8 +54,8 @@ Integration tests
4954

5055
.. code:: bash
5156
52-
KAFKA_VERSION=0.10.1.1 tox -e py27
53-
KAFKA_VERSION=0.8.2.2 tox -e py35
57+
KAFKA_VERSION=0.8.2.2 tox -e py27
58+
KAFKA_VERSION=1.0.1 tox -e py36
5459
5560
5661
Integration tests start Kafka and Zookeeper fixtures. This requires downloading
@@ -60,25 +65,24 @@ kafka server binaries:
6065
6166
./build_integration.sh
6267
63-
By default, this will install 0.8.2.2, 0.9.0.1, 0.10.1.1, and
64-
0.10.2.1 brokers into the servers/ directory. To install a specific version,
65-
e.g., set `KAFKA_VERSION=0.10.2.1`:
68+
By default, this will install the broker versions listed in build_integration.sh's `ALL_RELEASES`
69+
into the servers/ directory. To install a specific version, set the `KAFKA_VERSION` variable:
6670

6771
.. code:: bash
6872
69-
KAFKA_VERSION=0.10.2.1 ./build_integration.sh
73+
KAFKA_VERSION=1.0.1 ./build_integration.sh
7074
71-
Then run the tests against supported Kafka versions, simply set the `KAFKA_VERSION`
75+
Then to run the tests against a specific Kafka version, simply set the `KAFKA_VERSION`
7276
env variable to the server build you want to use for testing:
7377

7478
.. code:: bash
7579
76-
KAFKA_VERSION=0.10.2.1 tox -e py27
80+
KAFKA_VERSION=1.0.1 tox -e py36
7781
7882
To test against the kafka source tree, set KAFKA_VERSION=trunk
79-
[optionally set SCALA_VERSION (defaults to 2.10)]
83+
[optionally set SCALA_VERSION (defaults to the value set in `build_integration.sh`)]
8084

8185
.. code:: bash
8286
83-
SCALA_VERSION=2.11 KAFKA_VERSION=trunk ./build_integration.sh
84-
KAFKA_VERSION=trunk tox -e py35
87+
SCALA_VERSION=2.12 KAFKA_VERSION=trunk ./build_integration.sh
88+
KAFKA_VERSION=trunk tox -e py36

0 commit comments

Comments
 (0)