assertables/assert_ok/assert_ok_eq.rs
1//! Assert two expressions are Ok and their values are equal.
2//!
3//! Pseudocode:<br>
4//! (a ⇒ Ok(a1) ⇒ a1) = (b ⇒ Ok(b1) ⇒ b1)
5//!
6//! # Example
7//!
8//! ```rust
9//! use assertables::*;
10//!
11//! let a: Result<i8, i8> = Ok(1);
12//! let b: Result<i8, i8> = Ok(1);
13//! assert_ok_eq!(a, b);
14//! ```
15//!
16//! # Module macros
17//!
18//! * [`assert_ok_eq`](macro@crate::assert_ok_eq)
19//! * [`assert_ok_eq_as_result`](macro@crate::assert_ok_eq_as_result)
20//! * [`debug_assert_ok_eq`](macro@crate::debug_assert_ok_eq)
21
22/// Assert two expressions are Ok and their values are equal.
23///
24/// Pseudocode:<br>
25/// (a ⇒ Ok(a1) ⇒ a1) = (b ⇒ Ok(b1) ⇒ b1)
26///
27/// * If true, return Result `Ok((a1, b1))`.
28///
29/// * Otherwise, return Result `Err(message)`.
30///
31/// This macro is useful for runtime checks, such as checking parameters,
32/// or sanitizing inputs, or handling different results in different ways.
33///
34/// # Module macros
35///
36/// * [`assert_ok_eq`](macro@crate::assert_ok_eq)
37/// * [`assert_ok_eq_as_result`](macro@crate::assert_ok_eq_as_result)
38/// * [`debug_assert_ok_eq`](macro@crate::debug_assert_ok_eq)
39///
40#[macro_export]
41macro_rules! assert_ok_eq_as_result {
42 ($a:expr, $b:expr $(,)?) => {{
43 let a = ($a);
44 let b = ($b);
45 match (a, b) {
46 (Ok(a1), Ok(b1)) => {
47 if a1 == b1 {
48 Ok((a1, b1))
49 } else {
50 Err(
51 format!(
52 concat!(
53 "assertion failed: `assert_ok_eq!(a, b)`\n",
54 "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
55 " a label: `{}`,\n",
56 " a debug: `{:?}`,\n",
57 " a inner: `{:?}`,\n",
58 " b label: `{}`,\n",
59 " b debug: `{:?}`,\n",
60 " b inner: `{:?}`"
61 ),
62 stringify!($a),
63 a,
64 a1,
65 stringify!($b),
66 b,
67 b1
68 )
69 )
70 }
71 },
72 _ => {
73 Err(
74 format!(
75 concat!(
76 "assertion failed: `assert_ok_eq!(a, b)`\n",
77 "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
78 " a label: `{}`,\n",
79 " a debug: `{:?}`,\n",
80 " b label: `{}`,\n",
81 " b debug: `{:?}`",
82 ),
83 stringify!($a),
84 a,
85 stringify!($b),
86 b
87 )
88 )
89 }
90 }
91 }};
92}
93
94#[cfg(test)]
95mod test_assert_ok_eq_as_result {
96
97 #[test]
98 fn eq() {
99 let a: Result<i8, i8> = Ok(1);
100 let b: Result<i8, i8> = Ok(1);
101 let actual = assert_ok_eq_as_result!(a, b);
102 assert_eq!(actual.unwrap(), (1, 1));
103 }
104
105 #[test]
106 fn ne() {
107 let a: Result<i8, i8> = Ok(1);
108 let b: Result<i8, i8> = Ok(2);
109 let actual = assert_ok_eq_as_result!(a, b);
110 let message = concat!(
111 "assertion failed: `assert_ok_eq!(a, b)`\n",
112 "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
113 " a label: `a`,\n",
114 " a debug: `Ok(1)`,\n",
115 " a inner: `1`,\n",
116 " b label: `b`,\n",
117 " b debug: `Ok(2)`,\n",
118 " b inner: `2`",
119 );
120 assert_eq!(actual.unwrap_err(), message);
121 }
122
123 #[test]
124 fn not_ok() {
125 let a: Result<i8, i8> = Err(1);
126 let b: Result<i8, i8> = Ok(1);
127 let actual = assert_ok_eq_as_result!(a, b);
128 let message = concat!(
129 "assertion failed: `assert_ok_eq!(a, b)`\n",
130 "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
131 " a label: `a`,\n",
132 " a debug: `Err(1)`,\n",
133 " b label: `b`,\n",
134 " b debug: `Ok(1)`",
135 );
136 assert_eq!(actual.unwrap_err(), message);
137 }
138
139 #[test]
140 fn idempotent() {
141 let a = 100;
142 let b = 100;
143 let a_atomic = std::sync::atomic::AtomicU32::new(a);
144 let a_increment = || Err::<u32, u32>(a_atomic.fetch_add(1, std::sync::atomic::Ordering::SeqCst));
145 let b_atomic = std::sync::atomic::AtomicU32::new(b);
146 let b_increment = || Err::<u32, u32>(b_atomic.fetch_add(1, std::sync::atomic::Ordering::SeqCst));
147 let _ = assert_ok_eq_as_result!(a_increment(), b_increment());
148 assert_eq!(a_atomic.load(std::sync::atomic::Ordering::SeqCst), a + 1);
149 assert_eq!(b_atomic.load(std::sync::atomic::Ordering::SeqCst), b + 1);
150 }
151
152}
153
154/// Assert two expressions are Ok and their values are equal.
155///
156/// Pseudocode:<br>
157/// (a ⇒ Ok(a1) ⇒ a1) = (b ⇒ Ok(b1) ⇒ b1)
158///
159/// * If true, return `(a1, b1)`.
160///
161/// * Otherwise, call [`panic!`] with a message and the values of the
162/// expressions with their debug representations.
163///
164/// # Examples
165///
166/// ```rust
167/// use assertables::*;
168/// # use std::panic;
169///
170/// # fn main() {
171/// let a: Result<i8, i8> = Ok(1);
172/// let b: Result<i8, i8> = Ok(1);
173/// assert_ok_eq!(a, b);
174///
175/// # let result = panic::catch_unwind(|| {
176/// // This will panic
177/// let a: Result<i8, i8> = Ok(1);
178/// let b: Result<i8, i8> = Ok(2);
179/// assert_ok_eq!(a, b);
180/// # });
181/// // assertion failed: `assert_ok_eq!(a, b)`
182/// // https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html
183/// // a label: `a`,
184/// // a debug: `Ok(1)`,
185/// // a inner: `1`,
186/// // b label: `b`,
187/// // b debug: `Ok(2)`,
188/// // b inner: `2`
189/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
190/// # let message = concat!(
191/// # "assertion failed: `assert_ok_eq!(a, b)`\n",
192/// # "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
193/// # " a label: `a`,\n",
194/// # " a debug: `Ok(1)`,\n",
195/// # " a inner: `1`,\n",
196/// # " b label: `b`,\n",
197/// # " b debug: `Ok(2)`,\n",
198/// # " b inner: `2`",
199/// # );
200/// # assert_eq!(actual, message);
201/// # }
202/// ```
203///
204/// # Module macros
205///
206/// * [`assert_ok_eq`](macro@crate::assert_ok_eq)
207/// * [`assert_ok_eq_as_result`](macro@crate::assert_ok_eq_as_result)
208/// * [`debug_assert_ok_eq`](macro@crate::debug_assert_ok_eq)
209///
210#[macro_export]
211macro_rules! assert_ok_eq {
212 ($a:expr, $b:expr $(,)?) => {{
213 match $crate::assert_ok_eq_as_result!($a, $b) {
214 Ok(x) => x,
215 Err(err) => panic!("{}", err),
216 }
217 }};
218 ($a:expr, $b:expr, $($message:tt)+) => {{
219 match $crate::assert_ok_eq_as_result!($a, $b) {
220 Ok(x) => x,
221 Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
222 }
223 }};
224}
225
226#[cfg(test)]
227mod test_assert_ok_eq {
228 use std::panic;
229
230 #[test]
231 fn eq() {
232 let a: Result<i8, i8> = Ok(1);
233 let b: Result<i8, i8> = Ok(1);
234 let actual = assert_ok_eq!(a, b);
235 assert_eq!(actual, (1, 1));
236 }
237
238 #[test]
239 fn ne() {
240 let a: Result<i8, i8> = Ok(1);
241 let b: Result<i8, i8> = Ok(2);
242 let result = panic::catch_unwind(|| {
243 let _actual = assert_ok_eq!(a, b);
244 });
245 let message = concat!(
246 "assertion failed: `assert_ok_eq!(a, b)`\n",
247 "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
248 " a label: `a`,\n",
249 " a debug: `Ok(1)`,\n",
250 " a inner: `1`,\n",
251 " b label: `b`,\n",
252 " b debug: `Ok(2)`,\n",
253 " b inner: `2`",
254 );
255 assert_eq!(
256 result
257 .unwrap_err()
258 .downcast::<String>()
259 .unwrap()
260 .to_string(),
261 message
262 );
263 }
264
265 #[test]
266 fn not_ok() {
267 let a: Result<i8, i8> = Err(1);
268 let b: Result<i8, i8> = Ok(1);
269 let result = panic::catch_unwind(|| {
270 let _actual = assert_ok_eq!(a, b);
271 });
272 let message = concat!(
273 "assertion failed: `assert_ok_eq!(a, b)`\n",
274 "https://docs.rs/assertables/9.5.4/assertables/macro.assert_ok_eq.html\n",
275 " a label: `a`,\n",
276 " a debug: `Err(1)`,\n",
277 " b label: `b`,\n",
278 " b debug: `Ok(1)`",
279 );
280 assert_eq!(
281 result
282 .unwrap_err()
283 .downcast::<String>()
284 .unwrap()
285 .to_string(),
286 message
287 );
288 }
289}
290
291/// Assert two expressions are Ok and their values are equal.
292///
293/// Pseudocode:<br>
294/// (a ⇒ Ok(a1) ⇒ a1) = (b ⇒ Ok(b1) ⇒ b1)
295///
296/// This macro provides the same statements as [`assert_ok_eq`](macro.assert_ok_eq.html),
297/// except this macro's statements are only enabled in non-optimized
298/// builds by default. An optimized build will not execute this macro's
299/// statements unless `-C debug-assertions` is passed to the compiler.
300///
301/// This macro is useful for checks that are too expensive to be present
302/// in a release build but may be helpful during development.
303///
304/// The result of expanding this macro is always type checked.
305///
306/// An unchecked assertion allows a program in an inconsistent state to
307/// keep running, which might have unexpected consequences but does not
308/// introduce unsafety as long as this only happens in safe code. The
309/// performance cost of assertions, however, is not measurable in general.
310/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
311/// after thorough profiling, and more importantly, only in safe code!
312///
313/// This macro is intended to work in a similar way to
314/// [`::std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
315///
316/// # Module macros
317///
318/// * [`assert_ok_eq`](macro@crate::assert_ok_eq)
319/// * [`assert_ok_eq`](macro@crate::assert_ok_eq)
320/// * [`debug_assert_ok_eq`](macro@crate::debug_assert_ok_eq)
321///
322#[macro_export]
323macro_rules! debug_assert_ok_eq {
324 ($($arg:tt)*) => {
325 if $crate::cfg!(debug_assertions) {
326 $crate::assert_ok_eq!($($arg)*);
327 }
328 };
329}