Struct Pulsar

pub struct Pulsar { /* private fields */ }

Available on crate feature pulsar only.

Module to work with Apache Pulsar inside of tests. Requires protoc to be installed, otherwise will not build.

This module is based on the official Apache Pulsar docker image.

Example

use testcontainers_modules::{pulsar, testcontainers::runners::SyncRunner};

let pulsar = pulsar::Pulsar::default().start().unwrap();
let http_port = pulsar.get_host_port_ipv4(6650).unwrap();

// do something with the running pulsar instance..

Implementations

impl Pulsar

pub fn with_config_env( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Add configuration parameter to Pulsar conf/standalone.conf through setting environment variable.

Container will rewrite conf/standalone.conf file using these variables during startup with help of bin/apply-config-from-env.py script

pub fn with_admin_command( self, command: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Runs admin command after container start

pub fn with_tenant(self, tenant: impl Into<String>) -> Self

Creates tenant after container start

pub fn with_namespace(self, namespace: impl Into<String>) -> Self

Creates namespace after container start

pub fn with_topic(self, topic: impl Into<String>) -> Self

Creates topic after container start

Trait Implementations

impl Clone for Pulsar

fn clone(&self) -> Pulsar

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pulsar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Pulsar

fn default() -> Self

Creates new standalone pulsar container, with /pulsar/data as a temporary volume

impl Image for Pulsar

fn name(&self) -> &str

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> &str

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

Returns the mounts that needs to be created when a container is created.

fn env_vars( &self, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn exec_after_start( &self, _cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.

fn expose_ports(&self) -> &[ContainerPort]

Returns the ports that needs to be exposed when a container is created.

fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer>

Returns the files to be copied into the container at startup.

fn entrypoint(&self) -> Option<&str>

Returns the entrypoint this image needs to be created with.

fn exec_before_ready( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns commands that will be executed after the container has started, but before the Image::ready_conditions are awaited for.