Skip to main content

ContainerConfigBuilder

Struct ContainerConfigBuilder 

Source
pub struct ContainerConfigBuilder { /* private fields */ }
Expand description

Flexible container configuration builder

This struct provides a builder pattern for configuring Docker containers with explicit configuration options instead of hardcoded values.

Currently supports the minimal set of features needed by the provisioned container:

  • Image name and tag validation
  • Container name customization
  • Exposed ports (with validation)
  • Wait conditions (with reasonable limits)

Implementations§

Source§

impl ContainerConfigBuilder

Source

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

Create a new container configuration builder with the specified image

§Arguments
  • image - Docker image name with optional tag (e.g., “redis:7”, “app:latest”)
§Example
use torrust_tracker_deployer_lib::testing::e2e::containers::config_builder::ContainerConfigBuilder;

let builder = ContainerConfigBuilder::new("torrust-provisioned-instance:latest");
Source

pub fn with_exposed_port(self, port: u16) -> Self

Add an exposed port to the container configuration

§Arguments
  • port - Port number to expose (as u16)
§Example
use torrust_tracker_deployer_lib::testing::e2e::containers::config_builder::ContainerConfigBuilder;

let builder = ContainerConfigBuilder::new("torrust-provisioned-instance:latest")
    .with_exposed_port(22)
    .with_exposed_port(80);
Source

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

Set a custom container name for the running container

§Arguments
  • name - Container name to use when starting the container
§Example
use torrust_tracker_deployer_lib::testing::e2e::containers::config_builder::ContainerConfigBuilder;

let builder = ContainerConfigBuilder::new("torrust-provisioned-instance:latest")
    .with_container_name("my-custom-container-name");
Source

pub fn with_wait_condition(self, condition: WaitFor) -> Self

Add a wait condition to determine when the container is ready

§Arguments
  • condition - Wait condition (e.g., message on stdout, HTTP endpoint, etc.)
§Example
use torrust_tracker_deployer_lib::testing::e2e::containers::config_builder::ContainerConfigBuilder;
use testcontainers::core::WaitFor;

let builder = ContainerConfigBuilder::new("torrust-provisioned-instance:latest")
    .with_wait_condition(WaitFor::message_on_stdout("sshd entered RUNNING state"));
Source

pub fn build(self) -> Result<GenericImage>

Build the final GenericImage with all configured options and validation

This method creates a GenericImage with all the configuration options that were specified using the builder methods. It also validates the configuration to catch common issues early.

§Returns

A configured GenericImage ready to be used with testcontainers

§Errors

Returns an error if:

  • Image name is empty or invalid
  • Any port number is invalid (e.g., 0)
  • Too many wait conditions (performance concern)
§Example
use torrust_tracker_deployer_lib::testing::e2e::containers::config_builder::ContainerConfigBuilder;
use testcontainers::core::WaitFor;

let image = ContainerConfigBuilder::new("torrust-provisioned-instance:latest")
    .with_exposed_port(22)
    .with_wait_condition(WaitFor::message_on_stdout("sshd entered RUNNING state"))
    .build()?;
Source

pub fn image_name(&self) -> &str

Get the configured image name

§Returns

The Docker image name that was configured for this builder

Source

pub fn exposed_ports(&self) -> &[u16]

Get the configured exposed ports

§Returns

A slice of port numbers that will be exposed

Source

pub fn wait_conditions_count(&self) -> usize

Get the number of configured wait conditions

§Returns

The number of wait conditions configured

Trait Implementations§

Source§

impl Clone for ContainerConfigBuilder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContainerConfigBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = !

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more