1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
use std::collections::{HashMap, HashSet};
/// 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](https://buildpacks.io/docs/app-developer-guide/run-an-app/#run-a-multi-process-app)
///
/// # Example
/// ```no_run
/// 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| {
/// // ...
/// },
/// );
/// },
/// );
/// ```
#[derive(Clone, Default)]
pub struct ContainerConfig {
pub(crate) entrypoint: Option<String>,
pub(crate) command: Option<Vec<String>>,
pub(crate) env: HashMap<String, String>,
pub(crate) exposed_ports: HashSet<u16>,
}
impl ContainerConfig {
/// 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](https://buildpacks.io/docs/app-developer-guide/run-an-app/#run-a-multi-process-app)
///
/// # Example
/// ```no_run
/// 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| {
/// // ...
/// },
/// );
/// },
/// );
/// ```
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Override the image's `entrypoint` (which is the CNB default process-type).
///
/// See: [CNB App Developer Guide: Run a multi-process app](https://buildpacks.io/docs/app-developer-guide/run-an-app/#run-a-multi-process-app)
///
/// # Example
/// ```no_run
/// 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| {
/// // ...
/// });
/// },
/// );
/// ```
pub fn entrypoint(&mut self, entrypoint: impl Into<String>) -> &mut Self {
self.entrypoint = Some(entrypoint.into());
self
}
/// Set the container's `command` (CNB images have no default command).
///
/// See: [CNB App Developer Guide: Run a multi-process app](https://buildpacks.io/docs/app-developer-guide/run-an-app/#run-a-multi-process-app)
///
/// # Example
/// ```no_run
/// 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| {
/// // ...
/// },
/// );
/// },
/// );
/// ```
pub fn command<I: IntoIterator<Item = S>, S: Into<String>>(&mut self, command: I) -> &mut Self {
self.command = Some(command.into_iter().map(S::into).collect());
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
/// ```no_run
/// 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);
/// // ...
/// },
/// );
/// },
/// );
/// ```
pub fn expose_port(&mut self, port: u16) -> &mut Self {
self.exposed_ports.insert(port);
self
}
/// Inserts or updates an environment variable mapping for the container.
///
/// # Example
/// ```no_run
/// 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| {
/// // ...
/// },
/// );
/// },
/// );
/// ```
pub fn env(&mut self, key: impl Into<String>, value: impl Into<String>) -> &mut Self {
self.env.insert(key.into(), value.into());
self
}
/// Adds or updates multiple environment variable mappings for the container.
///
/// # Example
/// ```no_run
/// 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| {
/// // ...
/// },
/// );
/// },
/// );
/// ```
pub fn envs<K: Into<String>, V: Into<String>, I: IntoIterator<Item = (K, V)>>(
&mut self,
envs: I,
) -> &mut Self {
envs.into_iter().for_each(|(key, value)| {
self.env(key.into(), value.into());
});
self
}
}