Struct Solr

pub struct Solr { /* private fields */ }

Available on crate feature solr only.

Module to work with Solr inside of tests.

Starts an instance of Solr based on the official Solr docker image.

By default Solr is exposed via HTTP on Port 8983 (SOLR_PORT) and has no access control. Please refer to the Solr reference guide for more informations on how to interact with the API.

Example

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

let solr_instance = solr::Solr::default().start().unwrap();
let host_port = solr_instance.get_host_port_ipv4(solr::SOLR_PORT).unwrap();

let solr_url = format!("http://127.0.0.1:{}", host_port);

// use HTTP client to interact with the solr API

Trait Implementations

impl Clone for Solr

fn clone(&self) -> Solr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Solr

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

Formats the value using the given formatter.

impl Default for Solr

fn default() -> Solr

Returns the “default value” for a type.

impl Image for Solr

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 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 mounts(&self) -> impl IntoIterator<Item = &Mount>

Returns the mounts that needs to be created 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 cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

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

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

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 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.