Check explicitly for invalid model types (#37)

We explicitly check during the JSON de-serialization that model types correspond to the expected model types. We need to be particularly careful with concrete classes without descendants with a mandatory ``modelType``, as they do not necessarily require a model type for de-serialization, but the specs mandate it for reasons of backward compatibility. The code corresponds to [aas-core-codegen b537610b], and the test data corresponds to [aas-core3.0-testgen 9e523511c]. This is related to the issue [aas-core3.0-python #32], which discovered the problematic in the first place. [aas-core-codegen b537610b]: aas-core-works/aas-core-codegen@b537610b [aas-core3.0-testgen 9e523511c]: aas-core-works/aas-core3.0-testgen@9e523511c [aas-core3.0-python #32]: aas-core-works/aas-core3.0-python#32
aas-core-works · Jul 20, 2024 · 441b914 · 441b914
1 parent b7968a5
commit 441b914
Show file tree

Hide file tree

Showing 38 changed files with 1,017 additions and 25 deletions.
diff --git a/src/AasCore.Aas3_0/jsonization.cs b/src/AasCore.Aas3_0/jsonization.cs
diff --git a/src/aas-core3.0-csharp.sln.DotSettings.user b/src/aas-core3.0-csharp.sln.DotSettings.user
@@ -4,7 +4,7 @@
     &lt;TestId&gt;NUnit3x::BDA0E5A2-D48D-4888-9D52-44BD529F8108::net6.0::AasCore.Aas3_0.Tests.TestXmlizationErrors.Test_error_on_unexpected_declaration&lt;/TestId&gt;&#xD;
   &lt;/TestAncestor&gt;&#xD;
 &lt;/SessionState&gt;</s:String>
-	<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=bd994a3b_002D4a4e_002D4b0b_002D90d4_002Ddfcb614164d9/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" IsActive="True" Name="Test_XML_serialization" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;&#xD;
+	<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=bd994a3b_002D4a4e_002D4b0b_002D90d4_002Ddfcb614164d9/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" Name="Test_XML_serialization" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;&#xD;
   &lt;Or&gt;&#xD;
     &lt;ProjectFile&gt;BDA0E5A2-D48D-4888-9D52-44BD529F8108/f:TestXmlizationOfConcreteClasses.cs&lt;/ProjectFile&gt;&#xD;
     &lt;ProjectFile&gt;BDA0E5A2-D48D-4888-9D52-44BD529F8108/f:TestXmlizationOfConcreteClassesOutsideContainer.cs&lt;/ProjectFile&gt;&#xD;
@@ -17,12 +17,13 @@
     &lt;/TestAncestor&gt;&#xD;
   &lt;/Or&gt;&#xD;
 &lt;/SessionState&gt;</s:String>
-	<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=d08349d0_002D1d79_002D48ae_002D9b89_002D73f1b5254923/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" Name="Test_XML_serialization #2" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;&#xD;
+	<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=d08349d0_002D1d79_002D48ae_002D9b89_002D73f1b5254923/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" IsActive="True" Name="Test_XML_serialization #2" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;&#xD;
   &lt;TestAncestor&gt;&#xD;
     &lt;TestId&gt;NUnit3x::BDA0E5A2-D48D-4888-9D52-44BD529F8108::net6.0::AasCore.Aas3_0.Tests.TestExamples.Test_XML_serialization&lt;/TestId&gt;&#xD;
     &lt;TestId&gt;NUnit3x::BDA0E5A2-D48D-4888-9D52-44BD529F8108::net6.0::AasCore.Aas3_0.Tests.TestExamples.Test_JSON_deserialization&lt;/TestId&gt;&#xD;
     &lt;TestId&gt;NUnit3x::BDA0E5A2-D48D-4888-9D52-44BD529F8108::net6.0::AasCore.Aas3_0.Tests.TestExamples.Test_selective_enhancing&lt;/TestId&gt;&#xD;
     &lt;TestId&gt;NUnit3x::BDA0E5A2-D48D-4888-9D52-44BD529F8108::net6.0::AasCore.Aas3_0.Tests.TestXmlizationErrors.Test_error_on_unexpected_declaration&lt;/TestId&gt;&#xD;
+    &lt;TestId&gt;NUnit3x::BDA0E5A2-D48D-4888-9D52-44BD529F8108::net6.0::AasCore.Aas3_0.Tests.TestJsonizationOfConcreteClasses&lt;/TestId&gt;&#xD;
   &lt;/TestAncestor&gt;&#xD;
 &lt;/SessionState&gt;</s:String>
 

diff --git a/...pected/Unserializable/MissingModelType/AnnotatedRelationshipElement/withoutModelType.json b/...pected/Unserializable/MissingModelType/AnnotatedRelationshipElement/withoutModelType.json
@@ -0,0 +1,31 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "first": {
+            "keys": [
+              {
+                "type": "GlobalReference",
+                "value": "urn:another-company01:f390f801"
+              }
+            ],
+            "type": "ExternalReference"
+          },
+          "idShort": "something3fdd3eb4",
+          "second": {
+            "keys": [
+              {
+                "type": "GlobalReference",
+                "value": "urn:an-example05:b7bf2725"
+              }
+            ],
+            "type": "ExternalReference"
+          }
+        }
+      ]
+    }
+  ]
+}
diff --git a/...erializable/MissingModelType/AnnotatedRelationshipElement/withoutModelType.json.exception b/...erializable/MissingModelType/AnnotatedRelationshipElement/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...Unexpected/Unserializable/MissingModelType/AssetAdministrationShell/withoutModelType.json b/...Unexpected/Unserializable/MissingModelType/AssetAdministrationShell/withoutModelType.json
@@ -0,0 +1,11 @@
+{
+  "assetAdministrationShells": [
+    {
+      "assetInformation": {
+        "assetKind": "NotApplicable",
+        "globalAssetId": "something_eea66fa1"
+      },
+      "id": "something_142922d6"
+    }
+  ]
+}
diff --git a/.../Unserializable/MissingModelType/AssetAdministrationShell/withoutModelType.json.exception b/.../Unserializable/MissingModelType/AssetAdministrationShell/withoutModelType.json.exception
@@ -0,0 +1 @@
+Required property "modelType" is missing at: assetAdministrationShells[0]
diff --git a/...onment/Unexpected/Unserializable/MissingModelType/BasicEventElement/withoutModelType.json b/...onment/Unexpected/Unserializable/MissingModelType/BasicEventElement/withoutModelType.json
@@ -0,0 +1,24 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "direction": "output",
+          "idShort": "something3fdd3eb4",
+          "observed": {
+            "keys": [
+              {
+                "type": "Submodel",
+                "value": "urn:another-example11:3679ef43"
+              }
+            ],
+            "type": "ModelReference"
+          },
+          "state": "off"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...xpected/Unserializable/MissingModelType/BasicEventElement/withoutModelType.json.exception b/...xpected/Unserializable/MissingModelType/BasicEventElement/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...tainedInEnvironment/Unexpected/Unserializable/MissingModelType/Blob/withoutModelType.json b/...tainedInEnvironment/Unexpected/Unserializable/MissingModelType/Blob/withoutModelType.json
@@ -0,0 +1,14 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "contentType": "'VbrwFrYTU/fO7NnLxq   \t; \tMX.`10dB732`X5yRy=I56Ov9Us\t ;\t\t pRb~~hdw_C%2Zf=\"\"\t\t\t    \t\t\t \t \t\t \t  ; h=1t",
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...vironment/Unexpected/Unserializable/MissingModelType/Blob/withoutModelType.json.exception b/...vironment/Unexpected/Unserializable/MissingModelType/Blob/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...InEnvironment/Unexpected/Unserializable/MissingModelType/Capability/withoutModelType.json b/...InEnvironment/Unexpected/Unserializable/MissingModelType/Capability/withoutModelType.json
@@ -0,0 +1,13 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...ent/Unexpected/Unserializable/MissingModelType/Capability/withoutModelType.json.exception b/...ent/Unexpected/Unserializable/MissingModelType/Capability/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...nment/Unexpected/Unserializable/MissingModelType/ConceptDescription/withoutModelType.json b/...nment/Unexpected/Unserializable/MissingModelType/ConceptDescription/withoutModelType.json
@@ -0,0 +1,7 @@
+{
+  "conceptDescriptions": [
+    {
+      "id": "something_8ccad77f"
+    }
+  ]
+}
diff --git a/...pected/Unserializable/MissingModelType/ConceptDescription/withoutModelType.json.exception b/...pected/Unserializable/MissingModelType/ConceptDescription/withoutModelType.json.exception
@@ -0,0 +1 @@
+Required property "modelType" is missing at: conceptDescriptions[0]
diff --git a/...nexpected/Unserializable/MissingModelType/DataSpecificationIec61360/withoutModelType.json b/...nexpected/Unserializable/MissingModelType/DataSpecificationIec61360/withoutModelType.json
@@ -0,0 +1,29 @@
+{
+  "assetAdministrationShells": [
+    {
+      "assetInformation": {
+        "assetKind": "NotApplicable",
+        "globalAssetId": "something_eea66fa1"
+      },
+      "embeddedDataSpecifications": [
+        {
+          "dataSpecificationContent": {
+            "preferredName": [
+              {
+                "language": "i-enochian",
+                "text": "something_84b0b440"
+              },
+              {
+                "language": "en-GB",
+                "text": "Something random in English 5b15c20d"
+              }
+            ],
+            "value": "something_13759f45"
+          }
+        }
+      ],
+      "id": "something_142922d6",
+      "modelType": "AssetAdministrationShell"
+    }
+  ]
+}
diff --git a/...Unserializable/MissingModelType/DataSpecificationIec61360/withoutModelType.json.exception b/...Unserializable/MissingModelType/DataSpecificationIec61360/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: assetAdministrationShells[0].embeddedDataSpecifications[0].dataSpecificationContent
diff --git a/...inedInEnvironment/Unexpected/Unserializable/MissingModelType/Entity/withoutModelType.json b/...inedInEnvironment/Unexpected/Unserializable/MissingModelType/Entity/withoutModelType.json
@@ -0,0 +1,14 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "entityType": "CoManagedEntity",
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...ronment/Unexpected/Unserializable/MissingModelType/Entity/withoutModelType.json.exception b/...ronment/Unexpected/Unserializable/MissingModelType/Entity/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...tainedInEnvironment/Unexpected/Unserializable/MissingModelType/File/withoutModelType.json b/...tainedInEnvironment/Unexpected/Unserializable/MissingModelType/File/withoutModelType.json
@@ -0,0 +1,14 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "contentType": "'VbrwFrYTU/fO7NnLxq   \t; \tMX.`10dB732`X5yRy=I56Ov9Us\t ;\t\t pRb~~hdw_C%2Zf=\"\"\t\t\t    \t\t\t \t \t\t \t  ; h=1t",
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...vironment/Unexpected/Unserializable/MissingModelType/File/withoutModelType.json.exception b/...vironment/Unexpected/Unserializable/MissingModelType/File/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...nt/Unexpected/Unserializable/MissingModelType/MultiLanguageProperty/withoutModelType.json b/...nt/Unexpected/Unserializable/MissingModelType/MultiLanguageProperty/withoutModelType.json
@@ -0,0 +1,13 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...ted/Unserializable/MissingModelType/MultiLanguageProperty/withoutModelType.json.exception b/...ted/Unserializable/MissingModelType/MultiLanguageProperty/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...dInEnvironment/Unexpected/Unserializable/MissingModelType/Operation/withoutModelType.json b/...dInEnvironment/Unexpected/Unserializable/MissingModelType/Operation/withoutModelType.json
@@ -0,0 +1,13 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...ment/Unexpected/Unserializable/MissingModelType/Operation/withoutModelType.json.exception b/...ment/Unexpected/Unserializable/MissingModelType/Operation/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...edInEnvironment/Unexpected/Unserializable/MissingModelType/Property/withoutModelType.json b/...edInEnvironment/Unexpected/Unserializable/MissingModelType/Property/withoutModelType.json
@@ -0,0 +1,14 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4",
+          "valueType": "xs:decimal"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...nment/Unexpected/Unserializable/MissingModelType/Property/withoutModelType.json.exception b/...nment/Unexpected/Unserializable/MissingModelType/Property/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...ainedInEnvironment/Unexpected/Unserializable/MissingModelType/Range/withoutModelType.json b/...ainedInEnvironment/Unexpected/Unserializable/MissingModelType/Range/withoutModelType.json
@@ -0,0 +1,14 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4",
+          "valueType": "xs:decimal"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...ironment/Unexpected/Unserializable/MissingModelType/Range/withoutModelType.json.exception b/...ironment/Unexpected/Unserializable/MissingModelType/Range/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...ronment/Unexpected/Unserializable/MissingModelType/ReferenceElement/withoutModelType.json b/...ronment/Unexpected/Unserializable/MissingModelType/ReferenceElement/withoutModelType.json
@@ -0,0 +1,13 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...expected/Unserializable/MissingModelType/ReferenceElement/withoutModelType.json.exception b/...expected/Unserializable/MissingModelType/ReferenceElement/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...ment/Unexpected/Unserializable/MissingModelType/RelationshipElement/withoutModelType.json b/...ment/Unexpected/Unserializable/MissingModelType/RelationshipElement/withoutModelType.json
@@ -0,0 +1,31 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "first": {
+            "keys": [
+              {
+                "type": "GlobalReference",
+                "value": "urn:another-company01:f390f801"
+              }
+            ],
+            "type": "ExternalReference"
+          },
+          "idShort": "something3fdd3eb4",
+          "second": {
+            "keys": [
+              {
+                "type": "GlobalReference",
+                "value": "urn:an-example05:b7bf2725"
+              }
+            ],
+            "type": "ExternalReference"
+          }
+        }
+      ]
+    }
+  ]
+}
diff --git a/...ected/Unserializable/MissingModelType/RelationshipElement/withoutModelType.json.exception b/...ected/Unserializable/MissingModelType/RelationshipElement/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...edInEnvironment/Unexpected/Unserializable/MissingModelType/Submodel/withoutModelType.json b/...edInEnvironment/Unexpected/Unserializable/MissingModelType/Submodel/withoutModelType.json
@@ -0,0 +1,7 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017"
+    }
+  ]
+}
diff --git a/...nment/Unexpected/Unserializable/MissingModelType/Submodel/withoutModelType.json.exception b/...nment/Unexpected/Unserializable/MissingModelType/Submodel/withoutModelType.json.exception
@@ -0,0 +1 @@
+Required property "modelType" is missing at: submodels[0]
diff --git a/...nexpected/Unserializable/MissingModelType/SubmodelElementCollection/withoutModelType.json b/...nexpected/Unserializable/MissingModelType/SubmodelElementCollection/withoutModelType.json
@@ -0,0 +1,13 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4"
+        }
+      ]
+    }
+  ]
+}
diff --git a/...Unserializable/MissingModelType/SubmodelElementCollection/withoutModelType.json.exception b/...Unserializable/MissingModelType/SubmodelElementCollection/withoutModelType.json.exception
@@ -0,0 +1 @@
+Expected a model type, but none is present at: submodels[0].submodelElements[0]
diff --git a/...ment/Unexpected/Unserializable/MissingModelType/SubmodelElementList/withoutModelType.json b/...ment/Unexpected/Unserializable/MissingModelType/SubmodelElementList/withoutModelType.json
@@ -0,0 +1,14 @@
+{
+  "submodels": [
+    {
+      "id": "something_48c66017",
+      "modelType": "Submodel",
+      "submodelElements": [
+        {
+          "idShort": "something3fdd3eb4",
+          "typeValueListElement": "Entity"
+        }
+      ]
+    }
+  ]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Expected a model type, but none is present at: submodels[0].submodelElements[0]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Required property "modelType" is missing at: assetAdministrationShells[0]