assertables/assert_ok/

assert_ok.rs

//! Assert expression is Ok.
//!
//! Pseudocode:<br>
//! a is Ok.
//!
//! # Example
//!
//! ```rust
//! use assertables::*;
//!
//! let a: Result<i8, i8> = Ok(1);
//! assert_ok!(a);
//! ```
//!
//! # Module macros
//!
//! * [`assert_ok`](macro@crate::assert_ok)
//! * [`assert_ok_as_result`](macro@crate::assert_ok_as_result)
//! * [`debug_assert_ok`](macro@crate::debug_assert_ok)

/// Assert expression is Ok.
///
/// Pseudocode:<br>
/// a is Ok(a1)
///
/// * If true, return Result `Ok(a1)`.
///
/// * 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_ok`](macro@crate::assert_ok)
/// * [`assert_ok_as_result`](macro@crate::assert_ok_as_result)
/// * [`debug_assert_ok`](macro@crate::debug_assert_ok)
///
#[macro_export]
macro_rules! assert_ok_as_result {
    ($a:expr $(,)?) => {
        match ($a) {
            a => match (a) {
                Ok(a1) => Ok(a1),
                _ => Err(format!(
                    concat!(
                        "assertion failed: `assert_ok!(a)`\n",
                        "https://docs.rs/assertables/9.8.3/assertables/macro.assert_ok.html\n",
                        " a label: `{}`,\n",
                        " a debug: `{:?}`",
                    ),
                    stringify!($a),
                    a
                )),
            },
        }
    };
}

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

    #[test]
    fn success() {
        let a: Result<i8, i8> = Ok(1);
        for _ in 0..1 {
            let actual = assert_ok_as_result!(a);
            assert_eq!(actual.unwrap(), 1);
        }
    }

    #[test]
    fn success_once() {
        static A: Once = Once::new();
        fn a() -> Result<i8, i8> {
            if A.is_completed() {
                panic!("A.is_completed()")
            } else {
                A.call_once(|| {})
            }
            Ok(1)
        }

        assert_eq!(A.is_completed(), false);
        let result = assert_ok_as_result!(a());
        assert!(result.is_ok());
        assert_eq!(A.is_completed(), true);
    }

    #[test]
    fn failure() {
        let a: Result<i8, i8> = Err(1);
        let actual = assert_ok_as_result!(a);
        let message = concat!(
            "assertion failed: `assert_ok!(a)`\n",
            "https://docs.rs/assertables/9.8.3/assertables/macro.assert_ok.html\n",
            " a label: `a`,\n",
            " a debug: `Err(1)`",
        );
        assert_eq!(actual.unwrap_err(), message);
    }
}

/// Assert expression is Ok.
///
/// Pseudocode:<br>
/// a is Ok.
///
/// * If true, return `a1`.
///
/// * Otherwise, call [`panic!`] with a message and the values of the
///   expressions with their debug representations.
///
/// # Examples
///
/// ```rust
/// use assertables::*;
/// # use std::panic;
///
/// # fn main() {
/// let a: Result<i8, i8> = Ok(1);
/// assert_ok!(a);
///
/// # let result = panic::catch_unwind(|| {
/// // This will panic
/// let a: Result<i8, i8> = Err(1);
/// assert_ok!(a);
/// # });
/// // assertion failed: `assert_ok!(a)`
/// // https://docs.rs/assertables/…/assertables/macro.assert_ok.html
/// //  a label: `a`,
/// //  a debug: `Err(1)`
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let message = concat!(
/// #     "assertion failed: `assert_ok!(a)`\n",
/// #     "https://docs.rs/assertables/9.8.3/assertables/macro.assert_ok.html\n",
/// #     " a label: `a`,\n",
/// #     " a debug: `Err(1)`",
/// # );
/// # assert_eq!(actual, message);
/// # }
/// ```
///
/// # Module macros
///
/// * [`assert_ok`](macro@crate::assert_ok)
/// * [`assert_ok_as_result`](macro@crate::assert_ok_as_result)
/// * [`debug_assert_ok`](macro@crate::debug_assert_ok)
///
#[macro_export]
macro_rules! assert_ok {
    ($a:expr $(,)?) => {
        match $crate::assert_ok_as_result!($a) {
            Ok(x) => x,
            Err(err) => panic!("{}", err),
        }
    };
    ($a:expr, $($message:tt)+) => {
        match $crate::assert_ok_as_result!($a) {
            Ok(x) => x,
            Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
        }
    };
}

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

    #[test]
    fn success() {
        let a: Result<i8, i8> = Ok(1);
        for _ in 0..1 {
            let actual = assert_ok!(a);
            assert_eq!(actual, 1);
        }
    }

    #[test]
    fn failure() {
        let a: Result<i8, i8> = Err(1);
        let result = panic::catch_unwind(|| {
            let _actual = assert_ok!(a);
        });
        let message = concat!(
            "assertion failed: `assert_ok!(a)`\n",
            "https://docs.rs/assertables/9.8.3/assertables/macro.assert_ok.html\n",
            " a label: `a`,\n",
            " a debug: `Err(1)`",
        );
        assert_eq!(
            result
                .unwrap_err()
                .downcast::<String>()
                .unwrap()
                .to_string(),
            message
        );
    }
}

/// Assert expression is Ok.
///
/// Pseudocode:<br>
/// a is Ok.
///
/// This macro provides the same statements as [`assert_ok`](macro.assert_ok.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_ok`](macro@crate::assert_ok)
/// * [`assert_ok`](macro@crate::assert_ok)
/// * [`debug_assert_ok`](macro@crate::debug_assert_ok)
///
#[macro_export]
macro_rules! debug_assert_ok {
    ($($arg:tt)*) => {
        if $crate::cfg!(debug_assertions) {
            $crate::assert_ok!($($arg)*);
        }
    };
}