Skip to content

Commit

Permalink
refactor(trycmd): Use snapbox's example support
Browse files Browse the repository at this point in the history
  • Loading branch information
@epage
epage committed Feb 19, 2023
1 parent bb8da41 commit 1f995c3
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 145 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ diff = ["snapbox/diff"]
filesystem = ["snapbox/path"]

schema = ["dep:schemars", "dep:serde_json"]
examples = ["dep:escargot"]
examples = ["snapbox/examples"]
debug = ["snapbox/debug"]

[[bin]]
Expand Down
186 changes: 42 additions & 144 deletions src/cargo.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,151 +3,49 @@
#[doc(inline)]
pub use snapbox::cmd::cargo_bin;

/// Prepare an example for testing
///
/// Unlike `cargo_bin!`, this does not inherit all of the current compiler settings. It
/// will match the current target and profile but will not get feature flags. Pass those arguments
/// to the compiler via `args`.
///
/// ## Example
///
/// ```rust,no_run
/// #[test]
/// fn cli_tests() {
/// trycmd::TestCases::new()
/// .register_bin("example-fixture", trycmd::cargo::compile_example("example-fixture", []))
/// .case("examples/cmd/*.trycmd");
/// }
/// ```
#[cfg(feature = "examples")]
pub use examples::{compile_example, compile_examples};
pub fn compile_example<'a>(
target_name: &str,
args: impl IntoIterator<Item = &'a str>,
) -> crate::schema::Bin {
snapbox::cmd::compile_example(target_name, args).into()
}

/// Prepare all examples for testing
///
/// Unlike `cargo_bin!`, this does not inherit all of the current compiler settings. It
/// will match the current target and profile but will not get feature flags. Pass those arguments
/// to the compiler via `args`.
///
/// ## Example
///
/// ```rust,no_run
/// #[test]
/// fn cli_tests() {
/// trycmd::TestCases::new()
/// .register_bins(trycmd::cargo::compile_examples([]).unwrap())
/// .case("examples/cmd/*.trycmd");
/// }
/// ```
#[cfg(feature = "examples")]
pub(crate) mod examples {
/// Prepare an example for testing
///
/// Unlike `cargo_bin!`, this does not inherit all of the current compiler settings. It
/// will match the current target and profile but will not get feature flags. Pass those arguments
/// to the compiler via `args`.
///
/// ## Example
///
/// ```rust,no_run
/// #[test]
/// fn cli_tests() {
/// trycmd::TestCases::new()
/// .register_bin("example-fixture", trycmd::cargo::compile_example("example-fixture", []))
/// .case("examples/cmd/*.trycmd");
/// }
/// ```
pub fn compile_example<'a>(
target_name: &str,
args: impl IntoIterator<Item = &'a str>,
) -> crate::schema::Bin {
compile_example_path(target_name, args).into()
}

fn compile_example_path<'a>(
target_name: &str,
args: impl IntoIterator<Item = &'a str>,
) -> Result<crate::schema::Bin, crate::Error> {
snapbox::debug!("Compiling example {}", target_name);
let messages = escargot::CargoBuild::new()
.current_target()
.current_release()
.example(target_name)
.args(args)
.exec()
.map_err(|e| crate::Error::new(e.to_string()))?;
for message in messages {
let message = message.map_err(|e| crate::Error::new(e.to_string()))?;
let message = message
.decode()
.map_err(|e| crate::Error::new(e.to_string()))?;
snapbox::debug!("Message: {:?}", message);
if let Some(bin) = decode_example_message(&message) {
let (name, bin) = bin?;
assert_eq!(target_name, name);
return Ok(bin);
}
}

Err(crate::Error::new(format!(
"Unknown error building example {}",
target_name
)))
}

/// Prepare all examples for testing
///
/// Unlike `cargo_bin!`, this does not inherit all of the current compiler settings. It
/// will match the current target and profile but will not get feature flags. Pass those arguments
/// to the compiler via `args`.
///
/// ## Example
///
/// ```rust,no_run
/// #[test]
/// fn cli_tests() {
/// trycmd::TestCases::new()
/// .register_bins(trycmd::cargo::compile_examples([]).unwrap())
/// .case("examples/cmd/*.trycmd");
/// }
/// ```
pub fn compile_examples<'a>(
args: impl IntoIterator<Item = &'a str>,
) -> Result<impl Iterator<Item = (String, crate::schema::Bin)>, crate::Error> {
snapbox::debug!("Compiling examples");
let mut examples = std::collections::BTreeMap::new();

let messages = escargot::CargoBuild::new()
.current_target()
.current_release()
.examples()
.args(args)
.exec()
.map_err(|e| crate::Error::new(e.to_string()))?;
for message in messages {
let message = message.map_err(|e| crate::Error::new(e.to_string()))?;
let message = message
.decode()
.map_err(|e| crate::Error::new(e.to_string()))?;
snapbox::debug!("Message: {:?}", message);
if let Some(bin) = decode_example_message(&message) {
let (name, bin) = bin?;
examples.insert(name.to_owned(), bin);
}
}

Ok(examples.into_iter())
}

fn decode_example_message<'m>(
message: &'m escargot::format::Message,
) -> Option<Result<(&'m str, crate::schema::Bin), crate::Error>> {
match message {
escargot::format::Message::CompilerMessage(msg) => {
let level = msg.message.level;
if level == escargot::format::diagnostic::DiagnosticLevel::Ice
|| level == escargot::format::diagnostic::DiagnosticLevel::Error
{
let output = msg
.message
.rendered
.as_deref()
.unwrap_or_else(|| msg.message.message.as_ref())
.to_owned();
if is_example_target(&msg.target) {
let bin = crate::schema::Bin::Error(crate::Error::new(output));
Some(Ok((msg.target.name.as_ref(), bin)))
} else {
Some(Err(crate::Error::new(output)))
}
} else {
None
}
}
escargot::format::Message::CompilerArtifact(artifact) => {
if !artifact.profile.test && is_example_target(&artifact.target) {
let path = artifact
.executable
.clone()
.expect("cargo is new enough for this to be present");
let bin = crate::schema::Bin::Path(path.into_owned());
Some(Ok((artifact.target.name.as_ref(), bin)))
} else {
None
}
}
_ => None,
}
}

fn is_example_target(target: &escargot::format::Target) -> bool {
target.crate_types == ["bin"] && target.kind == ["example"]
}
pub fn compile_examples<'a>(
args: impl IntoIterator<Item = &'a str>,
) -> Result<impl Iterator<Item = (String, crate::schema::Bin)>, crate::Error> {
snapbox::cmd::compile_examples(args).map(|i| i.map(|(name, path)| (name, path.into())))
}

0 comments on commit 1f995c3

Please sign in to comment.