txtpp 0.2.4

A simple-to-use general purpose preprocessor for text files.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! Common utils for integration tests

use copy_dir::copy_dir;
use error_stack::Result;
use murmur3::murmur3_32;
use std::io::BufReader;
use std::path::{Path, PathBuf};
use txtpp::{error::TxtppError, *};

pub struct ItEnv {
    pub cfg: Config,
    test_description: String,
    test_dir: PathBuf,
}

impl ItEnv {
    pub fn new(example_dir_name: &str) -> Self {
        let test_description = example_dir_name.to_string();
        let mut read = BufReader::new(test_description.as_bytes());
        let test_name = format!(
            "test-{}",
            murmur3_32(&mut read, test_description.len().try_into().unwrap()).unwrap()
        );
        // create test directory
        let root_path = Path::new("target/test_out");
        if !root_path.exists() {
            std::fs::create_dir_all(root_path).unwrap();
        }
        let path = root_path.join(test_name);
        if path.exists() {
            std::fs::remove_dir_all(&path).unwrap();
        }

        // copy example directory to test directory
        copy_dir(example_dir_name, &path).unwrap();

        let config: Config = txtpp::Config {
            num_threads: 8,
            verbosity: Verbosity::Quiet,
            base_dir: path.clone(),
            ..Default::default()
        };

        Self {
            test_description,
            test_dir: path,
            cfg: config,
        }
    }

    #[inline]
    pub fn execute<F>(&mut self, f: F)
    where
        F: FnOnce(&mut Self),
    {
        f(self)
    }

    #[inline]
    pub fn cfg_mut(&mut self) -> &mut Config {
        &mut self.cfg
    }

    #[inline]
    pub fn run(&self) -> Result<(), TxtppError> {
        txtpp(self.cfg.clone())
    }

    #[inline]
    pub fn set_file(&self, file_name: &str, contents: &str) {
        let path = self.test_dir.join(file_name);
        std::fs::write(path, contents).unwrap();
    }

    #[inline]
    #[allow(dead_code)]
    pub fn delete_file(&self, file_name: &str) {
        let path = self.test_dir.join(file_name);
        std::fs::remove_file(path).unwrap();
    }

    pub fn assert_file_eq(&self, file_name: &str, expected_file_name: &str) {
        let expected_path = self.test_dir.join(expected_file_name);
        assert!(
            expected_path.exists(),
            "expected file `{}` does not exist in test `{}` ({})",
            expected_file_name,
            self.test_description,
            self.test_dir.display()
        );
        let actual_path = self.test_dir.join(file_name);
        assert!(
            actual_path.exists(),
            "expected output file `{}` does not exist in test `{}` ({})",
            file_name,
            self.test_description,
            self.test_dir.display()
        );
        let actual = std::fs::read_to_string(actual_path).unwrap();
        let expected = std::fs::read_to_string(&expected_path).unwrap();
        assert_eq!(
            actual,
            expected,
            "file comparions failed in test `{}` ({}) for `{}`",
            self.test_description,
            self.test_dir.display(),
            expected_path.display()
        );
    }

    #[inline]
    pub fn assert_path_exists(&self, path_name: &str, exists: bool) {
        let p = self.test_dir.join(path_name);
        // The file may not be immediately deleted, so we wait a bit if asserting false
        // (can try turning this on if tests fail)
        // if !exists {
        //     for _ in 0..10 {
        //         if !p.exists() {
        //             break;
        //         }
        //         thread::sleep(Duration::from_millis(500));
        //     }
        // }
        assert_eq!(
            p.exists(),
            exists,
            "file existence test failed in test `{}` ({}) for `{path_name}`",
            self.test_description,
            self.test_dir.display()
        );
    }

    pub fn get_modification_time(&self, path_name: &str) -> std::io::Result<std::time::SystemTime> {
        let p = self.test_dir.join(path_name);
        std::fs::metadata(p)?.modified()
    }
}

macro_rules! testit {
    ($test_name:ident, $fnonce:expr) => {
        #[test]
        #[allow(non_snake_case)]
        fn $test_name() {
            let mut env = ItEnv::new(&stringify!($test_name).replace("__", "/"));
            env.execute($fnonce);
        }
    };
}

pub(crate) use testit;