Improve integration tests for RS Service Account

Author: johlju

CHANGELOG.md

@@ -194,6 +194,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   for SQL Server Reporting Services or Power BI Report Server. Supports waiting
   for dependent services, configurable wait time, and accepts pipeline input
   from `Get-SqlDscRSConfiguration`.
+- Added public command `New-SqlDscRSEncryptionKey` to delete and regenerate the
+  Reporting Services encryption key. Wraps the `DeleteEncryptionKey` CIM method.
+  Warning: This operation cannot be undone and renders all encrypted content
+  unreadable.
+- Added public command `Remove-SqlDscRSEncryptionKey` to remove all encrypted
+  content from the report server database. Wraps the `DeleteEncryptionKey` CIM
+  method with `DeleteEncryptedContent` mode.
+- Added public command `Remove-SqlDscRSEncryptedInformation` to remove all encrypted
+  information from the report server database, including stored credentials and
+  connection strings. Wraps the `DeleteEncryptedInformation` CIM method.
 - Added public commands `Get-SqlDscRSServiceAccount` and
   `Set-SqlDscRSServiceAccount` to get and set the Windows service account for
   SQL Server Reporting Services or Power BI Report Server. `Set-SqlDscRSServiceAccount`

azure-pipelines.yml

@@ -143,10 +143,20 @@ stages:
               $pesterConfig.Run.Path = '.\tests\QA'
               $pesterConfig.Run.Throw = $true
               $pesterConfig.Output.Verbosity = 'Detailed'
+              $pesterConfig.TestResult.Enabled = $true
+              $pesterConfig.TestResult.OutputFormat = 'NUnitXml'
+              $pesterConfig.TestResult.OutputPath = ".\$(buildFolderName)\$(testResultFolderName)\NUnit_QA.xml"
 
               Invoke-Pester -Configuration $pesterConfig
             name: qualityTest
             displayName: 'Run SqlServerDsc QA Test'
+          - task: PublishTestResults@2
+            displayName: 'Publish Test Results'
+            condition: succeededOrFailed()
+            inputs:
+              testResultsFormat: 'NUnit'
+              testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit_QA.xml'
+              testRunTitle: 'QA'
 
       - job: Test_HQRM
         displayName: 'HQRM Test'
@@ -684,6 +694,7 @@ stages:
                   # Group 8
                   'tests/Integration/Commands/Repair-SqlDscPowerBIReportServer.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscRSUrlReservation.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Remove-SqlDscRSEncryptedInformation.Integration.Tests.ps1'
                   # Group 9
                   'tests/Integration/Commands/Uninstall-SqlDscPowerBIReportServer.Integration.Tests.ps1'
               )

source/en-US/SqlServerDsc.strings.psd1

@@ -827,15 +827,15 @@ ConvertFrom-StringData @'
     Remove_SqlDscRSEncryptionKey_ShouldProcessConfirmation = Are you sure you want to remove the encryption key from Reporting Services instance '{0}'? This is a destructive operation.
     # This string shall not end with full stop (.) since it is used as a title of ShouldProcess messages.
     Remove_SqlDscRSEncryptionKey_ShouldProcessCaption = Remove encryption key from Reporting Services instance
-    Remove_SqlDscRSEncryptionKey_FailedToRemove = Failed to remove encryption key from Reporting Services instance '{0}'. (RRSEK0001)
+    Remove_SqlDscRSEncryptionKey_FailedToRemove = Failed to remove encryption key from Reporting Services instance '{0}'. (RSREK0001)
 
     ## Remove-SqlDscRSEncryptedInformation
     Remove_SqlDscRSEncryptedInformation_Removing = Removing encrypted information from Reporting Services instance '{0}'.
     Remove_SqlDscRSEncryptedInformation_ShouldProcessDescription = Removing encrypted information from Reporting Services instance '{0}'. This is a destructive operation.
     Remove_SqlDscRSEncryptedInformation_ShouldProcessConfirmation = Are you sure you want to remove all encrypted information from Reporting Services instance '{0}'? This is a destructive operation.
     # This string shall not end with full stop (.) since it is used as a title of ShouldProcess messages.
     Remove_SqlDscRSEncryptedInformation_ShouldProcessCaption = Remove encrypted information from Reporting Services instance
-    Remove_SqlDscRSEncryptedInformation_FailedToRemove = Failed to remove encrypted information from Reporting Services instance '{0}'. (RRSREI0001)
+    Remove_SqlDscRSEncryptedInformation_FailedToRemove = Failed to remove encrypted information from Reporting Services instance '{0}'. (RSRSEI0001)
 
     ## Get-SqlDscRSServiceAccount
     Get_SqlDscRSServiceAccount_Getting = Getting service account for Reporting Services instance '{0}'.

tests/Integration/Commands/Remove-SqlDscRSEncryptedInformation.Integration.Tests.ps1

@@ -39,7 +39,7 @@ BeforeAll {
 #>
 
 Describe 'Remove-SqlDscRSEncryptedInformation' {
-    Context 'When removing encrypted information for SQL Server Reporting Services' -Tag @('Integration_SQL2017_RS') -Skip:$true {
+    Context 'When removing encrypted information for SQL Server 2017 Reporting Services' -Tag @('Integration_SQL2017_RS') -Skip:$true {
         BeforeAll {
             $script:configuration = Get-SqlDscRSConfiguration -InstanceName 'SSRS' -ErrorAction 'Stop'
         }
@@ -49,7 +49,7 @@ Describe 'Remove-SqlDscRSEncryptedInformation' {
         }
     }
 
-    Context 'When removing encrypted information for SQL Server Reporting Services' -Tag @('Integration_SQL2019_RS') {
+    Context 'When removing encrypted information for SQL Server 2019 Reporting Services' -Tag @('Integration_SQL2019_RS') {
         BeforeAll {
             $script:configuration = Get-SqlDscRSConfiguration -InstanceName 'SSRS' -ErrorAction 'Stop'
         }
@@ -59,7 +59,7 @@ Describe 'Remove-SqlDscRSEncryptedInformation' {
         }
     }
 
-    Context 'When removing encrypted information for SQL Server Reporting Services' -Tag @('Integration_SQL2022_RS') {
+    Context 'When removing encrypted information for SQL Server 2022 Reporting Services' -Tag @('Integration_SQL2022_RS') {
         BeforeAll {
             $script:configuration = Get-SqlDscRSConfiguration -InstanceName 'SSRS' -ErrorAction 'Stop'
         }

tests/Unit/Public/Request-SqlDscRSDatabaseRightsScript.Tests.ps1

@@ -186,31 +186,31 @@ Describe 'Request-SqlDscRSDatabaseRightsScript' {
         }
 
         It 'Should throw terminating error for UserName without backslash with IsRemote' {
-            $null = { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName 'SQLRSUser' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
+            { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName 'SQLRSUser' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
 
             Should -Not -Invoke -CommandName Invoke-RsCimMethod -ParameterFilter {
                 $MethodName -eq 'GenerateDatabaseRightsScript'
             }
         }
 
         It 'Should throw terminating error for UserName with multiple backslashes with IsRemote' {
-            $null = { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName 'DOMAIN\SUB\SQLRSUser' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
+            { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName 'DOMAIN\SUB\SQLRSUser' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
 
             Should -Not -Invoke -CommandName Invoke-RsCimMethod -ParameterFilter {
                 $MethodName -eq 'GenerateDatabaseRightsScript'
             }
         }
 
         It 'Should throw terminating error for UserName with only domain with IsRemote' {
-            $null = { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName 'DOMAIN\' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
+            { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName 'DOMAIN\' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
 
             Should -Not -Invoke -CommandName Invoke-RsCimMethod -ParameterFilter {
                 $MethodName -eq 'GenerateDatabaseRightsScript'
             }
         }
 
         It 'Should throw terminating error for UserName with only username with IsRemote' {
-            $null = { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName '\SQLRSUser' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
+            { $mockCimInstance | Request-SqlDscRSDatabaseRightsScript -DatabaseName 'ReportServer' -UserName '\SQLRSUser' -IsRemote } | Should -Throw -ErrorId 'UserName,New-ArgumentException'
 
             Should -Not -Invoke -CommandName Invoke-RsCimMethod -ParameterFilter {
                 $MethodName -eq 'GenerateDatabaseRightsScript'