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