assertables/assert_contains.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
//! Assert a container is a match for an expression.
//!
//! Pseudocode:<br>
//! a.contains(b)
//!
//! # Example
//!
//! ```rust
//! # #[macro_use] extern crate assertables;
//! # fn main() {
//! // String contains substring
//! let a: &str = "alfa";
//! let b: &str = "lf";
//! assert_contains!(a, b);
//!
//! // Range contains value
//! let a = 1..5;
//! let b = 2;
//! assert_contains!(a, &b);
//! # }
//! ```
//!
//! # Module macros
//!
//! * [`assert_contains`](macro@crate::assert_contains)
//! * [`assert_contains_as_result`](macro@crate::assert_contains_as_result)
//! * [`debug_assert_contains`](macro@crate::debug_assert_contains)
/// Assert an expression (such as a string) contains an expression (such as a substring).
///
/// Pseudocode:<br>
/// a.contains(b)
///
/// * If true, return Result `Ok(())`.
///
/// * Otherwise, return Result `Err` with a diagnostic message.
///
/// This macro provides the same statements as [`assert_contains`](macro.assert_contains.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_contains`](macro@crate::assert_contains)
/// * [`assert_contains_as_result`](macro@crate::assert_contains_as_result)
/// * [`debug_assert_contains`](macro@crate::debug_assert_contains)
///
#[macro_export]
macro_rules! assert_contains_as_result {
($container:expr, $containee:expr $(,)?) => {{
match (&$container, &$containee) {
(container, containee) => {
if container.contains($containee) {
Ok(())
} else {
Err(format!(
concat!(
"assertion failed: `assert_contains!(container, containee)`\n",
"https://docs.rs/assertables/8.9.0/assertables/macro.assert_contains.html\n",
" container label: `{}`,\n",
" container debug: `{:?}`,\n",
" containee label: `{}`,\n",
" containee debug: `{:?}`",
),
stringify!($container),
container,
stringify!($containee),
containee,
))
}
}
}
}};
}
#[cfg(test)]
mod tests {
//// For &str
#[test]
fn test_assert_contains_as_result_x_str_x_success() {
let a = "alfa";
let b = "lf";
let result = assert_contains_as_result!(a, b);
assert_eq!(result.unwrap(), ());
}
#[test]
fn test_assert_contains_as_result_x_str_x_failure() {
let a: &str = "alfa";
let b = "zz";
let result = assert_contains_as_result!(a, b);
let actual = result.unwrap_err();
let expect = concat!(
"assertion failed: `assert_contains!(container, containee)`\n",
"https://docs.rs/assertables/8.9.0/assertables/macro.assert_contains.html\n",
" container label: `a`,\n",
" container debug: `\"alfa\"`,\n",
" containee label: `b`,\n",
" containee debug: `\"zz\"`"
);
assert_eq!(actual, expect);
}
//// For Range
#[test]
fn test_assert_contains_as_result_x_range_x_success() {
let a = 1..5;
let b = 2;
let result = assert_contains_as_result!(a, &b);
assert_eq!(result.unwrap(), ());
}
#[test]
fn test_assert_contains_as_result_x_range_x_failure() {
let a = 1..5;
let b = 6;
let result = assert_contains_as_result!(a, &b);
let actual = result.unwrap_err();
let expect = concat!(
"assertion failed: `assert_contains!(container, containee)`\n",
"https://docs.rs/assertables/8.9.0/assertables/macro.assert_contains.html\n",
" container label: `a`,\n",
" container debug: `1..5`,\n",
" containee label: `&b`,\n",
" containee debug: `6`"
);
assert_eq!(actual, expect);
}
}
/// Assert a container is a match for an expression.
///
/// Pseudocode:<br>
/// a.contains(b)
///
/// * If true, return `()`.
///
/// * Otherwise, call [`panic!`] with a message and the values of the
/// expressions with their debug representations.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate assertables;
/// # use std::panic;
/// # fn main() {
/// // Return Ok when a string contains a substring
/// let a = "alfa";
/// let b = "lf";
/// assert_contains!(a, b);
///
/// // Return Ok when a range contains a value
/// let a = 1..5;
/// let b = 2;
/// assert_contains!(a, &b);
///
/// # let result = panic::catch_unwind(|| {
/// let a = "alfa";
/// let b = "zz";
/// assert_contains!(a, b);
/// # });
/// // assertion failed: `assert_contains!(container, containee)`
/// // https://docs.rs/assertables/8.9.0/assertables/macro.assert_contains.html
/// // container label: `a`,
/// // container debug: `\"alfa\"`,
/// // containee label: `b`,
/// // containee debug: `\"zz\"`
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let expect = concat!(
/// # "assertion failed: `assert_contains!(container, containee)`\n",
/// # "https://docs.rs/assertables/8.9.0/assertables/macro.assert_contains.html\n",
/// # " container label: `a`,\n",
/// # " container debug: `\"alfa\"`,\n",
/// # " containee label: `b`,\n",
/// # " containee debug: `\"zz\"`"
/// # );
/// # assert_eq!(actual, expect);
/// # }
/// ```
///
/// # Module macros
///
/// * [`assert_contains`](macro@crate::assert_contains)
/// * [`assert_contains_as_result`](macro@crate::assert_contains_as_result)
/// * [`debug_assert_contains`](macro@crate::debug_assert_contains)
///
#[macro_export]
macro_rules! assert_contains {
($container:expr, $containee:expr $(,)?) => {{
match assert_contains_as_result!($container, $containee) {
Ok(()) => (),
Err(err) => panic!("{}", err),
}
}};
($container:expr, $containee:expr, $($message:tt)+) => {{
match assert_contains_as_result!($container, $containee) {
Ok(()) => (),
Err(_err) => panic!("{}", $($message)+),
}
}};
}
/// Assert a container is a match for an expression.
///
/// Pseudocode:<br>
/// a.contains(b)
///
/// This macro provides the same statements as [`assert_contains`](macro.assert_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_contains`](macro@crate::assert_contains)
/// * [`assert_contains`](macro@crate::assert_contains)
/// * [`debug_assert_contains`](macro@crate::debug_assert_contains)
///
#[macro_export]
macro_rules! debug_assert_contains {
($($arg:tt)*) => {
if $crate::cfg!(debug_assertions) {
$crate::assert_contains!($($arg)*);
}
};
}