SQLRS: Various improvements

[randomnote1]

Pull Request (PR) description

• Added Power BI Report Server support
• Added the ability to change the service account
• Added the ability to define the database name

This Pull Request (PR) fixes the following issues

• Fixes SqlRS: Cannot set database location #148
• Fixes SqlRS: Feature Request - Define database name #149
• Fixes SqlRS: Add SSL functionality #587
• Fixes SqlRS: Add read only parameters for information collected by Get-TargetResource #626
• Fixes SqlRS: Does not work when reporting database machine is renamed #860
• Fixes SqlRs: Reporting services are not initialized #936

Task list

• Added an entry to the change log under the Unreleased section of the
  file CHANGELOG.md. Entry should say what was changed and how that
  affects users (if applicable), and reference the issue being resolved
  (if applicable).
• Resource documentation updated in the resource's README.md.
• Resource parameter descriptions updated in schema.mof.
• Comment-based help updated, including parameter descriptions.
• Localization strings updated.
• Examples updated.
• Unit tests updated. See DSC Community Testing Guidelines.
• Integration tests updated (where possible). See DSC Community Testing Guidelines.
• Code changes adheres to DSC Community Style Guidelines.

---

This change is 

[codecov]

Codecov Report

Merging #1758 (04685ba) into main (c780423) will decrease coverage by 7%.
The diff coverage is 35%.

❗ Current head 04685ba differs from pull request most recent head 3b225a3. Consider uploading reports for the commit 3b225a3 to get more accurate results

@@          Coverage Diff           @@
##           main   #1758     +/-   ##
======================================
- Coverage    92%     85%     -7%     
======================================
  Files        85      36     -49     
  Lines      7640    6490   -1150     
======================================
- Hits       7038    5533   -1505     
- Misses      602     957    +355     

Flag	Coverage Δ
unit	85% <35%> (-7%)	⬇️

Impacted Files	Coverage Δ
source/DSCResources/DSC_SqlRS/DSC_SqlRS.psm1	40% <35%> (-60%)	⬇️
...dules/SqlServerDsc.Common/SqlServerDsc.Common.psm1	98% <100%> (-1%)	⬇️

... and 49 files with indirect coverage changes

[randomnote1]

Reviewable status: 0 of 11 files reviewed, 1 unresolved discussion

---

source/DSCResources/DSC_SqlRS/DSC_SqlRS.psm1 line 1091 at r1 (raw file):

                    throw $_
                }
            }

I couldn't figure out how to mock Invoke-RsCimMethod to throw an error the first time and work the second time.

Code quote:

            catch [System.Management.Automation.RuntimeException]
            {
                if ( $_.Exception -match 'The report server was unable to validate the integrity of encrypted data in the database' )
                {
                    # Restore key here
                    $invokeRsCimMethodRestoreEncryptionKeyParameters = @{
                        CimInstance = $reportingServicesData.Configuration
                        MethodName  = 'RestoreEncryptionKey'
                        Arguments   = @{
                            KeyFile = $backupEncryptionKeyResult.KeyFile
                            Length = $restoreEncryptionKeyResult.Length
                            Password = $EncryptionKeyBackupCredential.GetNetworkCredential().Password
                        }
                    }

                    $restoreEncryptionKeyResult = Invoke-RsCimMethod @invokeRsCimMethodRestoreEncryptionKeyParameters

                    if ( $restoreEncryptionKeyResult.HRESULT -eq 0 )
                    {
                        # Finally, try and initialize the server again
                        Invoke-RsCimMethod @invokeRsCimMethodInitializeReportServerParameters
                    }
                }
                else
                {
                    throw $_
                }
            }

[johlju]

I'm waiting for the build workers to get the Windows patch for DSC so the integration tests can run. I will review then.

[randomnote1]

Looks like my Azure VMs started working again last week, so, hopefully soon!

[johlju]

/AzurePipelines run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[johlju]

@randomnote1 the integration test runs now - there are some failing tests in integration and unit tests. Let me know when they pass and I review.

[randomnote1]

@johlju, how do we log into the build servers to troubleshoot what is wrong? I recall seeing something somewhere, but I don't remember where!

[johlju]

It is not possible with the Azure DevOps build servers. It was possible way back when we used AppVeyor. I usually add debug verbose messages to see how far it comes before it throws to locate the line that fails. Not optimal, but often only way to find the issue if unit tests don’t catch it.

[johlju]

Reviewable status: 0 of 12 files reviewed, 1 unresolved discussion (waiting on @johlju and @randomnote1)

---

source/DSCResources/DSC_SqlRS/DSC_SqlRS.psm1 line 1091 at r1 (raw file):

Previously, randomnote1 (Dan Reist) wrote…

I couldn't figure out how to mock Invoke-RsCimMethod to throw an error the first time and work the second time.

I think it might be better to do a do-while-loop aroudn the entire try-catch-block? While $initialized -eq $false it tries to call Invoke-RsCimMethod? Then you don't have to add a second call to Invoke-RsCimMethod inside the catch block.
Suggest that you also add a variable $restoreKey and if that is true (default $false, and set to $true by catch block) then on next loop it tries to restore the key outside of the catch block.

You can mock it by adding a script variable inside the mock, e.g.

BeforeAll {
    Mock -CommandName Invoke-RsCimMethod -ParameterFilter {
        $MethodName -eq 'InitializeReportServer'
    } -MockWith {
        $script:callInvokeRsCimMethodCount += 1
    
        if ($script:callInvokeRsCimMethodCount -eq 2)
        { 
             throw 'terminating error'
        }
        else 
        {
            throw 'exception to try again' 
        }
    }
}

BeforeEach {
    $script:callInvokeRsCimMethodCount = 0
}

[randomnote1]

Reviewable status: 0 of 12 files reviewed, all discussions resolved (waiting on @johlju)

---

source/DSCResources/DSC_SqlRS/DSC_SqlRS.psm1 line 1091 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

I think it might be better to do a do-while-loop aroudn the entire try-catch-block? While $initialized -eq $false it tries to call Invoke-RsCimMethod? Then you don't have to add a second call to Invoke-RsCimMethod inside the catch block.
Suggest that you also add a variable $restoreKey and if that is true (default $false, and set to $true by catch block) then on next loop it tries to restore the key outside of the catch block.

You can mock it by adding a script variable inside the mock, e.g.

BeforeAll {
    Mock -CommandName Invoke-RsCimMethod -ParameterFilter {
        $MethodName -eq 'InitializeReportServer'
    } -MockWith {
        $script:callInvokeRsCimMethodCount += 1
    
        if ($script:callInvokeRsCimMethodCount -eq 2)
        { 
             throw 'terminating error'
        }
        else 
        {
            throw 'exception to try again' 
        }
    }
}

BeforeEach {
    $script:callInvokeRsCimMethodCount = 0
}

Done

[randomnote1]

/AzurePipelines run

[azure-pipelines]

Commenter does not have sufficient privileges for PR 1758 in repo dsccommunity/SqlServerDsc

[randomnote1]

@johlju, looks like the only failure in the pipelines was well before SqlRs was attempted. Can you re-start the pipeline to verify?

[johlju]

Restarted.

[johlju]

AzurePipelines run

[johlju]

Restart all jobs again because SQL2016 for one job only ran for 10 minutes before failing without stopping the pipeline.

[johlju]

/AzurePipelines run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[johlju]

Now both jobs for SQL2016 seems to fail on the same spot.

[randomnote1]

All right, thanks. I'll continue troubleshooting

[johlju]

I think we need to simplify these changes by splitting them up in several PR that add each new functionality instead of this massive PR. 🤔

[github-actions]

Labeling this pull request (PR) as abandoned since it has gone 14 days or more since the last update. An abandoned PR can be continued by another contributor. The abandoned label will be removed if work on this PR is taken up again.