tokmd-analysis 1.10.0

Analysis logic and enrichers for tokmd receipts.
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

//! Wave-49 deep tests for license report building.
//!
//! Covers metadata detection, text matching, confidence scoring,
//! sorting, serde roundtrips, and property-based tests.

use std::fs;
use std::path::PathBuf;

use crate::license::build_license_report;
use tempfile::tempdir;
use tokmd_analysis_types::AnalysisLimits;
use tokmd_analysis_types::{LicenseFinding, LicenseReport, LicenseSourceKind};

// ── 1. Empty files list returns empty report ────────────────────

#[test]
fn empty_files_returns_empty_report() {
    let dir = tempdir().unwrap();
    let report = build_license_report(dir.path(), &[], &AnalysisLimits::default()).unwrap();
    assert!(report.findings.is_empty());
    assert!(report.effective.is_none());
}

// ── 2. Cargo.toml metadata detection ────────────────────────────

#[test]
fn cargo_toml_metadata_detection() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join("Cargo.toml"),
        "[package]\nname = \"demo\"\nlicense = \"Apache-2.0\"\n",
    )
    .unwrap();
    let files = vec![PathBuf::from("Cargo.toml")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert_eq!(report.findings.len(), 1);
    assert_eq!(report.findings[0].spdx, "Apache-2.0");
    assert_eq!(report.findings[0].source_kind, LicenseSourceKind::Metadata);
    assert!((report.findings[0].confidence - 0.95).abs() < f32::EPSILON);
    assert_eq!(report.effective.as_deref(), Some("Apache-2.0"));
}

// ── 3. package.json string license ──────────────────────────────

#[test]
fn package_json_string_license() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join("package.json"),
        r#"{"name": "demo", "license": "ISC"}"#,
    )
    .unwrap();
    let files = vec![PathBuf::from("package.json")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert_eq!(report.findings.len(), 1);
    assert_eq!(report.findings[0].spdx, "ISC");
    assert_eq!(report.findings[0].source_kind, LicenseSourceKind::Metadata);
}

// ── 4. package.json object license with type field ──────────────

#[test]
fn package_json_object_license() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join("package.json"),
        r#"{"name": "demo", "license": {"type": "MIT", "url": "https://example.com"}}"#,
    )
    .unwrap();
    let files = vec![PathBuf::from("package.json")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert_eq!(report.findings[0].spdx, "MIT");
}

// ── 5. pyproject.toml detection ─────────────────────────────────

#[test]
fn pyproject_toml_detection() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join("pyproject.toml"),
        "[project]\nname = \"demo\"\nlicense = \"BSD-3-Clause\"\n",
    )
    .unwrap();
    let files = vec![PathBuf::from("pyproject.toml")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert_eq!(report.findings.len(), 1);
    assert_eq!(report.findings[0].spdx, "BSD-3-Clause");
}

// ── 6. Text license MIT detection ───────────────────────────────

#[test]
fn text_license_mit_detection() {
    let dir = tempdir().unwrap();
    let text = "MIT License\n\n\
        Permission is hereby granted, free of charge, to any person obtaining a copy \
        of this software and associated documentation files. \
        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND.";
    fs::write(dir.path().join("LICENSE"), text).unwrap();
    let files = vec![PathBuf::from("LICENSE")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert!(report.findings.iter().any(|f| f.spdx == "MIT"));
    let finding = report.findings.iter().find(|f| f.spdx == "MIT").unwrap();
    assert_eq!(finding.source_kind, LicenseSourceKind::Text);
    assert!(finding.confidence >= 0.6);
    assert!(finding.confidence <= 1.0);
}

// ── 7. Text license Apache-2.0 detection ────────────────────────

#[test]
fn text_license_apache_detection() {
    let dir = tempdir().unwrap();
    let text = "Apache License\nVersion 2.0, January 2004\n\
        http://www.apache.org/licenses/\n\
        limitations under the License.";
    fs::write(dir.path().join("LICENSE"), text).unwrap();
    let files = vec![PathBuf::from("LICENSE")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert!(report.findings.iter().any(|f| f.spdx == "Apache-2.0"));
}

// ── 8. Findings sorted by confidence desc, spdx asc ────────────

#[test]
fn findings_sorted_confidence_desc_spdx_asc() {
    let dir = tempdir().unwrap();
    // Metadata finding (confidence 0.95) + text finding (confidence < 0.95)
    fs::write(
        dir.path().join("Cargo.toml"),
        "[package]\nname = \"demo\"\nlicense = \"MIT\"\n",
    )
    .unwrap();
    let apache_text = "Apache License\nVersion 2.0\n\
        http://www.apache.org/licenses/\nlimitations under the License.";
    fs::write(dir.path().join("LICENSE"), apache_text).unwrap();
    let files = vec![PathBuf::from("Cargo.toml"), PathBuf::from("LICENSE")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert!(report.findings.len() >= 2);
    // Metadata (0.95) should come before text
    for pair in report.findings.windows(2) {
        assert!(
            pair[0].confidence >= pair[1].confidence,
            "findings should be sorted by confidence desc: {} >= {}",
            pair[0].confidence,
            pair[1].confidence
        );
    }
}

// ── 9. Effective is highest confidence finding ──────────────────

#[test]
fn effective_is_highest_confidence() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join("Cargo.toml"),
        "[package]\nname = \"demo\"\nlicense = \"GPL-3.0\"\n",
    )
    .unwrap();
    let files = vec![PathBuf::from("Cargo.toml")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    assert_eq!(
        report.effective.as_deref(),
        Some("GPL-3.0"),
        "effective should be the first finding's spdx"
    );
}

// ── 10. Serde roundtrip preserves all fields ────────────────────

#[test]
fn serde_roundtrip_preserves_all_fields() {
    let dir = tempdir().unwrap();
    let mit_text = "Permission is hereby granted, free of charge, \
        to any person. The software is provided \"as is\".";
    fs::write(dir.path().join("LICENSE"), mit_text).unwrap();
    fs::write(
        dir.path().join("Cargo.toml"),
        "[package]\nname = \"demo\"\nlicense = \"MIT\"\n",
    )
    .unwrap();
    let files = vec![PathBuf::from("Cargo.toml"), PathBuf::from("LICENSE")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();

    let json = serde_json::to_string(&report).unwrap();
    let deser: LicenseReport = serde_json::from_str(&json).unwrap();

    assert_eq!(deser.findings.len(), report.findings.len());
    assert_eq!(deser.effective, report.effective);
    for (orig, rt) in report.findings.iter().zip(deser.findings.iter()) {
        assert_eq!(orig.spdx, rt.spdx);
        assert!((orig.confidence - rt.confidence).abs() < f32::EPSILON);
        assert_eq!(orig.source_path, rt.source_path);
    }
}

// ── 11. Source path uses forward slashes ─────────────────────────

#[test]
fn source_path_forward_slashes() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join("Cargo.toml"),
        "[package]\nname = \"demo\"\nlicense = \"MIT\"\n",
    )
    .unwrap();
    let files = vec![PathBuf::from("Cargo.toml")];
    let report = build_license_report(dir.path(), &files, &AnalysisLimits::default()).unwrap();
    for f in &report.findings {
        assert!(
            !f.source_path.contains('\\'),
            "paths should use forward slashes"
        );
    }
}

// ── Proptest ────────────────────────────────────────────────────

mod properties {
    use super::*;
    use proptest::prelude::*;

    proptest! {
        #[test]
        fn confidence_always_in_range(
            spdx in "[A-Z]{2,6}-[0-9]\\.[0-9]",
            conf in 0.0f32..=1.0f32,
        ) {
            let finding = LicenseFinding {
                spdx,
                confidence: conf,
                source_path: "LICENSE".to_string(),
                source_kind: LicenseSourceKind::Text,
            };
            let json = serde_json::to_string(&finding).unwrap();
            let rt: LicenseFinding = serde_json::from_str(&json).unwrap();
            prop_assert!(rt.confidence >= 0.0 && rt.confidence <= 1.0);
            prop_assert_eq!(rt.source_kind, LicenseSourceKind::Text);
        }
    }
}