packr 0.5.1

A WebAssembly package runtime with extended WIT support for recursive types
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

//! Interface enforcement tests
//!
//! Tests that validate WASM modules implement WIT interfaces correctly.

use packr::parser::parse_interface;
use packr::runtime::InterfaceError;
use packr::Runtime;

/// A module with the correct Graph ABI signature: (i32, i32) -> i64
const VALID_PROCESS_MODULE: &str = r#"
(module
    (memory (export "memory") 1)

    ;; process: takes (ptr, len), returns packed (out_ptr, out_len)
    (func $process (param $in_ptr i32) (param $in_len i32) (result i64)
        ;; Just return the same pointer/length (echo behavior)
        (i64.or
            (i64.extend_i32_u (local.get $in_ptr))
            (i64.shl
                (i64.extend_i32_u (local.get $in_len))
                (i64.const 32)))
    )
    (export "process" (func $process))
)
"#;

/// A module with wrong signature: (i32, i32) -> i32 instead of i64
const WRONG_SIGNATURE_MODULE: &str = r#"
(module
    (memory (export "memory") 1)

    (func $process (param $in_ptr i32) (param $in_len i32) (result i32)
        (local.get $in_ptr)
    )
    (export "process" (func $process))
)
"#;

/// A module missing the required function
const MISSING_FUNCTION_MODULE: &str = r#"
(module
    (memory (export "memory") 1)

    (func $other (param $x i32) (result i32)
        (local.get $x)
    )
    (export "other" (func $other))
)
"#;

/// A module missing memory export
const NO_MEMORY_MODULE: &str = r#"
(module
    (func $process (param $in_ptr i32) (param $in_len i32) (result i64)
        (i64.const 0)
    )
    (export "process" (func $process))
)
"#;

/// A module with multiple functions
const MULTI_FUNCTION_MODULE: &str = r#"
(module
    (memory (export "memory") 1)

    (func $parse (param $in_ptr i32) (param $in_len i32) (result i64)
        (i64.or
            (i64.extend_i32_u (local.get $in_ptr))
            (i64.shl (i64.extend_i32_u (local.get $in_len)) (i64.const 32)))
    )

    (func $eval (param $in_ptr i32) (param $in_len i32) (result i64)
        (i64.or
            (i64.extend_i32_u (local.get $in_ptr))
            (i64.shl (i64.extend_i32_u (local.get $in_len)) (i64.const 32)))
    )

    (export "parse" (func $parse))
    (export "eval" (func $eval))
)
"#;

#[test]
fn valid_module_passes_validation() {
    let interface = parse_interface(
        r#"
        interface api {
            process: func(input: string) -> string;
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(VALID_PROCESS_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    // Should pass validation
    let result = instance.validate_interface(&interface);
    assert!(result.is_ok(), "Expected Ok, got {:?}", result);
}

#[test]
fn wrong_signature_fails_validation() {
    let interface = parse_interface(
        r#"
        interface api {
            process: func(input: string) -> string;
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(WRONG_SIGNATURE_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(matches!(
        result,
        Err(InterfaceError::SignatureMismatch { name, .. }) if name == "process"
    ));
}

#[test]
fn missing_function_fails_validation() {
    let interface = parse_interface(
        r#"
        interface api {
            process: func(input: string) -> string;
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(MISSING_FUNCTION_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(matches!(
        result,
        Err(InterfaceError::MissingFunction { name }) if name == "process"
    ));
}

#[test]
fn missing_memory_fails_validation() {
    let interface = parse_interface(
        r#"
        interface api {
            process: func(input: string) -> string;
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(NO_MEMORY_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(matches!(result, Err(InterfaceError::MissingMemory)));
}

#[test]
fn multi_function_interface_validation() {
    let interface = parse_interface(
        r#"
        interface lisp {
            variant sexpr {
                sym(string),
                num(s64),
                lst(list<sexpr>),
            }

            parse: func(input: string) -> result<sexpr, string>;
            eval: func(expr: sexpr) -> result<sexpr, string>;
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(MULTI_FUNCTION_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(result.is_ok(), "Expected Ok, got {:?}", result);
}

#[test]
fn partial_implementation_fails_validation() {
    let interface = parse_interface(
        r#"
        interface lisp {
            parse: func(input: string) -> string;
            eval: func(expr: string) -> string;
            compile: func(expr: string) -> string;
        }
    "#,
    )
    .expect("parse interface");

    // Module only has parse and eval, missing compile
    let wasm_bytes = wat::parse_str(MULTI_FUNCTION_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(matches!(
        result,
        Err(InterfaceError::MissingFunction { name }) if name == "compile"
    ));
}

#[test]
fn export_block_functions_validated() {
    let interface = parse_interface(
        r#"
        interface api {
            export api {
                process: func(input: string) -> string;
            }
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(VALID_PROCESS_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(result.is_ok(), "Expected Ok, got {:?}", result);
}

#[test]
fn export_block_missing_function_fails() {
    let interface = parse_interface(
        r#"
        interface api {
            export api {
                process: func(input: string) -> string;
                transform: func(input: string) -> string;
            }
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(VALID_PROCESS_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(matches!(
        result,
        Err(InterfaceError::MissingFunction { name }) if name == "transform"
    ));
}

#[test]
fn empty_interface_always_passes() {
    let interface = parse_interface(
        r#"
        interface empty {
        }
    "#,
    )
    .expect("parse interface");

    let wasm_bytes = wat::parse_str(VALID_PROCESS_MODULE).expect("parse WAT");
    let runtime = Runtime::new();
    let module = runtime.load_module(&wasm_bytes).expect("load module");
    let mut instance = module.instantiate().expect("instantiate");

    let result = instance.validate_interface(&interface);
    assert!(result.is_ok(), "Expected Ok, got {:?}", result);
}