diffguard 0.2.0

CLI for diff-scoped governance linting in pull requests
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

//! BDD tests for per-directory `.diffguard.toml` overrides.

use super::test_repo::TestRepo;

/// Scenario: A directory override disables a rule in that subtree.
#[test]
fn given_directory_rule_disable_when_check_then_subtree_is_skipped() {
    let repo = TestRepo::new();

    repo.write_config(
        r#"
[[rule]]
id = "custom.no_unwrap"
severity = "error"
message = "No unwrap"
patterns = ["\\.unwrap\\("]
paths = ["**/*.rs"]
ignore_comments = true
ignore_strings = true
"#,
    );

    repo.write_file(
        "src/generated/.diffguard.toml",
        r#"
[[rule]]
id = "custom.no_unwrap"
enabled = false
"#,
    );

    repo.write_file("src/lib.rs", "pub fn a() { let _ = Some(1).unwrap(); }\n");
    repo.write_file(
        "src/generated/lib.rs",
        "pub fn b() { let _ = Some(2).unwrap(); }\n",
    );
    let head_sha = repo.commit("add unwraps with generated override");

    let result = repo.run_check_with_args(&head_sha, &["--no-default-rules"]);
    result.assert_exit_code(2);

    let receipt = result.parse_receipt();
    assert!(receipt.has_finding_at("src/lib.rs", 1));
    assert!(!receipt.has_finding_at("src/generated/lib.rs", 1));
    assert_eq!(receipt.error_count(), 1);
}

/// Scenario: A directory override changes severity for that subtree.
#[test]
fn given_directory_severity_override_when_check_then_effective_severity_changes() {
    let repo = TestRepo::new();

    repo.write_config(
        r#"
[defaults]
fail_on = "warn"

[[rule]]
id = "custom.no_unwrap"
severity = "error"
message = "No unwrap"
patterns = ["\\.unwrap\\("]
paths = ["**/*.rs"]
ignore_comments = true
ignore_strings = true
"#,
    );

    repo.write_file(
        "src/legacy/.diffguard.toml",
        r#"
[[rule]]
id = "custom.no_unwrap"
severity = "warn"
"#,
    );

    repo.write_file(
        "src/legacy/lib.rs",
        "pub fn legacy() { let _ = Some(1).unwrap(); }\n",
    );
    let head_sha = repo.commit("legacy unwrap");

    let result = repo.run_check_with_args(&head_sha, &["--no-default-rules"]);
    result.assert_exit_code(3);

    let receipt = result.parse_receipt();
    assert!(receipt.has_finding_at("src/legacy/lib.rs", 1));
    assert_eq!(receipt.warn_count(), 1);
    assert_eq!(receipt.error_count(), 0);
}

/// Scenario: Child overrides can re-enable rules disabled by a parent override.
#[test]
fn given_parent_disable_and_child_enable_when_check_then_child_override_wins() {
    let repo = TestRepo::new();

    repo.write_config(
        r#"
[defaults]
fail_on = "warn"

[[rule]]
id = "custom.no_unwrap"
severity = "error"
message = "No unwrap"
patterns = ["\\.unwrap\\("]
paths = ["**/*.rs"]
ignore_comments = true
ignore_strings = true
"#,
    );

    repo.write_file(
        ".diffguard.toml",
        r#"
[[rule]]
id = "custom.no_unwrap"
enabled = false
"#,
    );

    repo.write_file(
        "src/legacy/.diffguard.toml",
        r#"
[[rule]]
id = "custom.no_unwrap"
enabled = true
severity = "warn"
"#,
    );

    repo.write_file(
        "src/new/lib.rs",
        "pub fn new_fn() { let _ = Some(1).unwrap(); }\n",
    );
    repo.write_file(
        "src/legacy/lib.rs",
        "pub fn legacy_fn() { let _ = Some(2).unwrap(); }\n",
    );
    let head_sha = repo.commit("parent disable child enable");

    let result = repo.run_check_with_args(&head_sha, &["--no-default-rules"]);
    result.assert_exit_code(3);

    let receipt = result.parse_receipt();
    assert!(!receipt.has_finding_at("src/new/lib.rs", 1));
    assert!(receipt.has_finding_at("src/legacy/lib.rs", 1));
    assert_eq!(receipt.warn_count(), 1);
    assert_eq!(receipt.error_count(), 0);
}