Struct Meilisearch

pub struct Meilisearch { /* private fields */ }

Available on crate feature meilisearch only.

Module to work with Meilisearch inside of tests.

Starts an instance of Meilisearch. This module is based on the official Meilisearch docker image documented in the Meilisearch docker docs.

Example

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

let meilisearch_instance = meilisearch::Meilisearch::default().start().unwrap();

let dashboard = format!(
    "http://{}:{}",
    meilisearch_instance.get_host().unwrap(),
    meilisearch_instance.get_host_port_ipv4(7700).unwrap()
);

Implementations

impl Meilisearch

pub fn with_master_key(self, master_key: &str) -> Self

Sets the MASTER_KEY for the Meilisearch instance. Default MASTER_KEY is None if not overridden by this function

See the official docs for this option

pub fn with_analytics(self, enabled: bool) -> Self

Configures analytics for the Meilisearch instance. Default is false if not overridden by this function This default differs from the dockerfile as we expect tests not to be good analytics.

See the official docs for this option

pub fn with_environment(self, environment: Environment) -> Self

Sets the environment of the Meilisearch instance. Default is Environment::Development if not overridden by this function. Setting it to Environment::Production requires authentication via Meilisearch::with_master_key

See the official docs for this option

pub fn with_log_level(self, level: LogLevel) -> Self

Sets the log level of the Meilisearch instance. Default is LogLevel::Info if not overridden by this function.

See the official docs for this option

Trait Implementations

impl Clone for Meilisearch

fn clone(&self) -> Meilisearch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Meilisearch

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

Formats the value using the given formatter.

impl Default for Meilisearch

fn default() -> Self

Starts an instance

• in development mode (see Meilisearch::with_environment to change this)
• without MASTER_KEY being set (see Meilisearch::with_master_key to change this)
• with Analytics disabled (see Meilisearch::with_analytics to change this)

impl Image for Meilisearch

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 expose_ports(&self) -> &[ContainerPort]

Returns the ports that needs to be exposed 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 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.