Merge pull request #644 from PowershellFrameworkCollective/development

1.12.346

Author: FriedrichWeinmann

PSFramework/PSFramework.psd1

@@ -4,7 +4,7 @@
 	RootModule = 'PSFramework.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '1.12.345'
+	ModuleVersion = '1.12.346'
 
 	# ID used to uniquely identify this module
 	GUID = '8028b914-132b-431f-baa9-94a6952f21ff'

PSFramework/bin/PSFramework.dll

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.12.346 (2024-09-25)
+
+- Fix: MessageLevel Modifiers break Write-PSFMessage
+
 ## 1.12.345 (2024-09-17)
 
 > Breaking Change

PSFramework/bin/PSFramework.pdb

@@ -0,0 +1,29 @@
+Describe "New-PSFMessageLevelModifier Unit Tests" -Tag "CI", "Pipeline", "Unit" {
+	BeforeAll {
+		[PSFramework.Message.MessageHost]::MessageLevelModifiers.Clear()
+	}
+	AfterAll {
+		[PSFramework.Message.MessageHost]::MessageLevelModifiers.Clear()
+	}
+	It "Should create a new message level modifier without error and as defined" {
+		{ New-PSFMessageLevelModifier -Name Test -Modifier -3 -IncludeFunctionName Get-Test -IncludeModuleName TestModule -IncludeTags Foo, Bar -EnableException } | Should -Not -Throw
+		{ Write-PSFMessage -Message Test } | Should -Not -Throw
+
+		$modifier = Get-PSFMessageLevelModifier
+		$modifier.Name | Should -Be 'Test'
+		$modifier.Modifier | Should -Be -3
+		$modifier.IncludeFunctionName | Should -Be 'Get-Test'
+		$modifier.IncludeModuleName | Should -Be TestModule
+		$modifier.IncludeTags.Count | Should -Be 2
+		$modifier.IncludeTags | Should -Contain Foo
+		$modifier.IncludeTags | Should -Contain Bar
+	}
+
+	It "Should apply  filters correctly" {
+		$modifier = Get-PSFMessageLevelModifier
+		$modifier.AppliesTo("Get-Test","TestModule", @('Foo', 'Test')) | Should -BeTrue
+		$modifier.AppliesTo("Get-Test","TestModule", @('Test')) | Should -BeFalse
+		$modifier.AppliesTo("Get-Test","TestModule", @('Bar', 'Test')) | Should -BeTrue
+		$modifier.AppliesTo("Get-Test2","TestModule", @('Foo', 'Test')) | Should -BeFalse
+	}
+}

PSFramework/bin/PSFramework.xml

@@ -61,15 +61,17 @@ public class MessageLevelModifier
         public bool AppliesTo(string FunctionName, string ModuleName, List<string> Tags)
         {
             // Negatives
-            if (ExcludeFunctionName.Equals(FunctionName, StringComparison.OrdinalIgnoreCase))
+            if (!String.IsNullOrEmpty(ExcludeFunctionName) && ExcludeFunctionName.Equals(FunctionName, StringComparison.OrdinalIgnoreCase))
                 return false;
-            if (ExcludeModuleName.Equals(ModuleName, StringComparison.OrdinalIgnoreCase))
+            if (!String.IsNullOrEmpty(ExcludeModuleName) && ExcludeModuleName.Equals(ModuleName, StringComparison.OrdinalIgnoreCase))
                 return false;
+            
             if (Tags != null)
                 foreach (string tag in ExcludeTags)
-                    foreach (string tag2 in Tags)
-                        if (tag.Equals(tag2, StringComparison.OrdinalIgnoreCase))
-                            return false;
+                    if (!String.IsNullOrEmpty(tag))
+                        foreach (string tag2 in Tags)
+                            if (tag.Equals(tag2, StringComparison.OrdinalIgnoreCase))
+                                return false;
 
             // Positives
             if (!String.IsNullOrEmpty(IncludeFunctionName))
@@ -83,9 +85,10 @@ public bool AppliesTo(string FunctionName, string ModuleName, List<string> Tags)
             {
                 if (Tags != null)
                     foreach (string tag in IncludeTags)
-                        foreach (string tag2 in Tags)
-                            if (tag.Equals(tag2, StringComparison.OrdinalIgnoreCase))
-                                return true;
+                        if (!String.IsNullOrEmpty(tag))
+                            foreach (string tag2 in Tags)
+                                if (tag.Equals(tag2, StringComparison.OrdinalIgnoreCase))
+                                    return true;
 
                 return false;
             }

PSFramework/changelog.md

@@ -262,6 +262,12 @@ public static object GetSerializationData(PSObject psObject)
         /// </summary>
         public static readonly ConcurrentDictionary<string, bool> AssemblyShortnameMapping = new ConcurrentDictionary<string, bool>(StringComparer.InvariantCultureIgnoreCase);
 
+        /// <summary>
+        /// Converts an object into XML
+        /// </summary>
+        /// <param name="Item">The object to serialize</param>
+        /// <returns>The XML form of the object</returns>
+        /// <exception cref="ArgumentNullException">$null objects are not accepted</exception>
         public static string ConvertToXml(object Item)
         {
             if (Item == null)
@@ -278,6 +284,12 @@ public static string ConvertToXml(object Item)
             return result;
         }
 
+        /// <summary>
+        /// Deserializes an XML object back into its object form
+        /// </summary>
+        /// <param name="Xml">The XML text to convert</param>
+        /// <param name="ExpectedType">What type to convert to</param>
+        /// <returns>The converted object</returns>
         public static object ConvertFromXml(string Xml, Type ExpectedType)
         {
             object result;