assertables 8.14.0

//! Assert a command stdout string is equal to an expression.
//!
//! Pseudocode:<br>
//! (command ⇒ stdout ⇒ string) = (expr into string)
//!
//! # Example
//!
//! ```rust
//! use assertables::*;
//! use std::process::Command;
//!
//! # fn main() {
//! let mut command = Command::new("bin/printf-stdout");
//! command.args(["%s", "alfa"]);
//! let bytes = vec![b'a', b'l', b'f', b'a'];
//! assert_command_stdout_eq_expr!(command, &bytes);
//! # }
//! ```
//!
//! # Module macros
//!
//! * [`assert_command_stdout_eq_expr`](macro@crate::assert_command_stdout_eq_expr)
//! * [`assert_command_stdout_eq_expr_as_result`](macro@crate::assert_command_stdout_eq_expr_as_result)
//! * [`debug_assert_command_stdout_eq_expr`](macro@crate::debug_assert_command_stdout_eq_expr)

/// Assert a command stdout string is equal to an expression.
///
/// Pseudocode:<br>
/// (command ⇒ stdout ⇒ string) = (expr into string)
///
/// * If true, return Result `Ok(())`.
///
/// * Otherwise, return Result `Err` with a diagnostic message.
///
/// This macro provides the same statements as [`assert_`](macro.assert_.html),
/// except this macro returns a Result, rather than doing a panic.
///
/// This macro is useful for runtime checks, such as checking parameters,
/// or sanitizing inputs, or handling different results in different ways.
///
/// # Module macros
///
/// * [`assert_command_stdout_eq_expr`](macro@crate::assert_command_stdout_eq_expr)
/// * [`assert_command_stdout_eq_expr_as_result`](macro@crate::assert_command_stdout_eq_expr_as_result)
/// * [`debug_assert_command_stdout_eq_expr`](macro@crate::debug_assert_command_stdout_eq_expr)
///
#[macro_export]
macro_rules! assert_command_stdout_eq_expr_as_result {
    ($a_command:expr, $b_expr:expr $(,)?) => {{
        match (/*&$command,*/ &$b_expr) {
            b_expr => {
                match $a_command.output() {
                    Ok(a_output) => {
                        let a = a_output.stdout;
                        if a.eq($b_expr) {
                            Ok(())
                        } else {
                            Err(format!(
                                concat!(
                                    "assertion failed: `assert_command_stdout_eq_expr!(a_command, b_expr)`\n",
                                    "https://docs.rs/assertables/", env!("CARGO_PKG_VERSION"), "/assertables/macro.assert_command_stdout_eq_expr.html\n",
                                    " a label: `{}`,\n",
                                    " a debug: `{:?}`,\n",
                                    " b label: `{}`,\n",
                                    " b debug: `{:?}`,\n",
                                    "       a: `{:?}`,\n",
                                    "       b: `{:?}`"
                                ),
                                stringify!($a_command),
                                $a_command,
                                stringify!($b_expr),
                                $b_expr,
                                a,
                                b_expr
                            ))
                        }
                    },
                    Err(err) => { 
                        Err(format!(
                            concat!(
                                "assertion failed: `assert_command_stdout_eq_expr!(a_command, b_expr)`\n",
                                "https://docs.rs/assertables/", env!("CARGO_PKG_VERSION"), "/assertables/macro.assert_command_stdout_eq_expr.html\n",
                                " a label: `{}`,\n",
                                " a debug: `{:?}`,\n",
                                " b label: `{}`,\n",
                                " b debug: `{:?}`,\n",
                                "     err: `{:?}`"
                            ),
                            stringify!($a_command),
                            $a_command,
                            stringify!($b_expr),
                            $b_expr,
                            err
                        ))
                    }
                }
            }
        }
    }};
}

#[cfg(test)]
mod tests {

    use std::process::Command;

    #[test]
    fn test_assert_command_stdout_eq_expr_as_result_x_success() {
        let mut a = Command::new("bin/printf-stdout");
        a.args(["%s", "alfa"]);
        let b = vec![b'a', b'l', b'f', b'a'];
        let result = assert_command_stdout_eq_expr_as_result!(a, &b);
        assert_eq!(result.unwrap(), ());
    }

    #[test]
    fn test_assert_command_stdout_eq_expr_as_result_x_failure() {
        let mut a = Command::new("bin/printf-stdout");
        a.args(["%s", "alfa"]);
        let b = vec![b'z'];
        let result = assert_command_stdout_eq_expr_as_result!(a, &b);
        let actual = result.unwrap_err();
        let expect = concat!(
            "assertion failed: `assert_command_stdout_eq_expr!(a_command, b_expr)`\n",
            "https://docs.rs/assertables/", env!("CARGO_PKG_VERSION"), "/assertables/macro.assert_command_stdout_eq_expr.html\n",
            " a label: `a`,\n",
            " a debug: `\"bin/printf-stdout\" \"%s\" \"alfa\"`,\n",
            " b label: `&b`,\n",
            " b debug: `[122]`,\n",
            "       a: `[97, 108, 102, 97]`,\n",
            "       b: `[122]`"
        );
        assert_eq!(actual, expect);
    }
}

/// Assert a command stdout string is equal to an expression.
///
/// * If true, return `()`.
///
/// * Otherwise, call [`panic!`] with a message and the values of the
///   expressions with their debug representations.
///
/// # Examples
///
/// ```rust
/// use assertables::*;
/// # use std::panic;
/// use std::process::Command;
///
/// # fn main() {
/// let mut command = Command::new("bin/printf-stdout");
/// command.args(["%s", "alfa"]);
/// let bytes = vec![b'a', b'l', b'f', b'a'];
/// assert_command_stdout_eq_expr!(command, &bytes);
///
/// # let result = panic::catch_unwind(|| {
/// let mut command = Command::new("bin/printf-stdout");
/// command.args(["%s", "alfa"]);
/// let bytes = vec![b'z'];
/// assert_command_stdout_eq_expr!(command, &bytes);
/// # });
/// // assertion failed: `assert_command_stdout_eq_expr!(a_command, b_expr)`
/// // https://docs.rs/assertables/8.14.0/assertables/macro.assert_command_stdout_eq_expr.html
/// //  a label: `command`,
/// //  a debug: `\"bin/printf-stdout\" \"%s\" \"alfa\"`,
/// //  b label: `&bytes`,
/// //  b debug: `[122]`,
/// //        a: `[97, 108, 102, 97]`,
/// //        b: `[122]`
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let expect = concat!(
/// #     "assertion failed: `assert_command_stdout_eq_expr!(a_command, b_expr)`\n",
/// #     "https://docs.rs/assertables/", env!("CARGO_PKG_VERSION"), "/assertables/macro.assert_command_stdout_eq_expr.html\n",
/// #     " a label: `command`,\n",
/// #     " a debug: `\"bin/printf-stdout\" \"%s\" \"alfa\"`,\n",
/// #     " b label: `&bytes`,\n",
/// #     " b debug: `[122]`,\n",
/// #     "       a: `[97, 108, 102, 97]`,\n",
/// #     "       b: `[122]`"
/// # );
/// # assert_eq!(actual, expect);
/// # }
/// ```
///
/// # Module macros
///
/// * [`assert_command_stdout_eq_expr`](macro@crate::assert_command_stdout_eq_expr)
/// * [`assert_command_stdout_eq_expr_as_result`](macro@crate::assert_command_stdout_eq_expr_as_result)
/// * [`debug_assert_command_stdout_eq_expr`](macro@crate::debug_assert_command_stdout_eq_expr)
///
#[macro_export]
macro_rules! assert_command_stdout_eq_expr {
    ($a_command:expr, $b_expr:expr $(,)?) => {{
        match $crate::assert_command_stdout_eq_expr_as_result!($a_command, $b_expr) {
            Ok(()) => (),
            Err(err) => panic!("{}", err),
        }
    }};
    ($a_command:expr, $b_expr:expr, $($message:tt)+) => {{
        match $crate::assert_command_stdout_eq_expr_as_result!($a_command, $b_expr) {
            Ok(()) => (),
            Err(_err) => panic!("{}", $($message)+),
        }
    }};
}

/// Assert a command stdout string is equal to an expression.
///
/// This macro provides the same statements as [`assert_command_stdout_eq_expr`](macro.assert_command_stdout_eq_expr.html),
/// except this macro's statements are only enabled in non-optimized
/// builds by default. An optimized build will not execute this macro's
/// statements unless `-C debug-assertions` is passed to the compiler.
///
/// This macro is useful for checks that are too expensive to be present
/// in a release build but may be helpful during development.
///
/// The result of expanding this macro is always type checked.
///
/// An unchecked assertion allows a program in an inconsistent state to
/// keep running, which might have unexpected consequences but does not
/// introduce unsafety as long as this only happens in safe code. The
/// performance cost of assertions, however, is not measurable in general.
/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
/// after thorough profiling, and more importantly, only in safe code!
///
/// This macro is intended to work in a similar way to
/// [`std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
///
/// # Module macros
///
/// * [`assert_command_stdout_eq_expr`](macro@crate::assert_command_stdout_eq_expr)
/// * [`assert_command_stdout_eq_expr`](macro@crate::assert_command_stdout_eq_expr)
/// * [`debug_assert_command_stdout_eq_expr`](macro@crate::debug_assert_command_stdout_eq_expr)
///
#[macro_export]
macro_rules! debug_assert_command_stdout_eq_expr {
    ($($arg:tt)*) => {
        if $crate::cfg!(debug_assertions) {
            $crate::assert_command_stdout_eq_expr!($($arg)*);
        }
    };
}