com.bakdata.schemaregistrymock.junit5.SchemaRegistryMockExtension Maven / Gradle / Ivy
/*
* MIT License
*
* Copyright (c) 2024 bakdata GmbH
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.bakdata.schemaregistrymock.junit5;
import com.bakdata.schemaregistrymock.SchemaRegistryMock;
import io.confluent.kafka.schemaregistry.SchemaProvider;
import io.confluent.kafka.schemaregistry.avro.AvroSchemaProvider;
import java.util.List;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
/**
* The schema registry mock implements a few basic HTTP endpoints that are used by the Avro serdes.
* In particular,
*
* - you can register a schema
* - retrieve a schema by id.
* - list and get schema versions of a subject
*
*
* If you use the TestTopology of the fluent Kafka Streams test, you don't have to interact with this class at
* all.
*
* Without the test framework, you can use the mock as follows:
*
* class SchemaRegistryMockTest {
* {@literal @RegisterExtension}
* final SchemaRegistryMockExtension schemaRegistry = new SchemaRegistryMockExtension();
*
* {@literal @Test}
* void shouldRegisterKeySchema() throws IOException, RestClientException {
* final Schema keySchema = this.createSchema("key_schema");
* final int id = this.schemaRegistry.registerKeySchema("test-topic", keySchema);
*
* final Schema retrievedSchema = this.schemaRegistry.getSchemaRegistryClient().getById(id);
* assertThat(retrievedSchema).isEqualTo(keySchema);
* }
* }
*
* To retrieve the url of the schema registry for a Kafka Streams config, please use {@link #getUrl()}
*/
public class SchemaRegistryMockExtension extends SchemaRegistryMock implements BeforeEachCallback, AfterEachCallback {
/**
* Create a new {@code SchemaRegistryMockExtension} with default {@link SchemaProvider SchemaProviders}.
*
* @see #SchemaRegistryMockExtension(List)
*/
public SchemaRegistryMockExtension() {
this(null);
}
/**
* Create a new {@code SchemaRegistryMockExtension} from {@link SchemaProvider SchemaProviders}.
*
* @param schemaProviders List of {@link SchemaProvider}. If null, {@link AvroSchemaProvider} will be used.
*/
public SchemaRegistryMockExtension(final List schemaProviders) {
super(schemaProviders);
}
@Override
public void afterEach(final ExtensionContext context) {
this.stop();
}
@Override
public void beforeEach(final ExtensionContext context) {
this.start();
}
}