Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extend Readme.md
Browse files Browse the repository at this point in the history
Argonus committed Dec 20, 2023
1 parent baf6484 commit ffa47f8
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit ffa47f8

Please sign in to comment.