Merge pull request #517 from BHoM/develop

michaelhoehn · web-flow · commit 7e322aa229f3 · 2025-06-25T10:23:42.000-04:00
8.2 Deployment
diff --git a/.ci/unit-tests/Example_Engine/Example_Engine.csproj b/.ci/unit-tests/Example_Engine/Example_Engine.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <Description>https://github.com/BHoM/Test_Toolkit</Description>
     <Configurations>Debug;Release;Test</Configurations>
-	  <FileVersion>8.1.0.0</FileVersion>
+	  <FileVersion>8.2.0.0</FileVersion>
 	  <AssemblyVersion>8.0.0.0</AssemblyVersion>
   </PropertyGroup>
 
diff --git a/.ci/unit-tests/NUnit_Engine_Tests/NUnit_Engine_Tests.csproj b/.ci/unit-tests/NUnit_Engine_Tests/NUnit_Engine_Tests.csproj
@@ -5,7 +5,7 @@
 <Description>https://github.com/BHoM/Test_Toolkit</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-	  <FileVersion>8.1.0.0</FileVersion>
+	  <FileVersion>8.2.0.0</FileVersion>
 	  <AssemblyVersion>8.0.0.0</AssemblyVersion>
     <IsPackable>false</IsPackable>
     <Configurations>Debug;Release;Test</Configurations>
diff --git a/.ci/unit-tests/NUnit_Engine_WrongReferencesTests/NUnit_Engine_WrongReferencesTests.csproj b/.ci/unit-tests/NUnit_Engine_WrongReferencesTests/NUnit_Engine_WrongReferencesTests.csproj
@@ -5,7 +5,7 @@
 <Description>https://github.com/BHoM/Test_Toolkit</Description>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-	  <FileVersion>8.1.0.0</FileVersion>
+	  <FileVersion>8.2.0.0</FileVersion>
 	  <AssemblyVersion>8.0.0.0</AssemblyVersion>
     <IsPackable>false</IsPackable>
 
diff --git a/CodeComplianceTest_Engine/Properties/AssemblyInfo.cs b/CodeComplianceTest_Engine/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/CodeComplianceTest_Engine/Query/Checks/HasDescriptionAttribute.cs b/CodeComplianceTest_Engine/Query/Checks/HasDescriptionAttribute.cs
@@ -39,8 +39,7 @@ public static partial class Query
     {
         [Message("Engine Method must contain a Description attribute", "HasDescriptionAttribute")]
         [ErrorLevel(TestStatus.Error)]
-        [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$")]
-        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$")]
+        [Path(@"([a-zA-Z0-9]+)_(Engine|Tests)\\.*\.cs$")]
         [Path(@"([a-zA-Z0-9]+)_Engine\\Objects\\.*\.cs$", false)]
         [IsPublic()]
         [ComplianceType("documentation")]
diff --git a/CodeComplianceTest_Engine/Query/Checks/IsPublicProperty.cs b/CodeComplianceTest_Engine/Query/Checks/IsPublicProperty.cs
@@ -35,11 +35,10 @@ namespace BH.Engine.Test.CodeCompliance.Checks
     public static partial class Query
     {
         [Message("Invalid oM property: Object properties must be public", "IsPublicProperty")]
-        [Path(@"([a-zA-Z0-9]+)_?oM\\.*\.cs$")]
+        [Path(@"([a-zA-Z0-9]+)(_?oM|_Tests)\\.*\.cs$")]
         [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_Adapter\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_UI\\.*\.cs$", false)]
-        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$")]
         [IsPublic(false)]
         [ComplianceType("code")]
         [ErrorLevel(TestStatus.Error)]
diff --git a/CodeComplianceTest_Engine/Query/Checks/IsVirtualProperty.cs b/CodeComplianceTest_Engine/Query/Checks/IsVirtualProperty.cs
@@ -35,11 +35,10 @@ namespace BH.Engine.Test.CodeCompliance.Checks
     public static partial class Query
     {
         [Message("Invalid oM property: Object properties must be virtual", "IsVirtualProperty")]
-        [Path(@"([a-zA-Z0-9]+)_?oM\\.*\.cs$")]
+        [Path(@"([a-zA-Z0-9]+)(_?oM|_Tests)\\.*\.cs$")]
         [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_Adapter\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_UI\\.*\.cs$", false)]
-        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$")]
         [IsPublic()]
         [ComplianceType("code")]
         [ErrorLevel(TestStatus.Error)]
diff --git a/CodeComplianceTest_Engine/Query/Checks/MethodNameContainsFileName.cs b/CodeComplianceTest_Engine/Query/Checks/MethodNameContainsFileName.cs
@@ -35,9 +35,7 @@ namespace BH.Engine.Test.CodeCompliance.Checks
     public static partial class Query
     {
         [Message("Method name must start with or end with the name of the file", "MethodNameContainsFileName")]
-        [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$")]
-        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$")]
-        [Path(@"([a-zA-Z0-9]+)_Engine\\Create\\.*\.cs$")]
+        [Path(@"([a-zA-Z0-9]+)_(Engine|Tests)\\.*\.cs$")]
         [Path(@"([a-zA-Z0-9]+)_Engine\\Convert\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_Engine\\Objects\\.*\.cs$", false)]
         [IsPublic()]
diff --git a/CodeComplianceTest_Engine/Query/Checks/ObjectNameMatchesFileName.cs b/CodeComplianceTest_Engine/Query/Checks/ObjectNameMatchesFileName.cs
@@ -38,8 +38,7 @@ public static partial class Query
 
         [Message("Class (object) name must match file name", "ObjectNameMatchesFileName")]
         [ErrorLevel(TestStatus.Error)]
-        [Path(@"([a-zA-Z0-9]+)_?oM\\.*\.cs$")]
-        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$")]
+        [Path(@"([a-zA-Z0-9]+)(_?oM|_Tests)\\.*\.cs$")]
         [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_Adapter\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_UI\\.*\.cs$", false)]
diff --git a/CodeComplianceTest_Engine/Query/Checks/PropertyAccessorsHaveNoBody.cs b/CodeComplianceTest_Engine/Query/Checks/PropertyAccessorsHaveNoBody.cs
@@ -35,8 +35,7 @@ namespace BH.Engine.Test.CodeCompliance.Checks
     public static partial class Query
     {
         [Message("Invalid oM property: Object property accessors must not have a body", "PropertyAccessorsHaveNoBody")]
-        [Path(@"([a-zA-Z0-9]+)_?oM\\.*\.cs$")]
-        [Path(@"([a-zA-Z0-9]+)_Tests\\.*\.cs$")]
+        [Path(@"([a-zA-Z0-9]+)(_?oM|_Tests)\\.*\.cs$")]
         [Path(@"([a-zA-Z0-9]+)_Engine\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_Adapter\\.*\.cs$", false)]
         [Path(@"([a-zA-Z0-9]+)_UI\\.*\.cs$", false)]
diff --git a/CodeComplianceTest_Engine/Query/CurrentVersion.cs b/CodeComplianceTest_Engine/Query/CurrentVersion.cs
@@ -42,7 +42,7 @@ public static string FullCurrentAssemblyVersion()
 
         public static string CurrentAssemblyFileVersion()
         {
-            return "8.1"; //Update each milestone - don't forget the one above!
+            return "8.2"; //Update each milestone - don't forget the one above!
         }
 
         public static string FullCurrentAssemblyFileVersion()
diff --git a/CodeCompliance_oM/Properties/AssemblyInfo.cs b/CodeCompliance_oM/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/InteroperabilityTest_Engine/Properties/AssemblyInfo.cs b/InteroperabilityTest_Engine/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/InteroperabilityTest_oM/Properties/AssemblyInfo.cs b/InteroperabilityTest_oM/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/NUnit_Engine/NUnit_Engine.csproj b/NUnit_Engine/NUnit_Engine.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Description>https://github.com/BHoM/Test_Toolkit</Description>
-    <FileVersion>8.1.0.0</FileVersion>
+    <FileVersion>8.2.0.0</FileVersion>
     <AssemblyVersion>8.0.0.0</AssemblyVersion>
     <RootNamespace>BH.Engine.Test.NUnit</RootNamespace>
     <BaseOutputPath>..\Build</BaseOutputPath>
diff --git a/NUnit_oM/NUnit_oM.csproj b/NUnit_oM/NUnit_oM.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Description>https://github.com/BHoM/Test_Toolkit</Description>
-    <FileVersion>8.1.0.0</FileVersion>
+    <FileVersion>8.2.0.0</FileVersion>
     <AssemblyVersion>8.0.0.0</AssemblyVersion>
     <RootNamespace>BH.oM.Test.NUnit</RootNamespace>
     <BaseOutputPath>..\Build</BaseOutputPath>
diff --git a/TestRunner/Properties/AssemblyInfo.cs b/TestRunner/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/Test_Engine/Properties/AssemblyInfo.cs b/Test_Engine/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/Test_Engine/Query/IsTestToolkit.cs b/Test_Engine/Query/IsTestToolkit.cs
@@ -0,0 +1,85 @@
+﻿/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.oM.Base;
+using BH.oM.Base.Attributes;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using System.Reflection;
+
+namespace BH.Engine.Test
+{
+    public static partial class Query
+    {
+        /***************************************************/
+        /**** Public Methods                            ****/
+        /***************************************************/
+
+        [Description("Checks if a type is defined in an assembly that is part of Test_Toolkit.")]
+        [Input("type", "Type to check.")]
+        [Output("isTestToolkit", "Returns true if the type is defined inside Test_Toolkit.")]
+        public static bool IsTestToolkit(this Type type)
+        {
+            if (type == null)
+                return false;
+
+            string assemblyName = type.Assembly?.GetName()?.Name;
+            
+            return m_testToolkitAssemblyNames.Contains(assemblyName);
+        }
+
+        /***************************************************/
+
+        [Description("Checks if a method is defined in an assembly that is part of Test_Toolkit.")]
+        [Input("method", "Method to check.")]
+        [Output("isTestToolkit", "Returns true if the method is defined inside Test_Toolkit.")]
+        public static bool IsTestToolkit(this MethodBase method)
+        {
+            if (method == null)
+                return false;
+
+            return method.DeclaringType.IsTestToolkit();
+        }
+
+        /***************************************************/
+        /**** Private Fields                            ****/
+        /***************************************************/
+
+        private static HashSet<string> m_testToolkitAssemblyNames = new HashSet<string> 
+        { 
+            "CodeComplianceTest_Engine", 
+            "CodeComplianceTest_oM", 
+            "InteroperabilityTest_Engine", 
+            "InteroperabilityTest_oM", 
+            "NUnit_Engine", 
+            "NUnit_oM", 
+            "Test_Engine", 
+            "TestRunner", 
+            "UnitTest_Engine", 
+            "UnitTest_oM" 
+        };
+
+        /***************************************************/
+    }
+}
diff --git a/Test_Engine/Query/VersioningAdapterConstructorList.cs b/Test_Engine/Query/VersioningAdapterConstructorList.cs
@@ -26,9 +26,11 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.IO;
 using System.Linq;
 using System.Reflection;
 
+
 namespace BH.Engine.Test
 {
     public static partial class Query
@@ -41,7 +43,7 @@ public static partial class Query
         [Input("includeRevit", "Toggle to control wheter assemblies depending on revit API dlls should be loaded or not.")]
         [MultiOutput(0, "included", "AdapterConstructors to be considered for adding to the Versioning TestSet.")]
         [MultiOutput(1, "ignored", "AdapterConstructors to _not_ be added to the Versioning TestSet.")]
-        public static Output<List<ConstructorInfo>, List<ConstructorInfo>> VersioningAdapterConstructorList(bool includeRevit = true)
+        public static Output<List<ConstructorInfo>, List<ConstructorInfo>> VersioningAdapterConstructorList(bool includeRevit = true, List<Type> ignoredTypes = null)
         {
             BH.Engine.Base.Compute.LoadAllAssemblies();
 
@@ -52,16 +54,30 @@ public static Output<List<ConstructorInfo>, List<ConstructorInfo>> VersioningAda
                     BH.Engine.Base.Compute.RecordError($"Exiting {nameof(VersioningAdapterConstructorList)} with empty lists returned as failed to execute {nameof(Compute.LoadRevitAssemblies)}.");
                     return new Output<List<ConstructorInfo>, List<ConstructorInfo>>() { Item1 = new List<ConstructorInfo>(), Item2 = new List<ConstructorInfo>() };
                 }
-            }
 
+            }
+            ignoredTypes = ignoredTypes ?? new List<Type>();
             List<ConstructorInfo> bhomAdapterConstructors = BH.Engine.Base.Query.AdapterTypeList().SelectMany(x => x.GetConstructors()).ToList();
 
             List<ConstructorInfo> included = new List<ConstructorInfo>();
             List<ConstructorInfo> ignored = new List<ConstructorInfo>();
 
-            foreach (var ctor in bhomAdapterConstructors) 
-            { 
-                if(ctor.IsNotImplemented() || ctor.IsDeprecated())
+            foreach (var ctor in bhomAdapterConstructors)
+            {
+                bool shouldBeIgnored = ignoredTypes.Any(x => x.IsAssignableFrom(ctor.DeclaringType));
+
+
+                bool isDepractedOrNotImplemented = false;
+                try
+                {
+                    isDepractedOrNotImplemented = ctor.IsDeprecated() || ctor.IsNotImplemented();
+                }
+                catch (Exception e)
+                {
+                    isDepractedOrNotImplemented = true;
+                    BH.Engine.Base.Compute.RecordError(e, $"Could not check if {ctor.DeclaringType.Name} was deprecated");
+                }
+                if (shouldBeIgnored || isDepractedOrNotImplemented || ctor.IsTestToolkit())
                     ignored.Add(ctor);
                 else
                     included.Add(ctor);
@@ -71,6 +87,8 @@ public static Output<List<ConstructorInfo>, List<ConstructorInfo>> VersioningAda
         }
 
         /***************************************************/
+
+
     }
 }
 
diff --git a/Test_Engine/Query/VersioningMethodList.cs b/Test_Engine/Query/VersioningMethodList.cs
@@ -56,10 +56,18 @@ public static Output<List<MethodInfo>, List<MethodInfo>> VersioningMethodList(bo
 
             List<MethodInfo> bhomMethodList = BH.Engine.Base.Query.BHoMMethodList();
 
-            List<MethodInfo> included = bhomMethodList;
+            List<MethodInfo> included = new List<MethodInfo>();
             List<MethodInfo> ignored = new List<MethodInfo>();
 
-            //Note, keeping both collections here for now to allow for future filtering without requirement of changing scripts.
+            foreach (MethodInfo method in bhomMethodList)
+            {
+                bool isPropMethod = method.DeclaringType.GetProperties().Any(x => x.GetSetMethod() == method || x.GetGetMethod() == method);
+                if (!method.IsTestToolkit() && !isPropMethod)
+                    included.Add(method);
+                else
+                    ignored.Add(method);
+            }
+
             return new Output<List<MethodInfo>, List<MethodInfo>> { Item1 = included, Item2 = ignored };
         }
 
diff --git a/Test_Engine/Query/VersioningTypeList.cs b/Test_Engine/Query/VersioningTypeList.cs
@@ -60,7 +60,17 @@ public static Output<List<Type>, List<Type>> VersioningTypeList(bool includeRevi
 
             foreach (Type type in bhomTypeList)
             {
-                if (typeof(IObject).IsAssignableFrom(type) && !type.IsAbstract && !type.IsDeprecated())
+                bool isDepracted = false;
+                try
+                {
+                    isDepracted = type.IsDeprecated();
+                }
+                catch (Exception e)
+                {
+                    isDepracted = true;
+                    BH.Engine.Base.Compute.RecordError(e, $"Could not check if {type.FullName} was deprecated");
+                }
+                if (!type.IsTestToolkit() && typeof(IObject).IsAssignableFrom(type) && !type.IsAbstract && !isDepracted)
                 {
                     includeTypeList.Add(type);
                 }
diff --git a/Test_Engine/Test_Engine.csproj b/Test_Engine/Test_Engine.csproj
@@ -91,6 +91,7 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Query\FullMessage.cs" />
     <Compile Include="Query\IsEqualOrMoreSevere.cs" />
+    <Compile Include="Query\IsTestToolkit.cs" />
     <Compile Include="Query\MostSevereStatus.cs" />
     <Compile Include="Query\TestInformationOfType.cs" />
     <Compile Include="Query\VersioningAdapterConstructorList.cs" />
diff --git a/UnitTest_Engine/Properties/AssemblyInfo.cs b/UnitTest_Engine/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
diff --git a/UnitTest_oM/Properties/AssemblyInfo.cs b/UnitTest_oM/Properties/AssemblyInfo.cs
@@ -55,7 +55,7 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("8.0.0.0")]
-[assembly: AssemblyFileVersion("8.1.0.0")]
+[assembly: AssemblyFileVersion("8.2.0.0")]
 
 
 
