slopguard-core 0.1.20

Core analysis engine for slopguard
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use std::fs::{create_dir, write};

use tempfile::tempdir;

use super::*;

#[test]
fn rule_activation_precedence() {
    let opt_in = parse_rule(
        r#"
id: opt-in
language: rust
severity: warning
category: slop
enabled: false
message: "Opt-in"
rule:
  pattern: $X.unwrap()
"#,
    )
    .unwrap();
    let mut config = crate::config::Config::default();

    assert!(!is_rule_active(&opt_in, &config), "enabled: false is off");

    config.rules.enable.push("opt-in".to_string());
    assert!(is_rule_active(&opt_in, &config), "enable list turns it on");

    config.rules.disable.push("opt-in".to_string());
    assert!(is_rule_active(&opt_in, &config), "enable wins over disable");

    config.rulesets.slop = false;
    assert!(is_rule_active(&opt_in, &config), "enable wins over ruleset");

    config.rules.enable.clear();
    config.rules.disable.clear();
    config.rulesets.slop = true;
    let mut default_on = opt_in.clone();
    default_on.enabled = true;
    assert!(is_rule_active(&default_on, &config));

    config.rules.disable.push("opt-in".to_string());
    assert!(!is_rule_active(&default_on, &config), "disable list");

    config.rules.disable.clear();
    config.rulesets.slop = false;
    assert!(!is_rule_active(&default_on, &config), "ruleset off");
}

#[test]
fn load_all_builtin_rules() {
    let rules = load_builtin_rules().unwrap();
    assert_eq!(
        rules.len(),
        97,
        "expected 97 builtin rules, got {}",
        rules.len()
    );

    let slop_count = rules
        .iter()
        .filter(|r| r.category == Some(Category::Slop))
        .count();
    let security_count = rules
        .iter()
        .filter(|r| r.category == Some(Category::Security))
        .count();
    let correctness_count = rules
        .iter()
        .filter(|r| r.category == Some(Category::Correctness))
        .count();
    assert_eq!(slop_count, 37, "expected 37 slop rules");
    assert_eq!(security_count, 22, "expected 22 security rules");
    assert_eq!(correctness_count, 38, "expected 38 correctness rules");

    assert!(rules
        .iter()
        .any(|r| r.id == RuleId::from("no-unwrap-in-prod")));
    assert!(rules
        .iter()
        .any(|r| r.id == RuleId::from("no-debug-on-secrets")));
    assert!(rules.iter().any(|r| r.id == RuleId::from("no-slop-words")));
    assert!(
        rules
            .iter()
            .any(|r| r.id == RuleId::from("max-file-lines") && r.is_metric()),
        "max-file-lines should be loaded as a metric rule"
    );
    assert!(
        rules
            .iter()
            .any(|r| r.id == RuleId::from("no-single-impl-trait") && r.is_cross_file()),
        "no-single-impl-trait should be loaded as a cross-file rule"
    );

    validate_unique_ids(&rules).unwrap();
}

#[test]
fn load_custom_rules_from_dir() {
    let dir = tempdir().unwrap();
    let rule_yaml = r#"
id: custom-rule
language: rust
severity: warning
message: "Custom rule"
rule:
  pattern: $X.clone()
"#;
    write(dir.path().join("custom.yml"), rule_yaml).unwrap();

    let rules = load_custom_rules(&[dir.path().to_path_buf()]).unwrap();
    assert_eq!(rules.len(), 1);
    assert_eq!(rules[0].id, RuleId::from("custom-rule"));
}

#[test]
fn reject_duplicate_ids_same_language() {
    let rule1 = parse_rule(
        r#"
id: same-id
language: rust
severity: error
message: "First"
rule:
  pattern: $X
"#,
    )
    .unwrap();
    let rule2 = parse_rule(
        r#"
id: same-id
language: rust
severity: warning
message: "Second"
rule:
  pattern: $Y
"#,
    )
    .unwrap();
    let err = validate_unique_ids(&[rule1, rule2]).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("duplicate rule id"),
        "expected duplicate id error, got: {msg}"
    );
    assert!(
        msg.contains("same-id"),
        "expected same-id in error, got: {msg}"
    );
}

#[test]
fn allow_same_id_different_language() {
    let rust_rule = parse_rule(
        r#"
id: shared-rule
language: rust
severity: error
message: "Rust variant"
rule:
  pattern: $X
"#,
    )
    .unwrap();
    let ts_rule = parse_rule(
        r#"
id: shared-rule
language: typescript
severity: error
message: "TypeScript variant"
rule:
  pattern: $X
"#,
    )
    .unwrap();
    validate_unique_ids(&[rust_rule, ts_rule]).unwrap();
}

#[test]
fn all_builtin_rules_valid_messages() {
    for path in BuiltinRules::iter() {
        if !is_rule_file(Path::new(path.as_ref())) {
            continue;
        }
        let file = BuiltinRules::get(&path).unwrap();
        let yaml = from_utf8(&file.data).unwrap();
        let rule: Rule = serde_yaml::from_str(yaml).unwrap();
        assert!(
            !rule.message.contains('\u{2014}'),
            "rule '{}' message contains em dash: {}",
            rule.id,
            rule.message
        );
        assert!(
            !rule.message.contains('\u{2013}'),
            "rule '{}' message contains en dash: {}",
            rule.id,
            rule.message
        );
        assert!(
            rule.message.is_ascii() || rule.message.chars().all(|c| c.is_ascii() || c == '\''),
            "rule '{}' message contains non-ASCII characters: {}",
            rule.id,
            rule.message
        );
    }
}

#[test]
fn all_builtin_rules_have_tests() {
    for path in BuiltinRules::iter() {
        if !is_rule_file(Path::new(path.as_ref())) {
            continue;
        }
        let file = BuiltinRules::get(&path).unwrap();
        let yaml = from_utf8(&file.data).unwrap();
        let rule: Rule = serde_yaml::from_str(yaml).unwrap();
        // A cross-file rule needs a whole project to mean anything, so no
        // snippet can exercise it.
        if rule.cross_file.is_some() {
            continue;
        }
        let tests = rule
            .tests
            .as_ref()
            .unwrap_or_else(|| panic!("rule '{}' (at {path}) is missing `tests` block", rule.id));
        if rule.is_metric() {
            // Two near-identical whole-file fixtures add no coverage, so a
            // metric rule only needs one case per direction.
            assert!(
                tests.should_match.len() + tests.should_match_files.len() >= 1,
                "metric rule '{}' (at {path}) needs >= 1 should_match case",
                rule.id
            );
            assert!(
                tests.should_not_match.len() + tests.should_not_match_files.len() >= 1,
                "metric rule '{}' (at {path}) needs >= 1 should_not_match case",
                rule.id
            );
            continue;
        }
        assert!(
            tests.should_match.len() >= 2,
            "rule '{}' (at {path}) needs >= 2 should_match, got {}",
            rule.id,
            tests.should_match.len()
        );
        assert!(
            tests.should_not_match.len() >= 2,
            "rule '{}' (at {path}) needs >= 2 should_not_match, got {}",
            rule.id,
            tests.should_not_match.len()
        );
    }
}

#[test]
fn all_builtin_rules_have_explicit_category() {
    for path in BuiltinRules::iter() {
        if !is_rule_file(Path::new(path.as_ref())) {
            continue;
        }
        let file = BuiltinRules::get(&path).unwrap();
        let yaml = from_utf8(&file.data).unwrap();
        let rule: Rule = serde_yaml::from_str(yaml).unwrap();
        assert!(
            rule.category.is_some(),
            "rule '{}' (at {path}) is missing an explicit `category` field",
            rule.id
        );
    }
}

fn fixture_metric_rule() -> Rule {
    parse_rule(
        r#"
id: fixture-reader
language: rust
severity: warning
category: slop
metric: file_lines
threshold: 500
message: "m"
"#,
    )
    .unwrap()
}

#[test]
fn read_fixture_rejects_parent_dir() {
    let rule = fixture_metric_rule();
    let err = read_fixture(&rule, "../secrets.rs").unwrap_err();
    assert!(
        matches!(err, RuleError::InvalidFixturePath { .. }),
        "{err:?}"
    );
}

#[test]
fn read_fixture_rejects_absolute_path() {
    let rule = fixture_metric_rule();
    let err = read_fixture(&rule, "/etc/passwd").unwrap_err();
    assert!(
        matches!(err, RuleError::InvalidFixturePath { .. }),
        "{err:?}"
    );
}

#[test]
fn read_fixture_from_custom_dir() {
    let dir = tempdir().unwrap();
    let fixtures = dir.path().join("fixtures");
    create_dir(&fixtures).unwrap();
    write(
        fixtures.join("big.rs"),
        "fn a() {}
fn b() {}
",
    )
    .unwrap();
    write(
        dir.path().join("metric.yml"),
        r#"
id: custom-metric
language: rust
severity: warning
category: slop
metric: file_lines
threshold: 1
message: "m"
tests:
  should_match_files:
    - "fixtures/big.rs"
"#,
    )
    .unwrap();

    let rules = load_custom_rules(&[dir.path().to_path_buf()]).unwrap();
    assert_eq!(rules.len(), 1);
    assert_eq!(rules[0].source_dir.as_deref(), Some(dir.path()));
    let content = read_fixture(&rules[0], "fixtures/big.rs").unwrap();
    assert_eq!(
        content,
        "fn a() {}
fn b() {}
"
    );
}

#[test]
fn read_fixture_missing_in_custom_dir() {
    let dir = tempdir().unwrap();
    write(
        dir.path().join("metric.yml"),
        r#"
id: custom-metric-missing
language: rust
severity: warning
category: slop
metric: file_lines
threshold: 1
message: "m"
"#,
    )
    .unwrap();
    let rules = load_custom_rules(&[dir.path().to_path_buf()]).unwrap();
    let err = read_fixture(&rules[0], "fixtures/nope.rs").unwrap_err();
    assert!(matches!(err, RuleError::FixtureNotFound { .. }), "{err:?}");
}

#[test]
fn read_builtin_fixture() {
    let rules = load_builtin_rules().unwrap();
    let rule = rules
        .iter()
        .find(|r| r.id == RuleId::from("max-file-lines"))
        .expect("max-file-lines should be a builtin rule");
    let content = read_fixture(rule, "fixtures/metrics/rust_large.rs").unwrap();
    assert!(
        content.lines().count() > 500,
        "the large fixture should exceed 500 lines, got {}",
        content.lines().count()
    );
}

#[test]
fn custom_rules_category_from_subdir() {
    let dir = tempdir().unwrap();
    let security_dir = dir.path().join("security");
    create_dir(&security_dir).unwrap();
    let rule_yaml = r#"
id: custom-sec
language: rust
severity: error
message: "Custom security"
rule:
  pattern: $X
"#;
    write(security_dir.join("rule.yml"), rule_yaml).unwrap();

    let rules = load_custom_rules(&[dir.path().to_path_buf()]).unwrap();
    assert_eq!(rules.len(), 1);
    assert_eq!(rules[0].category, Some(Category::Security));
}