assertables/assert_program_args/assert_program_args_stderr_ne_x.rs
1//! Assert a command (built with program and args) stderr is not equal to an expression.
2//!
3//! Pseudocode:<br>
4//! (a_program + a_args ⇒ command ⇒ stderr) ≠ (expr into string)
5//!
6//! # Example
7//!
8//! ```rust
9//! use assertables::*;
10//!
11//! let program = "bin/printf-stderr";
12//! let args = ["%s", "alfa"];
13//! let bytes = vec![b'x', b'x'];
14//! assert_program_args_stderr_ne_x!(program, args, bytes);
15//! ```
16//!
17//! # Module macros
18//!
19//! * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
20//! * [`assert_program_args_stderr_ne_x_as_result`](macro@crate::assert_program_args_stderr_ne_x_as_result)
21//! * [`debug_assert_program_args_stderr_ne_x`](macro@crate::debug_assert_program_args_stderr_ne_x)
22
23/// Assert a command (built with program and args) stderr is not equal to an expression.
24///
25/// Pseudocode:<br>
26/// (a_program + a_args ⇒ command ⇒ stderr) ≠ (expr into string)
27///
28/// * If true, return Result `Ok(stderr)`.
29///
30/// * Otherwise, return Result `Err(message)`.
31///
32/// This macro is useful for runtime checks, such as checking parameters,
33/// or sanitizing inputs, or handling different results in different ways.
34///
35/// # Module macros
36///
37/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
38/// * [`assert_program_args_stderr_ne_x_as_result`](macro@crate::assert_program_args_stderr_ne_x_as_result)
39/// * [`debug_assert_program_args_stderr_ne_x`](macro@crate::debug_assert_program_args_stderr_ne_x)
40///
41#[macro_export]
42macro_rules! assert_program_args_stderr_ne_x_as_result {
43 ($a_program:expr, $a_args:expr, $b_expr:expr $(,)?) => {
44 match (&$a_program, &$a_args, &$b_expr) {
45 (a_program, a_args, b_expr) => {
46 match assert_program_args_impl_prep!(a_program, a_args) {
47 Ok(a_output) => {
48 let a = a_output.stderr;
49 if a.ne(b_expr) {
50 Ok(a)
51 } else {
52 Err(
53 format!(
54 concat!(
55 "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
56 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stderr_ne_x.html\n",
57 " a_program label: `{}`,\n",
58 " a_program debug: `{:?}`,\n",
59 " a_args label: `{}`,\n",
60 " a_args debug: `{:?}`,\n",
61 " b_expr label: `{}`,\n",
62 " b_expr debug: `{:?}`,\n",
63 " a: `{:?}`,\n",
64 " b: `{:?}`"
65 ),
66 stringify!($a_program),
67 a_program,
68 stringify!($a_args),
69 a_args,
70 stringify!($b_expr),
71 $b_expr,
72 a,
73 b_expr
74 )
75 )
76 }
77 }
78 Err(err) => {
79 Err(
80 format!(
81 concat!(
82 "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
83 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stderr_ne_x.html\n",
84 " a_program label: `{}`,\n",
85 " a_program debug: `{:?}`,\n",
86 " a_args label: `{}`,\n",
87 " a_args debug: `{:?}`,\n",
88 " b_expr label: `{}`,\n",
89 " b_expr debug: `{:?}`,\n",
90 " err: `{:?}`"
91 ),
92 stringify!($a_program),
93 a_program,
94 stringify!($a_args),
95 a_args,
96 stringify!($b_expr),
97 $b_expr,
98 err
99 )
100 )
101 }
102 }
103 }
104 }
105 };
106}
107
108#[cfg(test)]
109mod test_assert_program_args_stderr_ne_x_as_result {
110 use std::sync::Once;
111
112 #[test]
113 fn lt() {
114 let a_program = "bin/printf-stderr";
115 let a_args = ["%s", "alfa"];
116 let b = vec![b'z', b'z'];
117 for _ in 0..1 {
118 let actual = assert_program_args_stderr_ne_x_as_result!(a_program, a_args, b);
119 assert_eq!(actual.unwrap(), vec![b'a', b'l', b'f', b'a']);
120 }
121 }
122
123 #[test]
124 fn lt_once() {
125 static A: Once = Once::new();
126 fn a() -> &'static str {
127 if A.is_completed() {
128 panic!("A.is_completed()")
129 } else {
130 A.call_once(|| {})
131 }
132 "bin/printf-stderr"
133 }
134
135 static A_ARGS: Once = Once::new();
136 fn a_args() -> [&'static str; 2] {
137 if A_ARGS.is_completed() {
138 panic!("A_ARGS.is_completed()")
139 } else {
140 A_ARGS.call_once(|| {})
141 }
142 ["%s", "alfa"]
143 }
144
145 static B: Once = Once::new();
146 fn b() -> Vec<u8> {
147 if B.is_completed() {
148 panic!("B.is_completed()")
149 } else {
150 B.call_once(|| {})
151 }
152 vec![b'z', b'z']
153 }
154
155 assert_eq!(A.is_completed(), false);
156 assert_eq!(A_ARGS.is_completed(), false);
157 assert_eq!(B.is_completed(), false);
158 let result = assert_program_args_stderr_ne_x_as_result!(a(), a_args(), b());
159 assert!(result.is_ok());
160 assert_eq!(A.is_completed(), true);
161 assert_eq!(A_ARGS.is_completed(), true);
162 assert_eq!(B.is_completed(), true);
163 }
164
165 #[test]
166 fn gt() {
167 let a_program = "bin/printf-stderr";
168 let a_args = ["%s", "alfa"];
169 let b = vec![b'a', b'a'];
170 for _ in 0..1 {
171 let actual = assert_program_args_stderr_ne_x_as_result!(a_program, a_args, b);
172 assert_eq!(actual.unwrap(), vec![b'a', b'l', b'f', b'a']);
173 }
174 }
175
176 #[test]
177 fn gt_once() {
178 static A: Once = Once::new();
179 fn a() -> &'static str {
180 if A.is_completed() {
181 panic!("A.is_completed()")
182 } else {
183 A.call_once(|| {})
184 }
185 "bin/printf-stderr"
186 }
187
188 static A_ARGS: Once = Once::new();
189 fn a_args() -> [&'static str; 2] {
190 if A_ARGS.is_completed() {
191 panic!("A_ARGS.is_completed()")
192 } else {
193 A_ARGS.call_once(|| {})
194 }
195 ["%s", "alfa"]
196 }
197
198 static B: Once = Once::new();
199 fn b() -> Vec<u8> {
200 if B.is_completed() {
201 panic!("B.is_completed()")
202 } else {
203 B.call_once(|| {})
204 }
205 vec![b'a', b'a']
206 }
207
208 assert_eq!(A.is_completed(), false);
209 assert_eq!(A_ARGS.is_completed(), false);
210 assert_eq!(B.is_completed(), false);
211 let result = assert_program_args_stderr_ne_x_as_result!(a(), a_args(), b());
212 assert!(result.is_ok());
213 assert_eq!(A.is_completed(), true);
214 assert_eq!(A_ARGS.is_completed(), true);
215 assert_eq!(B.is_completed(), true);
216 }
217
218 #[test]
219 fn eq() {
220 let a_program = "bin/printf-stderr";
221 let a_args = ["%s", "alfa"];
222 let b = vec![b'a', b'l', b'f', b'a'];
223 let actual = assert_program_args_stderr_ne_x_as_result!(a_program, a_args, b);
224 let message = concat!(
225 "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
226 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stderr_ne_x.html\n",
227 " a_program label: `a_program`,\n",
228 " a_program debug: `\"bin/printf-stderr\"`,\n",
229 " a_args label: `a_args`,\n",
230 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
231 " b_expr label: `b`,\n",
232 " b_expr debug: `[97, 108, 102, 97]`,\n",
233 " a: `[97, 108, 102, 97]`,\n",
234 " b: `[97, 108, 102, 97]`"
235 );
236 assert_eq!(actual.unwrap_err(), message);
237 }
238}
239
240/// Assert a command (built with program and args) stderr is not equal to an expression.
241///
242/// Pseudocode:<br>
243/// (a_program + a_args ⇒ command ⇒ stderr) ≠ (expr into string)
244///
245/// * If true, return `()`.
246///
247/// * Otherwise, call [`panic!`] with a message and the values of the
248/// expressions with their debug representations.
249///
250/// # Examples
251///
252/// ```rust
253/// use assertables::*;
254/// # use std::panic;
255///
256/// # fn main() {
257/// let program = "bin/printf-stderr";
258/// let args = ["%s", "alfa"];
259/// let bytes = vec![b'x', b'x'];
260/// assert_program_args_stderr_ne_x!(program, args, bytes);
261///
262/// # let result = panic::catch_unwind(|| {
263/// // This will panic
264/// let program = "bin/printf-stderr";
265/// let args = ["%s", "alfa"];
266/// let bytes = vec![b'a', b'l', b'f', b'a'];
267/// assert_program_args_stderr_ne_x!(program, args, bytes);
268/// # });
269/// // assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`
270/// // https://docs.rs/assertables/…/assertables/macro.assert_program_args_stderr_ne_x.html
271/// // a_program label: `program`,
272/// // a_program debug: `\"bin/printf-stderr\"`,
273/// // a_args label: `args`,
274/// // a_args debug: `[\"%s\", \"alfa\"]`,
275/// // b_expr label: `bytes`,
276/// // b_expr debug: `[97, 108, 102, 97]`,
277/// // a: `[97, 108, 102, 97]`,
278/// // b: `[97, 108, 102, 97]`
279/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
280/// # let message = concat!(
281/// # "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
282/// # "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stderr_ne_x.html\n",
283/// # " a_program label: `program`,\n",
284/// # " a_program debug: `\"bin/printf-stderr\"`,\n",
285/// # " a_args label: `args`,\n",
286/// # " a_args debug: `[\"%s\", \"alfa\"]`,\n",
287/// # " b_expr label: `bytes`,\n",
288/// # " b_expr debug: `[97, 108, 102, 97]`,\n",
289/// # " a: `[97, 108, 102, 97]`,\n",
290/// # " b: `[97, 108, 102, 97]`"
291/// # );
292/// # assert_eq!(actual, message);
293/// # }
294/// ```
295///
296/// # Module macros
297///
298/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
299/// * [`assert_program_args_stderr_ne_x_as_result`](macro@crate::assert_program_args_stderr_ne_x_as_result)
300/// * [`debug_assert_program_args_stderr_ne_x`](macro@crate::debug_assert_program_args_stderr_ne_x)
301///
302#[macro_export]
303macro_rules! assert_program_args_stderr_ne_x {
304 ($a_program:expr, $a_args:expr, $b_expr:expr $(,)?) => {
305 match $crate::assert_program_args_stderr_ne_x_as_result!($a_program, $a_args, $b_expr) {
306 Ok(x) => x,
307 Err(err) => panic!("{}", err),
308 }
309 };
310 ($a_program:expr, $a_args:expr, $b_expr:expr, $($message:tt)+) => {
311 match $crate::assert_program_args_stderr_ne_x_as_result!($a_program, $a_args, $b_expr) {
312 Ok(x) => x,
313 Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
314 }
315 };
316}
317
318#[cfg(test)]
319mod test_assert_program_args_stderr_ne_x {
320 use std::panic;
321
322 #[test]
323 fn ne() {
324 let a_program = "bin/printf-stderr";
325 let a_args = ["%s", "alfa"];
326 let b = vec![b'x', b'x'];
327 for _ in 0..1 {
328 let actual = assert_program_args_stderr_ne_x!(a_program, a_args, b);
329 assert_eq!(actual, vec![b'a', b'l', b'f', b'a']);
330 }
331 }
332
333 #[test]
334 fn eq() {
335 let a_program = "bin/printf-stderr";
336 let a_args = ["%s", "alfa"];
337 let b = vec![b'a', b'l', b'f', b'a'];
338 let result = panic::catch_unwind(|| {
339 let _actual = assert_program_args_stderr_ne_x!(a_program, a_args, b);
340 });
341 let message = concat!(
342 "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
343 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stderr_ne_x.html\n",
344 " a_program label: `a_program`,\n",
345 " a_program debug: `\"bin/printf-stderr\"`,\n",
346 " a_args label: `a_args`,\n",
347 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
348 " b_expr label: `b`,\n",
349 " b_expr debug: `[97, 108, 102, 97]`,\n",
350 " a: `[97, 108, 102, 97]`,\n",
351 " b: `[97, 108, 102, 97]`"
352 );
353 assert_eq!(
354 result
355 .unwrap_err()
356 .downcast::<String>()
357 .unwrap()
358 .to_string(),
359 message
360 );
361 }
362}
363
364/// Assert a command (built with program and args) stderr is not equal to an expression.
365///
366/// Pseudocode:<br>
367/// (a_program + a_args ⇒ command ⇒ stderr) ≠ (expr into string)
368///
369/// This macro provides the same statements as [`assert_program_args_stderr_ne_x`](macro.assert_program_args_stderr_ne_x.html),
370/// except this macro's statements are only enabled in non-optimized
371/// builds by default. An optimized build will not execute this macro's
372/// statements unless `-C debug-assertions` is passed to the compiler.
373///
374/// This macro is useful for checks that are too expensive to be present
375/// in a release build but may be helpful during development.
376///
377/// The result of expanding this macro is always type checked.
378///
379/// An unchecked assertion allows a program in an inconsistent state to
380/// keep running, which might have unexpected consequences but does not
381/// introduce unsafety as long as this only happens in safe code. The
382/// performance cost of assertions, however, is not measurable in general.
383/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
384/// after thorough profiling, and more importantly, only in safe code!
385///
386/// This macro is intended to work in a similar way to
387/// [`::std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
388///
389/// # Module macros
390///
391/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
392/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
393/// * [`debug_assert_program_args_stderr_ne_x`](macro@crate::debug_assert_program_args_stderr_ne_x)
394///
395#[macro_export]
396macro_rules! debug_assert_program_args_stderr_ne_x {
397 ($($arg:tt)*) => {
398 if $crate::cfg!(debug_assertions) {
399 $crate::assert_program_args_stderr_ne_x!($($arg)*);
400 }
401 };
402}