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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use std::{any::Any, sync::Arc};

use super::{check_value_report, satisfies_shape_predicate};
use crate::{
    ClaimPattern, ClassRef, Cx, MatchScore, Object, Ref, Result, Shape, ShapeDoc, ShapeMatch,
    Symbol, Value, Visibility, fact_private_capability,
};

struct TestShape {
    accepted: bool,
}

impl Shape for TestShape {
    fn symbol(&self) -> Option<Symbol> {
        Some(Symbol::qualified("test", "shape-report-shape"))
    }

    fn check_value(&self, _cx: &mut Cx, _value: Value) -> Result<ShapeMatch> {
        if self.accepted {
            Ok(ShapeMatch::accept(MatchScore::exact(9)))
        } else {
            Ok(ShapeMatch::reject("shape report rejected value"))
        }
    }

    fn check_expr(&self, _cx: &mut Cx, _expr: &crate::Expr) -> Result<ShapeMatch> {
        Ok(ShapeMatch::accept(MatchScore::exact(3)))
    }

    fn describe(&self, _cx: &mut Cx) -> Result<ShapeDoc> {
        Ok(ShapeDoc::new("test shape"))
    }
}

struct OpaqueTarget {
    publish: bool,
}

impl Object for OpaqueTarget {
    fn display(&self, _cx: &mut Cx) -> Result<String> {
        Ok("#<opaque-target>".to_owned())
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

impl crate::ObjectCompat for OpaqueTarget {
    fn class(&self, cx: &mut Cx) -> Result<ClassRef> {
        cx.factory().nil()
    }
    fn publish_shape_satisfaction_claims(&self, _cx: &mut Cx, _shape: &Ref) -> Result<bool> {
        Ok(self.publish)
    }
}

use crate::testing::bare_cx as cx;

fn shape_value(cx: &mut Cx, accepted: bool) -> Value {
    cx.factory()
        .opaque(Arc::new(TestShape { accepted }))
        .unwrap()
}

fn opaque_value(cx: &mut Cx, publish: bool) -> Value {
    cx.factory()
        .opaque(Arc::new(OpaqueTarget { publish }))
        .unwrap()
}

#[test]
fn successful_check_produces_report() {
    let mut cx = cx();
    let shape = shape_value(&mut cx, true);
    let value = cx.factory().string("stable".to_owned()).unwrap();

    let report = check_value_report(&mut cx, &shape, value).unwrap();

    assert!(report.accepted);
    assert_eq!(report.score, MatchScore::exact(9));
    assert_eq!(
        report.shape,
        Ref::Symbol(Symbol::qualified("test", "shape-report-shape"))
    );
    assert!(matches!(report.target, Ref::Content(_)));
    assert!(matches!(report.captures, Ref::Content(_)));
    assert!(matches!(report.id, Ref::Content(_)));
}

#[test]
fn successful_stable_target_inserts_satisfaction_claim() {
    let mut cx = cx();
    let shape = shape_value(&mut cx, true);
    let value = cx.factory().string("stable".to_owned()).unwrap();

    let report = check_value_report(&mut cx, &shape, value).unwrap();
    let claims = cx
        .query_facts(ClaimPattern::exact(
            report.target.clone(),
            satisfies_shape_predicate(),
            report.shape.clone(),
        ))
        .unwrap();

    assert_eq!(claims.len(), 1);
    assert_eq!(claims[0].evidence, vec![report.id.clone()]);
    assert_eq!(claims[0].visibility, Visibility::Public);
}

#[test]
fn failed_check_produces_report_without_satisfaction_claim() {
    let mut cx = cx();
    let shape = shape_value(&mut cx, false);
    let value = cx.factory().string("stable".to_owned()).unwrap();

    let report = check_value_report(&mut cx, &shape, value).unwrap();
    let claims = cx
        .query_facts(ClaimPattern::exact(
            report.target.clone(),
            satisfies_shape_predicate(),
            report.shape.clone(),
        ))
        .unwrap();

    assert!(!report.accepted);
    assert!(!report.diagnostics.is_empty());
    assert!(claims.is_empty());
}

#[test]
fn live_handle_satisfaction_claim_is_private_by_default() {
    let mut cx = cx();
    let shape = shape_value(&mut cx, true);
    let value = opaque_value(&mut cx, false);

    let report = check_value_report(&mut cx, &shape, value).unwrap();
    let pattern = ClaimPattern::exact(
        report.target.clone(),
        satisfies_shape_predicate(),
        report.shape.clone(),
    );

    assert!(matches!(report.target, Ref::Handle(_)));
    assert!(cx.query_facts(pattern.clone()).unwrap().is_empty());
    cx.grant(fact_private_capability());
    let claims = cx.query_facts(pattern).unwrap();
    assert_eq!(claims.len(), 1);
    assert_eq!(claims[0].visibility, Visibility::Private);
}

#[test]
fn live_handle_owner_can_publish_satisfaction_claim() {
    let mut cx = cx();
    let shape = shape_value(&mut cx, true);
    let value = opaque_value(&mut cx, true);

    let report = check_value_report(&mut cx, &shape, value).unwrap();
    let claims = cx
        .query_facts(ClaimPattern::exact(
            report.target.clone(),
            satisfies_shape_predicate(),
            report.shape.clone(),
        ))
        .unwrap();

    assert!(matches!(report.target, Ref::Handle(_)));
    assert_eq!(claims.len(), 1);
    assert_eq!(claims[0].visibility, Visibility::Public);
}