Merge pull request #4893 from NikCharlebois/Tests-Improvements

Fixes to Tests and EXOHostedOutboundSpamFilterPolicy
microsoft · Jul 16, 2024 · 64bf481 · 64bf481
2 parents 06f729c + 2d8ca47
commit 64bf481
Show file tree

Hide file tree

Showing 25 changed files with 39 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 # UNRELEASED
 
+* EXOHostedOutboundSpamFilterPolicy
+  * Changed the RecipientLimitInternalPerHour, RecipientLimitPerDay, and
+    RecipientLimitExternalPerHour parameters to UInt32.
 * M365DSCReport
   * Changes behaviour to not throw on empty configuration during report generation.  
     FIXES [#4559](https://github.com/microsoft/Microsoft365DSC/issues/4559)  

diff --git a/...t365DSC/DSCResources/MSFT_EXOHostedContentFilterRule/MSFT_EXOHostedContentFilterRule.psm1 b/...t365DSC/DSCResources/MSFT_EXOHostedContentFilterRule/MSFT_EXOHostedContentFilterRule.psm1
@@ -86,7 +86,7 @@ function Get-TargetResource
         $AccessTokens
     )
 
-    Write-Verbose -Message "Getting configuration of HostedContentFilterRule for $Identity"
+    Write-Verbose -Message "Getting configuration of HostedContentFilterRule for [$Identity]"
 
     #Ensure the proper dependencies are installed in the current environment.
     Confirm-M365DSCDependencies
@@ -122,10 +122,19 @@ function Get-TargetResource
         }
         catch
         {
-            $Message = 'Error calling {Get-HostedContentFilterRule}'
-            New-M365DSCLogEntry -Message $Message `
-                -Exception $_ `
-                -Source $MyInvocation.MyCommand.ModuleName
+            try
+            {
+                Write-Verbose -Message "Couldn't find rule by ID, trying by name."
+                $rules = Get-HostedContentFilterRule
+                $HostedContentFilterRule = $rules | Where-Object -FilterScript {$_.Name -eq $Identity -and $_.HostedContentFilterPolicy -eq $HostedContentFilterPolicy}
+            }
+            catch
+            {
+                $Message = 'Error calling {Get-HostedContentFilterRule}'
+                New-M365DSCLogEntry -Message $Message `
+                    -Exception $_ `
+                    -Source $MyInvocation.MyCommand.ModuleName
+            }
         }
         if (-not $HostedContentFilterRule)
         {

diff --git a/...ources/MSFT_EXOHostedOutboundSpamFilterPolicy/MSFT_EXOHostedOutboundSpamFilterPolicy.psm1 b/...ources/MSFT_EXOHostedOutboundSpamFilterPolicy/MSFT_EXOHostedOutboundSpamFilterPolicy.psm1
@@ -29,15 +29,15 @@ function Get-TargetResource
         $NotifyOutboundSpam = $true,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitInternalPerHour,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitPerDay,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitExternalPerHour,
 
         [Parameter()]
@@ -196,15 +196,15 @@ function Set-TargetResource
         $NotifyOutboundSpam = $true,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitInternalPerHour,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitPerDay,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitExternalPerHour,
 
         [Parameter()]
@@ -337,15 +337,15 @@ function Test-TargetResource
         $NotifyOutboundSpam = $true,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitInternalPerHour,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitPerDay,
 
         [Parameter()]
-        [System.String]
+        [System.UInt32]
         $RecipientLimitExternalPerHour,
 
         [Parameter()]

diff --git a/.../MSFT_EXOHostedOutboundSpamFilterPolicy/MSFT_EXOHostedOutboundSpamFilterPolicy.schema.mof b/.../MSFT_EXOHostedOutboundSpamFilterPolicy/MSFT_EXOHostedOutboundSpamFilterPolicy.schema.mof
@@ -7,9 +7,9 @@ class MSFT_EXOHostedOutboundSpamFilterPolicy : OMI_BaseResource
     [Write, Description("The BccSuspiciousOutboundMail parameter enables or disables adding recipients to the Bcc field of outgoing spam messages. Valid input for this parameter is $true or $false. The default value is $false. You specify the additional recipients using the BccSuspiciousOutboundAdditionalRecipients parameter.")] Boolean BccSuspiciousOutboundMail;
     [Write, Description("The NotifyOutboundSpam parameter enables or disables sending notification messages to administrators when an outgoing message is determined to be spam. Valid input for this parameter is $true or $false. The default value is $false. You specify the administrators to notify by using the NotifyOutboundSpamRecipients parameter.")] Boolean NotifyOutboundSpam;
     [Write, Description("The NotifyOutboundSpamRecipients parameter specifies the administrators to notify when an outgoing message is determined to be spam. Valid input for this parameter is an email address. Separate multiple email addresses with commas.")] String NotifyOutboundSpamRecipients[];
-    [Write, Description("The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used.")] String RecipientLimitInternalPerHour;
-    [Write, Description("The RecipientLimitPerDay parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used.")] String RecipientLimitPerDay;
-    [Write, Description("The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used.")] String RecipientLimitExternalPerHour;
+    [Write, Description("The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used.")] UInt32 RecipientLimitInternalPerHour;
+    [Write, Description("The RecipientLimitPerDay parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used.")] UInt32 RecipientLimitPerDay;
+    [Write, Description("The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used.")] UInt32 RecipientLimitExternalPerHour;
     [Write, Description("The ActionWhenThresholdReached parameter specifies the action to take when any of the limits specified in the policy are reached. Valid values are: Alert, BlockUser, BlockUserForToday. BlockUserForToday is the default value.")] String ActionWhenThresholdReached;
     [Write, Description("The AutoForwardingMode specifies how the policy controls automatic email forwarding to outbound recipients. Valid values are: Automatic, On, Off.")] String AutoForwardingMode;
     [Write, Description("Specify if this policy should exist or not."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXODistributionGroup/1-Create.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXODistributionGroup/1-Create.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXODistributionGroup 'DemoDG'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOEmailAddressPolicy/1-Create.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOEmailAddressPolicy/1-Create.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOEmailAddressPolicy 'ConfigureEmailAddressPolicy'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOHostedOutboundSpamFilterPolicy/1-Create.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOHostedOutboundSpamFilterPolicy/1-Create.ps1
@@ -33,9 +33,9 @@ Configuration Example
             BccSuspiciousOutboundMail                 = $False
             NotifyOutboundSpam                        = $False
             NotifyOutboundSpamRecipients              = @()
-            RecipientLimitExternalPerHour             = 0
-            RecipientLimitInternalPerHour             = 0
-            RecipientLimitPerDay                      = 0
+            #RecipientLimitExternalPerHour             = 0
+            #RecipientLimitInternalPerHour             = 0
+            #RecipientLimitPerDay                      = 0
             Ensure                                    = "Present"
             ApplicationId         = $ApplicationId
             TenantId              = $TenantId

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOHostedOutboundSpamFilterPolicy/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOHostedOutboundSpamFilterPolicy/2-Update.ps1
@@ -33,9 +33,9 @@ Configuration Example
             BccSuspiciousOutboundMail                 = $False
             NotifyOutboundSpam                        = $False
             NotifyOutboundSpamRecipients              = @()
-            RecipientLimitExternalPerHour             = 0
-            RecipientLimitInternalPerHour             = 1 # Updated Property
-            RecipientLimitPerDay                      = 0
+            #RecipientLimitExternalPerHour             = 0
+            #RecipientLimitInternalPerHour             = 1 # Updated Property
+            #RecipientLimitPerDay                      = 0
             Ensure                                    = "Present"
             ApplicationId         = $ApplicationId
             TenantId              = $TenantId

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOHostedOutboundSpamFilterRule/3-Remove.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOHostedOutboundSpamFilterRule/3-Remove.ps1
@@ -21,7 +21,6 @@ Configuration Example
 
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOHostedOutboundSpamFilterRule 'ConfigureHostedOutboundSpamFilterRule'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOMailContact/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOMailContact/2-Update.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOMailContact 'TestMailContact'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOMailContact/3-Remove.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOMailContact/3-Remove.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOMailContact 'TestMailContact'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRole/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRole/2-Update.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOManagementRole 'ConfigureManagementRole'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRoleAssignment/1-Create.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRoleAssignment/1-Create.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOManagementRoleAssignment 'AssignManagementRole'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRoleAssignment/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRoleAssignment/2-Update.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOManagementRoleAssignment 'AssignManagementRole'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRoleAssignment/3-Remove.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOManagementRoleAssignment/3-Remove.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOManagementRoleAssignment 'AssignManagementRole'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOQuarantinePolicy/1-Create.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOQuarantinePolicy/1-Create.ps1
@@ -18,7 +18,6 @@ Configuration Example
         [System.String]
         $CertificateThumbprint
     )
-    $OrganizationName = $Credscredential.UserName.Split('@')[1]
     Import-DscResource -ModuleName Microsoft365DSC
 
     node localhost

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOQuarantinePolicy/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOQuarantinePolicy/2-Update.ps1
@@ -18,10 +18,8 @@ Configuration Example
         [System.String]
         $CertificateThumbprint
     )
-    $OrganizationName = $Credscredential.UserName.Split('@')[1]
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOQuarantinePolicy 'ConfigureQuarantinePolicy'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOQuarantinePolicy/3-Remove.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOQuarantinePolicy/3-Remove.ps1
@@ -18,10 +18,8 @@ Configuration Example
         [System.String]
         $CertificateThumbprint
     )
-    $OrganizationName = $Credscredential.UserName.Split('@')[1]
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOQuarantinePolicy 'ConfigureQuarantinePolicy'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOSafeAttachmentPolicy/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOSafeAttachmentPolicy/2-Update.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOSafeAttachmentPolicy 'ConfigureSafeAttachmentPolicy'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOSafeAttachmentPolicy/3-Remove.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOSafeAttachmentPolicy/3-Remove.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOSafeAttachmentPolicy 'ConfigureSafeAttachmentPolicy'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOSafeAttachmentRule/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOSafeAttachmentRule/2-Update.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOSafeAttachmentRule 'ConfigureSafeAttachmentRule'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOSharedMailbox/3-Remove.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOSharedMailbox/3-Remove.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOSharedMailbox 'SharedMailbox'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOTransportRule/1-Create.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOTransportRule/1-Create.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOTransportRule 'ConfigureTransportRule'

diff --git a/Modules/Microsoft365DSC/Examples/Resources/EXOTransportRule/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/EXOTransportRule/2-Update.ps1
@@ -20,7 +20,6 @@ Configuration Example
     )
     Import-DscResource -ModuleName Microsoft365DSC
 
-    $Domain = $Credscredential.Username.Split('@')[1]
     node localhost
     {
         EXOTransportRule 'ConfigureTransportRule'

diff --git a/Tests/QA/Microsoft365DSC.Examples.Tests.ps1 b/Tests/QA/Microsoft365DSC.Examples.Tests.ps1
@@ -153,6 +153,10 @@ Describe -Name 'Successfully compile examples' {
                                         #>
                                     $exampleParameters.Add($parameterName, ('1' -as $parameterType))
                                 }
+                                elseif ($parameterName -eq 'TenantId')
+                                {
+                                    $exampleParameters.Add('TenantId', (New-Guid).ToString())
+                                }
                             }
                         }