slopguard-core 0.1.24

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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
use super::*;

#[test]
fn parse_valid_rule_all_fields() {
    let yaml = r#"
id: test-rule
language: rust
severity: error
message: "Test message"
note: "Test note"
category: security
fix: "Use X instead"
rule:
  kind: call_expression
  regex: '\.unwrap\(\)\s*$'
files:
  - "**/src/**/*.rs"
ignores:
  - "**/tests/**"
skip_test_code: true
tests:
  should_match:
    - "let x = foo().unwrap();"
  should_not_match:
    - "let x = foo()?;"
"#;
    let rule = parse_rule(yaml).unwrap();
    assert!(rule.skip_test_code);
    assert_eq!(rule.id, RuleId::from("test-rule"));
    assert_eq!(rule.language, Language::Rust);
    assert_eq!(rule.severity, Severity::Error);
    assert_eq!(rule.message, "Test message");
    assert_eq!(rule.note.as_deref(), Some("Test note"));
    assert_eq!(rule.category, Some(Category::Security));
    assert_eq!(rule.fix.as_deref(), Some("Use X instead"));
    assert!(!rule.rule.is_null());
    assert_eq!(rule.files.as_ref().unwrap().len(), 1);
    assert_eq!(rule.ignores.as_ref().unwrap().len(), 1);
    let tests = rule.tests.as_ref().unwrap();
    assert_eq!(tests.should_match.len(), 1);
    assert_eq!(tests.should_not_match.len(), 1);
}

#[test]
fn parse_rewrite_and_autofix_safe_default_false() {
    let yaml = r#"
id: no-rewrite
language: rust
severity: warning
message: "msg"
rule:
  pattern: $X.clone()
"#;
    let rule = parse_rule(yaml).unwrap();
    assert_eq!(rule.rewrite, None);
    assert!(!rule.autofix_safe, "autofix_safe must default to false");
    assert!(!rule.is_autofixable());
}

#[test]
fn parse_rewrite_with_autofix_safe() {
    let yaml = r#"
id: no-unnecessary-clone
language: rust
severity: warning
message: "msg"
fix: "Remove the .clone()."
rewrite: "$R"
autofix_safe: true
rule:
  pattern: $R.clone()
"#;
    let rule = parse_rule(yaml).unwrap();
    assert_eq!(rule.rewrite.as_deref(), Some("$R"));
    assert!(rule.autofix_safe);
    // `fix` (human message) and `rewrite` (pattern) are independent fields.
    assert_eq!(rule.fix.as_deref(), Some("Remove the .clone()."));
    assert!(rule.is_autofixable());
}

#[test]
fn rewrite_without_autofix_safe_is_not_autofixable() {
    let yaml = r#"
id: risky
language: rust
severity: warning
message: "msg"
rewrite: "$R"
rule:
  pattern: $R.clone()
"#;
    let rule = parse_rule(yaml).unwrap();
    assert!(rule.rewrite.is_some());
    assert!(!rule.autofix_safe);
    assert!(
        !rule.is_autofixable(),
        "a rewrite is inert without autofix_safe"
    );
}

#[test]
fn parse_rule_with_ai_check() {
    let yaml = r#"
id: ai-rule
language: rust
severity: warning
category: slop
message: "needs AI confirmation"
rule:
  kind: line_comment
  regex: 'SAFETY'
ai_check:
  prompt: "Is this SAFETY comment meaningful?\n{{code}}"
  model: "claude-haiku-4-5"
"#;
    let rule = parse_rule(yaml).unwrap();
    let ai = rule.ai_check.as_ref().expect("ai_check should be present");
    assert_eq!(ai.prompt, "Is this SAFETY comment meaningful?\n{{code}}");
    assert_eq!(ai.model.as_deref(), Some("claude-haiku-4-5"));
}

#[test]
fn parse_rule_ai_check_without_model() {
    let yaml = r#"
id: ai-rule-no-model
language: rust
severity: warning
category: slop
message: "needs AI confirmation"
rule:
  kind: line_comment
ai_check:
  prompt: "check {{filename}}"
"#;
    let rule = parse_rule(yaml).unwrap();
    let ai = rule.ai_check.as_ref().unwrap();
    assert_eq!(ai.prompt, "check {{filename}}");
    assert!(
        ai.model.is_none(),
        "model falls back to config when omitted"
    );
}

#[test]
fn ai_check_reason_defaults_to_static() {
    // A rule that does not set `reason` classifies with a static note: the
    // default must never escalate to the generative LLM.
    let yaml = r#"
id: ai-rule
language: rust
severity: warning
message: "m"
rule:
  kind: line_comment
ai_check:
  prompt: "check {{code}}"
"#;
    let ai = parse_rule(yaml).unwrap().ai_check.unwrap();
    assert_eq!(ai.reason, ReasonMode::Static);
    assert!(ai.threshold.is_none());
    assert!(ai.if_true.is_none());
    assert!(ai.if_false.is_none());
}

#[test]
fn ai_check_reason_generated_with_threshold_and_criteria() {
    let yaml = r#"
id: ai-rel
language: rust
severity: error
message: "m"
rule:
  kind: call_expression
ai_check:
  prompt: "audit {{code}}"
  reason: generated
  threshold: 0.6
  if_true: "external input reaches the call"
  if_false: "a constant or config value"
"#;
    let ai = parse_rule(yaml).unwrap().ai_check.unwrap();
    assert_eq!(ai.reason, ReasonMode::Generated);
    assert_eq!(ai.threshold, Some(0.6));
    assert_eq!(
        ai.if_true.as_deref(),
        Some("external input reaches the call")
    );
    assert_eq!(ai.if_false.as_deref(), Some("a constant or config value"));
}

#[test]
fn ai_check_unknown_reason_is_an_error() {
    let yaml = r#"
id: ai-bad
language: rust
severity: warning
message: "m"
rule:
  kind: line_comment
ai_check:
  prompt: "p"
  reason: sometimes
"#;
    assert!(
        parse_rule(yaml).is_err(),
        "an unknown reason mode must be rejected, not silently defaulted"
    );
}

#[test]
fn parse_minimal_rule() {
    let yaml = r#"
id: minimal-rule
language: rust
severity: warning
message: "Minimal"
rule:
  pattern: $X.unwrap()
"#;
    let rule = parse_rule(yaml).unwrap();
    assert_eq!(rule.id, RuleId::from("minimal-rule"));
    assert_eq!(rule.severity, Severity::Warning);
    assert!(rule.note.is_none());
    assert!(rule.category.is_none());
    assert!(rule.fix.is_none());
    assert!(rule.files.is_none());
    assert!(rule.ignores.is_none());
    assert!(!rule.skip_test_code);
    assert!(rule.tests.is_none());
    assert!(rule.enabled);
    assert!(rule.ai_check.is_none());
}

#[test]
fn reject_missing_id() {
    let yaml = r#"
language: rust
severity: error
message: "No id"
rule:
  pattern: $X
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("missing field"),
        "expected missing field error, got: {msg}"
    );
}

#[test]
fn reject_unsupported_language() {
    let yaml = r#"
id: bad-lang
language: python
severity: error
message: "Bad lang"
rule:
  pattern: $X
"#;
    let err = parse_rule(yaml).unwrap_err();
    assert!(matches!(err, RuleError::Parse(_)));
    let msg = err.to_string();
    assert!(
        msg.contains("unknown variant"),
        "expected unknown variant error, got: {msg}"
    );
}

#[test]
fn reject_empty_rule() {
    let yaml = r#"
id: empty-rule
language: rust
severity: error
message: "Empty rule"
rule:
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("must not be empty"),
        "expected empty rule error, got: {msg}"
    );
}

#[test]
fn reject_malformed_yaml() {
    let yaml = "this is: [not: valid: yaml: {{{";
    let err = parse_rule(yaml).unwrap_err();
    assert!(matches!(err, RuleError::Parse(_)));
}

#[test]
fn category_from_rule_path() {
    let category = |p: &str| Category::from_rule_path(Path::new(p));
    assert_eq!(category("slop/no-slop-words.yml"), Some(Category::Slop));
    assert_eq!(category("security/no-debug.yml"), Some(Category::Security));
    assert_eq!(
        category("correctness/no-unwrap.yml"),
        Some(Category::Correctness)
    );
    assert_eq!(category("unknown/something.yml"), None);
    assert_eq!(category("rule.yml"), None);
}

#[test]
fn parse_metric_rule() {
    let yaml = r#"
id: max-lines
language: rust
severity: warning
category: slop
metric: file_lines
threshold: 500
message: "File exceeds 500 lines ($value lines)."
"#;
    let rule = parse_rule(yaml).unwrap();
    assert_eq!(rule.metric, Some(Metric::FileLines));
    assert_eq!(rule.threshold, Some(500.0));
    assert!(rule.is_metric());
    assert_eq!(rule.metric_spec(), Some((Metric::FileLines, 500.0)));
    assert!(rule.rule.is_null());
}

#[test]
fn reject_metric_with_rule() {
    let yaml = r#"
id: both
language: rust
severity: warning
category: slop
metric: file_lines
threshold: 500
message: "m"
rule:
  pattern: $X
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("mutually exclusive"),
        "expected mutually exclusive error, got: {msg}"
    );
}

#[test]
fn reject_metric_without_threshold() {
    let yaml = r#"
id: no-threshold
language: rust
severity: warning
category: slop
metric: file_lines
message: "m"
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("threshold"),
        "expected threshold error, got: {msg}"
    );
}

#[test]
fn reject_fixture_files_on_ast_rule() {
    let yaml = r#"
id: ast-with-fixture
language: rust
severity: warning
category: slop
message: "m"
rule:
  pattern: $X
tests:
  should_match_files:
    - "fixtures/metrics/rust_large.rs"
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("only supported for metric rules"),
        "expected fixture-on-ast-rule error, got: {msg}"
    );
}

#[test]
fn parse_metric_rule_with_fixture_files() {
    let yaml = r#"
id: metric-with-fixtures
language: rust
severity: warning
category: slop
metric: import_count
threshold: 40
message: "m"
tests:
  should_match_files:
    - "fixtures/metrics/rust_large.rs"
  should_not_match_files:
    - "fixtures/metrics/rust_small.rs"
"#;
    let rule = parse_rule(yaml).unwrap();
    let tests = rule.tests.as_ref().unwrap();
    assert_eq!(
        tests.should_match_files,
        vec!["fixtures/metrics/rust_large.rs".to_string()]
    );
    assert_eq!(
        tests.should_not_match_files,
        vec!["fixtures/metrics/rust_small.rs".to_string()]
    );
}

#[test]
fn parse_cross_file_rule() {
    let yaml = r#"
id: no-single-impl-trait
language: rust
severity: warning
category: slop
cross_file: single_impl_trait
message: "Trait with a single implementation in the project."
"#;
    let rule = parse_rule(yaml).unwrap();
    assert_eq!(rule.cross_file, Some(CrossFileKind::SingleImplTrait));
    assert_eq!(rule.cross_file_kind(), Some(CrossFileKind::SingleImplTrait));
    assert!(rule.rule.is_null());
    assert!(rule.is_cross_file());
    assert!(!rule.is_metric());
}

#[test]
fn reject_cross_file_with_rule() {
    let yaml = r#"
id: cross-and-rule
language: rust
severity: warning
category: slop
cross_file: single_impl_trait
message: "m"
rule:
  pattern: $X
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("mutually exclusive"),
        "expected mutually exclusive error, got: {msg}"
    );
}

#[test]
fn reject_cross_file_with_metric() {
    let yaml = r#"
id: cross-and-metric
language: rust
severity: warning
category: slop
cross_file: single_impl_trait
metric: file_lines
threshold: 500
message: "m"
"#;
    let err = parse_rule(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("mutually exclusive"),
        "expected mutually exclusive error, got: {msg}"
    );
}

#[test]
fn reject_unknown_cross_file_kind() {
    let yaml = r#"
id: unknown-cross-file
language: rust
severity: warning
category: slop
cross_file: no_such_kind
message: "m"
"#;
    let err = parse_rule(yaml).unwrap_err();
    assert!(matches!(err, RuleError::Parse(_)));
    let msg = err.to_string();
    assert!(
        msg.contains("unknown variant"),
        "expected unknown variant error, got: {msg}"
    );
}