traverse-contracts 0.10.0

Contract definitions and validation for the Traverse capability runtime.
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

use serde::{Deserialize, Serialize};

/// Stable, machine-readable representation of a governed contract violation.
///
/// Governed by spec 040-contractual-enforcement-gate.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ViolationRecord {
    pub violation_code: String,
    pub path: String,
    pub message: String,
}

impl ViolationRecord {
    #[must_use]
    pub fn new(
        violation_code: impl Into<String>,
        path: impl Into<String>,
        message: impl Into<String>,
    ) -> Self {
        Self {
            violation_code: violation_code.into(),
            path: path.into(),
            message: message.into(),
        }
    }
}

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

    #[test]
    fn violation_record_new_round_trips_through_json() {
        let record = ViolationRecord::new("missing_required_field", "$.id", "id is required");
        let json = serde_json::to_string(&record);
        assert!(json.is_ok(), "serialize must succeed: {json:?}");
        let json = json.unwrap_or_default();

        let decoded = serde_json::from_str::<ViolationRecord>(&json);
        assert!(decoded.is_ok(), "deserialize must succeed: {decoded:?}");
        let decoded = decoded.unwrap_or_else(|_| record.clone());
        assert_eq!(decoded, record);
    }
}