tokmd-types 1.14.0

Core data types and contracts for tokmd. Tier 1 stability.
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

//! Sibling bundle file types for `tokmd render --from-packets`.
//!
//! These model producer artifacts such as `manual-candidates.json` and
//! `cards.json` that may supplement manifest `preset_inputs` when partial.

use serde::{Deserialize, Serialize};

/// Sibling artifact filename for manual candidate indexes.
pub const MANUAL_CANDIDATES_FILE: &str = "manual-candidates.json";

/// Sibling artifact filename for ReviewCard analyzer output.
pub const CARDS_FILE: &str = "cards.json";

/// Schema id recorded by unsafe-review `manual-candidates.json` exports.
pub const MANUAL_CANDIDATES_SCHEMA: &str = "manual-candidates/v1";

/// Parsed sibling inputs available to the packet renderer.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct PacketSiblingInputs {
    pub manual_candidates: Option<ManualCandidatesFile>,
    pub cards: Option<CardsFile>,
    pub load_notes: Vec<String>,
}

/// Bundle passed from CLI load through formatting.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PacketRenderBundle {
    pub manifest: super::TokmdPacketsManifest,
    pub siblings: PacketSiblingInputs,
}

/// `manual-candidates.json` index (minimal consumer contract).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ManualCandidatesFile {
    pub schema_version: String,
    #[serde(default)]
    pub candidates: Vec<ManualCandidateRecord>,
}

/// One manual candidate row from `manual-candidates.json`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct ManualCandidateRecord {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub invariant: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub safe_caller: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub unsafe_operation: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub operation_family: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub location_text: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub proof_mode: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fix_boundary: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pr_aperture: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub test_targets: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub do_not_touch: Vec<String>,
}

/// `cards.json` ReviewCard snapshot (minimal consumer contract).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CardsFile {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schema_version: Option<String>,
    #[serde(default, alias = "review_cards")]
    pub cards: Vec<ReviewCardRecord>,
}

/// One ReviewCard row from `cards.json`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct ReviewCardRecord {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub location_text: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub unsafe_operation: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub operation_family: Option<String>,
}

impl ManualCandidatesFile {
    /// Returns true when the file uses the supported schema id.
    pub fn schema_matches(&self) -> bool {
        self.schema_version == MANUAL_CANDIDATES_SCHEMA
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn manual_candidates_roundtrip() {
        let file = ManualCandidatesFile {
            schema_version: MANUAL_CANDIDATES_SCHEMA.into(),
            candidates: vec![ManualCandidateRecord {
                id: Some("seed-42".into()),
                title: Some("UTF-8 boundary".into()),
                invariant: Some("buffer bounds".into()),
                ..ManualCandidateRecord::default()
            }],
        };
        let json = serde_json::to_string(&file).unwrap();
        let back: ManualCandidatesFile = serde_json::from_str(&json).unwrap();
        assert_eq!(back, file);
        assert!(back.schema_matches());
    }

    #[test]
    fn cards_roundtrip_with_review_cards_alias() {
        let raw =
            r#"{"schema_version":"0.2","review_cards":[{"id":"rc-17","title":"slice read"}]}"#;
        let file: CardsFile = serde_json::from_str(raw).unwrap();
        assert_eq!(file.cards.len(), 1);
        assert_eq!(file.cards[0].id.as_deref(), Some("rc-17"));
    }
}