suitecase 0.0.5

The structured test toolkit. A sync Rust crate for named cases, optional suite and per-case hooks, and macros so each case appears in cargo test—without a custom harness or DSL.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Filesystem existence checks for tests.

use std::path::Path;

/// Asserts that `path` exists and is a regular file.
///
/// # Panics
///
/// Panics when the path is missing, not a file, or metadata cannot be read.
///
/// # Examples
///
/// ```
/// use std::fs;
/// use suitecase::assert::file_exists;
///
/// let path = std::env::temp_dir().join("suitecase_doc_file_exists");
/// let _ = fs::remove_file(&path);
/// fs::write(&path, b"x").unwrap();
/// file_exists(&path);
/// let _ = fs::remove_file(&path);
/// ```
#[track_caller]
pub fn file_exists(path: &Path) {
    match path.metadata() {
        Ok(m) if m.is_file() => {}
        Ok(_) => panic!(
            "assertion failed: `file_exists`: path exists but is not a file: {:?}",
            path
        ),
        Err(e) => panic!("assertion failed: `file_exists` {:?}: {e}", path),
    }
}

/// Asserts that `path` does not refer to an existing regular file.
///
/// # Panics
///
/// Panics when `path` exists and is a file.
///
/// # Examples
///
/// ```
/// use std::path::Path;
/// use suitecase::assert::no_file_exists;
///
/// no_file_exists(Path::new("/unlikely/path/that/does/not/exist/12345"));
/// ```
#[track_caller]
pub fn no_file_exists(path: &Path) {
    match path.metadata() {
        Ok(m) if m.is_file() => {
            panic!(
                "assertion failed: `no_file_exists`: file unexpectedly exists: {:?}",
                path
            );
        }
        Ok(_) => {}
        Err(_) => {}
    }
}

/// Asserts that `path` exists and is a directory.
///
/// # Panics
///
/// Panics when the path is missing, not a directory, or metadata cannot be read.
///
/// # Examples
///
/// ```
/// use std::fs;
/// use suitecase::assert::dir_exists;
///
/// let path = std::env::temp_dir().join("suitecase_doc_dir_exists");
/// let _ = fs::remove_dir_all(&path);
/// fs::create_dir_all(&path).unwrap();
/// dir_exists(&path);
/// let _ = fs::remove_dir_all(&path);
/// ```
#[track_caller]
pub fn dir_exists(path: &Path) {
    match path.metadata() {
        Ok(m) if m.is_dir() => {}
        Ok(_) => panic!(
            "assertion failed: `dir_exists`: path exists but is not a directory: {:?}",
            path
        ),
        Err(e) => panic!("assertion failed: `dir_exists` {:?}: {e}", path),
    }
}

/// Asserts that `path` does not refer to an existing directory.
///
/// # Panics
///
/// Panics when `path` exists and is a directory.
///
/// # Examples
///
/// ```
/// use std::path::Path;
/// use suitecase::assert::no_dir_exists;
///
/// no_dir_exists(Path::new("/unlikely/directory/not/here/99999"));
/// ```
#[track_caller]
pub fn no_dir_exists(path: &Path) {
    match path.metadata() {
        Ok(m) if m.is_dir() => {
            panic!(
                "assertion failed: `no_dir_exists`: directory unexpectedly exists: {:?}",
                path
            );
        }
        Ok(_) => {}
        Err(_) => {}
    }
}