com.github.charithe.kafka

Class KafkaJunitExtension

java.lang.Object

com.github.charithe.kafka.KafkaJunitExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver

public class KafkaJunitExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.ParameterResolver

KafkaJunitExtension provides a kafka broker that is started and stopped for each test. It is configured by the optional annotation @KafkaJunitExtensionConfig and provides dependency injection for constructors and methods for the classes KafkaHelper and EphemeralKafkaBroker Usage:

     
  @ExtendWith(KafkaJunitExtension.class)
  @KafkaJunitExtensionConfig(startupMode = StartupMode.WAIT_FOR_STARTUP)
 class MyTestClass {
       @BeforeEach
       void setUp(KafkaHelper kafkaHelper, EphemeralKafkaBroker broker) {

       }
 }
     
 

Constructor Summary

Constructors

Constructor and Description
KafkaJunitExtension()

Method Summary

Modifier and Type	Method and Description
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KafkaJunitExtension

public KafkaJunitExtension()

Method Detail

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

resolveParameter

public Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                               org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver