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'z', b'z'];
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.5.3/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.5.3/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
111 #[test]
112 fn ne() {
113 let a_program = "bin/printf-stderr";
114 let a_args = ["%s", "alfa"];
115 let b = vec![b'z', b'z'];
116 let actual = assert_program_args_stderr_ne_x_as_result!(&a_program, &a_args, b);
117 assert_eq!(actual.unwrap(), vec![b'a', b'l', b'f', b'a']);
118 }
119
120 #[test]
121 fn eq() {
122 let a_program = "bin/printf-stderr";
123 let a_args = ["%s", "alfa"];
124 let b = vec![b'a', b'l', b'f', b'a'];
125 let actual = assert_program_args_stderr_ne_x_as_result!(&a_program, &a_args, b);
126 let message = concat!(
127 "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
128 "https://docs.rs/assertables/9.5.3/assertables/macro.assert_program_args_stderr_ne_x.html\n",
129 " a_program label: `&a_program`,\n",
130 " a_program debug: `\"bin/printf-stderr\"`,\n",
131 " a_args label: `&a_args`,\n",
132 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
133 " b_expr label: `b`,\n",
134 " b_expr debug: `[97, 108, 102, 97]`,\n",
135 " a: `[97, 108, 102, 97]`,\n",
136 " b: `[97, 108, 102, 97]`")
137 ;
138 assert_eq!(actual.unwrap_err(), message);
139 }
140}
141
142/// Assert a command (built with program and args) stderr is not equal to an expression.
143///
144/// Pseudocode:<br>
145/// (a_program + a_args ⇒ command ⇒ stderr) ≠ (expr into string)
146///
147/// * If true, return `()`.
148///
149/// * Otherwise, call [`panic!`] with a message and the values of the
150/// expressions with their debug representations.
151///
152/// # Examples
153///
154/// ```rust
155/// use assertables::*;
156/// # use std::panic;
157///
158/// # fn main() {
159/// let program = "bin/printf-stderr";
160/// let args = ["%s", "alfa"];
161/// let bytes = vec![b'z', b'z'];
162/// assert_program_args_stderr_ne_x!(&program, &args, bytes);
163///
164/// # let result = panic::catch_unwind(|| {
165/// // This will panic
166/// let program = "bin/printf-stderr";
167/// let args = ["%s", "alfa"];
168/// let bytes = vec![b'a', b'l', b'f', b'a'];
169/// assert_program_args_stderr_ne_x!(&program, &args, bytes);
170/// # });
171/// // assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`
172/// // https://docs.rs/assertables/9.5.3/assertables/macro.assert_program_args_stderr_ne_x.html
173/// // a_program label: `&program`,
174/// // a_program debug: `\"bin/printf-stderr\"`,
175/// // a_args label: `&args`,
176/// // a_args debug: `[\"%s\", \"alfa\"]`,
177/// // b_expr label: `bytes`,
178/// // b_expr debug: `[97, 108, 102, 97]`,
179/// // a: `[97, 108, 102, 97]`,
180/// // b: `[97, 108, 102, 97]`
181/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
182/// # let message = concat!(
183/// # "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
184/// # "https://docs.rs/assertables/9.5.3/assertables/macro.assert_program_args_stderr_ne_x.html\n",
185/// # " a_program label: `&program`,\n",
186/// # " a_program debug: `\"bin/printf-stderr\"`,\n",
187/// # " a_args label: `&args`,\n",
188/// # " a_args debug: `[\"%s\", \"alfa\"]`,\n",
189/// # " b_expr label: `bytes`,\n",
190/// # " b_expr debug: `[97, 108, 102, 97]`,\n",
191/// # " a: `[97, 108, 102, 97]`,\n",
192/// # " b: `[97, 108, 102, 97]`"
193/// # );
194/// # assert_eq!(actual, message);
195/// # }
196/// ```
197///
198/// # Module macros
199///
200/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
201/// * [`assert_program_args_stderr_ne_x_as_result`](macro@crate::assert_program_args_stderr_ne_x_as_result)
202/// * [`debug_assert_program_args_stderr_ne_x`](macro@crate::debug_assert_program_args_stderr_ne_x)
203///
204#[macro_export]
205macro_rules! assert_program_args_stderr_ne_x {
206 ($a_program:expr, $a_args:expr, $b_expr:expr $(,)?) => {{
207 match $crate::assert_program_args_stderr_ne_x_as_result!($a_program, $a_args, $b_expr) {
208 Ok(x) => x,
209 Err(err) => panic!("{}", err),
210 }
211 }};
212 ($a_program:expr, $a_args:expr, $b_expr:expr, $($message:tt)+) => {{
213 match $crate::assert_program_args_stderr_ne_x_as_result!($a_program, $a_args, $b_expr) {
214 Ok(x) => x,
215 Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
216 }
217 }};
218}
219
220#[cfg(test)]
221mod test_assert_program_args_stderr_ne_x {
222 use std::panic;
223
224 #[test]
225 fn ne() {
226 let a_program = "bin/printf-stderr";
227 let a_args = ["%s", "alfa"];
228 let b = vec![b'z', b'z'];
229 let actual = assert_program_args_stderr_ne_x!(&a_program, &a_args, b);
230 assert_eq!(actual, vec![b'a', b'l', b'f', b'a']);
231 }
232
233 #[test]
234 fn eq() {
235 let a_program = "bin/printf-stderr";
236 let a_args = ["%s", "alfa"];
237 let b = vec![b'a', b'l', b'f', b'a'];
238 let result = panic::catch_unwind(|| {
239 let _actual = assert_program_args_stderr_ne_x!(&a_program, &a_args, b);
240 });
241 let message = concat!(
242 "assertion failed: `assert_program_args_stderr_ne_x!(a_program, a_args, b_expr)`\n",
243 "https://docs.rs/assertables/9.5.3/assertables/macro.assert_program_args_stderr_ne_x.html\n",
244 " a_program label: `&a_program`,\n",
245 " a_program debug: `\"bin/printf-stderr\"`,\n",
246 " a_args label: `&a_args`,\n",
247 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
248 " b_expr label: `b`,\n",
249 " b_expr debug: `[97, 108, 102, 97]`,\n",
250 " a: `[97, 108, 102, 97]`,\n",
251 " b: `[97, 108, 102, 97]`")
252 ;
253 assert_eq!(
254 result
255 .unwrap_err()
256 .downcast::<String>()
257 .unwrap()
258 .to_string(),
259 message
260 );
261 }
262}
263
264/// Assert a command (built with program and args) stderr is not equal to an expression.
265///
266/// Pseudocode:<br>
267/// (a_program + a_args ⇒ command ⇒ stderr) ≠ (expr into string)
268///
269/// This macro provides the same statements as [`assert_program_args_stderr_ne_x`](macro.assert_program_args_stderr_ne_x.html),
270/// except this macro's statements are only enabled in non-optimized
271/// builds by default. An optimized build will not execute this macro's
272/// statements unless `-C debug-assertions` is passed to the compiler.
273///
274/// This macro is useful for checks that are too expensive to be present
275/// in a release build but may be helpful during development.
276///
277/// The result of expanding this macro is always type checked.
278///
279/// An unchecked assertion allows a program in an inconsistent state to
280/// keep running, which might have unexpected consequences but does not
281/// introduce unsafety as long as this only happens in safe code. The
282/// performance cost of assertions, however, is not measurable in general.
283/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
284/// after thorough profiling, and more importantly, only in safe code!
285///
286/// This macro is intended to work in a similar way to
287/// [`::std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
288///
289/// # Module macros
290///
291/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
292/// * [`assert_program_args_stderr_ne_x`](macro@crate::assert_program_args_stderr_ne_x)
293/// * [`debug_assert_program_args_stderr_ne_x`](macro@crate::debug_assert_program_args_stderr_ne_x)
294///
295#[macro_export]
296macro_rules! debug_assert_program_args_stderr_ne_x {
297 ($($arg:tt)*) => {
298 if $crate::cfg!(debug_assertions) {
299 $crate::assert_program_args_stderr_ne_x!($($arg)*);
300 }
301 };
302}