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