sim-lib-stream-device 0.1.1

Hardware-free device sample contracts for SIM stream sources.
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

use std::sync::Arc;

use sim_kernel::{Expr, ObjectEncoding, Symbol, read_construct_capability, testing::bare_cx as cx};

use crate::{
    DeviceCaps, DeviceSample, DeviceSampleValue, ModeledDeviceCapsSource, ModeledSource,
    device_caps_sample_kind_symbol, device_sample_class_symbol, device_sample_record_symbol,
    install_device_stream_base, roundtrip_ok, sample_packet, seq_is_monotone,
};

#[test]
fn demo_sample_round_trips_and_fails_closed() {
    let sample = DeviceCaps::demo(7);
    assert!(roundtrip_ok(&sample));
    assert_eq!(DeviceCaps::from_expr(&sample.to_expr()).unwrap(), sample);

    let missing_seq = Expr::Map(vec![
        (
            Expr::Symbol(Symbol::new("kind")),
            Expr::Symbol(device_sample_record_symbol()),
        ),
        (
            Expr::Symbol(Symbol::new("sample")),
            Expr::Symbol(device_caps_sample_kind_symbol()),
        ),
    ]);
    let err = DeviceCaps::from_expr(&missing_seq).unwrap_err();
    assert!(err.to_string().contains("missing field seq"));

    let unknown = Expr::Map(vec![
        (
            Expr::Symbol(Symbol::new("kind")),
            Expr::Symbol(device_sample_record_symbol()),
        ),
        (
            Expr::Symbol(Symbol::new("sample")),
            Expr::Symbol(Symbol::qualified("stream/device-sample", "unknown")),
        ),
        (Expr::Symbol(Symbol::new("seq")), sim_value::build::uint(1)),
    ]);
    assert!(DeviceSampleValue::new(unknown).is_err());
}

#[test]
fn modeled_source_is_deterministic_and_seq_monotone() {
    let source = ModeledDeviceCapsSource::demo().with_seq_base(10);
    assert_eq!(source.at(4), source.at(4));
    assert_ne!(source.at(4).seq(), source.at(5).seq());
    assert_eq!(source.at(4).seq(), 14);
    assert!(seq_is_monotone(&source, 0, 16));
}

#[test]
fn sample_wraps_as_stream_data_packet() {
    let sample = DeviceCaps::demo(3);
    let packet = sample_packet(&sample);
    let sim_lib_stream_core::StreamPacket::Data(data) = packet else {
        panic!("device sample should wrap as data packet");
    };
    assert_eq!(data.kind, device_caps_sample_kind_symbol());
    assert_eq!(data.payload, sample.to_expr());
}

#[test]
fn device_sample_read_construct_round_trips() {
    let mut cx = cx();
    install_device_stream_base(&mut cx).unwrap();
    cx.grant(read_construct_capability());

    let sample = DeviceCaps::demo(11);
    let value = cx
        .factory()
        .opaque(Arc::new(DeviceSampleValue::new(sample.to_expr()).unwrap()))
        .unwrap();
    let ObjectEncoding::Constructor { class, args } = value
        .object()
        .as_object_encoder()
        .unwrap()
        .object_encoding(&mut cx)
        .unwrap()
    else {
        panic!("device sample should encode as constructor");
    };
    assert_eq!(class, device_sample_class_symbol());

    let args = args
        .iter()
        .map(|expr| cx.factory().expr(expr.clone()))
        .collect::<sim_kernel::Result<Vec<_>>>()
        .unwrap();
    let decoded = cx.read_construct(&class, args).unwrap();
    let decoded = decoded
        .object()
        .downcast_ref::<DeviceSampleValue>()
        .unwrap();
    assert_eq!(decoded.device_caps().unwrap(), sample);
}

#[test]
fn install_device_stream_base_registers_class_once() {
    let mut cx = cx();
    install_device_stream_base(&mut cx).unwrap();
    install_device_stream_base(&mut cx).unwrap();
    assert!(
        cx.registry()
            .class_by_symbol(&device_sample_class_symbol())
            .is_some()
    );
}