Skip to content

Commit 040d4c2

Browse files
committed
Add test description in README
1 parent 6460715 commit 040d4c2

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,37 @@ Eventually, we worked out the `modern-cpp-kafka`, -- a header-only library that
109109

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

112+
## How to Run Tests
113+
114+
* Unit test (`tests/unit`)
115+
116+
* The test could be run with no Kafka cluster depolyed
117+
118+
* Integration test (`tests/integration`)
119+
120+
* The test should be run with Kafka cluster depolyed
121+
122+
* The environment variable `KAFKA_BROKER_LIST` should be set
123+
124+
* E.g. `export KAFKA_BROKER_LIST=127.0.0.1:29091,127.0.0.1:29092,127.0.0.1:29093`
125+
126+
* Robustness test (`tests/robustness`)
127+
128+
* The test should be run with Kafka cluster depolyed locally
129+
130+
* The environment variable `KAFKA_BROKER_LIST` should be set
131+
132+
* The environment variable `KAFKA_BROKER_PIDS` should be set
133+
134+
* Make sure the test runner gets the privilege to stop/resume the pids
135+
136+
* E.g. `export KAFKA_BROKER_PIDS=61567,61569,61571`
137+
112138
## To Start
113139

114140
* Tutorial
115141

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

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

0 commit comments

Comments
 (0)