insta-cmd 0.7.0

//! `insta-cmd` is an extension to [insta](https://insta.rs/) that lets you snapshot
//! a command that produces (text) output to stdout and stderr.  It takes a
//! [`Command`](std::process::Command) from the standard library, runs it and
//! snapshots the output alongside the exit code.
//!
//! ```no_run
//! use std::process::Command;
//! use insta_cmd::assert_cmd_snapshot;
//!
//! assert_cmd_snapshot!(Command::new("echo").arg("Hello World!"));
//! ```
//!
//! ## Testing Binaries
//!
//! If you want to test binaries from your own project you can use the
//! [`get_cargo_bin`] and [`get_cargo_example`] functions to retrieve the path to
//! your binary. Cargo will automatically build binaries before running an
//! [integration test](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#integration-tests).
//! You will have to run ``cargo build --bin my-bin`` or
//! ``cargo build --example my-example`` before using `insta_cmd` in a unit test.
//!
//! Afterwards you can test it like this:
//!
//! ```no_run
//! use std::process::Command;
//! use insta_cmd::{assert_cmd_snapshot, get_cargo_bin};
//!
//! assert_cmd_snapshot!(Command::new(get_cargo_bin("hello")).arg("first arg"));
//! ```
//!
//! ## Passing Stdin
//!
//! To pass data via stdin and to have it snapshotted alongside, use the
//! [`pass_stdin`](SpawnExt::pass_stdin) extension method.  Inside the macro
//! it's automatically in scope.
//!
//! ```no_run
//! use std::process::Command;
//! use insta_cmd::assert_cmd_snapshot;
//!
//! assert_cmd_snapshot!(Command::new("cat").arg("-b").pass_stdin("Hello World"));
//! ```
#[doc(hidden)]
#[macro_use]
mod macros;

mod cargo;
mod spawn;

pub use crate::cargo::{get_cargo_bin, get_cargo_example};
pub use crate::spawn::{Spawn, SpawnExt};

#[allow(deprecated)]
pub use crate::spawn::StdinCommand;

pub use std::process::Command;

#[doc(hidden)]
pub mod _macro_support {
    pub use super::spawn::Spawn;
    pub use insta;
}

#[cfg(test)]
fn echo_test_helper(msg: &str) -> Command {
    #[cfg(windows)]
    {
        use std::os::windows::process::CommandExt;
        let mut rv = Command::new("cmd.exe");
        rv.arg("/c").arg("echo").raw_arg(msg);
        rv
    }
    #[cfg(unix)]
    {
        let mut rv = Command::new("echo");
        rv.arg(msg);
        rv
    }
}

#[cfg(test)]
fn cat_test_helper() -> Command {
    #[cfg(windows)]
    {
        use std::os::windows::process::CommandExt;
        let mut rv = Command::new("cmd.exe");
        rv.arg("/c").arg("find").arg("/v").raw_arg("\"\"");
        rv
    }
    #[cfg(unix)]
    {
        Command::new("cat")
    }
}

#[cfg(unix)]
#[test]
fn test_basic() {
    assert_cmd_snapshot!(["/bin/echo", "Hello World"]);
}

#[test]
fn test_command() {
    assert_cmd_snapshot!(echo_test_helper("Just some stuff"));
}

#[test]
fn test_env() {
    assert_cmd_snapshot!(echo_test_helper("Just some stuff")
        .env("K", "V")
        .env("A", "B")
        .env("Y", "Z"));
}

#[test]
fn test_env_remove_vs_empty() {
    assert_cmd_snapshot!(echo_test_helper("Testing env")
        .env("EMPTY_VAR", "")
        .env_remove("REMOVED_VAR"));
}

#[cfg(unix)]
#[test]
#[allow(deprecated)]
fn test_stdin() {
    assert_cmd_snapshot!(StdinCommand::new("cat", "Hello World!"));
}

#[test]
fn test_pass_stdin() {
    assert_cmd_snapshot!(cat_test_helper().pass_stdin("Hello World!\n"));
}

#[cfg(unix)]
#[test]
fn test_pass_stdin_on_array() {
    assert_cmd_snapshot!(["cat"].pass_stdin("Hello World!"));
}

#[cfg(unix)]
#[test]
fn test_failure() {
    assert_cmd_snapshot!(["false"]);
}

#[cfg(unix)]
#[test]
fn test_trailing_comma_one_arg() {
    assert_cmd_snapshot!(["echo", "42"],);
}

#[test]
fn test_trailing_comma_named_snapshot() {
    assert_cmd_snapshot!("named_snapshot_with_trailing_comma", echo_test_helper("27"),);
}

#[cfg(unix)]
#[test]
fn test_trailing_comma_inline_snapshot() {
    assert_cmd_snapshot!(
        Command::new("true"),
        @r###"
            success: true
            exit_code: 0
            ----- stdout -----

            ----- stderr -----
        "###,
    );
}