rustinel-core 0.1.1

Defensive Rust supply-chain risk analysis: static signals, policy and risk diff for Cargo lockfiles.
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

//! Snapshot tests for the human/markdown/json/sarif reporters. Deterministic
//! (no timestamp), so these lock the exact output format.

use rustinel_core::report::{self, OutputFormat};
use rustinel_core::sbom::{self, ExportFormat};
use rustinel_core::{analyze_diff, analyze_lockfile, lockfile, AnalysisOptions};
use std::path::PathBuf;

fn fixtures() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../fixtures")
}

fn opts(source: Option<PathBuf>, db: Option<PathBuf>) -> AnalysisOptions {
    AnalysisOptions {
        offline: true,
        source_path: source,
        advisory_db_path: db,
        ..Default::default()
    }
}

#[test]
fn snapshot_check_json_vuln() {
    let report = analyze_lockfile(
        &fixtures().join("vuln_project/Cargo.lock"),
        opts(None, Some(fixtures().join("advisory_db"))),
    )
    .unwrap();
    let json = report::render(&report, OutputFormat::Json).unwrap();
    insta::assert_snapshot!("check_json_vuln", json);
}

#[test]
fn snapshot_diff_markdown() {
    let report = analyze_diff(
        &fixtures().join("diff/base/Cargo.lock"),
        &fixtures().join("diff/head/Cargo.lock"),
        opts(Some(fixtures().join("mock_registry")), None),
    )
    .unwrap();
    let md = report::render(&report, OutputFormat::Markdown).unwrap();
    insta::assert_snapshot!("diff_markdown", md);
}

#[test]
fn snapshot_cyclonedx_vuln() {
    let lock_path = fixtures().join("vuln_project/Cargo.lock");
    let report =
        analyze_lockfile(&lock_path, opts(None, Some(fixtures().join("advisory_db")))).unwrap();
    let lock = lockfile::parse_lockfile(&lock_path).unwrap();
    let out = sbom::render(ExportFormat::CycloneDx, &lock, &report).unwrap();
    insta::assert_snapshot!("cyclonedx_vuln", out);
}

#[test]
fn snapshot_diff_sarif() {
    let report = analyze_diff(
        &fixtures().join("diff/base/Cargo.lock"),
        &fixtures().join("diff/head/Cargo.lock"),
        opts(Some(fixtures().join("mock_registry")), None),
    )
    .unwrap();
    let sarif = report::render(&report, OutputFormat::Sarif).unwrap();
    insta::assert_snapshot!("diff_sarif", sarif);
}

/// GitHub code scanning drops SARIF results that have no location and re-creates
/// alerts when fingerprints are missing. Every result must therefore carry a
/// physical location (anchored to the lockfile) and a stable partialFingerprint.
#[test]
fn sarif_results_are_code_scanning_ready() {
    let report = analyze_diff(
        &fixtures().join("diff/base/Cargo.lock"),
        &fixtures().join("diff/head/Cargo.lock"),
        opts(Some(fixtures().join("mock_registry")), None),
    )
    .unwrap();
    let sarif = report::render(&report, OutputFormat::Sarif).unwrap();

    let results = sarif.matches("\"ruleId\"").count();
    assert!(results > 0, "fixture must produce findings to test against");
    // Exactly one physical location per result, all anchored to the lockfile.
    assert_eq!(
        sarif.matches("\"physicalLocation\"").count(),
        results,
        "every SARIF result must carry exactly one location"
    );
    assert_eq!(sarif.matches("\"artifactLocation\"").count(), results);
    assert_eq!(
        sarif.matches("\"partialFingerprints\"").count(),
        results,
        "every SARIF result must carry a stable fingerprint"
    );
    assert!(sarif.contains("\"uri\": \"Cargo.lock\""));
    assert!(sarif.contains("\"rustinel/v1\""));
}