ocel 0.1.5

OCEL 2.0 data model, I/O (JSON/SQLite/XML), and validation library
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

use std::path::PathBuf;

use chrono::{DateTime, Utc};
use ocel::io::{json, sqlite, xml};
use ocel::{
    AttrType, AttributeDefinition, Event, EventType, ObjectType, Ocel, Relationship, Violation,
};

fn ts(secs: i64) -> DateTime<Utc> {
    DateTime::from_timestamp(secs, 0).unwrap()
}

fn fixture(name: &str) -> PathBuf {
    let mut p = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    p.push("tests/fixtures");
    p.push(name);
    p
}

#[test]
fn valid_fixture_passes() {
    let ocel = json::read_path(fixture("order_management_small.json")).unwrap();
    assert_eq!(ocel.validate(), Ok(()));
}

#[test]
fn minimal_passes() {
    let ocel = json::read_path(fixture("minimal.json")).unwrap();
    assert_eq!(ocel.validate(), Ok(()));
}

#[test]
fn detects_dangling_e2o_and_undeclared_type() {
    let ocel = Ocel {
        event_types: vec![],
        object_types: vec![],
        events: vec![Event {
            id: "e1".into(),
            event_type: "ghost".into(),
            time: ts(0),
            attributes: vec![],
            relationships: vec![Relationship {
                object_id: "missing".into(),
                qualifier: "q".into(),
            }],
        }],
        objects: vec![],
    };
    let violations = ocel.validate().unwrap_err();
    assert!(violations.contains(&Violation::UndeclaredEventType {
        event: "e1".into(),
        event_type: "ghost".into(),
    }));
    assert!(violations.contains(&Violation::DanglingE2O {
        event: "e1".into(),
        object: "missing".into(),
    }));
}

#[test]
fn detects_undeclared_attribute() {
    let ocel = Ocel {
        event_types: vec![EventType {
            name: "t".into(),
            attributes: vec![],
        }],
        object_types: vec![],
        events: vec![Event {
            id: "e1".into(),
            event_type: "t".into(),
            time: ts(0),
            attributes: vec![ocel::EventAttribute {
                name: "surprise".into(),
                value: ocel::AttrValue::String("x".into()),
            }],
            relationships: vec![],
        }],
        objects: vec![],
    };
    assert!(ocel
        .validate()
        .unwrap_err()
        .contains(&Violation::UndeclaredEventAttribute {
            event: "e1".into(),
            attribute: "surprise".into(),
        }));
}

/// Attribute names shared across types are allowed: the official datasets
/// (e.g. Zenodo Order Management) use names like "price" in multiple types.
#[test]
fn shared_attribute_names_across_types_are_valid() {
    let dup = || AttributeDefinition {
        name: "price".into(),
        value_type: AttrType::Float,
    };
    let ocel = Ocel {
        event_types: vec![],
        object_types: vec![
            ObjectType {
                name: "item".into(),
                attributes: vec![dup()],
            },
            ObjectType {
                name: "product".into(),
                attributes: vec![dup()],
            },
        ],
        events: vec![],
        objects: vec![],
    };
    assert_eq!(ocel.validate(), Ok(()));
}

/// The official `PM4Py` examples validate cleanly across all three formats.
/// Skips when absent; run `sh scripts/fetch-official-fixtures.sh` to enable it.
#[test]
fn official_examples_validate_if_present() {
    let json_path = fixture("official/ocel20_example.jsonocel");
    if !json_path.exists() {
        eprintln!("skipping: official fixtures not present");
        return;
    }
    assert_eq!(json::read_path(&json_path).unwrap().validate(), Ok(()));
    assert_eq!(
        sqlite::read_path(fixture("official/ocel20_example.sqlite"))
            .unwrap()
            .validate(),
        Ok(())
    );
    assert_eq!(
        xml::read_path(fixture("official/ocel20_example.xmlocel"))
            .unwrap()
            .validate(),
        Ok(())
    );
}