pytest-kafka

Release 0.5.0

Zookeeper, Kafka server, and Kafka consumer fixtures for Pytest

Homepage PyPI

License
MIT
Install
pip install pytest-kafka==0.5.0

Documentation

pytest-kafka

Pytest fixture factories for Zookeeper, Kafka server and Kafka consumer. API docs.

from pytest_kafka import make_zookeeper_process, make_kafka_server, make_kafka_consumer

ROOT = Path(__file__).parent
KAFKA_SCRIPTS = ROOT / 'kafka/bin/'
KAFKA_BIN = str(KAFKA_SCRIPTS / 'kafka-server-start.sh')
ZOOKEEPER_BIN = str(KAFKA_SCRIPTS / 'zookeeper-server-start.sh')

zookeeper_proc = make_zookeeper_process(ZOOKEEPER_BIN)
kafka_server = make_kafka_server(KAFKA_BIN, 'zookeeper_proc')
kafka_consumer = make_kafka_consumer(
    'kafka_server', seek_to_beginning=True, kafka_topics=['topic'])

This creates 3 fixtures:

  1. zookeeper_proc - Zookeeper process
  2. kafka_server - Kafka process
  3. kafka_consumer - usable kafka.KafkaConsumer instance

ZOOKEEPER_BIN and KAFKA_BIN are paths to launch scripts in your Kafka distribution. Check this project's setup.py to see a way of installing Kafka for development.

It is advised to pass seek_to_beginning=True because otherwise some messages may not be captured by the consumer. This requires knowing the topics upfront because without topics there's no partitions to seek.

It's possible to create multiple Kafka fixtures forming a cluster by passing the same Zookeeper fixture to them. For an example, check the tests.

Session-scoped fixtures are also available. Consult the test suite.

System requirements

Development

Execute ./setup.py develop in a virtualenv. This will take care of:

  • installing dependencies
  • updating pip
  • installing dev dependencies
  • installing Kafka to the project dir (for development only)

Acknowledgements

The library has been open-sourced from a codebase belonging to Infectious Media.

Stats

Dependencies
11
Dependent packages
1
Dependent repositories
0
Total releases
13
Latest release
First release
Stars
0
Forks
2
Contributors
0
SourceRank
8

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.6.0
0.5.1
0.5.0
0.4.0
0.3.3
0.3.2
0.3.1
0.3.0
0.2.0
0.1.1
See all 13 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2023-06-14 20:31:50 UTC

Login to resync this project