cargo-allow 0.1.3

Source-tree exception ledger and policy scanner for Rust repositories.
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

use crate::artifact_schema_support::{
    assert_enum_equals, assert_required_fields, governed_kind_enum, match_status_enum,
    parse_schema, required_schema_pointer,
};
use serde_json::Value;
use std::collections::BTreeSet;

#[test]
fn list_schema_locks_allow_entry_kind_contract() {
    let schema = parse_schema(
        "list",
        include_str!("../../../docs/schemas/list.schema.json"),
    );

    assert_eq!(
        schema
            .pointer("/properties/allow_entries/items/$ref")
            .and_then(Value::as_str),
        Some("#/$defs/allow_entry"),
        "list allow_entries should use allow entry rows"
    );

    let allow_entry = required_schema_pointer("list", &schema, "/$defs/allow_entry");
    assert_eq!(
        allow_entry
            .get("additionalProperties")
            .and_then(Value::as_bool),
        Some(false),
        "list allow entries should reject unknown fields"
    );
    assert_required_fields(
        "list allow entry",
        allow_entry,
        &[
            "id",
            "status",
            "matches",
            "kind",
            "family",
            "owner",
            "classification",
            "scope",
            "source_package",
            "evidence_count",
            "selector_precision",
            "broad_scope",
            "review_after",
            "expires",
            "reason",
        ],
    );
    let selector_precision = required_schema_pointer(
        "list allow entry",
        allow_entry,
        "/properties/selector_precision",
    );
    for field in ["broken_evidence_references", "weak_evidence_references"] {
        let evidence_count = required_schema_pointer(
            "list allow entry",
            allow_entry,
            &format!("/properties/{field}"),
        );
        assert_eq!(
            evidence_count.get("type").and_then(Value::as_str),
            Some("integer"),
            "list {field} type"
        );
        assert_eq!(
            evidence_count.get("minimum").and_then(Value::as_u64),
            Some(0),
            "list {field} minimum"
        );
    }
    assert_eq!(
        selector_precision.get("type").and_then(Value::as_str),
        Some("integer"),
        "list selector_precision type"
    );
    assert_eq!(
        selector_precision.get("minimum").and_then(Value::as_u64),
        Some(0),
        "list selector_precision minimum"
    );
    assert_eq!(
        allow_entry
            .pointer("/properties/broad_scope/type")
            .and_then(Value::as_str),
        Some("boolean"),
        "list broad_scope type"
    );
    assert_enum_equals(
        "list allow entry kind",
        &schema,
        "/$defs/allow_entry/properties/kind/enum",
        &governed_kind_enum(),
    );
    assert_enum_equals(
        "list allow entry status",
        &schema,
        "/$defs/allow_entry/properties/status/enum",
        &match_status_enum(),
    );
}

#[test]
fn list_schema_locks_allow_id_filter_contract() {
    let schema = parse_schema(
        "list",
        include_str!("../../../docs/schemas/list.schema.json"),
    );

    let filters = required_schema_pointer("list", &schema, "/properties/filters");
    assert!(
        filters.get("required").is_none(),
        "list filter fields should stay optional for list.v1 compatibility"
    );
    assert_list_filter_properties(filters);
    let allow_id = required_schema_pointer("list filters", filters, "/properties/allow_id");
    let types = allow_id
        .get("type")
        .and_then(Value::as_array)
        .unwrap_or_else(|| std::panic::panic_any("allow_id filter should be nullable string"));
    let types = types.iter().filter_map(Value::as_str).collect::<Vec<_>>();

    assert_eq!(types, vec!["string", "null"]);
}

fn assert_list_filter_properties(filters: &Value) {
    let Some(properties) = filters.get("properties").and_then(Value::as_object) else {
        std::panic::panic_any("list filters properties should be an object");
    };
    let actual = properties
        .keys()
        .map(String::as_str)
        .collect::<BTreeSet<_>>();
    let expected = [
        "kind",
        "family",
        "owner",
        "classification",
        "path",
        "source_package",
        "allow_id",
        "status",
        "expired",
        "review_due",
        "stale",
        "baseline_debt",
        "broad_scope",
        "missing_evidence",
        "broken_evidence",
        "weak_evidence",
    ]
    .into_iter()
    .collect::<BTreeSet<_>>();

    assert_eq!(actual, expected, "list filter schema properties");
}