Initialize-SqlDscRS: Add new command (#2400)

Author: johlju

CHANGELOG.md

@@ -177,6 +177,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added public command `Install-SqlDscFailoverCluster` to install SQL Server in
   a failover cluster configuration. Extracted from `Install-SqlDscServer`
   InstallFailoverCluster parameter set.
+- Added public command `Restart-SqlDscRSService` to restart the Windows service
+  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 `Test-SqlDscRSInitialized` to test whether a Reporting
+  Services instance is initialized by checking the `IsInitialized` property of
+  the configuration CIM instance
+  ([issue #2014](https://github.com/dsccommunity/SqlServerDsc/issues/2014)).
+- Added public command `Initialize-SqlDscRS` to initialize Reporting Services
+  by calling the `InitializeReportServer` CIM method. Used to complete initial
+  configuration after database and URL setup
+  ([issue #2014](https://github.com/dsccommunity/SqlServerDsc/issues/2014)).
 
 ### Changed
 
@@ -210,6 +222,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ([issue #2017](https://github.com/dsccommunity/SqlServerDsc/issues/2017))
     ([issue #2019](https://github.com/dsccommunity/SqlServerDsc/issues/2019))
     ([issue #2021](https://github.com/dsccommunity/SqlServerDsc/issues/2021)).
+  - Refactored to use the public command `Restart-SqlDscRSService` for restarting
+    the Reporting Services Windows service instead of calling the private
+    function `Restart-ReportingServicesService` directly.
+  - Refactored to use the public commands `Test-SqlDscRSInitialized` and
+    `Initialize-SqlDscRS` for checking and performing Reporting Services
+    initialization instead of accessing the `IsInitialized` property and
+    calling the CIM method directly
+    ([issue #2014](https://github.com/dsccommunity/SqlServerDsc/issues/2014)).
 - `Assert-SetupActionProperties`
   - Refactored to use the command `Get-FileVersion` from the DscResource.Common
     module instead of the private function `Get-FileVersionInformation`

azure-pipelines.yml

@@ -552,6 +552,11 @@ stages:
                   'tests/Integration/Commands/Remove-SqlDscRSUrlReservation.Integration.Tests.ps1'
                   'tests/Integration/Commands/Set-SqlDscRSUrlReservation.Integration.Tests.ps1'
                   'tests/Integration/Commands/Set-SqlDscRSDatabaseConnection.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Restart-SqlDscRSService.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Request-SqlDscRSDatabaseUpgradeScript.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Test-SqlDscRSInitialized.Integration.Tests.ps1'
+                  # Group 4
+                  'tests/Integration/Commands/Initialize-SqlDscRS.Integration.Tests.ps1'
                   # Group 8
                   'tests/Integration/Commands/Repair-SqlDscReportingService.Integration.Tests.ps1'
                   # Group 9
@@ -631,6 +636,10 @@ stages:
                   'tests/Integration/Commands/Remove-SqlDscRSUrlReservation.Integration.Tests.ps1'
                   'tests/Integration/Commands/Set-SqlDscRSUrlReservation.Integration.Tests.ps1'
                   'tests/Integration/Commands/Set-SqlDscRSDatabaseConnection.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Restart-SqlDscRSService.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Test-SqlDscRSInitialized.Integration.Tests.ps1'
+                  # Group 4
+                  'tests/Integration/Commands/Initialize-SqlDscRS.Integration.Tests.ps1'
                   # Group 8
                   'tests/Integration/Commands/Repair-SqlDscPowerBIReportServer.Integration.Tests.ps1'
                   # Group 9

source/DSCResources/DSC_SqlRS/DSC_SqlRS.psm1

@@ -80,7 +80,7 @@ function Get-TargetResource
             $getTargetResourceResult.DatabaseInstanceName = 'MSSQLSERVER'
         }
 
-        $isInitialized = $rsConfiguration.IsInitialized
+        $isInitialized = $rsConfiguration | Test-SqlDscRSInitialized
 
         [System.Boolean] $getTargetResourceResult.IsInitialized = $isInitialized
 
@@ -348,7 +348,7 @@ function Set-TargetResource
         $language = $wmiOperatingSystem.OSLanguage
         $restartReportingService = $false
 
-        if (-not $rsConfiguration.IsInitialized)
+        if (-not ($rsConfiguration | Test-SqlDscRSInitialized))
         {
             Write-Verbose -Message "Initializing Reporting Services on $DatabaseServerName\$DatabaseInstanceName."
 
@@ -456,7 +456,7 @@ function Set-TargetResource
             #>
             Write-Verbose -Message $script:localizedData.RestartToFinishInitialization
 
-            Restart-ReportingServicesService -ServiceName $reportingServicesServiceName -WaitTime 30
+            Restart-SqlDscRSService -ServiceName $reportingServicesServiceName -WaitTime 30 -Force
 
             <#
                 Wait for the service to be fully ready after restart before attempting
@@ -481,7 +481,7 @@ function Set-TargetResource
                 InitializeReportServer will fail on SQL Server Standard and
                 lower editions.
             #>
-            if (-not $rsConfiguration.IsInitialized)
+            if (-not ($rsConfiguration | Test-SqlDscRSInitialized))
             {
                 Write-Verbose -Message "Did not help restarting the Reporting Services service, running the CIM method to initialize report server on $DatabaseServerName\$DatabaseInstanceName for instance ID '$($rsConfiguration.InstallationID)'."
 
@@ -498,15 +498,7 @@ function Set-TargetResource
 
                 $restartReportingService = $true
 
-                $invokeRsCimMethodParameters = @{
-                    CimInstance = $rsConfiguration
-                    MethodName  = 'InitializeReportServer'
-                    Arguments   = @{
-                        InstallationId = $rsConfiguration.InstallationID
-                    }
-                }
-
-                Invoke-RsCimMethod @invokeRsCimMethodParameters -ErrorAction 'Stop'
+                $rsConfiguration | Initialize-SqlDscRS -Force -ErrorAction 'Stop'
             }
             else
             {
@@ -646,7 +638,7 @@ function Set-TargetResource
         elseif ( $restartReportingService -and (-not $SuppressRestart) )
         {
             Write-Verbose -Message $script:localizedData.Restart
-            Restart-ReportingServicesService -ServiceName $reportingServicesServiceName -WaitTime 30
+            Restart-SqlDscRSService -ServiceName $reportingServicesServiceName -WaitTime 30 -Force
 
             <#
                 Wait for the service to be fully ready after restart before attempting
@@ -850,81 +842,3 @@ function Test-TargetResource
 
     $result
 }
-
-<#
-    .SYNOPSIS
-        A wrapper for Invoke-CimMethod to be able to handle errors in one place.
-
-    .PARAMETER CimInstance
-        The CIM instance object that contains the method to call.
-
-    .PARAMETER MethodName
-        The method to call in the CIM Instance object.
-
-    .PARAMETER Arguments
-        The arguments that should be
-#>
-function Invoke-RsCimMethod
-{
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('AvoidThrowOutsideOfTry', '', Justification = 'Because the code throws based on an prior expression')]
-    [CmdletBinding()]
-    [OutputType([Microsoft.Management.Infrastructure.CimMethodResult])]
-    param
-    (
-
-        [Parameter(Mandatory = $true)]
-        [Microsoft.Management.Infrastructure.CimInstance]
-        $CimInstance,
-
-        [Parameter(Mandatory = $true)]
-        [System.String]
-        $MethodName,
-
-        [Parameter()]
-        [System.Collections.Hashtable]
-        $Arguments
-    )
-
-    $invokeCimMethodParameters = @{
-        MethodName  = $MethodName
-        ErrorAction = 'Stop'
-    }
-
-    if ($PSBoundParameters.ContainsKey('Arguments'))
-    {
-        $invokeCimMethodParameters['Arguments'] = $Arguments
-    }
-
-    $invokeCimMethodResult = $CimInstance | Invoke-CimMethod @invokeCimMethodParameters
-
-    <#
-        Successfully calling the method returns $invokeCimMethodResult.HRESULT -eq 0.
-        If an general error occur in the Invoke-CimMethod, like calling a method
-        that does not exist, returns $null in $invokeCimMethodResult.
-
-        cSpell: ignore HRESULT
-    #>
-    if ($invokeCimMethodResult -and $invokeCimMethodResult.HRESULT -ne 0)
-    {
-        if ($invokeCimMethodResult | Get-Member -Name 'ExtendedErrors')
-        {
-            <#
-                The returned object property ExtendedErrors is an array
-                so that needs to be concatenated.
-            #>
-            $errorMessage = $invokeCimMethodResult.ExtendedErrors -join ';'
-        }
-        else
-        {
-            $errorMessage = $invokeCimMethodResult.Error
-        }
-
-        throw 'Method {0}() failed with an error. Error: {1} (HRESULT:{2})' -f @(
-            $MethodName
-            $errorMessage
-            $invokeCimMethodResult.HRESULT
-        )
-    }
-
-    return $invokeCimMethodResult
-}

source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psd1

@@ -31,7 +31,6 @@
         'Connect-SQLAnalysis'
         'Get-SqlInstanceMajorVersion'
         'Restart-SqlService'
-        'Restart-ReportingServicesService'
         'Update-AvailabilityGroupReplica'
         'Test-LoginEffectivePermissions'
         'Test-AvailabilityReplicaSeedingModeAutomatic'

source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1

@@ -1128,64 +1128,6 @@ function Restart-SqlClusterService
     }
 }
 
-<#
-    .SYNOPSIS
-        Restarts a Reporting Services instance and associated services
-
-    .PARAMETER ServiceName
-        Name of the service to be restarted.
-
-    .PARAMETER WaitTime
-        Number of seconds to wait between service stop and service start.
-        Default value is 0 seconds.
-#>
-function Restart-ReportingServicesService
-{
-    [CmdletBinding()]
-    param
-    (
-        [Parameter(Mandatory = $true)]
-        [System.String]
-        $ServiceName,
-
-        [Parameter()]
-        [System.UInt16]
-        $WaitTime = 0
-    )
-
-    Write-Verbose -Message ($script:localizedData.GetServiceInformation -f $ServiceName) -Verbose
-    $reportingServicesService = Get-Service -Name $ServiceName
-
-    <#
-        Get all dependent services that are running.
-        There are scenarios where an automatic service is stopped and should
-        not be restarted automatically.
-    #>
-    $dependentService = $reportingServicesService.DependentServices | Where-Object -FilterScript {
-        $_.Status -eq 'Running'
-    }
-
-    Write-Verbose -Message ($script:localizedData.RestartService -f $reportingServicesService.DisplayName) -Verbose
-
-    Write-Verbose -Message ($script:localizedData.StoppingService -f $reportingServicesService.DisplayName) -Verbose
-    $reportingServicesService | Stop-Service -Force
-
-    if ($WaitTime -ne 0)
-    {
-        Write-Verbose -Message ($script:localizedData.WaitServiceRestart -f $WaitTime, $reportingServicesService.DisplayName) -Verbose
-        Start-Sleep -Seconds $WaitTime
-    }
-
-    Write-Verbose -Message ($script:localizedData.StartingService -f $reportingServicesService.DisplayName) -Verbose
-    $reportingServicesService | Start-Service
-
-    # Start dependent services
-    $dependentService | ForEach-Object -Process {
-        Write-Verbose -Message ($script:localizedData.StartingDependentService -f $_.DisplayName) -Verbose
-        $_ | Start-Service
-    }
-}
-
 <#
     .SYNOPSIS
         Executes the alter method on an Availability Group Replica object.

source/Modules/SqlServerDsc.Common/en-US/SqlServerDsc.Common.strings.psd1

@@ -24,9 +24,6 @@ ConvertFrom-StringData @'
     BringSqlServerAgentClusterResourcesOnline = Bringing the SQL Server Agent resource online. (SQLCOMMON0036)
     GetServiceInformation = Getting information about service '{0}'. (SQLCOMMON0037)
     RestartService = '{0}' service is restarting. (SQLCOMMON0038)
-    StoppingService = '{0}' service is stopping. (SQLCOMMON0039)
-    StartingService = '{0}' service is starting. (SQLCOMMON0040)
-    WaitServiceRestart = Waiting {0} seconds before starting service '{1}'. (SQLCOMMON0041)
     StartingDependentService = Starting service '{0}'. (SQLCOMMON0042)
     WaitingInstanceTimeout = Waiting for instance {0}\\{1} to report status online, with a timeout value of {2} seconds. (SQLCOMMON0043)
     FailedToConnectToInstanceTimeout = Failed to connect to the instance {0}\\{1} within the timeout period of {2} seconds. (SQLCOMMON0044)

source/Modules/SqlServerDsc.Common/sv-SE/SqlServerDsc.Common.strings.psd1

@@ -30,9 +30,6 @@ ConvertFrom-StringData @'
     BringSqlServerAgentClusterResourcesOnline = Tar SQL Server Agent resurser online. (SQLCOMMON0036)
     GetServiceInformation = Hämtar information om SQL Server-tjänst '{0}'. (SQLCOMMON0037)
     RestartService = '{0}' service is restarting. (SQLCOMMON0038)
-    StoppingService = '{0}' service is stopping. (SQLCOMMON0039)
-    StartingService = '{0}' service is starting. (SQLCOMMON0040)
-    WaitServiceRestart = Waiting {0} seconds before starting service '{1}'. (SQLCOMMON0041)
     StartingDependentService = Startar tjänst {0} (SQLCOMMON0042)
     WaitingInstanceTimeout = Waiting for instance {0}\\{1} to report status online, with a timeout value of {2} seconds. (SQLCOMMON0043)
     FailedToConnectToInstanceTimeout = Failed to connect to the instance {0}\\{1} within the timeout period of {2} seconds. (SQLCOMMON0044)

source/Public/Get-SqlDscRSConfiguration.ps1

@@ -51,7 +51,6 @@
 #>
 function Get-SqlDscRSConfiguration
 {
-    # cSpell: ignore PBIRS
     [CmdletBinding()]
     [OutputType([Microsoft.Management.Infrastructure.CimInstance])]
     param

source/Public/Get-SqlDscRSPackage.ps1

@@ -46,7 +46,6 @@
 #>
 function Get-SqlDscRSPackage
 {
-    # cSpell: ignore PBIRS
     [CmdletBinding()]
     [OutputType([System.Diagnostics.FileVersionInfo])]
     param

source/Public/Get-SqlDscRSSetupConfiguration.ps1

@@ -49,7 +49,6 @@
 #>
 function Get-SqlDscRSSetupConfiguration
 {
-    # cSpell: ignore PBIRS
     [CmdletBinding()]
     [OutputType([PSCustomObject[]])]
     param