assertables 9.9.0

//! Assert a command (built with program and args) stderr into a string contains a given containee.
//!
//! Pseudocode:<br>
//! (a_program + a_args ⇒ command ⇒ stderr ⇒ string) contains (expr into string)
//!
//! This uses [`::std::String`](https://doc.rust-lang.org/std/string/struct.String.html) method `contains`.
//!
//! * The containee can be a &str, char, a slice of chars, or a function or
//! closure that determines if a character contains.
//!
//! # Example
//!
//! ```rust
//! use assertables::*;
//!
//! let program = "bin/printf-stderr";
//! let args = ["%s", "alfa"];
//! let containee = "lf";
//! assert_program_args_stderr_string_contains!(program, args, containee);
//! ```
//!
//! # Module macros
//!
//! * [`assert_program_args_stderr_string_contains`](macro@crate::assert_program_args_stderr_string_contains)
//! * [`assert_program_args_stderr_string_contains_as_result`](macro@crate::assert_program_args_stderr_string_contains_as_result)
//! * [`debug_assert_program_args_stderr_string_contains`](macro@crate::debug_assert_program_args_stderr_string_contains)

/// Assert a command (built with program and args) stderr into a string contains a given containee.
///
/// Pseudocode:<br>
/// (a_program + a_args ⇒ command ⇒ stderr ⇒ string) contains (expr into string)
///
/// * If true, return Result `Ok(a_program + a_args ⇒ command ⇒ stderr ⇒ string)`.
///
/// * Otherwise, return Result `Err(message)`.
///
/// This macro is useful for runtime checks, such as checking parameters,
/// or sanitizing inputs, or handling different results in different ways.
///
/// # Module macros
///
/// * [`assert_program_args_stderr_string_contains`](macro@crate::assert_program_args_stderr_string_contains)
/// * [`assert_program_args_stderr_string_contains_as_result`](macro@crate::assert_program_args_stderr_string_contains_as_result)
/// * [`debug_assert_program_args_stderr_string_contains`](macro@crate::debug_assert_program_args_stderr_string_contains)
///
#[macro_export]
macro_rules! assert_program_args_stderr_string_contains_as_result {
    ($a_program:expr, $a_args:expr, $containee:expr $(,)?) => {
        match (&$a_program, &$a_args, &$containee) {
            (a_program, a_args, containee) => {
                match assert_program_args_impl_prep!(a_program, a_args) {
                    Ok(a_output) => {
                        let a_string = String::from_utf8(a_output.stderr).unwrap();
                        if a_string.contains(*containee) {
                            Ok(a_string)
                        } else {
                            Err(
                                format!(
                                    concat!(
                                        "assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`\n",
                                        "https://docs.rs/assertables/9.9.0/assertables/macro.assert_program_args_stderr_string_contains.html\n",
                                        " a_program label: `{}`,\n",
                                        " a_program debug: `{:?}`,\n",
                                        "    a_args label: `{}`,\n",
                                        "    a_args debug: `{:?}`,\n",
                                        " containee label: `{}`,\n",
                                        " containee debug: `{:?}`,\n",
                                        "               a: `{:?}`,\n",
                                        "       containee: `{:?}`"
                                    ),
                                    stringify!($a_program),
                                    a_program,
                                    stringify!($a_args),
                                    a_args,
                                    stringify!($containee),
                                    containee,
                                    a_string,
                                    $containee
                                )
                            )
                        }
                    },
                    Err(err) => {
                        Err(
                            format!(
                                concat!(
                                    "assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`\n",
                                    "https://docs.rs/assertables/9.9.0/assertables/macro.assert_program_args_stderr_string_contains.html\n",
                                    " a_program label: `{}`,\n",
                                    " a_program debug: `{:?}`,\n",
                                    "    a_args label: `{}`,\n",
                                    "    a_args debug: `{:?}`,\n",
                                    " containee label: `{}`,\n",
                                    " containee debug: `{:?}`,\n",
                                    "             err: `{:?}`"
                                ),
                                stringify!($a_program),
                                a_program,
                                stringify!($a_args),
                                a_args,
                                stringify!($containee),
                                containee,
                                err
                            )
                        )
                    }
                }
            }
        }
    };
}

#[cfg(test)]
mod test_assert_program_args_stderr_string_contains_as_result {
    use std::sync::Once;

    #[test]
    fn success() {
        let a_program = "bin/printf-stderr";
        let a_args = ["%s", "alfa"];
        let b = "lf";
        for _ in 0..1 {
            let actual =
                assert_program_args_stderr_string_contains_as_result!(a_program, a_args, b);
            assert_eq!(actual.unwrap(), "alfa");
        }
    }

    #[test]
    fn success_once() {
        static A: Once = Once::new();
        fn a() -> &'static str {
            if A.is_completed() {
                panic!("A.is_completed()")
            } else {
                A.call_once(|| {})
            }
            "bin/printf-stderr"
        }

        static A_ARGS: Once = Once::new();
        fn a_args() -> [&'static str; 2] {
            if A_ARGS.is_completed() {
                panic!("A_ARGS.is_completed()")
            } else {
                A_ARGS.call_once(|| {})
            }
            ["%s", "alfa"]
        }

        static B: Once = Once::new();
        fn b() -> &'static str {
            if B.is_completed() {
                panic!("B.is_completed()")
            } else {
                B.call_once(|| {})
            }
            "lf"
        }

        assert_eq!(A.is_completed(), false);
        assert_eq!(A_ARGS.is_completed(), false);
        assert_eq!(B.is_completed(), false);
        let result = assert_program_args_stderr_string_contains_as_result!(&a(), &a_args(), &b());
        assert!(result.is_ok());
        assert_eq!(A.is_completed(), true);
        assert_eq!(A_ARGS.is_completed(), true);
        assert_eq!(B.is_completed(), true);
    }

    #[test]
    fn failure() {
        let a_program = "bin/printf-stderr";
        let a_args = ["%s", "alfa"];
        let b = "zz";
        let actual = assert_program_args_stderr_string_contains_as_result!(a_program, a_args, b);
        let message = concat!(
            "assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`\n",
            "https://docs.rs/assertables/9.9.0/assertables/macro.assert_program_args_stderr_string_contains.html\n",
            " a_program label: `a_program`,\n",
            " a_program debug: `\"bin/printf-stderr\"`,\n",
            "    a_args label: `a_args`,\n",
            "    a_args debug: `[\"%s\", \"alfa\"]`,\n",
            " containee label: `b`,\n",
            " containee debug: `\"zz\"`,\n",
            "               a: `\"alfa\"`,\n",
            "       containee: `\"zz\"`"
        );
        assert_eq!(actual.unwrap_err(), message);
    }
}

/// Assert a command (built with program and args) stderr into a string contains a given containee.
///
/// Pseudocode:<br>
/// (a_program + a_args ⇒ command ⇒ stderr ⇒ string) contains (expr into string)
///
/// * If true, return (a_program + a_args ⇒ command ⇒ stderr ⇒ string).
///
/// * Otherwise, call [`panic!`] with a message and the values of the
///   expressions with their debug representations.
///
/// This uses [`::std::String`](https://doc.rust-lang.org/std/string/struct.String.html) method `contains`.
///
/// * The containee can be a &str, char, a slice of chars, or a function or
/// closure that determines if a character contains.
///
/// # Examples
///
/// ```rust
/// use assertables::*;
/// # use std::panic;
///
/// # fn main() {
/// let program = "bin/printf-stderr";
/// let args = ["%s", "alfa"];
/// let containee = "lf";
/// assert_program_args_stderr_string_contains!(program, args, containee);
///
/// # let result = panic::catch_unwind(|| {
/// // This will panic
/// let program = "bin/printf-stderr";
/// let args = ["%s", "alfa"];
/// let containee = "zz";
/// assert_program_args_stderr_string_contains!(program, args, containee);
/// # });
/// // assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`
/// // https://docs.rs/assertables/…/assertables/macro.assert_program_args_stderr_string_contains.html
/// //  a_program label: `program`,
/// //  a_program debug: `\"bin/printf-stderr\"`,
/// //     a_args label: `args`,
/// //     a_args debug: `[\"%s\", \"alfa\"]`,
/// //  containee label: `containee`,
/// //  containee debug: `\"zz\"`,
/// //                a: `\"alfa\"`,
/// //        containee: `\"zz\"`
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let message = concat!(
/// #     "assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`\n",
/// #     "https://docs.rs/assertables/9.9.0/assertables/macro.assert_program_args_stderr_string_contains.html\n",
/// #     " a_program label: `program`,\n",
/// #     " a_program debug: `\"bin/printf-stderr\"`,\n",
/// #     "    a_args label: `args`,\n",
/// #     "    a_args debug: `[\"%s\", \"alfa\"]`,\n",
/// #     " containee label: `containee`,\n",
/// #     " containee debug: `\"zz\"`,\n",
/// #     "               a: `\"alfa\"`,\n",
/// #     "       containee: `\"zz\"`"
/// # );
/// # assert_eq!(actual, message);
/// # }
/// ```
///
/// # Module macros
///
/// * [`assert_program_args_stderr_string_contains`](macro@crate::assert_program_args_stderr_string_contains)
/// * [`assert_program_args_stderr_string_contains_as_result`](macro@crate::assert_program_args_stderr_string_contains_as_result)
/// * [`debug_assert_program_args_stderr_string_contains`](macro@crate::debug_assert_program_args_stderr_string_contains)
///
#[macro_export]
macro_rules! assert_program_args_stderr_string_contains {
    ($a_program:expr, $a_args:expr, $containee:expr $(,)?) => {
        match $crate::assert_program_args_stderr_string_contains_as_result!($a_program, $a_args, $containee) {
            Ok(x) => x,
            Err(err) => panic!("{}", err),
        }
    };
    ($a_program:expr, $a_args:expr, $containee:expr, $($message:tt)+) => {
        match $crate::assert_program_args_stderr_string_contains_as_result!($a_program, $a_args, $containee) {
            Ok(x) => x,
            Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
        }
    };
}

#[cfg(test)]
mod test_assert_program_args_stderr_string_contains {
    use std::panic;

    #[test]
    fn success() {
        let a_program = "bin/printf-stderr";
        let a_args = ["%s", "alfa"];
        let b = "lf";
        for _ in 0..1 {
            let actual = assert_program_args_stderr_string_contains!(a_program, a_args, b);
            assert_eq!(actual, "alfa");
        }
    }

    #[test]
    fn failure() {
        let a_program = "bin/printf-stderr";
        let a_args = ["%s", "alfa"];
        let b = "zz";
        let result = panic::catch_unwind(|| {
            let _actual = assert_program_args_stderr_string_contains!(a_program, a_args, b);
        });
        let message = concat!(
            "assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`\n",
            "https://docs.rs/assertables/9.9.0/assertables/macro.assert_program_args_stderr_string_contains.html\n",
            " a_program label: `a_program`,\n",
            " a_program debug: `\"bin/printf-stderr\"`,\n",
            "    a_args label: `a_args`,\n",
            "    a_args debug: `[\"%s\", \"alfa\"]`,\n",
            " containee label: `b`,\n",
            " containee debug: `\"zz\"`,\n",
            "               a: `\"alfa\"`,\n",
            "       containee: `\"zz\"`"
        );
        assert_eq!(
            result
                .unwrap_err()
                .downcast::<String>()
                .unwrap()
                .to_string(),
            message
        );
    }
}

/// Assert a command (built with program and args) stderr into a string contains a given containee.
///
/// Pseudocode:<br>
/// (a_program + a_args ⇒ command ⇒ stderr ⇒ string) contains (expr into string)
///
/// This macro provides the same statements as [`assert_program_args_stderr_string_contains`](macro.assert_program_args_stderr_string_contains.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_program_args_stderr_string_contains`](macro@crate::assert_program_args_stderr_string_contains)
/// * [`assert_program_args_stderr_string_contains`](macro@crate::assert_program_args_stderr_string_contains)
/// * [`debug_assert_program_args_stderr_string_contains`](macro@crate::debug_assert_program_args_stderr_string_contains)
///
#[macro_export]
macro_rules! debug_assert_program_args_stderr_string_contains {
    ($($arg:tt)*) => {
        if cfg!(debug_assertions) {
            $crate::assert_program_args_stderr_string_contains!($($arg)*);
        }
    };
}

#[cfg(test)]
mod test_debug_assert_program_args_stderr_string_contains {
    use std::panic;

    #[test]
    fn success() {
        let a_program = "bin/printf-stderr";
        let a_args = ["%s", "alfa"];
        let b = "lf";
        for _ in 0..1 {
            let _actual = debug_assert_program_args_stderr_string_contains!(a_program, a_args, b);
            // assert_eq!(actual, "alfa");
        }
    }

    #[test]
    fn failure() {
        let a_program = "bin/printf-stderr";
        let a_args = ["%s", "alfa"];
        let b = "zz";
        let result = panic::catch_unwind(|| {
            let _actual = debug_assert_program_args_stderr_string_contains!(a_program, a_args, b);
        });
        let message = concat!(
            "assertion failed: `assert_program_args_stderr_string_contains!(a_program, a_args, containee)`\n",
            "https://docs.rs/assertables/9.9.0/assertables/macro.assert_program_args_stderr_string_contains.html\n",
            " a_program label: `a_program`,\n",
            " a_program debug: `\"bin/printf-stderr\"`,\n",
            "    a_args label: `a_args`,\n",
            "    a_args debug: `[\"%s\", \"alfa\"]`,\n",
            " containee label: `b`,\n",
            " containee debug: `\"zz\"`,\n",
            "               a: `\"alfa\"`,\n",
            "       containee: `\"zz\"`"
        );
        assert_eq!(
            result
                .unwrap_err()
                .downcast::<String>()
                .unwrap()
                .to_string(),
            message
        );
    }
}