Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
milenkovicm committed Nov 15, 2023
1 parent 0d0f6e4 commit eb6a418
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[package]
name = "testcontainers-redpanda-rs"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
license = "MIT"
description = "Unofficial redpanda test container"
homepage = "http://github.com/milenkovicm/testcontainers-redpanda-rs"
repository = "http://github.com/milenkovicm/testcontainers-redpanda-rs"
readme = "README.md"
categories = ["development-tools::testing"]
keywords = ["testcontainers", "testing", "kafka", "docker", "redpanda"]
keywords = ["testcontainers", "testing", "kafka", "docker", "redpanda", "integration-testing"]

[dependencies]
log = "0.4"
Expand Down
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,29 @@

Unofficial testcontainer for [Redpanda](https://redpanda.com).

Add dependency:

```toml
testcontainers-redpanda-rs = "0.1"
```

Usage example:

```rust
use testcontainers::clients;
use testcontainers_redpanda_rs::*;

let docker = clients::Cli::default();
let container = Redpanda::default();
let container = Redpanda::latest();

let server_node = docker.run(container);
let redpanda_node = docker.run(container);
// auto create topic is enabled
// use this to create topic with specific number
// of partitions.
server_node.exec(Redpanda::cmd_create_topic("new_topic_name", 3));
let bootstrap_servers = format!("localhost:{}", server_node.get_host_port_ipv4(REDPANDA_PORT));
redpanda_node.exec(Redpanda::cmd_create_topic("new_topic", 3));
let redpanda_server_address = format!("localhost:{}", redpanda_node.get_host_port_ipv4(REDPANDA_PORT));

println!("bootstrap servers: {}", bootstrap_servers);
println!("red panda server: {}", redpanda_server_address);
```

Current limitations:
Expand Down
3 changes: 2 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ use testcontainers::{
core::{ContainerState, ExecCommand, WaitFor},
Image, ImageArgs, RunnableImage,
};

/// Redpanda port
pub const REDPANDA_PORT: u16 = 9092;
/// Schema registry port
pub const SCHEMA_REGISTRY_PORT: u16 = 8081;

#[derive(Debug)]
Expand Down

0 comments on commit eb6a418

Please sign in to comment.