Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

Harden Firmament STEP export result contract

Yuechen Li905e6219e238
diff --git a/Aetheris.Kernel.Firmament.Tests/FirmamentStepExporterTests.cs b/Aetheris.Kernel.Firmament.Tests/FirmamentStepExporterTests.cs
index 21139e17..efcf46d2 100644
--- a/Aetheris.Kernel.Firmament.Tests/FirmamentStepExporterTests.cs
+++ b/Aetheris.Kernel.Firmament.Tests/FirmamentStepExporterTests.cs
@@ -5,7 +5,7 @@ namespace Aetheris.Kernel.Firmament.Tests;
public sealed class FirmamentStepExporterTests
{
[Fact]
- public void Export_SingleBoxFixture_Produces_NonEmpty_Deterministic_StepText()
+ public void Export_SingleBoxFixture_Returns_Explicit_Metadata_And_Persisted_Artifact()
{
var source = FirmamentCorpusHarness.ReadFixtureText("testdata/firmament/fixtures/m10a-valid-single-box-export.firmament");
@@ -15,35 +15,72 @@ public sealed class FirmamentStepExporterTests
Assert.True(first.IsSuccess);
Assert.True(second.IsSuccess);
Assert.Equal(FirmamentStepExporter.LastExecutedGeometricBodyPolicy, first.Value.ExportBodyPolicy);
+ Assert.Equal(FirmamentStepExporter.LastExecutedGeometricBodySelectionReason, first.Value.ExportBodySelectionReason);
Assert.Equal("base", first.Value.ExportedFeatureId);
+ Assert.Equal(0, first.Value.ExportedOpIndex);
+ Assert.Equal("primitive", first.Value.ExportedBodyCategory);
+ Assert.Equal("box", first.Value.ExportedFeatureKind);
Assert.NotEmpty(first.Value.StepText);
Assert.Contains("ISO-10303-21", first.Value.StepText, StringComparison.Ordinal);
Assert.Contains("MANIFOLD_SOLID_BREP", first.Value.StepText, StringComparison.Ordinal);
Assert.Equal(first.Value.StepText, second.Value.StepText);
- WriteExportArtifact("m10a-box.step", first.Value.StepText);
+ var artifactPath = WriteExportArtifact("m10a-box.step", first.Value.StepText);
+ Assert.True(File.Exists(artifactPath));
+ Assert.Equal(first.Value.StepText, File.ReadAllText(artifactPath));
}
[Fact]
- public void Export_PlacedPrimitiveFixture_Exports_Successfully()
+ public void Export_PlacedPrimitiveFixture_Exports_Successfully_With_Metadata_And_Deterministic_Text()
{
- var result = ExportFixture("testdata/firmament/fixtures/m10a-valid-placed-box-export.firmament");
+ var first = ExportFixture("testdata/firmament/fixtures/m10a-valid-placed-box-export.firmament");
+ var second = ExportFixture("testdata/firmament/fixtures/m10a-valid-placed-box-export.firmament");
- Assert.True(result.IsSuccess);
- Assert.Equal("placed_box", result.Value.ExportedFeatureId);
- Assert.Contains("CARTESIAN_POINT", result.Value.StepText, StringComparison.Ordinal);
+ Assert.True(first.IsSuccess);
+ Assert.True(second.IsSuccess);
+ Assert.Equal("placed_box", first.Value.ExportedFeatureId);
+ Assert.Equal(0, first.Value.ExportedOpIndex);
+ Assert.Equal("primitive", first.Value.ExportedBodyCategory);
+ Assert.Equal("box", first.Value.ExportedFeatureKind);
+ Assert.Equal(first.Value.StepText, second.Value.StepText);
+ Assert.Contains("CARTESIAN_POINT", first.Value.StepText, StringComparison.Ordinal);
}
[Fact]
- public void Export_BooleanFixture_Exports_Successfully()
+ public void Export_BooleanFixture_Exports_Successfully_With_Metadata_And_Deterministic_Text()
{
- var result = ExportFixture("testdata/firmament/fixtures/m10a-valid-boolean-export.firmament");
+ var first = ExportFixture("testdata/firmament/fixtures/m10a-valid-boolean-export.firmament");
+ var second = ExportFixture("testdata/firmament/fixtures/m10a-valid-boolean-export.firmament");
- Assert.True(result.IsSuccess);
- Assert.Equal("joined", result.Value.ExportedFeatureId);
- Assert.Contains("ADVANCED_FACE", result.Value.StepText, StringComparison.Ordinal);
+ Assert.True(first.IsSuccess);
+ Assert.True(second.IsSuccess);
+ Assert.Equal("joined", first.Value.ExportedFeatureId);
+ Assert.Equal(1, first.Value.ExportedOpIndex);
+ Assert.Equal("boolean", first.Value.ExportedBodyCategory);
+ Assert.Equal("add", first.Value.ExportedFeatureKind);
+ Assert.Equal(first.Value.StepText, second.Value.StepText);
+ Assert.Contains("ADVANCED_FACE", first.Value.StepText, StringComparison.Ordinal);
+
+ var artifactPath = WriteExportArtifact("m10a-boolean.step", first.Value.StepText);
+ Assert.True(File.Exists(artifactPath));
+ Assert.Equal(first.Value.StepText, File.ReadAllText(artifactPath));
+ }
+
+ [Fact]
+ public void Export_SchemaPresent_Model_Still_Exports_With_Stable_Metadata_And_Deterministic_Text()
+ {
+ var first = ExportFixture("testdata/firmament/fixtures/m10b-valid-schema-box-export.firmament");
+ var second = ExportFixture("testdata/firmament/fixtures/m10b-valid-schema-box-export.firmament");
- WriteExportArtifact("m10a-boolean.step", result.Value.StepText);
+ Assert.True(first.IsSuccess);
+ Assert.True(second.IsSuccess);
+ Assert.Equal("schema_box", first.Value.ExportedFeatureId);
+ Assert.Equal(0, first.Value.ExportedOpIndex);
+ Assert.Equal("primitive", first.Value.ExportedBodyCategory);
+ Assert.Equal("box", first.Value.ExportedFeatureKind);
+ Assert.Equal(first.Value.ExportBodyPolicy, second.Value.ExportBodyPolicy);
+ Assert.Equal(first.Value.ExportBodySelectionReason, second.Value.ExportBodySelectionReason);
+ Assert.Equal(first.Value.StepText, second.Value.StepText);
}
[Fact]
@@ -54,8 +91,12 @@ public sealed class FirmamentStepExporterTests
var export = FirmamentStepExporter.Export(compile.Compilation.Value);
Assert.True(export.IsSuccess);
+ Assert.Equal(FirmamentStepExporter.LastExecutedGeometricBodyPolicy, export.Value.ExportBodyPolicy);
+ Assert.Equal(FirmamentStepExporter.LastExecutedGeometricBodySelectionReason, export.Value.ExportBodySelectionReason);
Assert.Equal("cap", export.Value.ExportedFeatureId);
Assert.Equal(2, export.Value.ExportedOpIndex);
+ Assert.Equal("primitive", export.Value.ExportedBodyCategory);
+ Assert.Equal("box", export.Value.ExportedFeatureKind);
var expected = Step242Exporter.ExportBody(
compile.Compilation.Value.PrimitiveExecutionResult!.ExecutedPrimitives.Single(p => p.FeatureId == "cap").Body);
@@ -64,17 +105,17 @@ public sealed class FirmamentStepExporterTests
}
[Fact]
- public void Export_ValidationOps_Do_Not_Become_Export_Bodies()
+ public void Export_ValidationOps_Do_Not_Become_Export_Bodies_When_Final_Geometric_Body_Precedes_Validation()
{
const string source = """
firmament:
version: 1
model:
- name: validation_only_after_box
+ name: validation_after_geometry
units: mm
-ops[2]:
+ops[3]:
-
op: box
id: base
@@ -82,15 +123,27 @@ ops[2]:
2
3
4
+
+ -
+ op: box
+ id: cap
+ size[3]:
+ 5
+ 6
+ 7
+
-
op: expect_exists
- target: base
+ target: cap
""";
var result = Export(source);
Assert.True(result.IsSuccess);
- Assert.Equal("base", result.Value.ExportedFeatureId);
+ Assert.Equal("cap", result.Value.ExportedFeatureId);
+ Assert.Equal(1, result.Value.ExportedOpIndex);
+ Assert.Equal("primitive", result.Value.ExportedBodyCategory);
+ Assert.Equal("box", result.Value.ExportedFeatureKind);
}
[Fact]
@@ -118,7 +171,7 @@ ops[2]:
}
[Fact]
- public void Export_SchemaPresence_Does_Not_Change_Step_Semantics()
+ public void Export_SchemaPresence_Does_Not_Change_Step_Semantics_For_Equivalent_Geometry()
{
const string baseline = """
firmament:
@@ -165,6 +218,10 @@ ops[1]:
Assert.True(first.IsSuccess);
Assert.True(second.IsSuccess);
+ Assert.Equal(first.Value.ExportedFeatureId, second.Value.ExportedFeatureId);
+ Assert.Equal(first.Value.ExportedOpIndex, second.Value.ExportedOpIndex);
+ Assert.Equal(first.Value.ExportedBodyCategory, second.Value.ExportedBodyCategory);
+ Assert.Equal(first.Value.ExportedFeatureKind, second.Value.ExportedFeatureKind);
Assert.Equal(first.Value.StepText, second.Value.StepText);
}
@@ -180,7 +237,7 @@ ops[1]:
private static FirmamentCompileResult CompileFixture(string fixturePath) =>
FirmamentCorpusHarness.Compile(FirmamentCorpusHarness.ReadFixtureText(fixturePath));
- private static void WriteExportArtifact(string fileName, string stepText)
+ private static string WriteExportArtifact(string fileName, string stepText)
{
var path = Path.Combine(
FirmamentCorpusHarness.RepoRoot(),
@@ -191,5 +248,6 @@ ops[1]:
Directory.CreateDirectory(Path.GetDirectoryName(path)!);
File.WriteAllText(path, stepText);
+ return path;
}
}
diff --git a/Aetheris.Kernel.Firmament/FirmamentStepExportResult.cs b/Aetheris.Kernel.Firmament/FirmamentStepExportResult.cs
index e716d4f8..0b900a34 100644
--- a/Aetheris.Kernel.Firmament/FirmamentStepExportResult.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentStepExportResult.cs
@@ -4,4 +4,7 @@ public sealed record FirmamentStepExportResult(
string StepText,
string ExportedFeatureId,
int ExportedOpIndex,
- string ExportBodyPolicy = FirmamentStepExporter.LastExecutedGeometricBodyPolicy);
+ string ExportedBodyCategory,
+ string? ExportedFeatureKind = null,
+ string ExportBodyPolicy = FirmamentStepExporter.LastExecutedGeometricBodyPolicy,
+ string ExportBodySelectionReason = FirmamentStepExporter.LastExecutedGeometricBodySelectionReason);
diff --git a/Aetheris.Kernel.Firmament/FirmamentStepExporter.cs b/Aetheris.Kernel.Firmament/FirmamentStepExporter.cs
index 1a930c22..ff38226b 100644
--- a/Aetheris.Kernel.Firmament/FirmamentStepExporter.cs
+++ b/Aetheris.Kernel.Firmament/FirmamentStepExporter.cs
@@ -10,6 +10,7 @@ namespace Aetheris.Kernel.Firmament;
public static class FirmamentStepExporter
{
public const string LastExecutedGeometricBodyPolicy = "last-executed-geometric-body";
+ public const string LastExecutedGeometricBodySelectionReason = "Select the last successfully executed primitive or boolean body in source order; validation ops are never export bodies.";
public static KernelResult<FirmamentStepExportResult> Export(FirmamentCompileRequest request)
{
@@ -45,7 +46,9 @@ public static class FirmamentStepExporter
new FirmamentStepExportResult(
stepResult.Value,
selectionResult.Value.FeatureId,
- selectionResult.Value.OpIndex));
+ selectionResult.Value.OpIndex,
+ selectionResult.Value.BodyCategory,
+ selectionResult.Value.FeatureKind));
}
private static KernelResult<ExportBodySelection> SelectExportBody(FirmamentPrimitiveExecutionResult? primitiveExecutionResult)
@@ -61,14 +64,24 @@ public static class FirmamentStepExporter
{
selected = SelectLater(
selected,
- new ExportBodySelection(primitive.OpIndex, primitive.FeatureId, primitive.Body));
+ new ExportBodySelection(
+ primitive.OpIndex,
+ primitive.FeatureId,
+ ExportBodyCategoryPrimitive,
+ primitive.Kind.ToString().ToLowerInvariant(),
+ primitive.Body));
}
foreach (var boolean in primitiveExecutionResult.ExecutedBooleans)
{
selected = SelectLater(
selected,
- new ExportBodySelection(boolean.OpIndex, boolean.FeatureId, boolean.Body));
+ new ExportBodySelection(
+ boolean.OpIndex,
+ boolean.FeatureId,
+ ExportBodyCategoryBoolean,
+ boolean.Kind.ToString().ToLowerInvariant(),
+ boolean.Body));
}
return selected is null
@@ -96,5 +109,13 @@ public static class FirmamentStepExporter
FirmamentDiagnosticConventions.Source)
]);
- private sealed record ExportBodySelection(int OpIndex, string FeatureId, BrepBody Body);
+ private const string ExportBodyCategoryPrimitive = "primitive";
+ private const string ExportBodyCategoryBoolean = "boolean";
+
+ private sealed record ExportBodySelection(
+ int OpIndex,
+ string FeatureId,
+ string BodyCategory,
+ string FeatureKind,
+ BrepBody Body);
}
diff --git a/testdata/firmament/fixtures/m10b-valid-schema-box-export.firmament b/testdata/firmament/fixtures/m10b-valid-schema-box-export.firmament
new file mode 100644
index 00000000..e98c9844
--- /dev/null
+++ b/testdata/firmament/fixtures/m10b-valid-schema-box-export.firmament
@@ -0,0 +1,19 @@
+firmament:
+ version: 1
+
+model:
+ name: schema_box_export
+ units: mm
+
+schema:
+ process: additive
+ printer_resolution: 0.1
+
+ops[1]:
+ -
+ op: box
+ id: schema_box
+ size[3]:
+ 8
+ 9
+ 10