diff --git a/CHANGELOG.md b/CHANGELOG.md index 63731b73..413ba5ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ separate changelogs for each crate were used. If you need to refer to these old ### Added - `libcnb-package`: Add cross-compilation assistance for Linux `aarch64-unknown-linux-musl`. ([#577](https://github.com/heroku/libcnb.rs/pull/577)) +- `libcnb-test`: `LogOutput` now implements `std::fmt::Display`. ([#635](https://github.com/heroku/libcnb.rs/pull/635)) ### Changed diff --git a/libcnb-test/src/log.rs b/libcnb-test/src/log.rs index 519b6717..6bb93726 100644 --- a/libcnb-test/src/log.rs +++ b/libcnb-test/src/log.rs @@ -1,6 +1,15 @@ +use std::fmt::Display; + /// Log output from a command. #[derive(Debug, Default)] pub struct LogOutput { pub stdout: String, pub stderr: String, } + +impl Display for LogOutput { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let LogOutput { stdout, stderr } = self; + write!(f, "## stderr:\n\n{stderr}\n## stdout:\n\n{stdout}\n") + } +} diff --git a/libcnb-test/src/test_runner.rs b/libcnb-test/src/test_runner.rs index d88c9c2d..67284e71 100644 --- a/libcnb-test/src/test_runner.rs +++ b/libcnb-test/src/test_runner.rs @@ -1,9 +1,7 @@ use crate::docker::DockerRemoveImageCommand; use crate::pack::PackBuildCommand; use crate::util::CommandError; -use crate::{ - app, build, util, BuildConfig, BuildpackReference, LogOutput, PackResult, TestContext, -}; +use crate::{app, build, util, BuildConfig, BuildpackReference, PackResult, TestContext}; use std::borrow::Borrow; use std::env; use std::path::PathBuf; @@ -119,10 +117,10 @@ impl TestRunner { let output = match (&config.expected_pack_result, pack_result) { (PackResult::Success, Ok(output)) => output, - (PackResult::Failure, Err(CommandError::NonZeroExitCode { stdout, stderr, .. })) => { - LogOutput { stdout, stderr } + (PackResult::Failure, Err(CommandError::NonZeroExitCode { log_output, .. })) => { + log_output } - (PackResult::Failure, Ok(LogOutput { stdout, stderr })) => { + (PackResult::Failure, Ok(log_output)) => { // Ordinarily the Docker image created by `pack build` will either be cleaned up by // `TestContext::Drop` later on, or will not have been created in the first place, // if the `pack build` was not successful. However, in the case of an unexpectedly @@ -130,7 +128,7 @@ impl TestRunner { util::run_command(DockerRemoveImageCommand::new(image_name)).unwrap_or_else( |command_err| panic!("Error removing Docker image:\n\n{command_err}"), ); - panic!("The pack build was expected to fail, but did not:\n\n## stderr:\n\n{stderr}\n## stdout:\n\n{stdout}\n"); + panic!("The pack build was expected to fail, but did not:\n\n{log_output}"); } (_, Err(command_err)) => { panic!("Error performing pack build:\n\n{command_err}"); diff --git a/libcnb-test/src/util.rs b/libcnb-test/src/util.rs index e0dd8eef..5c629269 100644 --- a/libcnb-test/src/util.rs +++ b/libcnb-test/src/util.rs @@ -40,17 +40,18 @@ pub(crate) fn run_command(command: impl Into) -> Result, program: String, - stdout: String, - stderr: String, + log_output: LogOutput, }, } @@ -89,11 +89,10 @@ impl Display for CommandError { CommandError::NonZeroExitCode { program, exit_code, - stdout, - stderr, + log_output, } => write!( f, - "{program} command failed with exit code {}!\n\n## stderr:\n\n{stderr}\n## stdout:\n\n{stdout}\n", + "{program} command failed with exit code {}!\n\n{log_output}", exit_code.map_or(String::from(""), |exit_code| exit_code.to_string()) ), }