-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add support for
apache\kafka
docker image
Up till now kafka test container used `confluentinc/cp-kafka`, recently kafka started producing two official images `apache\kafka` and `apache\kafka-native` which may use `kraft` protocol, thus no zookeper instance is needed This commit exposes test container which utilizes those new containers, with `kraft` protocol. Default image is `apache\kafka-native` which provide fast starting speed. More details: - [KIP-974: Docker Image for GraalVM based Native Kafka Broker](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker) - [Java testcontainer implementation](https://github.com/testcontainers/testcontainers-java/blob/1.20.1/modules/kafka/src/main/java/org/testcontainers/kafka/KafkaContainer.java#)
- Loading branch information
1 parent
71875a6
commit 1dda4af
Showing
3 changed files
with
226 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,222 @@ | ||
use std::{borrow::Cow, collections::HashMap}; | ||
use testcontainers::{ | ||
core::{ContainerPort, ContainerState, ExecCommand, WaitFor}, | ||
Image, | ||
}; | ||
|
||
const KAFKA_NATIVE_IMAGE_NAME: &str = "apache/kafka-native"; | ||
const KAFKA_IMAGE_NAME: &str = "apache/kafka"; | ||
const TAG: &str = "latest"; | ||
|
||
pub const KAFKA_PORT: u16 = 9092; | ||
|
||
const START_SCRIPT: &str = "/opt/kafka/testcontainers_start.sh"; | ||
const DEFAULT_INTERNAL_TOPIC_RF: usize = 1; | ||
const DEFAULT_CLUSTER_ID: &str = "5L6g3nShT-eMCtK--X86sw"; | ||
const DEFAULT_BROKER_ID: usize = 1; | ||
|
||
#[derive(Debug, Clone)] | ||
pub struct Kafka { | ||
env_vars: HashMap<String, String>, | ||
image_name: String, | ||
} | ||
|
||
impl Default for Kafka { | ||
fn default() -> Self { | ||
let mut env_vars = HashMap::new(); | ||
|
||
env_vars.insert( | ||
"KAFKA_LISTENERS".to_owned(), | ||
format!( | ||
"PLAINTEXT://0.0.0.0:{KAFKA_PORT},BROKER://0.0.0.0:9093,CONTROLLER://0.0.0.0:9094" | ||
), | ||
); | ||
env_vars.insert("CLUSTER_ID".to_owned(), DEFAULT_CLUSTER_ID.to_owned()); | ||
env_vars.insert( | ||
"KAFKA_PROCESS_ROLES".to_owned(), | ||
"broker,controller".to_owned(), | ||
); | ||
|
||
env_vars.insert( | ||
"KAFKA_CONTROLLER_LISTENER_NAMES".to_owned(), | ||
"CONTROLLER".to_owned(), | ||
); | ||
env_vars.insert( | ||
"KAFKA_LISTENER_SECURITY_PROTOCOL_MAP".to_owned(), | ||
"BROKER:PLAINTEXT,PLAINTEXT:PLAINTEXT,CONTROLLER:PLAINTEXT".to_owned(), | ||
); | ||
env_vars.insert( | ||
"KAFKA_INTER_BROKER_LISTENER_NAME".to_owned(), | ||
"BROKER".to_owned(), | ||
); | ||
env_vars.insert( | ||
"KAFKA_ADVERTISED_LISTENERS".to_owned(), | ||
format!("PLAINTEXT://localhost:{KAFKA_PORT},BROKER://localhost:9092",), | ||
); | ||
env_vars.insert("KAFKA_BROKER_ID".to_owned(), DEFAULT_BROKER_ID.to_string()); | ||
env_vars.insert( | ||
"KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR".to_owned(), | ||
DEFAULT_INTERNAL_TOPIC_RF.to_string(), | ||
); | ||
env_vars.insert( | ||
"KAFKA_CONTROLLER_QUORUM_VOTERS".to_owned(), | ||
format!("{DEFAULT_BROKER_ID}@localhost:9094").to_owned(), | ||
); | ||
|
||
Self { | ||
env_vars, | ||
image_name: KAFKA_NATIVE_IMAGE_NAME.to_string(), | ||
} | ||
} | ||
} | ||
|
||
impl Kafka { | ||
pub fn with_jvm_image(mut self) -> Self { | ||
self.image_name = KAFKA_IMAGE_NAME.to_string(); | ||
|
||
self | ||
} | ||
} | ||
|
||
impl Image for Kafka { | ||
fn name(&self) -> &str { | ||
self.image_name.as_str() | ||
} | ||
|
||
fn tag(&self) -> &str { | ||
TAG | ||
} | ||
|
||
fn ready_conditions(&self) -> Vec<WaitFor> { | ||
vec![] | ||
} | ||
|
||
fn entrypoint(&self) -> Option<&str> { | ||
Some("bash") | ||
} | ||
|
||
fn env_vars( | ||
&self, | ||
) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)> { | ||
&self.env_vars | ||
} | ||
|
||
fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>> { | ||
vec![ | ||
"-c".to_string(), | ||
format!("while [ ! -f {START_SCRIPT} ]; do sleep 0.1; done; pwd &&chmod 755 {START_SCRIPT} && {START_SCRIPT}"), | ||
] | ||
.into_iter() | ||
} | ||
|
||
fn expose_ports(&self) -> &[ContainerPort] { | ||
&[ContainerPort::Tcp(KAFKA_PORT)] | ||
} | ||
|
||
fn exec_after_start( | ||
&self, | ||
cs: ContainerState, | ||
) -> Result<Vec<ExecCommand>, testcontainers::TestcontainersError> { | ||
let mut commands = vec![]; | ||
|
||
let cmd = vec![ | ||
"sh".to_string(), | ||
"-c".to_string(), | ||
format!( | ||
"echo '#!/usr/bin/env bash\nexport KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://127.0.0.1:{},BROKER://localhost:9093\n/etc/kafka/docker/run \n' > {}", | ||
cs.host_port_ipv4(ContainerPort::Tcp(KAFKA_PORT))?, | ||
START_SCRIPT | ||
), | ||
]; | ||
let ready_conditions = vec![WaitFor::message_on_stdout("Kafka Server started")]; | ||
commands.push(ExecCommand::new(cmd).with_container_ready_conditions(ready_conditions)); | ||
|
||
Ok(commands) | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use std::time::Duration; | ||
|
||
use futures::StreamExt; | ||
use rdkafka::{ | ||
consumer::{Consumer, StreamConsumer}, | ||
producer::{FutureProducer, FutureRecord}, | ||
ClientConfig, Message, | ||
}; | ||
use testcontainers::runners::AsyncRunner; | ||
|
||
use crate::kafka_native; | ||
|
||
#[tokio::test] | ||
async fn produce_and_consume_messages() -> Result<(), Box<dyn std::error::Error + 'static>> { | ||
let _ = pretty_env_logger::try_init().unwrap(); | ||
let kafka_node = kafka_native::Kafka::default().start().await?; | ||
|
||
let bootstrap_servers = format!( | ||
"127.0.0.1:{}", | ||
kafka_node | ||
.get_host_port_ipv4(kafka_native::KAFKA_PORT) | ||
.await? | ||
); | ||
|
||
let producer = ClientConfig::new() | ||
.set("bootstrap.servers", &bootstrap_servers) | ||
.set("message.timeout.ms", "5000") | ||
.create::<FutureProducer>() | ||
.expect("Failed to create Kafka FutureProducer"); | ||
|
||
let consumer = ClientConfig::new() | ||
.set("group.id", "testcontainer-rs") | ||
.set("bootstrap.servers", &bootstrap_servers) | ||
.set("session.timeout.ms", "6000") | ||
.set("enable.auto.commit", "false") | ||
.set("auto.offset.reset", "earliest") | ||
.create::<StreamConsumer>() | ||
.expect("Failed to create Kafka StreamConsumer"); | ||
|
||
let topic = "test-topic"; | ||
|
||
let number_of_messages_to_produce = 5_usize; | ||
let expected: Vec<String> = (0..number_of_messages_to_produce) | ||
.map(|i| format!("Message {i}")) | ||
.collect(); | ||
|
||
for (i, message) in expected.iter().enumerate() { | ||
producer | ||
.send( | ||
FutureRecord::to(topic) | ||
.payload(message) | ||
.key(&format!("Key {i}")), | ||
Duration::from_secs(0), | ||
) | ||
.await | ||
.unwrap(); | ||
} | ||
|
||
consumer | ||
.subscribe(&[topic]) | ||
.expect("Failed to subscribe to a topic"); | ||
|
||
let mut message_stream = consumer.stream(); | ||
for produced in expected { | ||
let borrowed_message = | ||
tokio::time::timeout(Duration::from_secs(10), message_stream.next()) | ||
.await | ||
.unwrap() | ||
.unwrap(); | ||
|
||
assert_eq!( | ||
produced, | ||
borrowed_message | ||
.unwrap() | ||
.payload_view::<str>() | ||
.unwrap() | ||
.unwrap() | ||
); | ||
} | ||
|
||
Ok(()) | ||
} | ||
} |
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