test_toolbox/
expect.rs

1/// Macro to define different expected values for `debug` and `release`
2///
3/// This is useful when testing logic with differing expected results based on build.
4///
5/// Basically erogonomifies the following ...
6///
7/// ```rust
8/// # use cfg_if::cfg_if;
9/// cfg_if! {
10///    if #[cfg(not(debug_assertions))] {
11///        let expected = 42; // release build value
12///    } else {
13///        let expected = 0; // debug build value
14///    }
15/// }
16/// ```
17/// with ...
18/// ```rust
19/// # use test_toolbox::expect;
20/// expect! { expected = 42, 0 }
21/// ```
22///
23/// # Features
24///
25/// * lets you define both `release` and `debug` initialization values for expected variable
26/// * lets you optionally provide an explicit `type` when defining an expected variable
27///
28/// \* `release` _initialization value is defined first, followed by the_ `debug` _value_
29///
30/// # Examples
31///
32/// * implicit type
33///
34/// ```rust
35/// # use test_toolbox::expect;
36/// // 42 is the expected value for release
37/// // default is the expected value for debug
38/// expect! { expected = 42, 0 }
39/// ```
40///
41/// * explict type
42///
43/// ```rust
44/// # use test_toolbox::expect;
45/// // 42 is the expected value for release
46/// // default is the expected value for debug
47/// expect! { expected: usize = 42, Default::default() }
48/// ```
49#[macro_export]
50macro_rules! expect {
51    // declare expected variable implicitly typed
52    ($var:ident = $rls:expr, $dgb:expr) => {
53        $crate::cfg_if::cfg_if! {
54            if #[cfg(not(debug_assertions))] {
55                let $var = $rls;
56            } else {
57                let $var = $dgb;
58            }
59        }
60    };
61    // declare expected variable explicitly typed
62    ($var:ident: $typ:ty = $rls:expr, $dgb:expr) => {
63        $crate::cfg_if::cfg_if! {
64            if #[cfg(not(debug_assertions))] {
65                let $var: $typ = $rls;
66            } else {
67                let $var: $typ = $dgb;
68            }
69        }
70    };
71}