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
use crate::pack::{run_pack_command, PackBuildCommand};
use crate::{app, build, util, BuildConfig, BuildpackReference, TestContext};
use bollard::Docker;
use std::borrow::Borrow;
use std::env;
use std::env::VarError;
use std::path::PathBuf;
/// Runner for libcnb integration tests.
///
/// # Example
/// ```no_run
/// use libcnb_test::{assert_contains, assert_empty, BuildConfig, TestRunner};
///
/// TestRunner::default().build(
/// BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
/// |context| {
/// assert_empty!(context.pack_stderr);
/// assert_contains!(context.pack_stdout, "Expected build output");
/// },
/// )
/// ```
pub struct TestRunner {
pub(crate) docker: Docker,
pub(crate) tokio_runtime: tokio::runtime::Runtime,
}
impl Default for TestRunner {
fn default() -> Self {
let tokio_runtime =
tokio::runtime::Runtime::new().expect("Could not create internal Tokio runtime");
let docker = match env::var("DOCKER_HOST") {
#[cfg(target_family = "unix")]
Ok(docker_host) if docker_host.starts_with("unix://") => {
Docker::connect_with_unix_defaults()
}
Ok(docker_host)
if docker_host.starts_with("tcp://") || docker_host.starts_with("https://") =>
{
#[cfg(not(feature = "remote-docker"))]
panic!("Cannot connect to DOCKER_HOST '{docker_host}' since it requires TLS. Please use a local Docker daemon instead (recommended), or else enable the experimental `remote-docker` feature.");
#[cfg(feature = "remote-docker")]
Docker::connect_with_ssl_defaults()
}
Ok(docker_host) => panic!("Cannot connect to unsupported DOCKER_HOST '{docker_host}'"),
Err(VarError::NotPresent) => Docker::connect_with_local_defaults(),
Err(VarError::NotUnicode(_)) => {
panic!("DOCKER_HOST environment variable is not unicode encoded!")
}
}
.expect("Could not connect to local Docker daemon");
Self::new(tokio_runtime, docker)
}
}
impl TestRunner {
/// Creates a new runner that uses the given Tokio runtime and Docker connection.
///
/// This function is meant for advanced use-cases where fine control over the Tokio runtime
/// and/or Docker connection is required. For the common use-cases, use `Runner::default`.
pub fn new(tokio_runtime: tokio::runtime::Runtime, docker: Docker) -> Self {
Self {
docker,
tokio_runtime,
}
}
/// Starts a new integration test build.
///
/// This function copies the application to a temporary directory (if necessary), cross-compiles the current
/// crate, packages it as a buildpack and then invokes [pack](https://buildpacks.io/docs/tools/pack/)
/// to build a new Docker image with the buildpacks specified by the passed [`BuildConfig`].
///
/// Since this function is supposed to only be used in integration tests, failures are not
/// signalled via [`Result`](Result) values. Instead, this function panics whenever an unexpected error
/// occurred to simplify testing code.
///
/// # Example
/// ```no_run
/// use libcnb_test::{assert_contains, assert_empty, BuildConfig, TestRunner};
///
/// TestRunner::default().build(
/// BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
/// |context| {
/// assert_empty!(context.pack_stderr);
/// assert_contains!(context.pack_stdout, "Expected build output");
/// },
/// )
/// ```
pub fn build<C: Borrow<BuildConfig>, F: FnOnce(TestContext)>(&self, config: C, f: F) {
self.build_internal(util::random_docker_identifier(), config, f);
}
pub(crate) fn build_internal<C: Borrow<BuildConfig>, F: FnOnce(TestContext)>(
&self,
image_name: String,
config: C,
f: F,
) {
let config = config.borrow();
let app_dir = {
let normalized_app_dir_path = if config.app_dir.is_relative() {
env::var("CARGO_MANIFEST_DIR")
.map(PathBuf::from)
.expect("Could not determine Cargo manifest directory")
.join(&config.app_dir)
} else {
config.app_dir.clone()
};
assert!(
normalized_app_dir_path.is_dir(),
"App dir is not a valid directory: {}",
normalized_app_dir_path.display()
);
// Copy the app to a temporary directory if an app_dir_preprocessor is specified and run the
// preprocessor. Skip app copying if no changes to the app will be made.
if let Some(app_dir_preprocessor) = &config.app_dir_preprocessor {
let temporary_app_dir = app::copy_app(&normalized_app_dir_path)
.expect("Could not copy app to temporary location");
(app_dir_preprocessor)(temporary_app_dir.as_path().to_owned());
temporary_app_dir
} else {
normalized_app_dir_path.into()
}
};
let temp_crate_buildpack_dir =
config
.buildpacks
.contains(&BuildpackReference::Crate)
.then(|| {
build::package_crate_buildpack(config.cargo_profile, &config.target_triple)
.expect("Could not package current crate as buildpack")
});
let mut pack_command = PackBuildCommand::new(&config.builder_name, &app_dir, &image_name);
config.env.iter().for_each(|(key, value)| {
pack_command.env(key, value);
});
for buildpack in &config.buildpacks {
match buildpack {
BuildpackReference::Crate => {
pack_command.buildpack(temp_crate_buildpack_dir.as_ref()
.expect("Test references crate buildpack, but crate wasn't packaged as a buildpack. This is an internal libcnb-test error, please report any occurrences."))
}
BuildpackReference::Other(id) => pack_command.buildpack(id.clone()),
};
}
let output = run_pack_command(pack_command, &config.expected_pack_result);
let test_context = TestContext {
pack_stdout: String::from_utf8_lossy(&output.stdout).into_owned(),
pack_stderr: String::from_utf8_lossy(&output.stderr).into_owned(),
image_name,
config: config.clone(),
runner: self,
};
f(test_context);
}
}