https://github.com/data-rocks-team/schemaregistry-junit
A library that provides an in-memory instance of Confluent Schema Registry to run your tests against
https://github.com/data-rocks-team/schemaregistry-junit
in-memory java junit kafka schema-registry
Last synced: 6 months ago
JSON representation
A library that provides an in-memory instance of Confluent Schema Registry to run your tests against
- Host: GitHub
- URL: https://github.com/data-rocks-team/schemaregistry-junit
- Owner: data-rocks-team
- License: mit
- Created: 2020-10-08T11:04:46.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-05-01T13:57:36.000Z (about 3 years ago)
- Last Synced: 2023-07-28T10:08:52.878Z (almost 3 years ago)
- Topics: in-memory, java, junit, kafka, schema-registry
- Language: Java
- Homepage: https://medium.com/data-rocks
- Size: 236 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# schemaregistry-junit
[](https://github.com/data-rocks-team/schemaregistry-junit/actions)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdata-rocks-team%2Fschemaregistry-junit?ref=badge_shield)
[](https://sonarcloud.io/dashboard?id=data-rocks-team_schemaregistry-junit)
[](https://sonarcloud.io/dashboard?id=data-rocks-team_schemaregistry-junit)
| Library | Version | Documentation | Vulnerability |
| ----------- | ----------- | ----------- | ----------- |
| [schemaregistry-junit5](https://mvnrepository.com/artifact/io.github.data-rocks-team/schemaregistry-junit5) | [](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aio.github.data-rocks-team%20a%3Aschemaregistry-junit5) | [](http://www.javadoc.io/doc/io.github.data-rocks-team/schemaregistry-junit5) | [](https://snyk.io/test/github/data-rocks-team/schemaregistry-junit?targetFile=schemaregistry-junit5/build.gradle)
| [schemaregistry-junit4](https://mvnrepository.com/artifact/io.github.data-rocks-team/schemaregistry-junit4) | [](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aio.github.data-rocks-team%20a%3Aschemaregistry-junit4) | [](http://www.javadoc.io/doc/io.github.data-rocks-team/schemaregistry-junit4) | [](https://snyk.io/test/github/data-rocks-team/schemaregistry-junit?targetFile=schemaregistry-junit4/build.gradle)
| [schemaregistry-junit-core](https://mvnrepository.com/artifact/io.github.data-rocks-team/schemaregistry-junit-core) | [](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aio.github.data-rocks-team%20a%3Aschemaregistry-junit-core) | [](http://www.javadoc.io/doc/io.github.data-rocks-team/schemaregistry-junit-core) | [](https://snyk.io/test/github/data-rocks-team/schemaregistry-junit?targetFile=schemaregistry-junit-core/build.gradle) |
Are you tired of waiting for [Docker](https://www.docker.com/) containers to fire up while testing
your Kafka solution? Or are you tired of waiting for an ephemeral environment to start? Are you
looking for a solution to reduce the time you are loosing waiting for
[Apache Kafka Cluster](https://kafka.apache.org/) and
[Confluent Schema Registry](https://docs.confluent.io/current/schema-registry/) to start while
testing?
*schemaregistry-junit* is the answer! By pairing *schemaregistry-junit* together with
[kafka-junit](https://github.com/salesforce/kafka-junit), you can speed up your tests and shorten
the feedback loop by reducing the time wasted waiting for Docker containers or ephemeral
environments to start.
*schemaregistry-junit* lets you run a fully working
[Confluent Schema Registry](https://docs.confluent.io/current/schema-registry/) in-memory. The
server lifecycle is fully automated via [JUnit](https://junit.org/junit5/) extensions.
A fluent DSL is provided to configure the Confluent Schema Registry.
This project was inspired by [kafka-junit](https://github.com/salesforce/kafka-junit).
## Features
- Support for JUnit 4 and JUnit 5
- Support all [Confluent SchemaRegistry](https://mvnrepository.com/artifact/io.confluent/kafka-schema-registry?repo=confluent-packages)
version from 4.0.0 to the latest
## Installation
The easiest way to include `schemaregistry-junit` in your project(s) is via Maven dependency. Binary, Sources
and Javadocs are all available in
[Maven Central](https://search.maven.org/search?q=g:io.github.data-rocks-team).
For JUnit 5
Maven
#### Example POM
```xml
io.github.data-rocks-team
schemaregistry-junit5
0.1.1
io.confluent
kafka-schema-registry
X.X.X
```
Gradle
#### Example build.gradle
```groovy
testImplementation 'io.github.data-rocks-team:schemaregistry-junit5:0.1.1'
testImplementation 'io.confluent:kafka-schema-registry:X.X.X'
```
For JUnit 4
Maven
#### Example POM
```xml
io.github.data-rocks-team
schemaregistry-junit4
0.1.1
io.confluent
kafka-schema-registry
X.X.X
```
Gradle
#### Example build.gradle
```groovy
testImplementation 'io.github.data-rocks-team:schemaregistry-junit4:0.1.1'
testImplementation 'io.confluent:kafka-schema-registry:X.X.X'
```
## How it works
Given a class using `SharedSchemaRegistryTestResource`, before all tests start,
[JUnit](https://junit.org/junit5/) calls the start function. This function replicates the behaviour
of [SchemaRegistryMain.java](https://github.com/confluentinc/schema-registry/blob/master/core/src/main/java/io/confluent/kafka/schemaregistry/rest/SchemaRegistryMain.java),
which first validates the settings and then starts the server. When all tests have been executed,
independently of the test results, JUnit calls the shutdown function, which will shut the server
down.
Logs generated by the server are redirected to the terminal.
## Regression testing
| Confluent Version | Regression test |
| ----------- | ----------- |
| 4.x.x | [](https://github.com/data-rocks-team/schemaregistry-junit/actions/workflows/gradle-regression-4x.yml) |
| 5.x.x | [](https://github.com/data-rocks-team/schemaregistry-junit/actions/workflows/gradle-regression-5x.yml) |
| 6.x.x | [](https://github.com/data-rocks-team/schemaregistry-junit/actions/workflows/gradle-regression-6x.yml) |
| 7.x.x | [](https://github.com/data-rocks-team/schemaregistry-junit/actions/workflows/gradle-regression-7x.yml) |
Every build is automatically tested against the latest patch version of every minor version since
4.0.0. For more details, check [regression-test](/regression-test).
Before compiling any example, run `./gradlew setDependenciesForRegressionTesting` in the main
project. This gradle task will ensure that the regression tests will use the same dependency
versions used in the main project. To ensure that `setDependenciesForExample` works as expected,
dependencies version should be defined in the `ext {}` section in the
[main build.gradle](build.gradle) and the example project should define versions as
`nameOfTheDependencyVersion = PLACEHOLDER` (see
[regression-test/build.gradle](regression-test/build.gradle)).
Upon bumping a major or minor version of `io.confluent:kafka-schema-registry`, a new regression test
should be added under [regression-test](regression-test).
## Examples
- [JUnit 5 example](/examples/junit-5)
- [JUnit 4 example](/examples/junit-4)
Before compiling any example, run `./gradlew setDependenciesForExample` in the main project. This
gradle task will ensure that the example project will use the same dependency versions used in the
main project. To ensure that `setDependenciesForExample` works as expected, dependencies
version should be defined in the `ext {}` section in the [main build.gradle](build.gradle) and the
example project should define versions as `nameOfTheDependencyVersion = PLACEHOLDER` (an example
can be found [here](examples/junit-5/build.gradle)).
## Contributing
Found a bug? You've got an awesome feature you want to add? We welcome contributions!
## Feedback
Any questions or suggestions? Get in touch!
[](https://twitter.com/FraNobilia)
[](https://www.linkedin.com/in/fnobilia/)
## Blog post
- [Docker free kafka integration tests](https://medium.com/data-rocks/docker-free-kafka-integration-tests-4cd045d6947a)
## License
MIT [view license](/LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdata-rocks-team%2Fschemaregistry-junit?ref=badge_large)