cadmpeg-codec-sat 0.6.2

Inspect and decode bare ASM .sat/.sab/.smt/.smb B-rep streams.
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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
// SPDX-License-Identifier: Apache-2.0
//! The registry is the oracle for the pinned ids, so the test reads it rather
//! than a second copy of the list.

#![allow(clippy::unwrap_used)]

use cadmpeg_test_support::wire;

use super::{
    classify, dialect_loss, layers, Family, RecordStreamStart, StreamEvidence, TextEvidence,
    DECLARED_ENCODING, DECLARED_TERMINATOR,
};
use crate::loss::SatLossCode;
use crate::test_support::test_streams::{
    acis_text_sphere_stream, binary_sphere_stream, text_sphere_stream, BinaryFixtureKind,
    UNVERIFIED_SAVE_FORMAT,
};
use crate::SatCodec;
use crate::FORMAT;
use cadmpeg_asm::dialect::{DECLARED_SAVE_FORMAT_MAJOR, DECLARED_SAVE_FORMAT_MINOR};
use cadmpeg_asm::kernel_header::{BinaryHeader, KernelHeader};
use cadmpeg_asm::sat;
use cadmpeg_core::decode::InspectOptions;
use cadmpeg_core::dialect::{Admission, DialectId, Grammar};
use cadmpeg_ir::codec::{Codec, DecodeOptions};
use std::io::Cursor;

#[test]
fn enum_and_registry_rows_are_closed_bidirectionally() -> Result<(), Box<dyn std::error::Error>> {
    let kernel = header(None);
    let reportable = [
        StreamEvidence::Binary {
            family: Family::Asm,
            header: &kernel,
            stream: Some(RecordStreamStart(0)),
        },
        StreamEvidence::Binary {
            family: Family::Acis,
            header: &kernel,
            stream: Some(RecordStreamStart(0)),
        },
        StreamEvidence::Text(None),
    ]
    .map(|evidence| evidence.dialect());
    cadmpeg_test_support::assert_dialect_rows_closed(&reportable, FORMAT)?;
    Ok(())
}

/// A kernel header declaring `save_format_version` and nothing else that
/// classification reads.
fn header(save_format_version: Option<u32>) -> BinaryHeader {
    BinaryHeader {
        width: cadmpeg_asm::kernel_header::RefWidth::Four,
        metadata: KernelHeader {
            save_format_version,
            entity_count: None,
            flags: None,
            product_family: None,
            product_version: None,
            save_date: None,
            scale: None,
            linear: None,
            angular: None,
        },
    }
}

#[test]
fn only_the_acis_kernel_branches_are_banded() {
    for version in [Some(10_000), Some(21_700), Some(21_800), Some(23_200), None] {
        let kernel = header(version);
        // Stated as the raw declared word, not as a second call to the code
        // under test.
        let verified = matches!(version, Some(21_700..=21_899));
        let nearest = if matches!(version, Some(23_200)) {
            "acis:save-format-218"
        } else {
            "acis:save-format-217"
        };

        for asm in [
            StreamEvidence::Binary {
                family: Family::Asm,
                header: &kernel,
                stream: Some(RecordStreamStart(0)),
            },
            StreamEvidence::Text(Some(TextEvidence {
                branch: sat::Terminator::Asm,
                header: &kernel.metadata,
            })),
        ] {
            let (host, kernel) = layers(&asm);
            assert_eq!(host.admission(), &Admission::Admitted, "{version:?}");
            assert_eq!(kernel.admission(), &Admission::Admitted, "{version:?}");
        }

        let (host, matched) = layers(&StreamEvidence::Binary {
            family: Family::Acis,
            header: &kernel,
            stream: Some(RecordStreamStart(0)),
        });
        assert_eq!(host.admission(), &Admission::Admitted, "{version:?}");
        if verified {
            assert_eq!(matched.admission(), &Admission::Admitted, "{version:?}");
            assert!(dialect_loss(&matched).is_none(), "{version:?}");
        } else {
            assert!(
                matches!(matched.admission(), Admission::Unverified { .. }),
                "{version:?}"
            );
            assert_eq!(
                matched.using(),
                Some(DialectId::parse(nearest).expect("test id has dialect grammar")),
                "{version:?}"
            );
            let loss = dialect_loss(&matched).expect("the recovery is charged");
            assert_eq!(loss.code, SatLossCode::SourceDialectUnverified.kind());
            assert!(loss.message.contains(nearest), "{}", loss.message);
        }

        let (host, matched) = layers(&StreamEvidence::Text(Some(TextEvidence {
            branch: sat::Terminator::Acis,
            header: &kernel.metadata,
        })));
        assert_eq!(host.admission(), &Admission::Admitted, "{version:?}");
        if verified {
            assert_eq!(matched.admission(), &Admission::Admitted, "{version:?}");
            assert!(dialect_loss(&matched).is_none(), "{version:?}");
        } else {
            assert_eq!(matched.admission(), &Admission::Residual, "{version:?}");
            let loss = dialect_loss(&matched).expect("the recovery is charged");
            assert_eq!(loss.code, SatLossCode::SourceDialectUnverified.kind());
            assert!(
                !loss.message.contains("acis:save-format"),
                "{}",
                loss.message
            );
            assert!(loss
                .message
                .contains("no declared save-band grammar as a substitute"));
        }
    }
}

#[test]
fn a_stream_that_stops_at_its_own_discriminant_is_refused() {
    let kernel = header(None);
    // The three identified rows are shared by inspect and decode refusal.
    for (evidence, id) in [
        (
            StreamEvidence::Binary {
                family: Family::Asm,
                header: &kernel,
                stream: None,
            },
            "sat:asm-binary",
        ),
        (
            StreamEvidence::Binary {
                family: Family::Acis,
                header: &kernel,
                stream: None,
            },
            "sat:acis-binary",
        ),
        (StreamEvidence::Text(None), "sat:text"),
    ] {
        let (matched, _) = layers(&evidence);
        assert_eq!(matched.dialect().as_str(), id);
        assert_eq!(matched.admission(), &Admission::Refused, "{id}");
    }
}

#[test]
fn the_recovery_loss_is_charged_exactly_on_the_unverified_admission() {
    // The biconditional §7 requires: `Unverified`/`Residual` and the
    // `source.kernel-dialect-unverified` charge are the same fact, read from one
    // place. `Refused` here is structural — the discriminant matched and the
    // stream did not frame — and carries no recovery mark.
    let verified = header(Some(21_800));
    let unverified = header(Some(UNVERIFIED_SAVE_FORMAT));
    for evidence in [
        StreamEvidence::Binary {
            family: Family::Asm,
            header: &verified,
            stream: Some(RecordStreamStart(0)),
        },
        StreamEvidence::Binary {
            family: Family::Asm,
            header: &unverified,
            stream: Some(RecordStreamStart(0)),
        },
        StreamEvidence::Binary {
            family: Family::Asm,
            header: &verified,
            stream: None,
        },
        StreamEvidence::Binary {
            family: Family::Acis,
            header: &verified,
            stream: Some(RecordStreamStart(0)),
        },
        StreamEvidence::Binary {
            family: Family::Acis,
            header: &unverified,
            stream: Some(RecordStreamStart(0)),
        },
        StreamEvidence::Binary {
            family: Family::Acis,
            header: &verified,
            stream: None,
        },
        StreamEvidence::Text(Some(TextEvidence {
            branch: sat::Terminator::Asm,
            header: &unverified.metadata,
        })),
        StreamEvidence::Text(Some(TextEvidence {
            branch: sat::Terminator::Acis,
            header: &unverified.metadata,
        })),
        StreamEvidence::Text(None),
    ] {
        let (_, matched) = layers(&evidence);
        assert_eq!(
            matches!(
                matched.admission(),
                Admission::Unverified { .. } | Admission::Residual
            ),
            dialect_loss(&matched).is_some(),
            "{:?}",
            matched.admission()
        );
    }
}

#[test]
fn the_declared_keys_are_pinned() {
    let kernel = header(Some(21_804));

    let binary = classify(&StreamEvidence::Binary {
        family: Family::Acis,
        header: &kernel,
        stream: Some(RecordStreamStart(0)),
    })
    .declared()
    .clone();
    assert_eq!(binary[DECLARED_ENCODING], "binary");
    assert!(!binary.contains_key(DECLARED_SAVE_FORMAT_MAJOR));
    assert!(!binary.contains_key(DECLARED_SAVE_FORMAT_MINOR));
    assert!(!binary.contains_key(DECLARED_TERMINATOR));

    let text = classify(&StreamEvidence::Text(Some(TextEvidence {
        branch: sat::Terminator::Acis,
        header: &kernel.metadata,
    })))
    .declared()
    .clone();
    assert_eq!(text[DECLARED_ENCODING], "text");
    assert_eq!(text[DECLARED_TERMINATOR], "End-of-ACIS-data");
    assert!(!text.contains_key(DECLARED_SAVE_FORMAT_MAJOR));
    assert!(!text.contains_key(DECLARED_SAVE_FORMAT_MINOR));

    let asm_text = classify(&StreamEvidence::Text(Some(TextEvidence {
        branch: sat::Terminator::Asm,
        header: &kernel.metadata,
    })))
    .declared()
    .clone();
    assert_eq!(asm_text[DECLARED_TERMINATOR], "End-of-ASM-data");

    // An absent save-format word declares no band, which is a different
    // statement from a declaration of zero.
    let silent = classify(&StreamEvidence::Binary {
        family: Family::Asm,
        header: &header(None),
        stream: Some(RecordStreamStart(0)),
    })
    .declared()
    .clone();
    assert!(!silent.contains_key(DECLARED_SAVE_FORMAT_MAJOR));
    assert!(!silent.contains_key(DECLARED_SAVE_FORMAT_MINOR));
}

/// An ACIS-terminated text stream at `save_format_version`.
///
/// The product strings name ASM while the terminator names ACIS, which is the
/// asymmetry the gate must ignore: the branch comes from the terminator line.
fn acis_text(save_format_version: u32) -> Vec<u8> {
    format!(
        "{save_format_version} 0 1 0 \n\
         16 Autodesk Neutron 21 ASM 232.4.0.65535 OSX 9 Synthetic \n\
         1 1e-06 1.0e-10 \n\
         body $-1 -1 $-1 $-1 $-1 $-1 #\n\
         End-of-ACIS-data \n"
    )
    .into_bytes()
}

/// One end-to-end case: real bytes, the row they must classify into, and
/// whether semantic decode is admitted.
struct Case {
    label: &'static str,
    bytes: Vec<u8>,
    id: &'static str,
    kernel_id: &'static str,
    kernel_admission: Admission,
}

fn cases() -> Vec<Case> {
    vec![
        Case {
            label: "asm text sphere",
            bytes: text_sphere_stream(1.0),
            id: "sat:text",
            kernel_id: "acis:text-asm",
            kernel_admission: Admission::Admitted,
        },
        Case {
            label: "asm binary sphere",
            bytes: binary_sphere_stream(BinaryFixtureKind::Asm),
            id: "sat:asm-binary",
            kernel_id: "acis:asm-binaryfile-8",
            kernel_admission: Admission::Admitted,
        },
        Case {
            label: "acis binary sphere at 218",
            bytes: binary_sphere_stream(BinaryFixtureKind::Acis),
            id: "sat:acis-binary",
            kernel_id: "acis:save-format-218",
            kernel_admission: Admission::Admitted,
        },
        Case {
            label: "acis text at 700",
            bytes: acis_text(700),
            id: "sat:text",
            kernel_id: "acis:text-acis",
            kernel_admission: Admission::Residual,
        },
        Case {
            label: "acis text sphere outside the verified band",
            bytes: acis_text_sphere_stream(UNVERIFIED_SAVE_FORMAT),
            id: "sat:text",
            kernel_id: "acis:text-acis",
            kernel_admission: Admission::Residual,
        },
        Case {
            label: "acis binary sphere outside the verified band",
            bytes: binary_sphere_stream(BinaryFixtureKind::AcisUnverifiedBand),
            id: "sat:acis-binary",
            kernel_id: "acis:save-format-binary-other",
            kernel_admission: Admission::Unverified {
                using: Grammar::of(&cadmpeg_asm::dialect::ACIS_SAVE_FORMAT_218),
            },
        },
        Case {
            label: "acis text at 218",
            bytes: acis_text(21_800),
            id: "sat:text",
            kernel_id: "acis:text-acis",
            kernel_admission: Admission::Admitted,
        },
    ]
}

#[test]
fn decode_admission_matches_the_stream_and_carries_the_recovery_mark() {
    // End to end on real bytes: the admission the decode reports, and the
    // recovery loss charged exactly with it.
    let recovery = SatLossCode::SourceDialectUnverified.kind();
    for case in cases() {
        let result = SatCodec
            .decode(
                &mut Cursor::new(case.bytes.clone()),
                &DecodeOptions::default(),
            )
            .unwrap_or_else(|error| panic!("{}: {error}", case.label));
        let charged = result
            .report()
            .losses
            .iter()
            .any(|loss| loss.code == recovery);
        let matched = result
            .report()
            .dialects()
            .expect("SAT reports dialect layers")
            .primary();

        assert_eq!(matched.admission(), &Admission::Admitted, "{}", case.label);
        let kernel = result
            .report()
            .dialects()
            .as_ref()
            .expect("SAT reports dialect layers")
            .iter()
            .nth(1)
            .expect("SAT reports its ACIS layer");
        assert_eq!(kernel.admission(), &case.kernel_admission, "{}", case.label);
        assert_eq!(
            matches!(
                kernel.admission(),
                Admission::Unverified { .. } | Admission::Residual
            ),
            charged,
            "{}: admission and the recovery mark must agree",
            case.label
        );
    }
}

#[test]
fn an_unverified_band_recovers_the_same_solid_as_the_verified_one() {
    // The recovery is real, not a relabelled refusal: the same records under a
    // band no row verifies decode to the same solid, in both encodings.
    for (label, bytes) in [
        ("text", acis_text_sphere_stream(UNVERIFIED_SAVE_FORMAT)),
        (
            "binary",
            binary_sphere_stream(BinaryFixtureKind::AcisUnverifiedBand),
        ),
    ] {
        let result = SatCodec
            .decode(&mut Cursor::new(bytes), &DecodeOptions::default())
            .unwrap_or_else(|error| panic!("{label}: {error}"));
        assert!(result.report().geometry_transferred(), "{label}");
        assert_eq!(result.ir().model.bodies.len(), 1, "{label}");
        assert_eq!(result.ir().model.faces.len(), 1, "{label}");
        assert_eq!(result.ir().model.surfaces.len(), 1, "{label}");
        assert_eq!(
            wire::coverage(result.report())["unknown_records"],
            0,
            "{label}"
        );
    }
}

#[test]
fn decode_reports_exactly_one_primary_layer_match_and_mirrors_it_into_the_source() {
    for case in cases() {
        let result = SatCodec
            .decode(
                &mut Cursor::new(case.bytes.clone()),
                &DecodeOptions::default(),
            )
            .unwrap_or_else(|error| panic!("{}: {error}", case.label));
        let dialects = result
            .report()
            .dialects()
            .expect("SAT reports dialect layers");

        assert_eq!(dialects.iter().count(), 2, "{}", case.label);
        let matched = dialects.primary();
        assert_eq!(matched.format(), FORMAT, "{}", case.label);
        assert_eq!(matched.dialect().as_str(), case.id, "{}", case.label);
        let kernel = dialects.iter().nth(1).expect("SAT reports its ACIS layer");
        assert_eq!(kernel.format(), "acis", "{}", case.label);
        assert_eq!(kernel.dialect().as_str(), case.kernel_id, "{}", case.label);

        // Identity survives refusal: the empty-IR result carries the same row.
        let source = result.ir().source.as_ref().expect("source metadata");
        assert_eq!(source.dialect(), Some(matched), "{}", case.label);
        assert!(
            !source.dialect().unwrap().declared().is_empty(),
            "{}: every stream declares at least its encoding",
            case.label
        );
    }
}

#[test]
fn inspect_and_decode_agree_on_the_row_and_the_admission() {
    for case in cases() {
        let summary = SatCodec
            .inspect(
                &mut Cursor::new(case.bytes.clone()),
                &InspectOptions::default(),
            )
            .unwrap_or_else(|error| panic!("{}: {error}", case.label));
        let decoded = SatCodec
            .decode(
                &mut Cursor::new(case.bytes.clone()),
                &DecodeOptions::default(),
            )
            .unwrap_or_else(|error| panic!("{}: {error}", case.label));

        assert_eq!(
            summary
                .dialects()
                .as_ref()
                .expect("SAT inspection reports dialect layers")
                .iter()
                .count(),
            2,
            "{}",
            case.label
        );
        assert_eq!(
            summary.dialects(),
            decoded.report().dialects(),
            "{}: inspect and decode read the same evidence",
            case.label
        );
    }
}

#[test]
fn a_stream_matching_no_discriminant_never_reaches_a_report() {
    // `sat:unknown` is unreachable through the normal catalog: detection
    // reports no confidence, and both entry points refuse the bytes outright.
    let bytes = b"not a stream at all".to_vec();
    assert!(SatCodec
        .inspect(&mut Cursor::new(bytes.clone()), &InspectOptions::default())
        .is_err());
    assert!(SatCodec
        .decode(&mut Cursor::new(bytes), &DecodeOptions::default())
        .is_err());
}