codewalk 0.2.4

Walk code trees with binary detection, bounded reads, and scanner-oriented filtering
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

#![allow(clippy::unwrap_used, clippy::expect_used)]

use std::fs::{self, File};
use std::io::Write;
use std::os::unix::fs::symlink;
use std::path::{Path, PathBuf};
use tempfile::TempDir;

use codewalk::{CodeWalker, WalkConfig};

fn setup_test_dir() -> TempDir {
    tempfile::tempdir().expect("failed to create temp dir")
}

fn create_file<P: AsRef<Path>>(path: P, content: &[u8]) {
    let mut f = File::create(path).expect("failed to create file");
    f.write_all(content).expect("failed to write file");
}

fn create_dir<P: AsRef<Path>>(path: P) {
    fs::create_dir_all(path).expect("failed to create dir");
}

fn walk_paths(walker: CodeWalker) -> Vec<PathBuf> {
    let mut paths = Vec::new();
    for result in walker.walk_iter() {
        if let Ok(entry) = result {
            paths.push(entry.path);
        }
    }
    paths.sort();
    paths
}

#[test]
fn test_01_symlink_outside_root() {
    let td = setup_test_dir();
    let root = td.path().join("root");
    let outside = td.path().join("outside");
    create_dir(&root);
    create_dir(&outside);
    create_file(outside.join("secret.txt"), b"secret");

    // Create symlink pointing outside
    symlink(&outside, root.join("link_to_outside")).unwrap();

    let config = WalkConfig {
        follow_symlinks: true,
        ..WalkConfig::default()
    };
    let walker = CodeWalker::new(&root, config);
    let paths = walk_paths(walker);

    // It should not traverse outside the root.
    // It might list the symlink itself if walkdir includes it, or skip it,
    // but definitely NOT `secret.txt`.
    assert!(!paths.iter().any(|p| p.ends_with("secret.txt")));
}

#[test]
fn test_02_symlink_loop() {
    let td = setup_test_dir();
    let root = td.path();
    let dir_a = root.join("a");
    let dir_b = root.join("b");
    create_dir(&dir_a);
    create_dir(&dir_b);

    symlink(&dir_b, dir_a.join("link_to_b")).unwrap();
    symlink(&dir_a, dir_b.join("link_to_a")).unwrap();

    let config = WalkConfig {
        follow_symlinks: true,
        ..WalkConfig::default()
    };
    let walker = CodeWalker::new(root, config);
    // Should complete without infinite loop
    let _paths = walk_paths(walker);
}

#[test]
fn test_03_symlink_chain_depth() {
    let td = setup_test_dir();
    let root = td.path();

    let mut last_target = root.join("target.txt");
    create_file(&last_target, b"end of chain");

    // Create a chain of 20 symlinks
    for i in 0..20 {
        let link = root.join(format!("link_{}", i));
        symlink(&last_target, &link).unwrap();
        last_target = link;
    }

    let config = WalkConfig {
        follow_symlinks: true,
        ..WalkConfig::default()
    };
    let walker = CodeWalker::new(root, config);
    // Walk shouldn't hang or crash. The walker should reject deep chains.
    let _paths = walk_paths(walker);
}

#[test]
fn test_04_directory_with_100k_files() {
    let td = setup_test_dir();
    let root = td.path();

    // Instead of actually creating 100K files which might slow down test suite,
    // we'll do 10K. It still tests memory/OOM resilience for a large directory.
    let target = 10_000;
    for i in 0..target {
        create_file(root.join(format!("file_{}.txt", i)), b"test");
    }

    let walker = CodeWalker::new(root, WalkConfig::default());
    let paths = walk_paths(walker);
    // Just checking it completes and collects all files
    assert_eq!(paths.len(), target);
}

#[test]
fn test_05_file_named_env() {
    let td = setup_test_dir();
    let root = td.path();
    create_file(root.join(".env"), b"SECRET=123");

    let walker = CodeWalker::new(root, WalkConfig::default().skip_hidden(false));
    let paths = walk_paths(walker);

    assert!(paths.iter().any(|p| p.ends_with(".env")));
}

#[test]
fn test_06_node_modules_excluded() {
    let td = setup_test_dir();
    let root = td.path();
    let nm = root.join("node_modules");
    create_dir(&nm);
    create_file(nm.join("index.js"), b"console.log('hi');");
    create_file(root.join("main.js"), b"console.log('main');");

    let walker = CodeWalker::new(root, WalkConfig::default());
    let paths = walk_paths(walker);

    assert!(
        !paths
            .iter()
            .any(|p| p.to_string_lossy().contains("node_modules"))
    );
    assert!(paths.iter().any(|p| p.ends_with("main.js")));
}

#[test]
fn test_07_git_excluded() {
    let td = setup_test_dir();
    let root = td.path();
    let git = root.join(".git");
    create_dir(&git);
    create_file(git.join("config"), b"[core]");
    create_file(root.join("main.rs"), b"fn main() {}");

    let walker = CodeWalker::new(root, WalkConfig::default());
    let paths = walk_paths(walker);

    assert!(!paths.iter().any(|p| p.to_string_lossy().contains(".git")));
    assert!(paths.iter().any(|p| p.ends_with("main.rs")));
}

#[test]
fn test_08_target_excluded() {
    let td = setup_test_dir();
    let root = td.path();
    let target = root.join("target");
    create_dir(&target);
    create_file(target.join("debug.log"), b"log");
    create_file(root.join("main.rs"), b"fn main() {}");

    let walker = CodeWalker::new(root, WalkConfig::default());
    let paths = walk_paths(walker);

    assert!(!paths.iter().any(|p| p.to_string_lossy().contains("target")));
    assert!(paths.iter().any(|p| p.ends_with("main.rs")));
}

#[test]
fn test_09_binary_file_skip_true() {
    let td = setup_test_dir();
    let root = td.path();
    // ELF magic bytes
    let elf_magic = b"\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00";
    create_file(root.join("prog.bin"), elf_magic);
    create_file(root.join("text.txt"), b"hello");

    let config = WalkConfig {
        skip_binary: true,
        ..WalkConfig::default()
    };
    let walker = CodeWalker::new(root, config);
    let paths = walk_paths(walker);

    assert!(!paths.iter().any(|p| p.ends_with("prog.bin")));
    assert!(paths.iter().any(|p| p.ends_with("text.txt")));
}

#[test]
fn test_10_binary_file_skip_false() {
    let td = setup_test_dir();
    let root = td.path();
    let elf_magic = b"\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00";
    create_file(root.join("prog.bin"), elf_magic);
    create_file(root.join("text.txt"), b"hello");

    let config = WalkConfig {
        skip_binary: false,
        ..WalkConfig::default()
    };
    let walker = CodeWalker::new(root, config);
    let paths = walk_paths(walker);

    assert!(paths.iter().any(|p| p.ends_with("prog.bin")));
    assert!(paths.iter().any(|p| p.ends_with("text.txt")));
}