kimun 0.20.0

Code metrics tool — health score, complexity, duplication, hotspots, ownership
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

use super::*;
use crate::walk::{ExcludeFilter, WalkConfig};
use std::fs;

#[test]
fn run_on_empty_dir() {
    let dir = tempfile::tempdir().unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    run(&cfg, false, 20, 6).unwrap();
}

#[test]
fn run_on_empty_dir_json() {
    let dir = tempfile::tempdir().unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    run(&cfg, true, 20, 6).unwrap();
}

#[test]
fn run_on_rust_file() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(
        dir.path().join("main.rs"),
        "fn main() {\n    let x = 1;\n    let y = x + 2;\n    println!(\"{}\", y);\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    run(&cfg, false, 20, 6).unwrap();
}

#[test]
fn run_json_output() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(
        dir.path().join("main.rs"),
        "fn main() {\n    let x = 1;\n    let y = x + 2;\n    println!(\"{}\", y);\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    run(&cfg, true, 20, 6).unwrap();
}

#[test]
fn run_skips_binary() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(dir.path().join("data.c"), b"hello\x00world").unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    run(&cfg, false, 20, 6).unwrap();
}

// --- Tests that verify actual report structure ---

#[test]
fn build_report_empty_dir() {
    let dir = tempfile::tempdir().unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();
    assert!(report.loc.is_empty());
    assert_eq!(report.duplication.total_code_lines, 0);
    assert_eq!(report.indent.total_count, 0);
    assert!(report.indent.entries.is_empty());
}

#[test]
fn build_report_counts_loc() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(
        dir.path().join("main.rs"),
        "// comment\nfn main() {\n    let x = 1;\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    assert_eq!(report.loc.len(), 1);
    assert_eq!(report.loc[0].name, "Rust");
    assert_eq!(report.loc[0].files, 1);
    assert_eq!(report.loc[0].comment, 1);
    assert_eq!(report.loc[0].code, 3);
}

#[test]
fn build_report_dedup_for_loc() {
    let dir = tempfile::tempdir().unwrap();
    let content = "fn foo() {\n    let x = 1;\n}\n";
    fs::write(dir.path().join("a.rs"), content).unwrap();
    fs::write(dir.path().join("b.rs"), content).unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    // Duplicate files deduplicated — consistent with km loc
    assert_eq!(report.loc[0].files, 1);
}

#[test]
fn build_report_detects_duplicates() {
    let dir = tempfile::tempdir().unwrap();
    // Two files with different wrappers but a shared 7-line block inside.
    // Different overall content avoids content-hash deduplication.
    let shared = "    let x = read();\n    let y = transform(x);\n    write(y);\n    log(\"done\");\n    cleanup();\n    validate();\n    finish();\n";
    let code_a = format!("fn process_a() {{\n{}}}\n", shared);
    let code_b = format!("fn process_b() {{\n{}}}\n", shared);
    fs::write(dir.path().join("a.rs"), &code_a).unwrap();
    fs::write(dir.path().join("b.rs"), &code_b).unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    // Shared block detected across both files
    assert_eq!(report.duplication.duplicate_groups, 1);
    assert!(report.duplication.duplicated_lines >= 7);
    assert_eq!(report.duplication.total_code_lines, 18);
    assert_eq!(report.duplication.files_with_duplicates, 2);
    assert!(report.duplication.largest_block >= 7);
}

#[test]
fn build_report_top_truncates() {
    let dir = tempfile::tempdir().unwrap();
    // Create 3 files with different content so all produce indent results
    fs::write(dir.path().join("a.rs"), "fn a() {\n    let x = 1;\n}\n").unwrap();
    fs::write(
        dir.path().join("b.rs"),
        "fn b() {\n    let x = 1;\n    let y = 2;\n}\n",
    )
    .unwrap();
    fs::write(
        dir.path().join("c.rs"),
        "fn c() {\n    let x = 1;\n    let y = 2;\n    let z = 3;\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 2, 6).unwrap();

    // 3 files analyzed, but only top 2 shown
    assert_eq!(report.indent.total_count, 3);
    assert_eq!(report.indent.entries.len(), 2);
}

#[test]
fn build_report_full_shows_all() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(dir.path().join("a.rs"), "fn a() {\n    let x = 1;\n}\n").unwrap();
    fs::write(
        dir.path().join("b.rs"),
        "fn b() {\n    let x = 1;\n    let y = 2;\n}\n",
    )
    .unwrap();
    fs::write(
        dir.path().join("c.rs"),
        "fn c() {\n    let x = 1;\n    let y = 2;\n    let z = 3;\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, usize::MAX, 6).unwrap();

    // all 3 files shown when top is usize::MAX (--full mode)
    assert_eq!(report.indent.total_count, 3);
    assert_eq!(report.indent.entries.len(), 3);
}

#[test]
fn build_report_excludes_tests() {
    let dir = tempfile::tempdir().unwrap();
    fs::create_dir(dir.path().join("tests")).unwrap();
    fs::write(
        dir.path().join("tests/integration.rs"),
        "fn test() {\n    assert!(true);\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    // Test file in tests/ dir should be excluded
    assert!(report.loc.is_empty());
}

#[test]
fn build_report_includes_tests_with_flag() {
    let dir = tempfile::tempdir().unwrap();
    fs::create_dir(dir.path().join("tests")).unwrap();
    fs::write(
        dir.path().join("tests/integration.rs"),
        "fn test() {\n    assert!(true);\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), true, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    assert!(!report.loc.is_empty());
}

#[test]
fn build_report_mi_computed() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(
        dir.path().join("main.rs"),
        "fn main() {\n    let x = 1;\n    let y = x + 2;\n    println!(\"{}\", y);\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    assert_eq!(report.mi_visual_studio.entries.len(), 1);
    assert_eq!(report.mi_verifysoft.entries.len(), 1);

    let vs = &report.mi_visual_studio.entries[0];
    // VS MI ~71.07 for this simple function — green level
    assert!((vs.mi_score - 71.07).abs() < 1.0);
    assert_eq!(vs.level, "green");

    let vf = &report.mi_verifysoft.entries[0];
    // Verifysoft MI ~121.54 — good level (no comments, so MIcw is zero)
    assert!((vf.mi_score - 121.54).abs() < 1.0);
    assert_eq!(vf.level, "good");
}

#[test]
fn build_report_json_structure() {
    let dir = tempfile::tempdir().unwrap();
    fs::write(
        dir.path().join("main.rs"),
        "// comment\nfn main() {\n    let x = 1;\n}\n",
    )
    .unwrap();
    let filter = ExcludeFilter::default();
    let cfg = WalkConfig::new(dir.path(), false, &filter);
    let report = build_report(&cfg, 20, 6).unwrap();

    // Serialize to JSON and parse back to verify structure
    let json_str = serde_json::to_string(&report).unwrap();
    let value: serde_json::Value = serde_json::from_str(&json_str).unwrap();

    assert!(value["path"].is_string());
    assert_eq!(value["top"], 20);
    assert_eq!(value["include_tests"], false);
    assert_eq!(value["min_lines"], 6);
    assert!(value["loc"].is_array());
    assert!(value["duplication"]["total_code_lines"].is_number());
    assert!(value["indent"]["total_count"].is_number());
    assert!(value["indent"]["entries"].is_array());
    assert!(value["halstead"]["total_count"].is_number());
    assert!(value["cyclomatic"]["total_count"].is_number());
    assert!(value["mi_visual_studio"]["total_count"].is_number());
    assert!(value["mi_verifysoft"]["total_count"].is_number());
}

#[test]
fn build_report_min_lines_affects_dups() {
    let dir = tempfile::tempdir().unwrap();
    // Two files with different wrappers but shared 5-line block
    let shared = "    let a = 1;\n    let b = 2;\n    let c = 3;\n    let d = 4;\n    let e = 5;\n";
    let code_a = format!("fn fa() {{\n{}}}\n", shared);
    let code_b = format!("fn fb() {{\n{}}}\n", shared);
    fs::write(dir.path().join("a.rs"), &code_a).unwrap();
    fs::write(dir.path().join("b.rs"), &code_b).unwrap();

    // min_lines=3: block of 5 lines >= 3, so duplicates detected
    let filter = ExcludeFilter::default();
    let cfg_low = WalkConfig::new(dir.path(), false, &filter);
    let report_low = build_report(&cfg_low, 20, 3).unwrap();
    assert!(report_low.duplication.duplicate_groups > 0);

    // min_lines=100: block of 5 lines < 100, so no duplicates detected
    let cfg_high = WalkConfig::new(dir.path(), false, &filter);
    let report_high = build_report(&cfg_high, 20, 100).unwrap();
    assert_eq!(report_high.duplication.duplicate_groups, 0);
}