Merge remote-tracking branch 'origin/main'

Updated to latest IDS repository structure.
buildingSMART · Sep 18, 2024 · 57353ec · 57353ec
2 parents b1f902b + 8d11214
commit 57353ec
Show file tree

Hide file tree

Showing 14 changed files with 104 additions and 28 deletions.
diff --git a/SolutionTooling/BuildingSmartRepoFiles.cs b/SolutionTooling/BuildingSmartRepoFiles.cs
@@ -20,7 +20,7 @@ private static string IdsRepoPath
                 if (subIDS != null)
                 {
                     if (
-                        subIDS.GetDirectories("Development").Any()
+                        subIDS.GetDirectories("RepositoryAutomation").Any()
                         && subIDS.GetDirectories(".nuke").Any()
                         )
                         return subIDS.FullName;
@@ -49,8 +49,9 @@ private static string IdsToolRepoPath
     }
 
     // private static string IfcOpenShellTestcasesPath => Path.Combine(IfcOpenShellPath, "src", "ifctester", "test", "build", "testcases");
-    private static string IdsRepositoryTestcasesPath => Path.Combine(IdsRepositoryDocumentationPath, "testcases");
-    private static string IdsRepositoryDevelopmentPath => Path.Combine(IdsRepoPath, @"Development");
+    private static string IdsRepositoryTestcasesPath => Path.Combine(IdsRepositoryDocumentationPath, "ImplementersDocumentation", "TestCases");
+    private static string IdsRepositorySchemaPath => Path.Combine(IdsRepoPath, @"Schema");
+    private static string IdsRepositoryExamplePath => Path.Combine(IdsRepoPath, "Documentation", @"Examples");
     private static string IdsRepositoryDocumentationPath => Path.Combine(IdsRepoPath, @"Documentation");
 
     public static FileInfo GetIdsToolSchema()
@@ -67,7 +68,7 @@ public static FileInfo GetIdsTestSuiteSchema()
 
     public static FileInfo GetIdsSchema()
     {
-        var schema = Path.Combine(IdsRepositoryDevelopmentPath, "ids.xsd");
+        var schema = Path.Combine(IdsRepositorySchemaPath, "ids.xsd");
         return new FileInfo(schema);
     }
 
@@ -106,18 +107,18 @@ private static IEnumerable<object[]> GetFilesOrEmpty(DirectoryInfo d, string sea
 		}
 	}
 
-	public static FileInfo GetIdsRepositoryDevelopmentFileInfo(string idsFile)
+	public static FileInfo GetIdsRepositoryExampleFileInfo(string idsFile)
     {
-        var d = new DirectoryInfo(IdsRepositoryDevelopmentPath);
+        var d = new DirectoryInfo(IdsRepositoryExamplePath);
         var comb = d.FullName + idsFile;
         var f = new FileInfo(comb);
         return f;
     }
 
-    public static IEnumerable<object[]> GetIdsRepositoryDevelopmentIdsFiles()
+    public static IEnumerable<object[]> GetIdsRepositoryExampleIdsFiles()
     {
         // start from current directory and look in relative position for the bs IDS repository
-        var d = new DirectoryInfo(IdsRepositoryDevelopmentPath);
+        var d = new DirectoryInfo(IdsRepositoryExamplePath);
         if (!d.Exists)
         {
             // returning a single invalid entry so that it can be skipped
@@ -136,9 +137,9 @@ public static FileInfo GetDocumentation(string fileName)
         return new FileInfo(Path.Combine(IdsRepositoryDocumentationPath, fileName));
     }
 
-    public static FileInfo GetDevelopment(string fileName)
+    public static FileInfo GetSchemaPath(string fileName)
     {
-        return new FileInfo(Path.Combine(IdsRepositoryDevelopmentPath, fileName));
+        return new FileInfo(Path.Combine(IdsRepositorySchemaPath, fileName));
     }
 
     public static bool FilesAreIdentical(FileInfo repoSchema, FileInfo toolSchema)

diff --git a/ids-lib.codegen/IdsRepo_Updater.cs b/ids-lib.codegen/IdsRepo_Updater.cs
@@ -160,7 +160,7 @@ private static IEnumerable<UpdatableFile> UpdateDocumentationUnits(DirectoryInfo
 
         private static IEnumerable<UpdatableFile> UpdateEmbeddedSchema(DirectoryInfo solutionDir)
         {
-            var sourceFile = BuildingSmartRepoFiles.GetDevelopment("ids.xsd");
+            var sourceFile = BuildingSmartRepoFiles.GetSchemaPath("ids.xsd");
             if (sourceFile.Exists)
             {
                 var destination = Path.Combine(
@@ -178,7 +178,7 @@ private static IEnumerable<UpdatableFile> UpdateEmbeddedSchema(DirectoryInfo sol
 
         private static IEnumerable<UpdatableFile> UpdateTestingSchema(DirectoryInfo solutionDir)
         {
-            var sourceFile = BuildingSmartRepoFiles.GetDevelopment("ids.xsd");
+            var sourceFile = BuildingSmartRepoFiles.GetSchemaPath("ids.xsd");
             if (sourceFile.Exists)
             {
                 var destination = Path.Combine(

diff --git a/ids-lib/IfcSchema/SchemaInfo.cs b/ids-lib/IfcSchema/SchemaInfo.cs
@@ -302,7 +302,16 @@ internal static IEnumerable<string> PossibleTypesForPropertySets(IfcSchemaVersio
                     {
                         var tp = schema[item];
                         if (tp is not null && tp.RelationTypeClasses is not null)
+                        {
                             typeObjects.AddRange(tp.RelationTypeClasses);
+                            // RelationTypeClasses only includes immediate ancestors, so we need to include all subClasses of any TypeObjects
+                            // as these also are valid for the propertySet
+                            var subTypes = tp.RelationTypeClasses.SelectMany(typ => schema[typ]!.SubClasses.Select(s => s.Name)).Distinct();
+                            if(subTypes.Any())
+                            {
+                                typeObjects.AddRange(subTypes);
+                            }
+                        }
                     }
                     if (typeObjects.Any())
                         thisPsetTypes = thisPsetTypes.ToList().Concat(typeObjects.Distinct()).ToList();
@@ -552,24 +561,24 @@ public static IEnumerable<string> GetConcreteClassesFrom(string topClass, IfcSch
         {
             if (schemaVersions.IsSingleSchema())
             {
-				var schema = GetSchemas(schemaVersions).First();
+                var schema = GetSchemas(schemaVersions).First();
                 if (schema is null)
                     return Enumerable.Empty<string>();
                 var top = schema[topClass];
                 if (top is null)
                     return Enumerable.Empty<string>();
-				return top.MatchingConcreteClasses.Select(x=>x.Name);
-			}
+                return top.MatchingConcreteClasses.Select(x=>x.Name);
+            }
 
-			var schemas = GetSchemas(schemaVersions);
+            var schemas = GetSchemas(IfcSchemaVersions.IfcAllVersions);
             List<string> ret = new();
-			foreach (var schema in schemas)
+            foreach (var schema in schemas)
             {
                 var top = schema[topClass];
                 if (top is null)
                     continue;
                 ret = ret.Union(top.MatchingConcreteClasses.Select(x => x.Name)).ToList();
-			}
+            }
             return ret;
         }
 

diff --git a/ids-lib/LibraryInformation.cs b/ids-lib/LibraryInformation.cs
@@ -26,5 +26,5 @@ public static class LibraryInformation
 	/// <summary>
 	/// Static field with hardcoded DLL version number. 
 	/// </summary>
-	public static string AssemblyVersion => "1.0.77";
+	public static string AssemblyVersion => "1.0.78";
 }
diff --git a/ids-lib/ids-lib.csproj b/ids-lib/ids-lib.csproj
@@ -20,7 +20,7 @@
 		<PackageReleaseNotes>First implementation.</PackageReleaseNotes>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<!-- Github actions are setup so that when this version is bumped the nuget package is uploaded -->
-		<AssemblyVersion>1.0.77</AssemblyVersion>
+		<AssemblyVersion>1.0.78</AssemblyVersion>
 		<FileVersion>$(AssemblyVersion)</FileVersion>
 		<Version>$(AssemblyVersion)</Version>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>

diff --git a/ids-tool.tests/AuditTests.cs b/ids-tool.tests/AuditTests.cs
@@ -25,7 +25,7 @@ public AuditTests(ITestOutputHelper outputHelper)
     private ITestOutputHelper XunitOutputHelper { get; }
 
     [SkippableTheory]
-    [MemberData(nameof(GetIdsRepositoryDevelopmentIdsFiles))]
+    [MemberData(nameof(GetIdsRepositoryExampleIdsFiles))]
     public void FullAuditOfDevelopmentFilesOk(string developmentIdsFile)
     {
         Skip.If(developmentIdsFile == string.Empty, "IDS repository folder not available for extra tests.");
@@ -34,7 +34,7 @@ public void FullAuditOfDevelopmentFilesOk(string developmentIdsFile)
     }
 
 	[SkippableTheory]
-	[MemberData(nameof(GetIdsRepositoryDevelopmentIdsFiles))]
+	[MemberData(nameof(GetIdsRepositoryExampleIdsFiles))]
 	public void FullAuditOfDevelopmentFilesWithItsSchemaOk(string developmentIdsFile)
 	{
 		var repoSchema = BuildingSmartRepoFiles.GetIdsSchema();

diff --git a/ids-tool.tests/Helpers/LoggerAndAuditHelpers.cs b/ids-tool.tests/Helpers/LoggerAndAuditHelpers.cs
@@ -18,7 +18,7 @@ internal static class LoggerAndAuditHelpers
 {
 	public static FileInfo GetAndCheckIdsRepositoryDevelopmentFileInfo(string theFile)
     {
-		FileInfo f = BuildingSmartRepoFiles.GetIdsRepositoryDevelopmentFileInfo(theFile);
+		FileInfo f = BuildingSmartRepoFiles.GetIdsRepositoryExampleFileInfo(theFile);
 		f.Exists.Should().BeTrue("test file must be found");
 		return f;
 	}

diff --git a/ids-tool.tests/IdsInfoTests.cs b/ids-tool.tests/IdsInfoTests.cs
@@ -26,7 +26,7 @@ public async Task InvalidFilesDontBreak(string idsFile, bool isIds)
     }
 
     [SkippableTheory]
-    [MemberData(nameof(GetIdsRepositoryDevelopmentIdsFiles))]
+    [MemberData(nameof(GetIdsRepositoryExampleIdsFiles))]
     public async Task CanReadIdsDevelopmentFiles(string idsFile)
     {
         Skip.If(idsFile == string.Empty, "IDS repository folder not available for extra tests.");

diff --git a/ids-tool.tests/IfcSchemaTests.cs b/ids-tool.tests/IfcSchemaTests.cs
@@ -121,7 +121,20 @@ public void CanGetConcreteSubclasses()
 
 	}
 
-	[Theory]
+    [Fact]
+    public void CanGetConcreteSubclassesForSpecificSchema()
+    {
+        // IFCCABLECARRIERSEGMENT is new in IFC4
+        var elements = SchemaInfo.GetConcreteClassesFrom("IFCCABLECARRIERSEGMENT", IfcSchemaVersions.Ifc4);
+        elements.Should().NotBeNull();
+        elements.Should().HaveCount(1);
+
+        elements = SchemaInfo.GetConcreteClassesFrom("IFCFACILITYPART", IfcSchemaVersions.Ifc4x3);
+        elements.Should().Contain("IfcRailwayPart");
+        elements.Should().HaveCount(5);
+    }
+
+        [Theory]
     [InlineData("IFCOBJECTDEFINITION", 194,366)]
     [InlineData("IFCWALL",2, 3)]
     [InlineData("IFCNOTEXISTING",-1, -1)]
@@ -228,5 +241,21 @@ public void OnlyTopLevelClassesShouldRemoveAllSubClasses()
     }
 
 
+    [Fact]
+    public void AllSubClassesOfTypesAreIncludedAsPossibleTypesForPropertySets()
+    {
+        var psets = new[] { "Pset_ManufacturerTypeInformation" };
+        var classes = SchemaInfo.PossibleTypesForPropertySets(IfcSchemaVersions.Ifc2x3, psets).Select(e=> e.ToUpperInvariant());
+
+        // Sanity checking
+        classes.Should().Contain("IFCWALL");
+        classes.Should().Contain("IFCWALLTYPE");
+        classes.Should().Contain("IFCDISTRIBUTIONCONTROLELEMENT");
+
+        // Bug - IFC2x3 Type Subtypes were not being returned: Issue #39
+        classes.Should().Contain("IFCACTUATORTYPE"); 
+        classes.Should().Contain("IFCAIRTERMINALTYPE");
+    }
+
 
 }
diff --git a/ids-tool.tests/IssueFiles/Issue 39 - IfcTypeObjects allowed.ids b/ids-tool.tests/IssueFiles/Issue 39 - IfcTypeObjects allowed.ids
@@ -0,0 +1,27 @@
+<ids xmlns="http://standards.buildingsmart.org/IDS" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://standards.buildingsmart.org/IDS http://standards.buildingsmart.org/IDS/1.0/ids.xsd">
+  <info>
+    <title>Can select IfcTypeObjects that don't have equivalent IfcObject in IFC2x3</title>
+  </info>
+  <specifications>
+    <specification ifcVersion="IFC2X3" name="IfcActuatorType.ModelLabel"
+                   description="Issue is that there's no IFCACTUATOR instance in IFC2x3 so we get a false 'Inconsistent Clauses' 201 error, since subClasses were not being considered">
+      <applicability minOccurs="0" maxOccurs="unbounded">
+        <entity>
+          <name>
+            <simpleValue>IFCACTUATORTYPE</simpleValue>
+          </name>
+        </entity>
+      </applicability>
+      <requirements>
+        <property dataType="IFCLABEL">
+          <propertySet>
+            <simpleValue>Pset_ManufacturerTypeInformation</simpleValue>
+          </propertySet>
+          <baseName>
+            <simpleValue>ModelLabel</simpleValue>
+          </baseName>
+        </property>
+      </requirements>
+    </specification>
+  </specifications>
+</ids>
diff --git a/ids-tool.tests/IssueTests.cs b/ids-tool.tests/IssueTests.cs
@@ -59,5 +59,12 @@ public void Issue_30_ShouldReturnError()
 			var f = new FileInfo("IssueFiles/Issue 30 - should return error.ids");
 			LoggerAndAuditHelpers.FullAudit(f, XunitOutputHelper, IdsLib.Audit.Status.IdsContentError, 2);
 		}
-	}
+
+        [Fact]
+        public void Issue_39_SubClassesOfObjectTypesAllowPsets()
+        {
+            var f = new FileInfo("IssueFiles/Issue 39 - IfcTypeObjects allowed.ids");
+            LoggerAndAuditHelpers.FullAudit(f, XunitOutputHelper, IdsLib.Audit.Status.Ok);
+        }
+    }
 }
diff --git a/ids-tool.tests/SchemaLoadingTests.cs b/ids-tool.tests/SchemaLoadingTests.cs
@@ -21,7 +21,7 @@ public SchemaLoadingTests(ITestOutputHelper outputHelper)
     /// In case this test fails, see <see cref="AuditTests.FullAuditOfDevelopmentFilesOk"/> for issues in the file.
     /// </summary>
     [SkippableTheory]
-    [MemberData(nameof(GetIdsRepositoryDevelopmentIdsFiles))]
+    [MemberData(nameof(GetIdsRepositoryExampleIdsFiles))]
     public void CanLoadEmbeddedResourceSchema(string idsFile)
     {
         Skip.If(idsFile == string.Empty, "IDS repository folder not available for extra tests.");

diff --git a/ids-tool.tests/ids-tool.tests.csproj b/ids-tool.tests/ids-tool.tests.csproj
@@ -168,6 +168,9 @@
 		<None Update="IssueFiles\Issue 08 - Regex pattern.ids">
 		  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
 		</None>
+		<None Update="IssueFiles\Issue 39 - IfcTypeObjects allowed.ids">
+		  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+		</None>
 		<None Update="IssueFiles\Issue 11 - IfcLogical.ids">
 		  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
 		</None>

diff --git a/ids-tool/ids-tool.csproj b/ids-tool/ids-tool.csproj
@@ -16,7 +16,7 @@
 		<PackageIcon>icon.png</PackageIcon>
 		<PackageTags>IDS, buildingSmart</PackageTags>
 		<!-- Github actions are setup so that when this version is bumped the nuget package is uploaded -->
-		<AssemblyVersion>1.0.77</AssemblyVersion>
+		<AssemblyVersion>1.0.78</AssemblyVersion>
 		<FileVersion>$(AssemblyVersion)</FileVersion>
 		<Version>$(AssemblyVersion)</Version>
 		<RepositoryUrl>https://github.com/buildingSMART/IDS-Audit-tool.git</RepositoryUrl>