sim-kernel 0.1.0-rc.1

SIM workspace package for sim kernel.
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

use crate::{
    CapabilityName, Consistency, Cx, Diagnostic, EvalFabric, EvalMode, EvalReply, EvalRequest,
    EventKind, EventSource, Expr, ObserveMode, RealizeRequest, Result, Value, realize_events,
    realize_final,
};

#[derive(Clone)]
struct StaticFabric {
    reply: EvalReply,
}

impl EvalFabric for StaticFabric {
    fn realize(&self, _cx: &mut Cx, _request: EvalRequest) -> Result<EvalReply> {
        Ok(self.reply.clone())
    }
}

fn request(expr: Expr) -> EvalRequest {
    EvalRequest {
        expr,
        result_shape: None,
        required_capabilities: Vec::new(),
        deadline: None,
        consistency: Consistency::LocalFirst,
        mode: EvalMode::Eval,
        answer_limit: None,
        stream_buffer: None,
        stream: false,
        trace: false,
    }
}

fn reply(value: Value) -> EvalReply {
    EvalReply {
        value,
        diagnostics: Vec::new(),
        trace: None,
    }
}

#[test]
fn eventful_realize_source_drains_to_final_then_done() {
    let mut cx = Cx::stub();
    let value = cx.factory().string("ok".to_owned()).unwrap();
    let fabric = StaticFabric {
        reply: reply(value.clone()),
    };

    let source = realize_events(&mut cx, &fabric, request(Expr::String("task".to_owned())))
        .expect("event source");
    let mut kinds = Vec::new();
    while let Some(event) = source.next(&mut cx).unwrap() {
        kinds.push(event.kind);
    }

    assert!(matches!(kinds.first(), Some(EventKind::Started { .. })));
    assert!(matches!(
        kinds.get(kinds.len().saturating_sub(2)),
        Some(EventKind::Final(_))
    ));
    assert!(matches!(kinds.last(), Some(EventKind::Done)));
}

#[test]
fn eventful_realize_drains_back_to_eval_reply() {
    let mut cx = Cx::stub();
    let value = cx.factory().string("final".to_owned()).unwrap();
    let fabric = StaticFabric {
        reply: reply(value.clone()),
    };

    let drained = realize_final(&mut cx, &fabric, request(Expr::Nil)).unwrap();

    assert_eq!(drained.value, value);
    assert!(drained.diagnostics.is_empty());
    assert!(drained.trace.is_none());
}

#[test]
fn diagnostics_survive_eventful_realize() {
    let mut cx = Cx::stub();
    let value = cx.factory().nil().unwrap();
    let diagnostic = Diagnostic::info("kept");
    let fabric = StaticFabric {
        reply: EvalReply {
            value,
            diagnostics: vec![diagnostic.clone()],
            trace: None,
        },
    };

    let drained = realize_final(&mut cx, &fabric, request(Expr::Nil)).unwrap();

    assert_eq!(drained.diagnostics, vec![diagnostic]);
}

#[test]
fn trace_survives_eventful_realize() {
    let mut cx = Cx::stub();
    let value = cx.factory().nil().unwrap();
    let trace = cx.factory().string("trace".to_owned()).unwrap();
    let fabric = StaticFabric {
        reply: EvalReply {
            value,
            diagnostics: Vec::new(),
            trace: Some(trace.clone()),
        },
    };

    let drained = realize_final(&mut cx, &fabric, request(Expr::Nil)).unwrap();

    assert_eq!(drained.trace, Some(trace));
}

#[test]
fn old_eval_request_observation_flags_map_to_realize_request() {
    let mut cx = Cx::stub();
    let mut streaming = request(Expr::Nil);
    streaming.stream = true;
    streaming.trace = true;
    streaming.stream_buffer = Some(8);
    streaming.required_capabilities = vec![CapabilityName::new("demo")];

    let eventful = RealizeRequest::from_eval_request(&mut cx, &streaming).unwrap();
    let back = eventful.to_eval_request(&mut cx).unwrap();

    assert_eq!(eventful.observe, ObserveMode::Events);
    assert_eq!(eventful.buffer_limit, Some(8));
    assert_eq!(
        eventful.required_capabilities,
        vec![CapabilityName::new("demo")]
    );
    assert!(back.stream);
    assert!(back.trace);
    assert_eq!(back.stream_buffer, Some(8));
}