Changes to SqlSetup and SqlRS

- Made the error message more descriptive when the Set-TargetResource
  function calls the Test-TargetResource function to verify the desired
  state.

CHANGELOG.md

@@ -22,12 +22,20 @@
   - Added additional unit tests for code coverage.
 - Changes to SqlSetup
   - Concatenated Robocopy localization strings ([issue #694](https://github.com/PowerShell/SqlServerDsc/issues/694)).
+  - Made the error message more descriptive when the Set-TargetResource
+    function calls the Test-TargetResource function to verify the desired
+    state.
 - Changes to SqlWaitForAG
   - Added en-US localization ([issue #625](https://github.com/PowerShell/SqlServerDsc/issues/625)).
 - Changes to SqlServerPermission
   - Added en-US localization ([issue #619](https://github.com/PowerShell/SqlServerDsc/issues/619)).
 - Changes to SqlWindowsFirewall
   - Added en-US localization ([issue #614](https://github.com/PowerShell/SqlServerDsc/issues/614)).
+- Changes to SqlRS
+  - Fixed one of the error handling to use localization, and made the
+    error message more descriptive when the Set-TargetResource function
+    calls the Test-TargetResource function to verify the desired
+    state. *This was done prior to adding full en-US localization.*
 
 ## 12.4.0.0
 

DSCResources/MSFT_SqlRS/MSFT_SqlRS.psm1

@@ -7,6 +7,8 @@ Import-Module -Name (Join-Path -Path $script:localizationModulePath -ChildPath '
 $script:resourceHelperModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath 'DscResource.Common'
 Import-Module -Name (Join-Path -Path $script:resourceHelperModulePath -ChildPath 'DscResource.Common.psm1')
 
+$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_SqlWindowsFirewall'
+
 <#
     .SYNOPSIS
         Gets the SQL Reporting Services initialization status.
@@ -670,7 +672,8 @@ function Set-TargetResource
 
     if ( -not (Test-TargetResource @PSBoundParameters) )
     {
-        throw New-TerminatingError -ErrorType TestFailedAfterSet -ErrorCategory InvalidResult
+        $errorMessage = $script:localizedData.TestFailedAfterSet
+        New-InvalidResultException -Message $errorMessage
     }
 }
 

DSCResources/MSFT_SqlRS/en-US/MSFT_SqlRSSetup.strings.psd1

@@ -0,0 +1,3 @@
+ConvertFrom-StringData @'
+    TestFailedAfterSet = Test-TargetResource function returned false when Set-TargetResource function verified the desired state. This indicates that the Set-TargetResource did not correctly set set the desired state, or that the function Test-TargetResource does not correctly evaluates the desired state.
+'@

DSCResources/MSFT_SqlSetup/en-US/MSFT_SqlSetup.strings.psd1

@@ -55,7 +55,7 @@ ConvertFrom-StringData @'
     SetupFailed = Please see the 'Summary.txt' log file in the 'Setup Bootstrap\\Log' folder.
     Reboot = Rebooting target node.
     SuppressReboot = Suppressing reboot of target node.
-    TestFailedAfterSet = Test-TargetResource returned false after calling Set-TargetResource.
+    TestFailedAfterSet = Test-TargetResource function returned false when Set-TargetResource function verified the desired state. This indicates that the Set-TargetResource did not correctly set set the desired state, or that the function Test-TargetResource does not correctly evaluates the desired state.
     FeaturesFound = Found features already installed: {0}
     NoFeaturesFound = No features are installed.
     UnableToFindFeature = Unable to find feature '{0}' among the installed features: '{1}'.

DSCResources/MSFT_SqlSetup/sv-SE/MSFT_SqlSetup.strings.psd1

@@ -55,7 +55,7 @@ ConvertFrom-StringData @'
     SetupFailed = Vänligen titta i loggfilen 'Summary.txt' i sökvägen 'Setup Bootstrap\\Log'.
     Reboot = Startar om målnod.
     SuppressReboot = Förhindrar omstart av målnod.
-    TestFailedAfterSet = Test-TargetResource retunerade falskt efter anropet till Set-TargetResource.
+    TestFailedAfterSet = Funktionen Test-TargetResource returnerade falskt när funktionen Set-TargetResource verifierade önskad konfiguration. Detta indikerar att funktionen Set-TargetResource inte på ett korrekt sätt kunde sätta önskad konfiguration, eller att funktionen Test-TargetResource inte utvärderar önskad konfiguration på korrekt sätt.
     FeaturesFound = Funktioner funna: {0}
     UnableToFindFeature = Kunde inte hitta funktion '{0}' bland som installerade funktionerna: '{1}'.
     EvaluatingClusterParameters = Klustrad installation, kontrollerar parametrar.

Modules/DscResource.Common/en-US/DscResource.Common.strings.psd1

@@ -65,7 +65,6 @@ ConvertFrom-StringData @'
     # Common
     NoKeyFound = No Localization key found for ErrorType: '{0}'.
     AbsentNotImplemented = Ensure = Absent is not implemented!
-    TestFailedAfterSet = Test-TargetResource returned false after calling set.
     RemoteConnectionFailed = Remote PowerShell connection to Server '{0}' failed.
     TODO = ToDo. Work not implemented at this time.
     UnexpectedErrorFromGet = Got unexpected result from Get-TargetResource. No change is made.

Modules/DscResource.Common/sv-SE/DscResource.Common.strings.psd1

@@ -54,7 +54,6 @@ ConvertFrom-StringData @'
     # Common
     NoKeyFound = No Localization key found for ErrorType: '{0}'.
     AbsentNotImplemented = Ensure = Absent is not implemented!
-    TestFailedAfterSet = Test-TargetResource returned false after calling set.
     RemoteConnectionFailed = Remote PowerShell connection to Server '{0}' failed.
     TODO = ToDo. Work not implemented at this time.
     UnexpectedErrorFromGet = Got unexpected result from Get-TargetResource. No change is made.

Tests/Unit/MSFT_SqlRS.Tests.ps1

@@ -417,7 +417,7 @@ try
                         }
 
                         It 'Should throw the correct error message' {
-                            { Set-TargetResource @defaultParameters } | Should -Throw 'Test-TargetResource returned false after calling set.'
+                            { Set-TargetResource @defaultParameters } | Should -Throw $script:localizedData.TestFailedAfterSet
                         }
                     }