riptree2 0.9.0

riptree2 is a Rust rewrite of the Unix tree command. It aims to be a drop in replacement (`alias tree="rt --compat"`) with some quality of life improvements, such as automatically respecting ignore 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

use std::{
    fs::File,
    io::BufReader,
    path::{Path, PathBuf},
    process::Command,
};

use assert_cmd::cargo::CommandCargoExt;
use fixtures::fixtures;
use serde::Deserialize;
use test_utils::TestWorkingDir;

#[derive(Deserialize)]
struct TestDescription {
    description: String,
    args: Vec<String>,
    current_directory: Option<String>,
    assert_file_contents: Option<Vec<String>>,
}

#[fixtures(["tests/fixtures/conformance/*", "!*.skip"])]
fn test(test_dir: &Path) {
    let test_description: TestDescription = {
        let path = test_dir.join("test.json");
        let file = File::open(path).unwrap();
        let reader = BufReader::new(file);
        serde_json::from_reader(reader).unwrap()
    };

    eprintln!("[TEST DESCRIPTION]\n{}\n\n", test_description.description);

    let test_working_dir = TestWorkingDir::new(test_dir);
    let command_current_directory = match test_description.current_directory {
        Some(current_directory) => test_working_dir.as_ref().join(current_directory),
        None => test_working_dir.as_ref().to_path_buf(),
    };

    let reference_binary = std::env::var_os("TREE_REFERENCE_BIN").unwrap_or("tree".into());
    let reference_output = Command::new(reference_binary)
        .current_dir(&command_current_directory)
        .args(&test_description.args)
        .output()
        .unwrap();
    let reference_code = reference_output.status.code().unwrap();
    let reference_stdout = String::from_utf8(reference_output.stdout).unwrap();
    let reference_stderr = String::from_utf8(reference_output.stderr).unwrap();

    struct FileContentAssertion {
        file: String,
        reference_content: String,
        sut_snapshot_path: PathBuf,
    }

    let file_content_assertions = if let Some(files) = test_description.assert_file_contents {
        Some(
            files
                .into_iter()
                .map(|file| {
                    let path = test_working_dir.as_ref().join(&file);
                    let reference_content = match std::fs::read_to_string(&path) {
                        Ok(content) => format!("{file}:\n\n{content}"),
                        Err(err) => format!("{file}:\n\n{err}"),
                    };
                    if path.exists() {
                        std::fs::remove_file(&path).unwrap();
                    }
                    let sanitised_file_name = file.replace("/", "__");
                    let reference_snapshot_path =
                        test_dir.join(format!("file.{sanitised_file_name}.reference.snap"));
                    std::fs::write(reference_snapshot_path, &reference_content).unwrap();
                    FileContentAssertion {
                        file,
                        reference_content,
                        sut_snapshot_path: test_dir
                            .join(format!("file.{sanitised_file_name}.sut.snap")),
                    }
                })
                .collect::<Vec<_>>(),
        )
    } else {
        None
    };

    let code_reference_snapshot_path = test_dir.join("code.reference.snap");
    let stdout_reference_snapshot_path = test_dir.join("stdout.reference.snap");
    let stderr_reference_snapshot_path = test_dir.join("stderr.reference.snap");

    std::fs::write(code_reference_snapshot_path, format!("{reference_code}")).unwrap();
    std::fs::write(
        stdout_reference_snapshot_path,
        format!("{reference_stdout}"),
    )
    .unwrap();
    std::fs::write(
        stderr_reference_snapshot_path,
        format!("{reference_stderr}"),
    )
    .unwrap();

    let sut_output = Command::cargo_bin("rt")
        .unwrap()
        .current_dir(&command_current_directory)
        .arg("--compat")
        .args(&test_description.args)
        .output()
        .unwrap();
    let sut_code = sut_output.status.code().unwrap();
    let sut_stdout = String::from_utf8(sut_output.stdout).unwrap();
    let sut_stderr = String::from_utf8(sut_output.stderr).unwrap();

    let code_sut_snapshot_path = test_dir.join("code.sut.snap");
    let stdout_sut_snapshot_path = test_dir.join("stdout.sut.snap");
    let stderr_sut_snapshot_path = test_dir.join("stderr.sut.snap");

    std::fs::write(code_sut_snapshot_path, sut_code.to_string()).unwrap();
    std::fs::write(stdout_sut_snapshot_path, &sut_stdout).unwrap();
    std::fs::write(stderr_sut_snapshot_path, &sut_stderr).unwrap();

    pretty_assertions::assert_eq!(reference_code, sut_code);
    pretty_assertions::assert_eq!(reference_stdout, sut_stdout);
    pretty_assertions::assert_eq!(reference_stderr, sut_stderr);

    if let Some(file_content_assertions) = file_content_assertions {
        for FileContentAssertion {
            file,
            reference_content,
            sut_snapshot_path,
        } in file_content_assertions
        {
            let path = test_working_dir.as_ref().join(&file);
            let sut_content = match std::fs::read_to_string(path) {
                Ok(content) => format!("{file}:\n\n{content}"),
                Err(err) => format!("{file}:\n\n{err}"),
            };
            std::fs::write(sut_snapshot_path, &sut_content).unwrap();
            pretty_assertions::assert_eq!(reference_content, sut_content);
        }
    }
}

#[fixtures(["tests/fixtures/conformance/*.skip"])]
#[ignore]
fn skipped_test(_: &Path) {}