diff --git a/README.md b/README.md index a4ccbe7..38c8a0d 100644 --- a/README.md +++ b/README.md @@ -107,3 +107,30 @@ a Kafka client. This serves a few purposes: Regardless, it is not a production-ready implementation. I would refer you to KafkaEx or brod for that. + +## Testing + +Kayrock includes a test suite that checks that the generated code is correct. +We have both unit tests and integration tests. + +The unit tests are run as part of the normal mix test process. To run unit tests + +```shell +mix test +``` + +The integration tests require a running docker, currently we are using docker-compose to run a kafka cluster. +But we are in a process of migrating to use [testcontainers](https://github.com/testcontainers/testcontainers-elixir) +to run kafka cluster. + +To run original integration tests + +```shell +mix test --include integration +``` + +To run integration tests with testcontainers + +```shell +mix test.integration +``` \ No newline at end of file