ADDomain: Add Get-ADDomain Additional Retry Exceptions

CHANGELOG.md

@@ -37,6 +37,9 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)
 - ADOrganizationalUnit
   - Fixed issue where Get-DscConfiguration / Test-DscConfiguration throw an exception when parent path does not yet exist
     ([issue #553](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/553))
+- ADDomain
+  - Added additional Get-ADDomain retry exceptions
+    ([issue #574](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/574)).
 
 ### Changed
 

Tests/Unit/MSFT_ADDomain.Tests.ps1

@@ -261,6 +261,48 @@ try
                     }
                 }
 
+                Context 'When Get-ADDomain throws an AuthenticationException until timeout' {
+                    BeforeAll {
+                        Mock -CommandName Get-AdDomain `
+                            -MockWith { throw New-Object -TypeName 'System.Security.Authentication.AuthenticationException' }
+                        Mock -CommandName Start-Sleep
+                    }
+
+                    It 'Should throw the correct exception' {
+                        { Get-TargetResource @mockGetTargetResourceParameters } |
+                            Should -Throw ($script:localizedData.MaxDomainRetriesReachedError -f $mockDomainFQDN)
+                    }
+
+                    It 'Should call the expected mocks' {
+                        Assert-MockCalled -CommandName Get-ADDomain `
+                            -ParameterFilter { $Identity -eq $mockDomainFQDN } `
+                            -Exactly -Times $maxRetries
+                        Assert-MockCalled -CommandName Start-Sleep `
+                            -Exactly -Times $maxRetries
+                    }
+                }
+
+                Context 'When Get-ADDomain throws an InvalidOperationException until timeout' {
+                    BeforeAll {
+                        Mock -CommandName Get-AdDomain `
+                            -MockWith { throw New-Object -TypeName 'System.InvalidOperationException' }
+                        Mock -CommandName Start-Sleep
+                    }
+
+                    It 'Should throw the correct exception' {
+                        { Get-TargetResource @mockGetTargetResourceParameters } |
+                            Should -Throw ($script:localizedData.MaxDomainRetriesReachedError -f $mockDomainFQDN)
+                    }
+
+                    It 'Should call the expected mocks' {
+                        Assert-MockCalled -CommandName Get-ADDomain `
+                            -ParameterFilter { $Identity -eq $mockDomainFQDN } `
+                            -Exactly -Times $maxRetries
+                        Assert-MockCalled -CommandName Start-Sleep `
+                            -Exactly -Times $maxRetries
+                    }
+                }
+
                 Context 'When Get-ADForest throws an unexpected error' {
                     BeforeAll {
                         Mock -CommandName Get-AdForest `

source/DSCResources/MSFT_ADDomain/MSFT_ADDomain.psm1

@@ -100,9 +100,11 @@ function Get-TargetResource
             {
                 $domain = Get-ADDomain -Identity $domainFQDN -Server localhost -ErrorAction Stop
             }
-            catch [Microsoft.ActiveDirectory.Management.ADServerDownException]
+            catch [Microsoft.ActiveDirectory.Management.ADServerDownException], `
+                [System.Security.Authentication.AuthenticationException], `
+                [System.InvalidOperationException]
             {
-                Write-Verbose ($script:localizedData.ADServerDown -f $domainFQDN)
+                Write-Verbose ($script:localizedData.ADServerNotReady -f $domainFQDN)
                 $domainFound = $false
                 # will fall into the retry mechanism.
             }

source/DSCResources/MSFT_ADDomain/en-US/MSFT_ADDomain.strings.psd1

@@ -1,7 +1,7 @@
 # culture="en-US"
 ConvertFrom-StringData @'
     QueryDomain                        = Querying for domain '{0}'. (ADD0001)
-    ADServerDown                       = The AD Server for domain '{0}' is currently down. (ADD0002)
+    ADServerNotReady                   = The AD Server for domain '{0}' is currently not ready. (ADD0002)
     DomainFound                        = Active Directory domain '{0}' found. (ADD0003)
     CreatingChildDomain                = Creating domain '{0}' as a child of domain '{1}'. (ADD0004)
     CreatedChildDomain                 = Child domain '{0}' created. (ADD0005)