-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Updated docker and kafka feature (#777)
- Loading branch information
1 parent
c0759e7
commit 0869f9f
Showing
15 changed files
with
286 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
https://micronaut-projects.github.io/micronaut-test-resources/latest/guide/#modules-kafka[Micronaut Test Resources] simplifies running Kafka for local development and testing. | ||
|
||
> Micronaut Test Resources Kafka support will automatically start a Kafka container and provide the value of the `kafka.bootstrap.servers` property. | ||
|
||
https://micronaut.io/launch[Micronaut Launch] and CLI already apply Test Resources to your build when you https://micronaut.io/launch?features=kafka[select the `kafka` feature]. | ||
|
||
Micronaut Test Resources uses https://testcontainers.com[Test Containers] under the hood. If you prefer to use Test Containers directly, you can create a https://www.testcontainers.org/test_framework_integration/manual_lifecycle_control/#singleton-containers[Singleton Container] and combine it with https://micronaut-projects.github.io/micronaut-test/latest/api/io/micronaut/test/support/TestPropertyProvider.html[Micronaut Test `TestPropertyProvider`]: | ||
|
||
snippet::io.micronaut.kafka.docs.AbstractKafkaTest[] | ||
|
||
And then test: | ||
|
||
snippet::io.micronaut.kafka.docs.MyTest[] |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
plugins { | ||
groovy | ||
} | ||
|
||
dependencies { | ||
testImplementation(platform(mn.micronaut.core.bom)) | ||
testCompileOnly(mn.micronaut.inject.groovy) | ||
testImplementation(libs.testcontainers.kafka) | ||
testImplementation(mnTest.micronaut.test.spock) | ||
testRuntimeOnly(libs.junit.jupiter.engine) | ||
testImplementation(libs.awaitility) | ||
testImplementation(projects.micronautKafka) | ||
} | ||
|
||
tasks.withType<Test> { | ||
useJUnitPlatform() | ||
} |
24 changes: 24 additions & 0 deletions
24
test-suite-groovy/src/test/groovy/io/micronaut/kafka/docs/AbstractKafkaTest.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
package io.micronaut.kafka.docs | ||
|
||
import io.micronaut.test.support.TestPropertyProvider | ||
import org.testcontainers.containers.KafkaContainer | ||
import org.testcontainers.utility.DockerImageName | ||
import spock.lang.Specification | ||
|
||
/** | ||
* @see <a href="https://www.testcontainers.org/test_framework_integration/manual_lifecycle_control/#singleton-containers">Singleton containers</a> | ||
*/ | ||
abstract class AbstractKafkaTest extends Specification implements TestPropertyProvider { | ||
|
||
static final KafkaContainer MY_KAFKA | ||
|
||
static { | ||
MY_KAFKA = new KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:latest")) | ||
MY_KAFKA.start() | ||
} | ||
|
||
@Override | ||
Map<String, String> getProperties() { | ||
["kafka.bootstrap.servers": MY_KAFKA.getBootstrapServers()] | ||
} | ||
} |
54 changes: 54 additions & 0 deletions
54
test-suite-groovy/src/test/groovy/io/micronaut/kafka/docs/MyTest.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
package io.micronaut.kafka.docs | ||
|
||
import io.micronaut.configuration.kafka.annotation.* | ||
import io.micronaut.context.annotation.* | ||
import io.micronaut.test.extensions.spock.annotation.MicronautTest | ||
import jakarta.inject.Inject | ||
import spock.lang.Ignore | ||
|
||
import static java.util.concurrent.TimeUnit.SECONDS | ||
import static org.awaitility.Awaitility.await | ||
|
||
@Property(name = "spec.name", value = "MyTest") | ||
@MicronautTest | ||
@Ignore("It hangs forever in the CI") | ||
class MyTest extends AbstractKafkaTest { | ||
|
||
@Inject | ||
MyProducer producer | ||
@Inject | ||
MyConsumer consumer | ||
|
||
void "test kafka running"() { | ||
given: | ||
String message = "hello" | ||
|
||
when: | ||
producer.produce(message) | ||
|
||
then: | ||
await().atMost(5, SECONDS).until(() -> consumer.consumed == message) | ||
|
||
cleanup: | ||
MY_KAFKA.stop() | ||
} | ||
|
||
@Requires(property = "spec.name", value = "MyTest") | ||
@KafkaClient | ||
static interface MyProducer { | ||
@Topic("my-topic") | ||
void produce(String message) | ||
} | ||
|
||
@Requires(property = "spec.name", value = "MyTest") | ||
@KafkaListener(offsetReset = OffsetReset.EARLIEST) | ||
static class MyConsumer { | ||
String consumed | ||
|
||
@Topic("my-topic") | ||
void consume(String message) { | ||
consumed = message | ||
} | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
plugins { | ||
id("org.jetbrains.kotlin.jvm") version "1.8.22" | ||
id("org.jetbrains.kotlin.kapt") version "1.8.22" | ||
} | ||
|
||
dependencies { | ||
kaptTest(platform(mn.micronaut.core.bom)) | ||
kaptTest(mn.micronaut.inject.java) | ||
testImplementation(libs.testcontainers.kafka) | ||
testImplementation(mnTest.micronaut.test.junit5) | ||
testRuntimeOnly(libs.junit.jupiter.engine) | ||
testImplementation(libs.awaitility) | ||
testImplementation(projects.micronautKafka) | ||
} | ||
|
||
tasks.withType<Test> { | ||
useJUnitPlatform() | ||
} |
26 changes: 26 additions & 0 deletions
26
test-suite-kotlin/src/test/kotlin/io/micronaut/kafka/docs/AbstractKafkaTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
package io.micronaut.kafka.docs | ||
|
||
import io.micronaut.test.support.TestPropertyProvider | ||
import org.testcontainers.containers.KafkaContainer | ||
import org.testcontainers.utility.DockerImageName | ||
import java.util.* | ||
|
||
/** | ||
* @see <a href="https://www.testcontainers.org/test_framework_integration/manual_lifecycle_control/#singleton-containers">Singleton containers</a> | ||
*/ | ||
abstract class AbstractKafkaTest : TestPropertyProvider { | ||
|
||
companion object { | ||
var MY_KAFKA: KafkaContainer = KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:latest")) | ||
|
||
init { | ||
MY_KAFKA.start() | ||
} | ||
} | ||
|
||
override fun getProperties(): MutableMap<String, String> { | ||
return Collections.singletonMap( | ||
"kafka.bootstrap.servers", MY_KAFKA.getBootstrapServers() | ||
) | ||
} | ||
} |
41 changes: 41 additions & 0 deletions
41
test-suite-kotlin/src/test/kotlin/io/micronaut/kafka/docs/MyTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
package io.micronaut.kafka.docs | ||
|
||
import io.micronaut.configuration.kafka.annotation.* | ||
import io.micronaut.context.annotation.* | ||
import io.micronaut.test.extensions.junit5.annotation.MicronautTest | ||
import org.awaitility.Awaitility.await | ||
import org.junit.jupiter.api.* | ||
import java.util.concurrent.* | ||
|
||
@Property(name = "spec.name", value = "MyTest") | ||
@MicronautTest | ||
@TestInstance(TestInstance.Lifecycle.PER_CLASS) | ||
@Disabled("It hangs forever in the CI") | ||
internal class MyTest : AbstractKafkaTest() { | ||
@Test | ||
fun testKafkaRunning(producer: MyProducer, consumer: MyConsumer) { | ||
val message = "hello" | ||
producer.produce(message) | ||
await().atMost(5, TimeUnit.SECONDS) | ||
.until { consumer.consumed == message } | ||
MY_KAFKA.stop() | ||
} | ||
|
||
@Requires(property = "spec.name", value = "MyTest") | ||
@KafkaClient | ||
interface MyProducer { | ||
@Topic("my-topic") | ||
fun produce(message: String) | ||
} | ||
|
||
@Requires(property = "spec.name", value = "MyTest") | ||
@KafkaListener(offsetReset = OffsetReset.EARLIEST) | ||
class MyConsumer { | ||
var consumed: String? = null | ||
|
||
@Topic("my-topic") | ||
fun consume(message: String) { | ||
consumed = message | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
plugins { | ||
java | ||
} | ||
|
||
dependencies { | ||
testAnnotationProcessor(platform(mn.micronaut.core.bom)) | ||
testAnnotationProcessor(mn.micronaut.inject.java) | ||
testImplementation(libs.testcontainers.kafka) | ||
testImplementation(mnTest.micronaut.test.junit5) | ||
testRuntimeOnly(libs.junit.jupiter.engine) | ||
testImplementation(libs.awaitility) | ||
testImplementation(projects.micronautKafka) | ||
} | ||
|
||
tasks.withType<Test> { | ||
useJUnitPlatform() | ||
} |
28 changes: 28 additions & 0 deletions
28
test-suite/src/test/java/io/micronaut/kafka/docs/AbstractKafkaTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
package io.micronaut.kafka.docs; | ||
|
||
import io.micronaut.test.support.TestPropertyProvider; | ||
import org.testcontainers.containers.KafkaContainer; | ||
import org.testcontainers.utility.DockerImageName; | ||
|
||
import java.util.*; | ||
|
||
/** | ||
* @see <a href="https://www.testcontainers.org/test_framework_integration/manual_lifecycle_control/#singleton-containers">Singleton containers</a> | ||
*/ | ||
abstract class AbstractKafkaTest implements TestPropertyProvider { | ||
|
||
static final KafkaContainer MY_KAFKA; | ||
|
||
static { | ||
MY_KAFKA = new KafkaContainer( | ||
DockerImageName.parse("confluentinc/cp-kafka:latest")); | ||
MY_KAFKA.start(); | ||
} | ||
|
||
@Override | ||
public Map<String, String> getProperties() { | ||
return Collections.singletonMap( | ||
"kafka.bootstrap.servers", MY_KAFKA.getBootstrapServers() | ||
); | ||
} | ||
} |
40 changes: 40 additions & 0 deletions
40
test-suite/src/test/java/io/micronaut/kafka/docs/MyTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
package io.micronaut.kafka.docs; | ||
|
||
import io.micronaut.configuration.kafka.annotation.*; | ||
import io.micronaut.context.annotation.*; | ||
import io.micronaut.test.extensions.junit5.annotation.MicronautTest; | ||
import org.junit.jupiter.api.*; | ||
|
||
import static java.util.concurrent.TimeUnit.SECONDS; | ||
import static org.awaitility.Awaitility.await; | ||
|
||
@Property(name = "spec.name", value = "MyTest") | ||
@MicronautTest | ||
@TestInstance(TestInstance.Lifecycle.PER_CLASS) | ||
@Disabled("It hangs forever in the CI") | ||
class MyTest extends AbstractKafkaTest { | ||
@Test | ||
void testKafkaRunning(MyProducer producer, MyConsumer consumer) { | ||
final String message = "hello"; | ||
producer.produce(message); | ||
await().atMost(5, SECONDS).until(() -> message.equals(consumer.consumed)); | ||
MY_KAFKA.stop(); | ||
} | ||
|
||
@Requires(property = "spec.name", value = "MyTest") | ||
@KafkaClient | ||
interface MyProducer { | ||
@Topic("my-topic") | ||
void produce(String message); | ||
} | ||
|
||
@Requires(property = "spec.name", value = "MyTest") | ||
@KafkaListener(offsetReset = OffsetReset.EARLIEST) | ||
static class MyConsumer { | ||
String consumed; | ||
@Topic("my-topic") | ||
public void consume(String message) { | ||
consumed = message; | ||
} | ||
} | ||
} |