diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2018-10-26 22:14:42 -0700 |
|---|---|---|
| committer | Jeff Widman <jeff@jeffwidman.com> | 2018-10-27 00:00:00 -0700 |
| commit | 4f4e4fb5da8861593d084fa8a9de223ed7439ccf (patch) | |
| tree | 0513be73a0d77f14ef483d41f4daca295130cd23 | |
| parent | 8791f0558fc103df43a2d7ab214904ad9a15f147 (diff) | |
| download | kafka-python-4f4e4fb5da8861593d084fa8a9de223ed7439ccf.tar.gz | |
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.
| -rw-r--r-- | docs/tests.rst | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/docs/tests.rst b/docs/tests.rst index 74642c9..5983475 100644 --- a/docs/tests.rst +++ b/docs/tests.rst @@ -23,8 +23,13 @@ fixtures for client / consumer / producer testing. Unit tests ------------------ -To run the tests locally, install tox -- `pip install tox` -See https://tox.readthedocs.io/en/latest/install.html +To run the tests locally, install tox: + +.. code:: bash + + pip install tox + +For more details, see https://tox.readthedocs.io/en/latest/install.html Then simply run tox, optionally setting the python environment. If unset, tox will loop through all environments. @@ -49,8 +54,8 @@ Integration tests .. code:: bash - KAFKA_VERSION=0.10.1.1 tox -e py27 - KAFKA_VERSION=0.8.2.2 tox -e py35 + KAFKA_VERSION=0.8.2.2 tox -e py27 + KAFKA_VERSION=1.0.1 tox -e py36 Integration tests start Kafka and Zookeeper fixtures. This requires downloading @@ -60,25 +65,24 @@ kafka server binaries: ./build_integration.sh -By default, this will install 0.8.2.2, 0.9.0.1, 0.10.1.1, and -0.10.2.1 brokers into the servers/ directory. To install a specific version, - e.g., set `KAFKA_VERSION=0.10.2.1`: +By default, this will install the broker versions listed in build_integration.sh's `ALL_RELEASES` +into the servers/ directory. To install a specific version, set the `KAFKA_VERSION` variable: .. code:: bash - KAFKA_VERSION=0.10.2.1 ./build_integration.sh + KAFKA_VERSION=1.0.1 ./build_integration.sh -Then run the tests against supported Kafka versions, simply set the `KAFKA_VERSION` +Then to run the tests against a specific Kafka version, simply set the `KAFKA_VERSION` env variable to the server build you want to use for testing: .. code:: bash - KAFKA_VERSION=0.10.2.1 tox -e py27 + KAFKA_VERSION=1.0.1 tox -e py36 To test against the kafka source tree, set KAFKA_VERSION=trunk -[optionally set SCALA_VERSION (defaults to 2.10)] +[optionally set SCALA_VERSION (defaults to the value set in `build_integration.sh`)] .. code:: bash - SCALA_VERSION=2.11 KAFKA_VERSION=trunk ./build_integration.sh - KAFKA_VERSION=trunk tox -e py35 + SCALA_VERSION=2.12 KAFKA_VERSION=trunk ./build_integration.sh + KAFKA_VERSION=trunk tox -e py36 |