Merge pull request #284 from CBenghi/development

Updated audit tool and fixed #111
buildingSMART · May 3, 2024 · 858f910 · 858f910
2 parents 08a4e25 + cf35548
commit 858f910
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 15 deletions.
diff --git a/.nuke/build.schema.json b/.nuke/build.schema.json
@@ -77,7 +77,8 @@
               "AuditDocTestCases",
               "CleanSchemaProject",
               "CompileSchemaProject",
-              "CreateTestCases"
+              "CreateTestCases",
+              "TestAccurateInvalid"
             ]
           }
         },
@@ -92,7 +93,8 @@
               "AuditDocTestCases",
               "CleanSchemaProject",
               "CompileSchemaProject",
-              "CreateTestCases"
+              "CreateTestCases",
+              "TestAccurateInvalid"
             ]
           }
         },

diff --git a/Documentation/testcases/partof/fail-the_container_predefined_type_must_match_exactly_1_2.ifc b/Documentation/testcases/partof/fail-the_container_predefined_type_must_match_exactly_1_2.ifc
@@ -6,7 +6,7 @@ FILE_SCHEMA(('IFC4'));
 ENDSEC;
 DATA;
 #1=IFCELEMENTASSEMBLY('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,$,$,$,$,$,$);
-#2=IFCSPACE('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BURROW',$,$,$,$,$,$);
+#2=IFCSPACE('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BURROW',$,$,$,$,.USERDEFINED.,$,$);
 #3=IFCRELCONTAINEDINSPATIALSTRUCTURE('05rScmOVzMoQXOfbYdtLYj',$,$,$,(#1),#2);
 ENDSEC;
 END-ISO-10303-21;
diff --git a/Documentation/testcases/partof/fail-the_nest_predefined_type_must_match_exactly_1_2.ifc b/Documentation/testcases/partof/fail-the_nest_predefined_type_must_match_exactly_1_2.ifc
@@ -5,7 +5,7 @@ FILE_NAME('','2022-10-07T13:48:44',(),(),'IfcOpenShell v0.7.0-dc67287d','IfcOpen
 FILE_SCHEMA(('IFC4'));
 ENDSEC;
 DATA;
-#1=IFCFURNITURE('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,'WATERBOTTLE',$,$,$,$);
+#1=IFCFURNITURE('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,'WATERBOTTLE',$,$,$,.USERDEFINED.);
 #2=IFCDISCRETEACCESSORY('0eA6m4fELI9QBIhP3wiLAp',$,$,$,$,$,$,$,$);
 #3=IFCRELNESTS('05rScmOVzMoQXOfbYdtLYj',$,$,$,#1,(#2));
 ENDSEC;

diff --git a/Documentation/testcases/partof/invalid-a_group_predefined_type_must_match_exactly_2_2.ifc b/Documentation/testcases/partof/invalid-a_group_predefined_type_must_match_exactly_2_2.ifc
@@ -6,7 +6,7 @@ FILE_SCHEMA(('IFC4'));
 ENDSEC;
 DATA;
 #1=IFCELEMENTASSEMBLY('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,$,$,$,$,$,$);
-#2=IFCINVENTORY('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BUNNY',$,$,$,$,$,$);
+#2=IFCINVENTORY('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BUNNY',.USERDEFINED.,$,$,$,$,$);
 #3=IFCRELASSIGNSTOGROUP('05rScmOVzMoQXOfbYdtLYj',$,$,$,(#1),$,#2);
 ENDSEC;
 END-ISO-10303-21;
diff --git a/Documentation/testcases/partof/pass-a_group_predefined_type_must_match_exactly_2_2.ifc b/Documentation/testcases/partof/pass-a_group_predefined_type_must_match_exactly_2_2.ifc
@@ -6,7 +6,7 @@ FILE_SCHEMA(('IFC4'));
 ENDSEC;
 DATA;
 #1=IFCELEMENTASSEMBLY('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,$,$,$,$,$,$);
-#2=IFCINVENTORY('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BUNNY',$,$,$,$,$,$);
+#2=IFCINVENTORY('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BUNNY',.USERDEFINED.,$,$,$,$,$);
 #3=IFCRELASSIGNSTOGROUP('05rScmOVzMoQXOfbYdtLYj',$,$,$,(#1),$,#2);
 ENDSEC;
 END-ISO-10303-21;
diff --git a/Documentation/testcases/partof/pass-the_container_predefined_type_must_match_exactly_2_2.ifc b/Documentation/testcases/partof/pass-the_container_predefined_type_must_match_exactly_2_2.ifc
@@ -6,7 +6,7 @@ FILE_SCHEMA(('IFC4'));
 ENDSEC;
 DATA;
 #1=IFCELEMENTASSEMBLY('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,$,$,$,$,$,$);
-#2=IFCSPACE('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BURROW',$,$,$,$,$,$);
+#2=IFCSPACE('0eA6m4fELI9QBIhP3wiLAp',$,$,$,'BURROW',$,$,$,$,.USERDEFINED.,$);
 #3=IFCRELCONTAINEDINSPATIALSTRUCTURE('05rScmOVzMoQXOfbYdtLYj',$,$,$,(#1),#2);
 ENDSEC;
 END-ISO-10303-21;
diff --git a/Documentation/testcases/partof/pass-the_nest_predefined_type_must_match_exactly_2_2.ifc b/Documentation/testcases/partof/pass-the_nest_predefined_type_must_match_exactly_2_2.ifc
@@ -5,7 +5,7 @@ FILE_NAME('','2022-10-07T13:48:44',(),(),'IfcOpenShell v0.7.0-dc67287d','IfcOpen
 FILE_SCHEMA(('IFC4'));
 ENDSEC;
 DATA;
-#1=IFCFURNITURE('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,'WATERBOTTLE',$,$,$,$);
+#1=IFCFURNITURE('1hqIFTRjfV6AWq_bMtnZwI',$,$,$,'WATERBOTTLE',$,$,$,.USERDEFINED.);
 #2=IFCDISCRETEACCESSORY('0eA6m4fELI9QBIhP3wiLAp',$,$,$,$,$,$,$,$);
 #3=IFCRELNESTS('05rScmOVzMoQXOfbYdtLYj',$,$,$,#1,(#2));
 ENDSEC;

diff --git a/build/Build.cs b/build/Build.cs
@@ -10,7 +10,7 @@
 class Build : NukeBuild
 {
     public static int Main() => Execute<Build>(x => x.AuditAllIdsFiles);
-
+    
     [Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")]
     private readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release;
 
@@ -184,15 +184,53 @@ class Build : NukeBuild
             var inputFolder = RootDirectory / "Documentation" / "testcases";
             var arguments = $"audit \"{inputFolder}\" --omitContentAuditPattern \"[\\\\|/]invalid-\" -x \"{schemaFile}\"";
             IdsTool(arguments, workingDirectory: IdsToolPath);
-        }); 
+        });
 
-    /// <summary>
-    /// Perform all quality assurance of published IDS files; this is the one invoked by default
-    /// </summary>
-    Target AuditAllIdsFiles => _ => _
+	/// <summary>
+	/// Audits the validity of Documentation/testcases folder in the repository, using ids-tool.
+	/// The tool is deployed by the annotated <see cref="IdsTool"/>.
+	/// The schema is loaded from the repository to ensure internal coherence.
+	/// </summary>
+	Target TestAccurateInvalid => _ => _
+		.AssuredAfterFailure()
+		.Executes(() =>
+		{
+			// we are omitting tests on the content of the Documentation/testcases folder, 
+			// because they include IDSs that intentionally contain errors
+			//
+			// todo: once stable, this could be improved to omit contents based on failure patter name
+			// todo: once stable, constrained on expected auditing failures on the "fail-" cases should be added
+			var schemaFile = RootDirectory / "Development" / "ids.xsd";
+			var inputFolder = RootDirectory / "Documentation" / "testcases";
+
+            DirectoryInfo d = new DirectoryInfo(inputFolder);
+            foreach (var invalidFile in d.GetFiles("invalid-*.ids", SearchOption.AllDirectories))
+            {
+                Console.WriteLine(invalidFile.FullName); 
+				var arguments = $"audit \"{invalidFile}\" -x \"{schemaFile}\"";
+                try
+                {
+					var t = IdsTool(arguments, workingDirectory: IdsToolPath);
+				}
+                catch (ProcessException ex)
+                {
+                    if (ex.ExitCode != 16)
+                        throw new Exception("Unexpected exit code");
+                    
+                }
+			}
+
+
+		});
+
+	/// <summary>
+	/// Perform all quality assurance of published IDS files; this is the one invoked by default
+	/// </summary>
+	Target AuditAllIdsFiles => _ => _
         .AssuredAfterFailure()
         .DependsOn(AuditDocTestCases)
         .DependsOn(AuditDevelopment)
+        .DependsOn(TestAccurateInvalid)
         .Executes(() =>
         {
             Console.WriteLine("This is an utility target that launches all available IDS auditing targets.");

diff --git a/build/_build.csproj b/build/_build.csproj
@@ -13,7 +13,7 @@
 
   <ItemGroup>
     <PackageReference Include="Nuke.Common" Version="6.3.0" />
-    <PackageReference Include="ids-tool.CommandLine" Version="1.0.72" />
+    <PackageReference Include="ids-tool.CommandLine" Version="1.0.73" />
     <PackageDownload Include="dotnet-xscgen" Version="[2.1.1094]" />
   </ItemGroup>