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
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
use super::test_support::test_finding_at_line;
use super::*;
use crate::{CargoAllowCli, CargoAllowCommand, RootArgs};
use allow_core::{AllowConfig, AllowEntry};
use allow_policy::render_policy;
use clap::Parser;
use std::fs;
use std::process::Command;

#[test]
fn clap_parses_add_from_finding() {
    let parsed = CargoAllowCli::try_parse_from(argv(vec![
        "cargo-allow",
        "add",
        "--kind",
        "panic",
        "--path",
        "src/lib.rs",
        "--line",
        "42",
        "--owner",
        "parser",
        "--reason",
        "validated invariant",
        "--evidence",
        "test:parser_invariant",
        "--write",
        "policy/allow.proposed.toml",
        "--force",
        "--summary-format",
        "json",
        "--summary-output",
        "target/add-summary.json",
    ]))
    .unwrap_or_else(|err| std::panic::panic_any(format!("CLI should parse: {err}")));

    assert!(matches!(
        parsed.command,
        Some(CargoAllowCommand::Add(AddArgs {
            kind,
            path,
            line: 42,
            owner,
            reason,
            evidence,
            write: Some(write),
            force: true,
            summary_format: AddSummaryFormat::Json,
            summary_output: Some(summary_output),
            ..
        })) if kind == "panic"
            && path == Path::new("src/lib.rs")
            && owner == "parser"
            && reason == "validated invariant"
            && evidence == vec!["test:parser_invariant".to_string()]
            && write == Path::new("policy/allow.proposed.toml")
            && summary_output == Path::new("target/add-summary.json")
    ));
}

#[test]
fn select_add_finding_picks_nearest_path_and_kind() {
    let findings = vec![
        test_finding_at_line(
            FindingKind::Panic,
            Some("unwrap"),
            "src/lib.rs",
            "method_call",
            10,
        ),
        test_finding_at_line(
            FindingKind::Panic,
            Some("expect"),
            "src/lib.rs",
            "method_call",
            40,
        ),
        test_finding_at_line(
            FindingKind::Unsafe,
            Some("unsafe_fn"),
            "src/lib.rs",
            "unsafe_fn",
            39,
        ),
    ];
    let kind = parse_kind_filter("panic")
        .unwrap_or_else(|err| std::panic::panic_any(format!("kind should parse: {err}")));

    let (_index, selected) = select_add_finding(&findings, kind, Path::new("src/lib.rs"), 39)
        .unwrap_or_else(|err| std::panic::panic_any(format!("finding should select: {err}")));

    assert_eq!(selected.family.as_deref(), Some("expect"));
    assert_eq!(selected.span.as_ref().map(|span| span.line), Some(40));
}

#[test]
fn select_add_finding_fails_closed_on_equal_nearest_findings() {
    let findings = vec![
        test_finding_at_line(
            FindingKind::Panic,
            Some("unwrap"),
            "src/lib.rs",
            "method_call",
            40,
        ),
        test_finding_at_line(
            FindingKind::Panic,
            Some("expect"),
            "src/lib.rs",
            "method_call",
            42,
        ),
    ];
    let kind = parse_kind_filter("panic")
        .unwrap_or_else(|err| std::panic::panic_any(format!("kind should parse: {err}")));

    let err = select_add_finding(&findings, kind, Path::new("src/lib.rs"), 41)
        .expect_err("equally near findings should be ambiguous");

    assert!(err.to_string().contains("ambiguous add request"));
}

#[test]
fn ensure_addable_outcome_rejects_already_matched_findings() {
    assert!(ensure_addable_outcome(MatchStatus::New).is_ok());

    let err = ensure_addable_outcome(MatchStatus::Matched)
        .expect_err("matched finding should not be addable");

    assert!(err.to_string().contains("already receipted"));
}

#[test]
fn allow_entry_from_finding_uses_structural_selector_and_review_metadata() {
    let mut finding = test_finding_at_line(
        FindingKind::Panic,
        Some("unwrap"),
        "src/lib.rs",
        "method_call",
        42,
    );
    finding.identity.container = Some("parse_span".to_string());
    finding.identity.callee = Some("unwrap".to_string());
    finding.identity.normalized_snippet_hash = Some("fnv1a64:1234".to_string());

    let entry = allow_entry_from_finding(AddEntryRequest {
        finding: &finding,
        id: "allow-0099".to_string(),
        owner: "parser".to_string(),
        classification: "validated_invariant".to_string(),
        reason: "Parser validates the span before unwrapping.".to_string(),
        evidence: vec!["test:parser_validates_span".to_string()],
        review_after: "2026-11-01".to_string(),
        expires: None,
    });

    assert_eq!(entry.id, "allow-0099");
    assert_eq!(entry.owner, "parser");
    assert_eq!(entry.selector.container.as_deref(), Some("parse_span"));
    assert_eq!(entry.selector.callee.as_deref(), Some("unwrap"));
    assert_eq!(
        entry.selector.normalized_snippet_hash.as_deref(),
        Some("fnv1a64:1234")
    );
    assert_eq!(entry.last_seen.as_ref().map(|last| last.line), Some(42));
}

#[test]
fn add_evidence_requirement_covers_high_risk_policy_exceptions() {
    let unsafe_finding = test_finding_at_line(
        FindingKind::Unsafe,
        Some("unsafe_block"),
        "src/lib.rs",
        "unsafe_block",
        42,
    );
    let process_finding = test_finding_at_line(
        FindingKind::PolicyException,
        Some("process_spawn"),
        "src/lib.rs",
        "policy_exception",
        42,
    );
    let network_finding = test_finding_at_line(
        FindingKind::PolicyException,
        Some("network_destination"),
        "src/lib.rs",
        "policy_exception",
        42,
    );
    let workflow_finding = test_finding_at_line(
        FindingKind::PolicyException,
        Some("github_workflow"),
        ".github/workflows/ci.yml",
        "tracked_file",
        1,
    );

    let unsafe_err =
        require_add_evidence(&unsafe_finding, &[]).expect_err("unsafe add should require evidence");
    assert!(
        unsafe_err
            .to_string()
            .contains("unsafe allow entries require at least one --evidence reference")
    );
    let process_err = require_add_evidence(&process_finding, &[])
        .expect_err("process policy add should require evidence");
    assert!(process_err.to_string().contains(
        "policy_exception.process_spawn allow entries require at least one --evidence reference"
    ));
    let network_err = require_add_evidence(&network_finding, &[])
        .expect_err("network policy add should require evidence");
    assert!(
        network_err.to_string().contains(
            "policy_exception.network_destination allow entries require at least one --evidence reference"
        )
    );
    assert!(
        require_add_evidence(&workflow_finding, &[]).is_ok(),
        "lower-risk policy exceptions can still be added without immediate evidence"
    );
}

#[test]
fn add_required_evidence_must_be_typed() {
    let process_finding = test_finding_at_line(
        FindingKind::PolicyException,
        Some("process_spawn"),
        "src/lib.rs",
        "policy_exception",
        42,
    );
    let weak_references = vec![
        "manual review note".to_string(),
        "spreadsheet:manual-review".to_string(),
        "test:".to_string(),
    ];

    let err = require_add_evidence(&process_finding, &weak_references)
        .expect_err("weak evidence should not satisfy high-risk add evidence gate");

    assert!(
        err.to_string()
            .contains("require at least one typed --evidence reference"),
        "diagnostic should explain typed evidence requirement: {err}"
    );
    assert!(
        require_add_evidence(
            &process_finding,
            &["test:process_spawn_is_guarded".to_string()]
        )
        .is_ok(),
        "recognized non-empty evidence references should satisfy the gate"
    );
    assert!(
        require_add_evidence(
            &process_finding,
            &[
                "manual review note".to_string(),
                "doc:docs/policy/process-spawn.md".to_string()
            ]
        )
        .is_ok(),
        "one typed reference should satisfy the gate even if another retained reference is weak"
    );
}

#[test]
fn default_add_review_after_is_relative_to_current_date() {
    let before = allow_core::SimpleDate::today_utc_approx().add_days(ADD_REVIEW_AFTER_DEFAULT_DAYS);
    let review_after = default_add_review_after();
    let after = allow_core::SimpleDate::today_utc_approx().add_days(ADD_REVIEW_AFTER_DEFAULT_DAYS);
    let parsed = allow_core::SimpleDate::parse(&review_after)
        .unwrap_or_else(|| std::panic::panic_any("default review_after should be a valid date"));

    assert!(
        before <= parsed && parsed <= after,
        "default add review_after should stay relative to the current UTC date"
    );
}

#[test]
fn cmd_add_rejects_untracked_local_evidence_by_default() {
    let root = add_fixture_dir();
    write_add_fixture_with_untracked_evidence(&root);
    let output = root.join("policy/allow.added.toml");

    let err = cmd_add(&AddArgs {
        root: RootArgs {
            root: Some(root.clone()),
        },
        config: Some(root.join("policy/allow.toml")),
        kind: "panic".to_string(),
        path: PathBuf::from("src/lib.rs"),
        line: 1,
        owner: "parser".to_string(),
        classification: "reviewed_exception".to_string(),
        reason: "Parser validates before unwrap.".to_string(),
        evidence: vec!["test:parser_validates".to_string()],
        id: None,
        review_after: Some("2026-11-01".to_string()),
        expires: None,
        include_untracked: false,
        write: Some(output.clone()),
        force: false,
        summary_format: AddSummaryFormat::Human,
        summary_output: None,
    })
    .expect_err("add should reject retained untracked local evidence by default");

    assert!(
        err.to_string()
            .contains("not in the default source-tree inventory"),
        "diagnostic should explain source-tree evidence boundary: {err}"
    );
    assert!(
        !output.exists(),
        "add should not write policy output when evidence validation fails"
    );
    fs::remove_dir_all(root)
        .unwrap_or_else(|err| std::panic::panic_any(format!("remove fixture dir: {err}")));
}

#[test]
fn cmd_add_include_untracked_accepts_untracked_local_evidence() {
    let root = add_fixture_dir();
    write_add_fixture_with_untracked_evidence(&root);
    let output = root.join("policy/allow.added.toml");

    cmd_add(&AddArgs {
        root: RootArgs {
            root: Some(root.clone()),
        },
        config: Some(root.join("policy/allow.toml")),
        kind: "panic".to_string(),
        path: PathBuf::from("src/lib.rs"),
        line: 1,
        owner: "parser".to_string(),
        classification: "reviewed_exception".to_string(),
        reason: "Parser validates before unwrap.".to_string(),
        evidence: vec!["test:parser_validates".to_string()],
        id: None,
        review_after: Some("2026-11-01".to_string()),
        expires: None,
        include_untracked: true,
        write: Some(output.clone()),
        force: false,
        summary_format: AddSummaryFormat::Human,
        summary_output: None,
    })
    .unwrap_or_else(|err| {
        std::panic::panic_any(format!(
            "add should accept include-untracked evidence: {err}"
        ))
    });

    let rendered = fs::read_to_string(&output)
        .unwrap_or_else(|err| std::panic::panic_any(format!("read output policy: {err}")));
    assert!(rendered.contains("allow-0002"));
    assert!(rendered.contains("test:parser_validates"));
    fs::remove_dir_all(root)
        .unwrap_or_else(|err| std::panic::panic_any(format!("remove fixture dir: {err}")));
}

fn argv(items: Vec<&str>) -> Vec<String> {
    items.into_iter().map(String::from).collect()
}

fn write_add_fixture_with_untracked_evidence(root: &std::path::Path) {
    fs::create_dir_all(root.join("policy"))
        .unwrap_or_else(|err| std::panic::panic_any(format!("policy dir: {err}")));
    fs::create_dir_all(root.join("src"))
        .unwrap_or_else(|err| std::panic::panic_any(format!("src dir: {err}")));
    fs::write(
        root.join("src/lib.rs"),
        "fn parse(value: Option<u8>) -> u8 { value.unwrap() }\n",
    )
    .unwrap_or_else(|err| std::panic::panic_any(format!("source write: {err}")));
    let mut cfg = AllowConfig::empty();
    cfg.workspace.ignored = vec!["policy/evidence.md".to_string()];
    cfg.allow.push(test_policy_entry_with_untracked_evidence());
    fs::write(root.join("policy/allow.toml"), render_policy(&cfg))
        .unwrap_or_else(|err| std::panic::panic_any(format!("policy write: {err}")));
    git(root, &["init"]);
    git(
        root,
        &["config", "user.email", "cargo-allow@example.invalid"],
    );
    git(root, &["config", "user.name", "cargo-allow test"]);
    git(root, &["add", "policy/allow.toml", "src/lib.rs"]);
    git(root, &["commit", "-m", "base policy"]);
    fs::write(root.join("policy/evidence.md"), "untracked evidence")
        .unwrap_or_else(|err| std::panic::panic_any(format!("evidence doc: {err}")));
}

fn test_policy_entry_with_untracked_evidence() -> AllowEntry {
    AllowEntry {
        id: "allow-0001".to_string(),
        kind: FindingKind::NonRustFile,
        family: Some("configuration".to_string()),
        path: Some(PathBuf::from("policy/allow.toml")),
        glob: None,
        owner: "core".to_string(),
        classification: "fixture".to_string(),
        reason: "fixture policy file".to_string(),
        evidence: vec!["doc:policy/evidence.md".to_string()],
        links: Vec::new(),
        occurrence_limit: None,
        lifecycle: allow_core::Lifecycle {
            created: None,
            review_after: Some("2026-11-01".to_string()),
            expires: None,
        },
        selector: allow_core::Selector {
            ast_kind: Some("tracked_file".to_string()),
            ..allow_core::Selector::default()
        },
        last_seen: None,
    }
}

fn add_fixture_dir() -> std::path::PathBuf {
    let stamp = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|duration| duration.as_nanos())
        .unwrap_or(0);
    let dir = std::env::temp_dir().join(format!("cargo-allow-add-{}-{stamp}", std::process::id()));
    match fs::remove_dir_all(&dir) {
        Ok(()) => {}
        Err(err) if err.kind() == std::io::ErrorKind::NotFound => {}
        Err(err) => std::panic::panic_any(format!("remove add fixture {}: {err}", dir.display())),
    }
    fs::create_dir_all(&dir)
        .unwrap_or_else(|err| std::panic::panic_any(format!("create add fixture: {err}")));
    dir
}

fn git(root: &std::path::Path, args: &[&str]) {
    let output = Command::new("git")
        .arg("-C")
        .arg(root)
        .args(args)
        .output()
        .unwrap_or_else(|err| std::panic::panic_any(format!("git {args:?}: {err}")));
    if !output.status.success() {
        std::panic::panic_any(format!(
            "git {args:?} failed: stdout=`{}` stderr=`{}`",
            String::from_utf8_lossy(&output.stdout),
            String::from_utf8_lossy(&output.stderr)
        ));
    }
}