Struct LocalStackPro

pub struct LocalStackPro { /* private fields */ }

Available on crate feature localstack only.

This module provides LocalStack (Pro Edition).

Currently pinned to version 3.0

Configuration

For configuration, LocalStack uses environment variables. You can go here for the full list.

Testcontainers support setting environment variables with the method RunnableImage::with_env_var((impl Into<String>, impl Into<String>)). You will have to convert the Image into a RunnableImage first.

use testcontainers_modules::{localstack::LocalStackPro, testcontainers::ImageExt};

let container_request =
    LocalStackPro::new("YOUR AUTH TOKEN HERE").with_env_var("SERVICES", "s3");

No environment variables are required.

Implementations

impl LocalStackPro

pub fn new(auth_token: impl Into<String>) -> Self

Create new LocalStackPro container instance using the specified LocalStack auth token

pub fn from_env() -> Self

Create new LocalStackPro container instance using the auth token from the local LOCALSTACK_AUTH_TOKEN environment variable

pub fn with_auth_token(auth_token: Option<impl Into<String>>) -> Self

Create new LocalStackPro container instance using the specified (optional) auth token

Trait Implementations

impl Clone for LocalStackPro

fn clone(&self) -> LocalStackPro

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalStackPro

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

Formats the value using the given formatter.

impl Default for LocalStackPro

fn default() -> Self

Returns the “default value” for a type.

impl Image for LocalStackPro

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.