assertables/assert_program_args/assert_program_args_stdout_gt_x.rs
1//! Assert a command (built with program and args) stdout is greater than an expression.
2//!
3//! Pseudocode:<br>
4//! (a_program + a_args ⇒ command ⇒ stdout) > (expr into string)
5//!
6//! # Example
7//!
8//! ```rust
9//! use assertables::*;
10//!
11//! let program = "bin/printf-stdout";
12//! let args = ["%s", "alfa"];
13//! let bytes = vec![b'a', b'a'];
14//! assert_program_args_stdout_gt_x!(program, args, bytes);
15//! ```
16//!
17//! # Module macros
18//!
19//! * [`assert_program_args_stdout_gt_x`](macro@crate::assert_program_args_stdout_gt_x)
20//! * [`assert_program_args_stdout_gt_x_as_result`](macro@crate::assert_program_args_stdout_gt_x_as_result)
21//! * [`debug_assert_program_args_stdout_gt_x`](macro@crate::debug_assert_program_args_stdout_gt_x)
22
23/// Assert a command (built with program and args) stdout is greater than an expression.
24///
25/// Pseudocode:<br>
26/// (a_program + a_args ⇒ command ⇒ stdout) > (expr into string)
27///
28/// * If true, return Result `Ok(stdout)`.
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_stdout_gt_x`](macro@crate::assert_program_args_stdout_gt_x)
38/// * [`assert_program_args_stdout_gt_x_as_result`](macro@crate::assert_program_args_stdout_gt_x_as_result)
39/// * [`debug_assert_program_args_stdout_gt_x`](macro@crate::debug_assert_program_args_stdout_gt_x)
40///
41#[macro_export]
42macro_rules! assert_program_args_stdout_gt_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.stdout;
49 if a.gt(b_expr) {
50 Ok(a)
51 } else {
52 Err(
53 format!(
54 concat!(
55 "assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`\n",
56 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_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_stdout_gt_x!(a_program, a_args, b_expr)`\n",
83 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_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_stdout_gt_x_as_result {
110 use std::sync::Once;
111
112 #[test]
113 fn gt() {
114 let a_program = "bin/printf-stdout";
115 let a_args = ["%s", "alfa"];
116 let b = vec![b'a', b'a'];
117 for _ in 0..1 {
118 let actual = assert_program_args_stdout_gt_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 gt_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-stdout"
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'a', b'a']
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_stdout_gt_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 eq() {
167 let a_program = "bin/printf-stdout";
168 let a_args = ["%s", "alfa"];
169 let b = vec![b'a', b'l', b'f', b'a'];
170 let actual = assert_program_args_stdout_gt_x_as_result!(a_program, a_args, b);
171 let message = concat!(
172 "assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`\n",
173 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_x.html\n",
174 " a_program label: `a_program`,\n",
175 " a_program debug: `\"bin/printf-stdout\"`,\n",
176 " a_args label: `a_args`,\n",
177 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
178 " b_expr label: `b`,\n",
179 " b_expr debug: `[97, 108, 102, 97]`,\n",
180 " a: `[97, 108, 102, 97]`,\n",
181 " b: `[97, 108, 102, 97]`"
182 );
183 assert_eq!(actual.unwrap_err(), message);
184 }
185
186 #[test]
187 fn lt() {
188 let a_program = "bin/printf-stdout";
189 let a_args = ["%s", "alfa"];
190 let b = vec![b'z', b'z'];
191 let actual = assert_program_args_stdout_gt_x_as_result!(a_program, a_args, b);
192 let message = concat!(
193 "assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`\n",
194 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_x.html\n",
195 " a_program label: `a_program`,\n",
196 " a_program debug: `\"bin/printf-stdout\"`,\n",
197 " a_args label: `a_args`,\n",
198 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
199 " b_expr label: `b`,\n",
200 " b_expr debug: `[122, 122]`,\n",
201 " a: `[97, 108, 102, 97]`,\n",
202 " b: `[122, 122]`"
203 );
204 assert_eq!(actual.unwrap_err(), message);
205 }
206}
207
208/// Assert a command (built with program and args) stdout is greater than an expression.
209///
210/// Pseudocode:<br>
211/// (a_program + a_args ⇒ command ⇒ stdout) > (expr into string)
212///
213/// * If true, return `(stdout)`.
214///
215/// * Otherwise, call [`panic!`] with a message and the values of the
216/// expressions with their debug representations.
217///
218/// # Examples
219///
220/// ```rust
221/// use assertables::*;
222/// # use std::panic;
223///
224/// # fn main() {
225/// let program = "bin/printf-stdout";
226/// let args = ["%s", "alfa"];
227/// let bytes = vec![b'a', b'a'];
228/// assert_program_args_stdout_gt_x!(program, args, bytes);
229///
230/// # let result = panic::catch_unwind(|| {
231/// // This will panic
232/// let program = "bin/printf-stdout";
233/// let args = ["%s", "alfa"];
234/// let bytes = vec![b'z', b'z'];
235/// assert_program_args_stdout_gt_x!(program, args, bytes);
236/// # });
237/// // assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`
238/// // https://docs.rs/assertables/…/assertables/macro.assert_program_args_stdout_gt_x.html
239/// // a_program label: `program`,
240/// // a_program debug: `\"bin/printf-stdout\"`,
241/// // a_args label: `args`,
242/// // a_args debug: `[\"%s\", \"alfa\"]`,
243/// // b_expr label: `bytes`,
244/// // b_expr debug: `[122, 122]`,
245/// // a: `[97, 108, 102, 97]`,
246/// // b: `[122, 122]`
247/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
248/// # let message = concat!(
249/// # "assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`\n",
250/// # "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_x.html\n",
251/// # " a_program label: `program`,\n",
252/// # " a_program debug: `\"bin/printf-stdout\"`,\n",
253/// # " a_args label: `args`,\n",
254/// # " a_args debug: `[\"%s\", \"alfa\"]`,\n",
255/// # " b_expr label: `bytes`,\n",
256/// # " b_expr debug: `[122, 122]`,\n",
257/// # " a: `[97, 108, 102, 97]`,\n",
258/// # " b: `[122, 122]`"
259/// # );
260/// # assert_eq!(actual, message);
261/// # }
262/// ```
263///
264/// # Module macros
265///
266/// * [`assert_program_args_stdout_gt_x`](macro@crate::assert_program_args_stdout_gt_x)
267/// * [`assert_program_args_stdout_gt_x_as_result`](macro@crate::assert_program_args_stdout_gt_x_as_result)
268/// * [`debug_assert_program_args_stdout_gt_x`](macro@crate::debug_assert_program_args_stdout_gt_x)
269///
270#[macro_export]
271macro_rules! assert_program_args_stdout_gt_x {
272 ($a_program:expr, $a_args:expr, $b_expr:expr $(,)?) => {
273 match $crate::assert_program_args_stdout_gt_x_as_result!($a_program, $a_args, $b_expr) {
274 Ok(x) => x,
275 Err(err) => panic!("{}", err),
276 }
277 };
278 ($a_program:expr, $a_args:expr, $b_expr:expr, $($message:tt)+) => {
279 match $crate::assert_program_args_stdout_gt_x_as_result!($a_program, $a_args, $b_expr) {
280 Ok(x) => x,
281 Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
282 }
283 };
284}
285
286#[cfg(test)]
287mod test_assert_program_args_stdout_gt_x {
288 use std::panic;
289
290 #[test]
291 fn gt() {
292 let a_program = "bin/printf-stdout";
293 let a_args = ["%s", "alfa"];
294 let b = vec![b'a', b'a'];
295 for _ in 0..1 {
296 let actual = assert_program_args_stdout_gt_x!(a_program, a_args, b);
297 assert_eq!(actual, vec![b'a', b'l', b'f', b'a']);
298 }
299 }
300
301 #[test]
302 fn eq() {
303 let a_program = "bin/printf-stdout";
304 let a_args = ["%s", "alfa"];
305 let b = vec![b'a', b'l', b'f', b'a'];
306 let result = panic::catch_unwind(|| {
307 let _actual = assert_program_args_stdout_gt_x!(a_program, a_args, b);
308 });
309 let message = concat!(
310 "assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`\n",
311 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_x.html\n",
312 " a_program label: `a_program`,\n",
313 " a_program debug: `\"bin/printf-stdout\"`,\n",
314 " a_args label: `a_args`,\n",
315 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
316 " b_expr label: `b`,\n",
317 " b_expr debug: `[97, 108, 102, 97]`,\n",
318 " a: `[97, 108, 102, 97]`,\n",
319 " b: `[97, 108, 102, 97]`"
320 );
321 assert_eq!(
322 result
323 .unwrap_err()
324 .downcast::<String>()
325 .unwrap()
326 .to_string(),
327 message
328 );
329 }
330
331 #[test]
332 fn lt() {
333 let a_program = "bin/printf-stdout";
334 let a_args = ["%s", "alfa"];
335 let b = vec![b'z', b'z'];
336 let result = panic::catch_unwind(|| {
337 let _actual = assert_program_args_stdout_gt_x!(a_program, a_args, b);
338 });
339 let message = concat!(
340 "assertion failed: `assert_program_args_stdout_gt_x!(a_program, a_args, b_expr)`\n",
341 "https://docs.rs/assertables/9.8.4/assertables/macro.assert_program_args_stdout_gt_x.html\n",
342 " a_program label: `a_program`,\n",
343 " a_program debug: `\"bin/printf-stdout\"`,\n",
344 " a_args label: `a_args`,\n",
345 " a_args debug: `[\"%s\", \"alfa\"]`,\n",
346 " b_expr label: `b`,\n",
347 " b_expr debug: `[122, 122]`,\n",
348 " a: `[97, 108, 102, 97]`,\n",
349 " b: `[122, 122]`"
350 );
351 assert_eq!(
352 result
353 .unwrap_err()
354 .downcast::<String>()
355 .unwrap()
356 .to_string(),
357 message
358 );
359 }
360}
361
362/// Assert a command (built with program and args) stdout is greater than an expression.
363///
364/// Pseudocode:<br>
365/// (a_program + a_args ⇒ command ⇒ stdout) > (expr into string)
366///
367/// This macro provides the same statements as [`assert_program_args_stdout_gt_x`](macro.assert_program_args_stdout_gt_x.html),
368/// except this macro's statements are only enabled in non-optimized
369/// builds by default. An optimized build will not execute this macro's
370/// statements unless `-C debug-assertions` is passed to the compiler.
371///
372/// This macro is useful for checks that are too expensive to be present
373/// in a release build but may be helpful during development.
374///
375/// The result of expanding this macro is always type checked.
376///
377/// An unchecked assertion allows a program in an inconsistent state to
378/// keep running, which might have unexpected consequences but does not
379/// introduce unsafety as long as this only happens in safe code. The
380/// performance cost of assertions, however, is not measurable in general.
381/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
382/// after thorough profiling, and more importantly, only in safe code!
383///
384/// This macro is intended to work in a similar way to
385/// [`::std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
386///
387/// # Module macros
388///
389/// * [`assert_program_args_stdout_gt_x`](macro@crate::assert_program_args_stdout_gt_x)
390/// * [`assert_program_args_stdout_gt_x`](macro@crate::assert_program_args_stdout_gt_x)
391/// * [`debug_assert_program_args_stdout_gt_x`](macro@crate::debug_assert_program_args_stdout_gt_x)
392///
393#[macro_export]
394macro_rules! debug_assert_program_args_stdout_gt_x {
395 ($($arg:tt)*) => {
396 if $crate::cfg!(debug_assertions) {
397 $crate::assert_program_args_stdout_gt_x!($($arg)*);
398 }
399 };
400}