golem-schema 1.6.2

Golem schema and value model
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

use super::*;
use crate::schema::graph::{SchemaGraph, SchemaTypeDef};
use crate::schema::metadata::TypeId;
use crate::schema::schema_type::{NamedFieldType, VariantCaseType};
use crate::schema::tool::{CommandTree, Doc, MonomorphicToolMiddlewareScope, ToolMiddlewareScope};
use test_r::test;

fn tool(name: &str) -> Tool {
    Tool {
        version: "1.0.0".to_string(),
        requires_filesystem: false,
        commands: CommandTree {
            nodes: vec![CommandNode {
                name: name.to_string(),
                aliases: vec![],
                doc: Doc::default(),
                globals: Globals::default(),
                subcommands: vec![],
                body: None,
            }],
        },
        schema: SchemaGraph::empty(),
    }
}

#[test]
fn rejects_malformed_middleware_identity_and_both_embedded_tools() {
    let middleware = ToolMiddleware {
        name: "Bad_Name".to_string(),
        version: "middleware-v3".to_string(),
        aliases: vec!["Bad_Name".to_string()],
        doc: Doc::default(),
        scope: ToolMiddlewareScope::Monomorphic(Box::new(MonomorphicToolMiddlewareScope {
            presented: tool("BadPresented"),
            expected: Some(tool("BadExpected")),
        })),
        parameter_schema: SchemaGraph::empty(),
    };

    let errors = validate_tool_middleware(&middleware).unwrap_err();
    assert!(errors.iter().any(|e| matches!(
        e,
        ToolMiddlewareValidationError::InvalidIdentifier {
            kind: "tool middleware name",
            ..
        }
    )));
    assert!(
        errors
            .iter()
            .any(|e| matches!(e, ToolMiddlewareValidationError::DuplicateIdentity { .. }))
    );
    assert!(
        errors
            .iter()
            .any(|e| matches!(e, ToolMiddlewareValidationError::InvalidPresentedTool(_)))
    );
    assert!(
        errors
            .iter()
            .any(|e| matches!(e, ToolMiddlewareValidationError::InvalidExpectedTool(_)))
    );
}

#[test]
fn rejects_empty_tool_and_middleware_versions() {
    let mut invalid_tool = tool("valid");
    invalid_tool.version.clear();
    assert!(
        validate_tool(&invalid_tool)
            .unwrap_err()
            .contains(&ToolValidationError::EmptyVersion)
    );
    let middleware = ToolMiddleware {
        name: "valid".into(),
        version: " ".into(),
        aliases: vec![],
        doc: Doc::default(),
        scope: ToolMiddlewareScope::Universal,
        parameter_schema: SchemaGraph::empty(),
    };
    assert_eq!(
        validate_tool_middleware(&middleware).unwrap_err(),
        vec![ToolMiddlewareValidationError::EmptyVersion]
    );
}

fn universal_middleware(parameter_schema: SchemaGraph) -> ToolMiddleware {
    ToolMiddleware {
        name: "valid".into(),
        version: "1".into(),
        aliases: vec![],
        doc: Doc::default(),
        scope: ToolMiddlewareScope::Universal,
        parameter_schema,
    }
}

#[test]
fn accepts_static_record_and_variant_parameter_schema() {
    let schema = SchemaGraph::anonymous(SchemaType::Record {
        fields: vec![NamedFieldType {
            name: "mode".into(),
            body: SchemaType::Variant {
                cases: vec![VariantCaseType {
                    name: "named".into(),
                    payload: Some(SchemaType::string()),
                    metadata: Default::default(),
                }],
                metadata: Default::default(),
            },
            metadata: Default::default(),
        }],
        metadata: Default::default(),
    });
    assert!(validate_tool_middleware(&universal_middleware(schema)).is_ok());
}

#[test]
fn rejects_nested_and_definition_host_or_async_parameter_types() {
    let schema = SchemaGraph {
        defs: vec![SchemaTypeDef {
            id: TypeId::new("capability"),
            name: None,
            body: SchemaType::permission_card(Default::default()),
        }],
        root: SchemaType::tuple(vec![
            SchemaType::list(SchemaType::stream(Some(SchemaType::string()))),
            SchemaType::ref_to(TypeId::new("capability")),
        ]),
    };
    let errors = validate_tool_middleware(&universal_middleware(schema)).unwrap_err();
    assert!(
        errors.contains(&ToolMiddlewareValidationError::ForbiddenParameterType(
            "stream"
        ))
    );
    assert!(
        errors.contains(&ToolMiddlewareValidationError::ForbiddenParameterType(
            "permission-card"
        ))
    );
}

#[test]
fn rejects_malformed_parameter_graph() {
    let schema = SchemaGraph::anonymous(SchemaType::ref_to(TypeId::new("missing")));
    assert!(
        validate_tool_middleware(&universal_middleware(schema))
            .unwrap_err()
            .iter()
            .any(|error| matches!(
                error,
                ToolMiddlewareValidationError::InvalidParameterSchema(_)
            ))
    );
}