From e3a3da8fecfd08b4815a782ba2dc449d71e8f6e9 Mon Sep 17 00:00:00 2001 From: Manuel Fuchs Date: Thu, 17 Aug 2023 18:27:53 +0200 Subject: [PATCH] Refactor libcnb-cargo integration tests (#637) --- libcnb-cargo/Cargo.toml | 1 - libcnb-cargo/src/main.rs | 2 - libcnb-cargo/tests/test.rs | 509 +++++++++++++++++++------------------ 3 files changed, 268 insertions(+), 244 deletions(-) diff --git a/libcnb-cargo/Cargo.toml b/libcnb-cargo/Cargo.toml index a39d1832..d5eefe23 100644 --- a/libcnb-cargo/Cargo.toml +++ b/libcnb-cargo/Cargo.toml @@ -31,5 +31,4 @@ thiserror = "1.0.41" toml.workspace = true [dev-dependencies] -fs_extra = "1.3.0" tempfile = "3.6.0" diff --git a/libcnb-cargo/src/main.rs b/libcnb-cargo/src/main.rs index ed2b1003..82df916e 100644 --- a/libcnb-cargo/src/main.rs +++ b/libcnb-cargo/src/main.rs @@ -9,8 +9,6 @@ mod package; // Suppress warnings due to the `unused_crate_dependencies` lint not handling integration tests well. #[cfg(test)] -use fs_extra as _; -#[cfg(test)] use tempfile as _; use crate::cli::{Cli, LibcnbSubcommand}; diff --git a/libcnb-cargo/tests/test.rs b/libcnb-cargo/tests/test.rs index 378f3ce6..10c9c9db 100644 --- a/libcnb-cargo/tests/test.rs +++ b/libcnb-cargo/tests/test.rs @@ -1,307 +1,334 @@ -use fs_extra::dir::{copy, CopyOptions}; -use libcnb_data::buildpack::{BuildpackDescriptor, BuildpackId}; +// Enable Clippy lints that are disabled by default. +// https://rust-lang.github.io/rust-clippy/stable/index.html +#![warn(clippy::pedantic)] + +use libcnb_data::buildpack::BuildpackId; use libcnb_data::buildpack_id; -use libcnb_package::{get_buildpack_target_dir, read_buildpack_data, read_buildpackage_data}; -use std::env; -use std::io::Read; -use std::path::PathBuf; -use std::process::{Command, Stdio}; -use tempfile::{tempdir, TempDir}; +use libcnb_data::buildpackage::BuildpackageDependency; +use libcnb_package::{read_buildpack_data, read_buildpackage_data}; +use std::io::ErrorKind; +use std::path::{Path, PathBuf}; +use std::process::Command; +use std::{env, fs}; +use tempfile::{tempdir_in, TempDir}; #[test] #[ignore = "integration test"] fn package_buildpack_in_single_buildpack_project() { - let packaging_test = BuildpackPackagingTest::new("single_buildpack", X86_64_UNKNOWN_LINUX_MUSL); - let output = packaging_test.run_libcnb_package(); + let fixture_dir = copy_fixture_to_temp_dir("single_buildpack").unwrap(); + let buildpack_id = buildpack_id!("single-buildpack"); + + let output = Command::new(CARGO_LIBCNB_BINARY_UNDER_TEST) + .args(["libcnb", "package", "--release"]) + .current_dir(&fixture_dir) + .output() + .unwrap(); + + let packaged_buildpack_dir = create_packaged_buildpack_dir_resolver( + &fixture_dir.path().join(TARGET_DIR_NAME), + true, + X86_64_UNKNOWN_LINUX_MUSL, + )(&buildpack_id); + assert_eq!( - output.stdout.trim(), - [packaging_test.target_dir_name(buildpack_id!("single-buildpack"))].join("\n") + String::from_utf8_lossy(&output.stdout), + format!("{}\n", packaged_buildpack_dir.to_string_lossy()) ); - assert_compiled_buildpack(&packaging_test, buildpack_id!("single-buildpack")); + + validate_packaged_buildpack(&packaged_buildpack_dir, &buildpack_id); } #[test] #[ignore = "integration test"] fn package_single_meta_buildpack_in_monorepo_buildpack_project() { - let packaging_test = - BuildpackPackagingTest::new("multiple_buildpacks", X86_64_UNKNOWN_LINUX_MUSL); - let output = packaging_test.run_libcnb_package_from("meta-buildpacks/meta-one"); - assert_eq!( - output.stdout.trim(), - [packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/meta-one"))].join("\n") + let fixture_dir = copy_fixture_to_temp_dir("multiple_buildpacks").unwrap(); + + let output = Command::new(CARGO_LIBCNB_BINARY_UNDER_TEST) + .args(["libcnb", "package", "--release"]) + .current_dir(fixture_dir.path().join("meta-buildpacks").join("meta-one")) + .output() + .unwrap(); + + let packaged_buildpack_dir_resolver = create_packaged_buildpack_dir_resolver( + &fixture_dir.path().join(TARGET_DIR_NAME), + true, + X86_64_UNKNOWN_LINUX_MUSL, ); - assert_compiled_buildpack(&packaging_test, buildpack_id!("multiple-buildpacks/one")); - assert_compiled_buildpack(&packaging_test, buildpack_id!("multiple-buildpacks/two")); - assert_compiled_meta_buildpack( - &packaging_test, - buildpack_id!("multiple-buildpacks/meta-one"), - vec![ - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/one")), - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/two")), - packaging_test - .dir() - .join("meta-buildpacks/meta-one/../../buildpacks/not_libcnb") + + assert_eq!( + String::from_utf8_lossy(&output.stdout), + format!( + "{}\n", + packaged_buildpack_dir_resolver(&buildpack_id!("multiple-buildpacks/meta-one")) .to_string_lossy() - .to_string(), - String::from("docker://docker.io/heroku/procfile-cnb:2.0.0"), - ], + ) + ); + + validate_packaged_meta_buildpack( + &packaged_buildpack_dir_resolver(&buildpack_id!("multiple-buildpacks/meta-one")), + &buildpack_id!("multiple-buildpacks/meta-one"), + &[ + BuildpackageDependency::try_from(packaged_buildpack_dir_resolver(&buildpack_id!( + "multiple-buildpacks/one" + ))), + BuildpackageDependency::try_from(packaged_buildpack_dir_resolver(&buildpack_id!( + "multiple-buildpacks/two" + ))), + BuildpackageDependency::try_from( + fixture_dir + .path() + .join("meta-buildpacks/meta-one/../../buildpacks/not_libcnb"), + ), + BuildpackageDependency::try_from("docker://docker.io/heroku/procfile-cnb:2.0.0"), + ] + .into_iter() + .collect::, _>>() + .unwrap(), ); + + for buildpack_id in [ + buildpack_id!("multiple-buildpacks/one"), + buildpack_id!("multiple-buildpacks/two"), + ] { + validate_packaged_buildpack( + &packaged_buildpack_dir_resolver(&buildpack_id), + &buildpack_id, + ); + } } #[test] #[ignore = "integration test"] fn package_single_buildpack_in_monorepo_buildpack_project() { - let packaging_test = - BuildpackPackagingTest::new("multiple_buildpacks", X86_64_UNKNOWN_LINUX_MUSL); - let output = packaging_test.run_libcnb_package_from("buildpacks/one"); + let fixture_dir = copy_fixture_to_temp_dir("multiple_buildpacks").unwrap(); + let buildpack_id = buildpack_id!("multiple-buildpacks/one"); + + let output = Command::new(CARGO_LIBCNB_BINARY_UNDER_TEST) + .args(["libcnb", "package", "--release"]) + .current_dir(fixture_dir.path().join("buildpacks/one")) + .output() + .unwrap(); + + let packaged_buildpack_dir = create_packaged_buildpack_dir_resolver( + &fixture_dir.path().join(TARGET_DIR_NAME), + true, + X86_64_UNKNOWN_LINUX_MUSL, + )(&buildpack_id); + assert_eq!( - output.stdout.trim(), - [packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/one"))].join("\n") + String::from_utf8_lossy(&output.stdout), + format!("{}\n", packaged_buildpack_dir.to_string_lossy()) ); - assert_compiled_buildpack(&packaging_test, buildpack_id!("multiple-buildpacks/one")); - assert!(!packaging_test - .target_dir(buildpack_id!("multiple-buildpacks/two")) - .exists()); - assert!(!packaging_test - .target_dir(buildpack_id!("multiple-buildpacks/meta-one")) - .exists()); + + validate_packaged_buildpack(&packaged_buildpack_dir, &buildpack_id); } #[test] #[ignore = "integration test"] fn package_all_buildpacks_in_monorepo_buildpack_project() { - let packaging_test = - BuildpackPackagingTest::new("multiple_buildpacks", X86_64_UNKNOWN_LINUX_MUSL); - let output = packaging_test.run_libcnb_package(); + let fixture_dir = copy_fixture_to_temp_dir("multiple_buildpacks").unwrap(); + + let dependent_buildpack_ids = [ + buildpack_id!("multiple-buildpacks/one"), + buildpack_id!("multiple-buildpacks/two"), + ]; + + let output = Command::new(CARGO_LIBCNB_BINARY_UNDER_TEST) + .args(["libcnb", "package", "--release"]) + .current_dir(&fixture_dir) + .output() + .unwrap(); + + let packaged_buildpack_dir_resolver = create_packaged_buildpack_dir_resolver( + &fixture_dir.path().join(TARGET_DIR_NAME), + true, + X86_64_UNKNOWN_LINUX_MUSL, + ); + assert_eq!( - output.stdout.trim(), - [ - packaging_test - .dir() - .join("buildpacks/not_libcnb") - .to_string_lossy() - .to_string(), - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/meta-one")), - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/one")), - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/two")), - ] - .join("\n") + String::from_utf8_lossy(&output.stdout), + format!( + "{}\n", + [ + fixture_dir.path().join("buildpacks/not_libcnb"), + packaged_buildpack_dir_resolver(&buildpack_id!("multiple-buildpacks/meta-one")), + packaged_buildpack_dir_resolver(&buildpack_id!("multiple-buildpacks/one")), + packaged_buildpack_dir_resolver(&buildpack_id!("multiple-buildpacks/two")) + ] + .map(|path| path.to_string_lossy().into_owned()) + .join("\n") + ) ); - assert_compiled_buildpack(&packaging_test, buildpack_id!("multiple-buildpacks/one")); - assert_compiled_buildpack(&packaging_test, buildpack_id!("multiple-buildpacks/two")); - assert_compiled_meta_buildpack( - &packaging_test, - buildpack_id!("multiple-buildpacks/meta-one"), - vec![ - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/one")), - packaging_test.target_dir_name(buildpack_id!("multiple-buildpacks/two")), - packaging_test - .dir() - .join("meta-buildpacks/meta-one/../../buildpacks/not_libcnb") - .to_string_lossy() - .to_string(), - String::from("docker://docker.io/heroku/procfile-cnb:2.0.0"), - ], + + validate_packaged_meta_buildpack( + &packaged_buildpack_dir_resolver(&buildpack_id!("multiple-buildpacks/meta-one")), + &buildpack_id!("multiple-buildpacks/meta-one"), + &[ + BuildpackageDependency::try_from(packaged_buildpack_dir_resolver(&buildpack_id!( + "multiple-buildpacks/one" + ))), + BuildpackageDependency::try_from(packaged_buildpack_dir_resolver(&buildpack_id!( + "multiple-buildpacks/two" + ))), + BuildpackageDependency::try_from( + fixture_dir + .path() + .join("meta-buildpacks/meta-one/../../buildpacks/not_libcnb"), + ), + BuildpackageDependency::try_from("docker://docker.io/heroku/procfile-cnb:2.0.0"), + ] + .into_iter() + .collect::, _>>() + .unwrap(), ); + + for buildpack_id in dependent_buildpack_ids { + validate_packaged_buildpack( + &packaged_buildpack_dir_resolver(&buildpack_id), + &buildpack_id, + ); + } } #[test] #[ignore = "integration test"] fn package_non_libcnb_buildpack_in_meta_buildpack_project() { - let packaging_test = - BuildpackPackagingTest::new("multiple_buildpacks", X86_64_UNKNOWN_LINUX_MUSL); - let output = packaging_test.run_libcnb_package_from("buildpacks/not_libcnb"); + let fixture_dir = copy_fixture_to_temp_dir("multiple_buildpacks").unwrap(); + + let output = Command::new(CARGO_LIBCNB_BINARY_UNDER_TEST) + .args(["libcnb", "package", "--release"]) + .current_dir(fixture_dir.path().join("buildpacks/not_libcnb")) + .output() + .unwrap(); + assert_eq!( - output.stdout.trim(), - [packaging_test - .dir() - .join("buildpacks/not_libcnb") - .to_string_lossy() - .to_string()] - .join("\n") + String::from_utf8_lossy(&output.stdout), + format!( + "{}\n", + fixture_dir + .path() + .join("buildpacks/not_libcnb") + .to_string_lossy() + ) ); - assert!(!packaging_test - .target_dir(buildpack_id!("multiple-buildpacks/one")) - .exists()); - assert!(!packaging_test - .target_dir(buildpack_id!("multiple-buildpacks/two")) - .exists()); - assert!(!packaging_test - .target_dir(buildpack_id!("multiple-buildpacks/meta-one")) - .exists()); } #[test] #[ignore = "integration test"] fn package_command_error_when_run_in_project_with_no_buildpacks() { - let packaging_test = BuildpackPackagingTest::new("no_buildpacks", X86_64_UNKNOWN_LINUX_MUSL); - let output = packaging_test.run_libcnb_package(); - assert_ne!(output.code, Some(0)); + let fixture_dir = copy_fixture_to_temp_dir("no_buildpacks").unwrap(); + + let output = Command::new(CARGO_LIBCNB_BINARY_UNDER_TEST) + .args(["libcnb", "package", "--release"]) + .current_dir(&fixture_dir) + .output() + .unwrap(); + + assert_ne!(output.status.code(), Some(0)); assert_eq!( - output.stderr, + String::from_utf8_lossy(&output.stderr), "šŸ” Locating buildpacks...\nāŒ No buildpacks found!\n" ); } -fn assert_compiled_buildpack(packaging_test: &BuildpackPackagingTest, buildpack_id: BuildpackId) { - let buildpack_target_dir = PathBuf::from(packaging_test.target_dir_name(buildpack_id.clone())); - - assert!(buildpack_target_dir.exists()); - assert!(buildpack_target_dir.join("buildpack.toml").exists()); - assert!(buildpack_target_dir.join("package.toml").exists()); - assert!(buildpack_target_dir.join("bin").join("build").exists()); - assert!(buildpack_target_dir.join("bin").join("detect").exists()); - - let buildpack_data = read_buildpack_data(&buildpack_target_dir).unwrap(); - let id = match buildpack_data.buildpack_descriptor { - BuildpackDescriptor::Single(descriptor) => descriptor.buildpack.id, - BuildpackDescriptor::Meta(descriptor) => descriptor.buildpack.id, - }; - assert_eq!(id, buildpack_id); +fn validate_packaged_buildpack(packaged_buildpack_dir: &Path, buildpack_id: &BuildpackId) { + assert!(packaged_buildpack_dir.join("buildpack.toml").exists()); + assert!(packaged_buildpack_dir.join("package.toml").exists()); + assert!(packaged_buildpack_dir.join("bin").join("build").exists()); + assert!(packaged_buildpack_dir.join("bin").join("detect").exists()); + + assert_eq!( + &read_buildpack_data(packaged_buildpack_dir) + .unwrap() + .buildpack_descriptor + .buildpack() + .id, + buildpack_id + ); } -fn assert_compiled_meta_buildpack( - packaging_test: &BuildpackPackagingTest, - buildpack_id: BuildpackId, - dependencies: Vec, +fn validate_packaged_meta_buildpack( + packaged_buildpack_dir: &Path, + buildpack_id: &BuildpackId, + expected_buildpackage_dependencies: &[BuildpackageDependency], ) { - let buildpack_target_dir = PathBuf::from(packaging_test.target_dir_name(buildpack_id.clone())); - - assert!(buildpack_target_dir.exists()); - assert!(buildpack_target_dir.join("buildpack.toml").exists()); - assert!(buildpack_target_dir.join("package.toml").exists()); - - let buildpack_data = read_buildpack_data(&buildpack_target_dir).unwrap(); - let id = match buildpack_data.buildpack_descriptor { - BuildpackDescriptor::Single(descriptor) => descriptor.buildpack.id, - BuildpackDescriptor::Meta(descriptor) => descriptor.buildpack.id, - }; - assert_eq!(id, buildpack_id); - - let buildpackage_data = read_buildpackage_data(buildpack_target_dir) - .unwrap() - .unwrap(); - let compiled_uris: Vec<_> = buildpackage_data - .buildpackage_descriptor - .dependencies - .iter() - .map(|buildpackage_uri| buildpackage_uri.uri.to_string()) - .collect(); - assert_eq!(compiled_uris, dependencies); -} + assert!(packaged_buildpack_dir.join("buildpack.toml").exists()); + assert!(packaged_buildpack_dir.join("package.toml").exists()); -struct BuildpackPackagingTest { - fixture_name: String, - temp_dir: TempDir, - release_build: bool, - target_triple: String, -} + assert_eq!( + &read_buildpack_data(packaged_buildpack_dir) + .unwrap() + .buildpack_descriptor + .buildpack() + .id, + buildpack_id + ); -struct TestOutput { - stdout: String, - stderr: String, - code: Option, + assert_eq!( + read_buildpackage_data(packaged_buildpack_dir) + .unwrap() + .unwrap() + .buildpackage_descriptor + .dependencies, + expected_buildpackage_dependencies + ); } -impl BuildpackPackagingTest { - fn new(fixture_name: &str, target_triple: &str) -> Self { - let source_directory = env::current_dir() - .unwrap() - .join("fixtures") - .join(fixture_name); - let target_directory = tempdir().unwrap(); - let copy_options = CopyOptions::new(); - copy(source_directory, &target_directory, ©_options).unwrap(); - BuildpackPackagingTest { - fixture_name: fixture_name.to_string(), - temp_dir: target_directory, - release_build: true, - target_triple: String::from(target_triple), - } - } +fn create_packaged_buildpack_dir_resolver( + cargo_target_dir: &Path, + release: bool, + target_triple: &str, +) -> impl Fn(&BuildpackId) -> PathBuf { + let cargo_target_dir = PathBuf::from(cargo_target_dir); + let target_triple = target_triple.to_string(); - fn dir(&self) -> PathBuf { - self.temp_dir - .path() - .canonicalize() - .unwrap() - .join(&self.fixture_name) + move |buildpack_id| { + cargo_target_dir + .join("buildpack") + .join(&target_triple) + .join(if release { "release" } else { "debug" }) + .join(buildpack_id.as_str().replace('/', "_")) } +} - fn target_dir_name(&self, buildpack_id: BuildpackId) -> String { - self.target_dir(buildpack_id) - .canonicalize() - .unwrap() - .to_string_lossy() - .to_string() - } +fn copy_fixture_to_temp_dir(name: &str) -> Result { + let fixture_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("fixtures") + .join(name); - fn target_dir(&self, buildpack_id: BuildpackId) -> PathBuf { - get_buildpack_target_dir( - &buildpack_id, - &self.dir().join("target"), - self.release_build, - &self.target_triple, - ) - } + // Instead of using `tempfile::tempdir` directly, we get the temporary directory ourselves and + // canonicalize it before creating a temporary directory inside. We do this since on some + // operating systems (macOS specifically, see: https://github.com/rust-lang/rust/issues/99608), + // `env::temp_dir` will return a path with symlinks in it and `TempDir` doesn't allow + // canonicalization after the fact. + // + // Since libcnb-cargo itself also canonicalizes, we need to do the same so we can compare + // paths when they're output as strings. + env::temp_dir() + .canonicalize() + .and_then(tempdir_in) + .and_then(|temp_dir| copy_dir_recursively(&fixture_dir, temp_dir.path()).map(|_| temp_dir)) +} - fn run_libcnb_package(&self) -> TestOutput { - self.run_libcnb_package_from(".") - } +fn copy_dir_recursively(source: &Path, destination: &Path) -> std::io::Result<()> { + match fs::create_dir(destination) { + Err(io_error) if io_error.kind() == ErrorKind::AlreadyExists => Ok(()), + other => other, + }?; - fn run_libcnb_package_from(&self, from_dir: &str) -> TestOutput { - // borrowed from assert_cmd - let suffix = env::consts::EXE_SUFFIX; - - let target_dir = env::current_exe() - .ok() - .map(|mut path| { - path.pop(); - if path.ends_with("deps") { - path.pop(); - } - path - }) - .unwrap(); - - let name = "cargo-libcnb"; - - let cargo_libcnb = env::var_os(format!("CARGO_BIN_EXE_{name}")) - .map(|p| p.into()) - .unwrap_or_else(|| target_dir.join(format!("{name}{suffix}"))); - - let mut cmd = Command::new(cargo_libcnb) - .args(["libcnb", "package", "--release"]) - .current_dir(self.dir().join(from_dir)) - .stdout(Stdio::piped()) - .stderr(Stdio::piped()) - .spawn() - .unwrap(); - - let status = cmd.wait().unwrap(); - - let mut stdout = String::new(); - cmd.stdout - .take() - .unwrap() - .read_to_string(&mut stdout) - .unwrap(); - println!("STDOUT:\n{stdout}"); + for entry in fs::read_dir(source)? { + let dir_entry = entry?; - let mut stderr = String::new(); - cmd.stderr - .take() - .unwrap() - .read_to_string(&mut stderr) - .unwrap(); - println!("STDERR:\n{stderr}"); - - TestOutput { - stdout: String::from_utf8_lossy(stdout.as_bytes()).to_string(), - stderr: String::from_utf8_lossy(stderr.as_bytes()).to_string(), - code: status.code(), + if dir_entry.file_type()?.is_dir() { + copy_dir_recursively(&dir_entry.path(), &destination.join(dir_entry.file_name()))?; + } else { + fs::copy(dir_entry.path(), destination.join(dir_entry.file_name()))?; } } + + Ok(()) } const X86_64_UNKNOWN_LINUX_MUSL: &str = "x86_64-unknown-linux-musl"; +const TARGET_DIR_NAME: &str = "target"; +const CARGO_LIBCNB_BINARY_UNDER_TEST: &str = env!("CARGO_BIN_EXE_cargo-libcnb");