Skip to content

Commit

Permalink
Add test description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
kenneth-jia committed May 25, 2021
1 parent 6460715 commit 040d4c2
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,37 @@ Eventually, we worked out the `modern-cpp-kafka`, -- a header-only library that

* GCC only (with optimization, e.g. -O2)

## How to Run Tests

* Unit test (`tests/unit`)

* The test could be run with no Kafka cluster depolyed

* Integration test (`tests/integration`)

* The test should be run with Kafka cluster depolyed

* The environment variable `KAFKA_BROKER_LIST` should be set

* E.g. `export KAFKA_BROKER_LIST=127.0.0.1:29091,127.0.0.1:29092,127.0.0.1:29093`

* Robustness test (`tests/robustness`)

* The test should be run with Kafka cluster depolyed locally

* The environment variable `KAFKA_BROKER_LIST` should be set

* The environment variable `KAFKA_BROKER_PIDS` should be set

* Make sure the test runner gets the privilege to stop/resume the pids

* E.g. `export KAFKA_BROKER_PIDS=61567,61569,61571`

## To Start

* Tutorial

* [Debuting a Modern C++ API for Apache Kafka](https://www.confluent.io/blog/modern-cpp-kafka-api-for-safe-easy-messaging)
* Confluent Blog [Debuting a Modern C++ API for Apache Kafka](https://www.confluent.io/blog/modern-cpp-kafka-api-for-safe-easy-messaging)

* [KafkaProducer Quick Start](doc/KafkaProducerQuickStart.md)

Expand Down

0 comments on commit 040d4c2

Please sign in to comment.