aprender-contracts 0.34.0

Papers to Math to Contracts in Code — YAML contract parsing, validation, scaffold generation, and Kani harness codegen for provable Rust kernels
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
    use super::*;

    fn test_index() -> ContractIndex {
        let dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../contracts");
        ContractIndex::build_from_directory(&dir).unwrap()
    }

    #[test]
    fn semantic_query_returns_results() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax numerical stability".to_string(),
            limit: 50, // Increased from default for 405-contract corpus
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(!output.results.is_empty());
        assert!(
            output.results.iter().any(|r| r.stem.contains("softmax")),
            "Results should include softmax contract, got: {:?}",
            output.results.iter().map(|r| &r.stem).collect::<Vec<_>>()
        );
    }

    #[test]
    fn literal_query_finds_contracts() {
        let index = test_index();
        let params = QueryParams {
            query: "RMSNorm".to_string(),
            mode: SearchMode::Literal,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(!output.results.is_empty());
    }

    #[test]
    fn regex_query_works() {
        let index = test_index();
        let params = QueryParams {
            query: r"(?i)softmax".to_string(),
            mode: SearchMode::Regex,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(!output.results.is_empty());
    }

    #[test]
    fn obligation_filter_narrows_results() {
        let index = test_index();
        let all = QueryParams {
            query: "kernel".to_string(),
            ..Default::default()
        };
        let filtered = QueryParams {
            query: "kernel".to_string(),
            obligation_filter: Some("invariant".to_string()),
            ..Default::default()
        };
        let all_out = execute(&index, &all);
        let filtered_out = execute(&index, &filtered);
        assert!(filtered_out.total_matches <= all_out.total_matches);
    }

    #[test]
    fn limit_caps_results() {
        let index = test_index();
        let params = QueryParams {
            query: "kernel".to_string(),
            limit: 3,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(output.results.len() <= 3);
    }

    #[test]
    fn show_score_enriches_results() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            show_score: true,
            limit: 1,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(!output.results.is_empty());
        assert!(output.results[0].score.is_some());
    }

    #[test]
    fn display_output_is_valid() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            limit: 2,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let text = output.to_string();
        assert!(text.contains("[1]"));
        assert!(text.contains("softmax"));
    }

    #[test]
    fn proof_status_enrichment_works() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            show_proof_status: true,
            limit: 1,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(!output.results.is_empty());
        let ps = output.results[0].proof_status.as_ref().unwrap();
        assert!(!ps.level.is_empty());
    }

    #[test]
    fn binding_enrichment_without_registry() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            show_binding: true,
            limit: 1,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(!output.results.is_empty());
        assert!(!output.results[0].bindings.is_empty());
        assert_eq!(output.results[0].bindings[0].status, "no binding registry");
    }

    #[test]
    fn binding_enrichment_with_registry() {
        let binding_path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
            .join("../../contracts/aprender/binding.yaml");
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            show_binding: true,
            binding_path: Some(binding_path.display().to_string()),
            limit: 5,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let has_bound = output.results.iter().any(|r| {
            r.bindings
                .iter()
                .any(|b| b.status != "no binding registry")
        });
        assert!(has_bound, "Should find implemented bindings");
    }

    #[test]
    fn min_score_filter_works() {
        let index = test_index();
        let high = QueryParams {
            query: "kernel".to_string(),
            min_score: Some(0.80),
            ..Default::default()
        };
        let low = QueryParams {
            query: "kernel".to_string(),
            min_score: Some(0.10),
            ..Default::default()
        };
        let high_out = execute(&index, &high);
        let low_out = execute(&index, &low);
        assert!(high_out.total_matches <= low_out.total_matches);
    }

    #[test]
    fn markdown_output_format() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            show_score: true,
            show_paper: true,
            limit: 2,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let md = output.to_markdown();
        assert!(md.contains("## Query:"));
        assert!(md.contains("### 1."));
        assert!(md.contains("**Score:**"));
    }

    #[test]
    fn empty_query_returns_empty() {
        let index = test_index();
        let params = QueryParams {
            query: String::new(),
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(output.results.is_empty());
    }

    #[test]
    fn display_with_all_enrichment() {
        let index = test_index();
        let binding_path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
            .join("../../contracts/aprender/binding.yaml");
        let params = QueryParams {
            query: "softmax".to_string(),
            show_score: true,
            show_proof_status: true,
            show_binding: true,
            show_graph: true,
            show_paper: true,
            binding_path: Some(binding_path.display().to_string()),
            limit: 2,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let text = output.to_string();
        assert!(text.contains("Score:"));
        assert!(text.contains("Proof Level:"));
    }

    #[test]
    fn markdown_with_proof_and_binding() {
        let index = test_index();
        let binding_path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
            .join("../../contracts/aprender/binding.yaml");
        let params = QueryParams {
            query: "softmax".to_string(),
            show_score: true,
            show_proof_status: true,
            show_binding: true,
            show_paper: true,
            binding_path: Some(binding_path.display().to_string()),
            limit: 2,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let md = output.to_markdown();
        assert!(md.contains("**Proof Level:**"));
        assert!(md.contains("**Bindings:**"));
        assert!(md.contains("**Papers:**"));
    }

    #[test]
    fn invalid_regex_returns_empty() {
        let index = test_index();
        let params = QueryParams {
            query: r"[invalid(".to_string(),
            mode: SearchMode::Regex,
            ..Default::default()
        };
        let output = execute(&index, &params);
        assert!(output.results.is_empty());
    }

    #[test]
    fn unproven_filter_narrows() {
        let index = test_index();
        let all = QueryParams {
            query: "kernel".to_string(),
            limit: 100,
            ..Default::default()
        };
        let unproven = QueryParams {
            query: "kernel".to_string(),
            unproven_only: true,
            limit: 100,
            ..Default::default()
        };
        let all_out = execute(&index, &all);
        let unproven_out = execute(&index, &unproven);
        assert!(unproven_out.total_matches <= all_out.total_matches);
    }

    #[test]
    fn kind_filter_narrows_to_registries() {
        use crate::schema::ContractKind;
        let index = test_index();
        let all = QueryParams {
            query: ".".to_string(),
            mode: SearchMode::Regex,
            limit: 1000,
            ..Default::default()
        };
        let registries = QueryParams {
            query: ".".to_string(),
            mode: SearchMode::Regex,
            limit: 1000,
            kind_filter: Some(ContractKind::Registry),
            ..Default::default()
        };
        let all_out = execute(&index, &all);
        let registry_out = execute(&index, &registries);
        assert!(registry_out.total_matches < all_out.total_matches);
        assert!(
            registry_out.total_matches > 0,
            "contracts dir should contain at least one registry"
        );
        // Every returned result must be a registry.
        for r in &registry_out.results {
            assert_eq!(
                r.kind,
                ContractKind::Registry,
                "{} returned by --kind registry should be Registry kind, got {:?}",
                r.stem,
                r.kind,
            );
        }
    }

    #[test]
    fn kind_filter_pattern_finds_pattern_contracts() {
        use crate::schema::ContractKind;
        let index = test_index();
        let patterns = QueryParams {
            query: ".".to_string(),
            mode: SearchMode::Regex,
            limit: 100,
            kind_filter: Some(ContractKind::Pattern),
            ..Default::default()
        };
        let output = execute(&index, &patterns);
        // Repo ships 4 pattern contracts under contracts/patterns/.
        assert!(
            output.total_matches >= 4,
            "expected >= 4 pattern contracts, got {}",
            output.total_matches,
        );
        for r in &output.results {
            assert_eq!(r.kind, ContractKind::Pattern);
        }
    }

    #[test]
    fn kind_filter_kernel_excludes_registries() {
        use crate::schema::ContractKind;
        let index = test_index();
        let kernels = QueryParams {
            query: ".".to_string(),
            mode: SearchMode::Regex,
            limit: 1000,
            kind_filter: Some(ContractKind::Kernel),
            ..Default::default()
        };
        let output = execute(&index, &kernels);
        for r in &output.results {
            assert_ne!(
                r.kind,
                ContractKind::Registry,
                "{} kernel result should not be a registry",
                r.stem,
            );
        }
    }

    #[test]
    fn depended_by_filter() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            depended_by: Some("attention-kernel-v1".to_string()),
            limit: 100,
            ..Default::default()
        };
        let output = execute(&index, &params);
        for r in &output.results {
            let att = index.get_by_stem("attention-kernel-v1").unwrap();
            assert!(
                att.depends_on.contains(&r.stem),
                "{} should be a dependency of attention-kernel-v1",
                r.stem
            );
        }
    }

    #[test]
    fn case_sensitive_literal() {
        let index = test_index();
        let insensitive = QueryParams {
            query: "rmsnorm".to_string(),
            mode: SearchMode::Literal,
            case_sensitive: false,
            limit: 100,
            ..Default::default()
        };
        let sensitive = QueryParams {
            query: "rmsnorm".to_string(),
            mode: SearchMode::Literal,
            case_sensitive: true,
            limit: 100,
            ..Default::default()
        };
        let insensitive_out = execute(&index, &insensitive);
        let sensitive_out = execute(&index, &sensitive);
        assert!(insensitive_out.total_matches >= sensitive_out.total_matches);
    }

    #[test]
    fn graph_enrichment_shows_depends() {
        let index = test_index();
        let params = QueryParams {
            query: "attention".to_string(),
            show_graph: true,
            limit: 5,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let text = output.to_string();
        let has_deps = output.results.iter().any(|r| !r.depends_on.is_empty());
        if has_deps {
            assert!(text.contains("Depends on:"));
        }
    }

    #[test]
    fn get_by_equation_works() {
        let index = test_index();
        let results = index.get_by_equation("softmax");
        assert!(!results.is_empty());
    }

    #[test]
    fn get_by_obligation_works() {
        let index = test_index();
        let results = index.get_by_obligation("invariant");
        assert!(!results.is_empty());
    }

    #[test]
    fn clean_path_strips_prefix() {
        assert_eq!(
            clean_path("/home/user/src/provable-contracts/contracts/softmax-kernel-v1.yaml"),
            "contracts/softmax-kernel-v1.yaml"
        );
        assert_eq!(
            clean_path("../../contracts/aprender/binding.yaml"),
            "contracts/aprender/binding.yaml"
        );
        assert_eq!(clean_path("no-match.yaml"), "no-match.yaml");
    }

    #[test]
    fn query_result_path_is_clean() {
        let index = test_index();
        let params = QueryParams {
            query: "softmax".to_string(),
            limit: 1,
            ..Default::default()
        };
        let output = execute(&index, &params);
        let path = &output.results[0].path;
        assert!(
            path.starts_with("contracts/"),
            "path should be relative: {path}"
        );
        assert!(!path.contains("/../"), "path should not contain /../: {path}");
    }