retree 0.6.0

Fast, cross-platform GNU tree compatible directory listing
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318

/// Integration tests for --max-entries flag
mod common;
use common::{retree, CLEAN};

use std::fs;
use tempfile::tempdir;

// ============================================================================
// Truncation occurs when entries exceed the limit
// ============================================================================

#[test]
fn test_max_entries_truncates_output() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    // 15 files — well above limit of 5
    for i in 0..15 {
        fs::write(p.join(format!("file_{:02}.txt", i)), "").unwrap();
    }

    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "5"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        stderr.contains("output truncated at 5 entries (--max-entries)"),
        "Expected truncation message in stderr, got: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    let names = common::extract_names(&stdout);
    assert!(
        names.len() <= 5,
        "Expected at most 5 entries, got {}: {names:?}",
        names.len()
    );
}

// ============================================================================
// No truncation when entries fit within the limit
// ============================================================================

#[test]
fn test_max_entries_no_truncation_within_limit() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    fs::write(p.join("a.txt"), "").unwrap();
    fs::write(p.join("b.txt"), "").unwrap();
    fs::write(p.join("c.txt"), "").unwrap();

    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "10"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        !stderr.contains("truncated"),
        "Should NOT truncate when within limit, stderr: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    assert!(stdout.contains("a.txt"));
    assert!(stdout.contains("b.txt"));
    assert!(stdout.contains("c.txt"));
}

// ============================================================================
// Edge case: --max-entries 1
// ============================================================================

#[test]
fn test_max_entries_one() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    for i in 0..10 {
        fs::write(p.join(format!("file_{}.txt", i)), "").unwrap();
    }

    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "1"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        stderr.contains("output truncated at 1 entries (--max-entries)"),
        "Expected truncation message, got: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    let names = common::extract_names(&stdout);
    assert!(
        names.len() <= 1,
        "Expected at most 1 entry, got {}: {names:?}",
        names.len()
    );
}

// ============================================================================
// Truncation with nested subdirectories (dirs + files count toward limit)
// ============================================================================

#[test]
fn test_max_entries_with_subdirectories() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    // 6 entries total: dir_a, dir_a/f1, dir_a/f2, dir_b, dir_b/f3, root.txt
    fs::create_dir(p.join("dir_a")).unwrap();
    fs::create_dir(p.join("dir_b")).unwrap();
    fs::write(p.join("dir_a/f1.txt"), "").unwrap();
    fs::write(p.join("dir_a/f2.txt"), "").unwrap();
    fs::write(p.join("dir_b/f3.txt"), "").unwrap();
    fs::write(p.join("root.txt"), "").unwrap();

    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "3"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        stderr.contains("output truncated at 3 entries (--max-entries)"),
        "Expected truncation message, got: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    let names = common::extract_names(&stdout);
    assert!(
        names.len() <= 3,
        "Expected at most 3 entries, got {}: {names:?}",
        names.len()
    );
}

// ============================================================================
// Truncation does NOT cause non-zero exit code
// ============================================================================

#[test]
fn test_max_entries_exit_code_zero() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    for i in 0..5 {
        fs::write(p.join(format!("f{}.txt", i)), "").unwrap();
    }

    retree()
        .args(CLEAN)
        .args(["--max-entries", "2"])
        .arg(p)
        .assert()
        .success();
}

// ============================================================================
// Without --max-entries all entries are shown, no truncation message
// ============================================================================

#[test]
fn test_without_max_entries_shows_all() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    for i in 0..5 {
        fs::write(p.join(format!("item_{}.txt", i)), "").unwrap();
    }

    let output = retree().args(CLEAN).arg(p).assert().success();

    let stderr = common::output_stderr(&output);
    assert!(
        !stderr.contains("truncated"),
        "Without --max-entries there should be no truncation, stderr: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    for i in 0..5 {
        let name = format!("item_{}.txt", i);
        assert!(stdout.contains(&name), "{name} missing from output");
    }
}

// ============================================================================
// Exact boundary: entries == limit → no truncation
// ============================================================================

#[test]
fn test_max_entries_exact_boundary_no_truncation() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    // Exactly 3 entries in a flat directory
    fs::write(p.join("one.txt"), "").unwrap();
    fs::write(p.join("two.txt"), "").unwrap();
    fs::write(p.join("three.txt"), "").unwrap();

    // Limit set above entry count — no truncation
    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "4"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        !stderr.contains("truncated"),
        "When entries < limit, no truncation expected, stderr: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    assert!(stdout.contains("one.txt"));
    assert!(stdout.contains("two.txt"));
    assert!(stdout.contains("three.txt"));
}

#[test]
fn test_max_entries_at_exact_count_no_truncation() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    fs::write(p.join("one.txt"), "").unwrap();
    fs::write(p.join("two.txt"), "").unwrap();
    fs::write(p.join("three.txt"), "").unwrap();

    // Limit == entry count → all entries shown, nothing truncated
    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "3"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        !stderr.contains("truncated"),
        "When entries == limit, no truncation expected, stderr: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    assert!(stdout.contains("one.txt"));
    assert!(stdout.contains("two.txt"));
    assert!(stdout.contains("three.txt"));
}

// ============================================================================
// --max-entries 0 means unlimited (no truncation)
// ============================================================================

#[test]
fn test_max_entries_zero_means_unlimited() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    fs::write(p.join("a.txt"), "").unwrap();
    fs::write(p.join("b.txt"), "").unwrap();
    fs::write(p.join("c.txt"), "").unwrap();

    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "0"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        !stderr.contains("truncated"),
        "--max-entries 0 should mean unlimited, stderr: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    assert!(stdout.contains("a.txt"), "a.txt missing");
    assert!(stdout.contains("b.txt"), "b.txt missing");
    assert!(stdout.contains("c.txt"), "c.txt missing");
}

#[test]
fn test_max_entries_zero_means_unlimited_streaming() {
    let dir = tempdir().unwrap();
    let p = dir.path();

    fs::write(p.join("x.txt"), "").unwrap();
    fs::write(p.join("y.txt"), "").unwrap();

    let output = retree()
        .args(CLEAN)
        .args(["--max-entries", "0", "--streaming"])
        .arg(p)
        .assert()
        .success();

    let stderr = common::output_stderr(&output);
    assert!(
        !stderr.contains("truncated"),
        "--max-entries 0 --streaming should mean unlimited, stderr: {stderr}"
    );

    let stdout = common::output_stdout(&output);
    assert!(stdout.contains("x.txt"), "x.txt missing");
    assert!(stdout.contains("y.txt"), "y.txt missing");
}