Struct libcnb_test::ContainerConfig

source ·

pub struct ContainerConfig { /* private fields */ }

Expand description

Config used when starting a container.

By default the container will run the CNB default process-type, however this can be overridden using ContainerConfig::entrypoint and ContainerConfig::command. See: CNB App Developer Guide: Run a multi-process app

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(
            ContainerConfig::new()
                .env("PORT", "12345")
                .expose_port(12345),
            |container| {
                // ...
            },
        );
    },
);

Implementations§

source §

impl ContainerConfig

source

pub fn new() -> Self

Creates an empty ContainerConfig instance.

By default the container will run the CNB default process-type, however this can be overridden using ContainerConfig::entrypoint and ContainerConfig::command. See: CNB App Developer Guide: Run a multi-process app

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(
            ContainerConfig::new()
                .env("PORT", "12345")
                .expose_port(12345),
            |container| {
                // ...
            },
        );
    },
);

source

pub fn entrypoint(&mut self, entrypoint: impl Into<String>) -> &mut Self

Override the image’s entrypoint (which is the CNB default process-type).

See: CNB App Developer Guide: Run a multi-process app

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(ContainerConfig::new().entrypoint("worker"), |container| {
            // ...
        });
    },
);

source

pub fn command<I: IntoIterator<Item = S>, S: Into<String>>( &mut self, command: I ) -> &mut Self

Set the container’s command (CNB images have no default command).

See: CNB App Developer Guide: Run a multi-process app

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(
            ContainerConfig::new().command(["--additional-arg1", "--additional-arg2"]),
            |container| {
                // ...
            },
        );
    },
);

source

pub fn expose_port(&mut self, port: u16) -> &mut Self

Exposes a given port of the container to the host machine.

The given port is mapped to a random port on the host machine. Use crate::ContainerContext::address_for_port to obtain the local port for a mapped port.

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(
            ContainerConfig::new()
                .env("PORT", "12345")
                .expose_port(12345),
            |container| {
                let address_on_host = container.address_for_port(12345);
                // ...
            },
        );
    },
);

source

pub fn env( &mut self, key: impl Into<String>, value: impl Into<String> ) -> &mut Self

Inserts or updates an environment variable mapping for the container.

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(
            ContainerConfig::new()
                .env("PORT", "5678")
                .env("DEBUG", "true"),
            |container| {
                // ...
            },
        );
    },
);

source

pub fn envs<K: Into<String>, V: Into<String>, I: IntoIterator<Item = (K, V)>>( &mut self, envs: I ) -> &mut Self

Adds or updates multiple environment variable mappings for the container.

§Example

use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};

TestRunner::default().build(
    BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
    |context| {
        // ...
        context.start_container(
            ContainerConfig::new().envs([("PORT", "5678"), ("DEBUG", "true")]),
            |container| {
                // ...
            },
        );
    },
);