SqlServerDsc: Added SQL Server 2019 Integration Tests (and unit test) plus additional, 'SqlSetup' resource `InstallSharedDir` fix. #1676

SphenicPaul · 2021-01-23T17:16:50Z

Pull Request (PR) description

Made a number of changes to enable SQL Server 2019 integration tests to be executed as part of the Azure DevOps, pipeline.

Changes include:

Amending the SqlServerDsc module, Azure DevOps pipeline (defined in azure-pipelines.yml definition) to add additional "Job" in the "Test" stage to run integration tests for SQL Server 2019.
Amended integration scripts for the SqlAgentAlert, SqlAgentFailsafe, SqlAgentOperator, SqlDatabase, SqlDatabaseDefaultLocation, SqlDatabaseMail, SqlDatabaseObjectPermission, SqlDatabasePermission, SqlDatabaseUser, SqlEndpoint, SqlLogin, SqlProtocol, SqlProtocolTcpIp, SqlRS, SqlRSSetup, SqlReplication, SqlRole, SqlScript, SqlScriptQuery, SqlSecureConnection, SqlServiceAccount and SqlSetup resources to support SQL Server 2019 execution.
Added functionality (within integration tests) to download SQL Server 2019 ISO via an additional EXE.
Updating integration test README.md file to include SQL Server 2019.
Updated relevant unit tests, where required.
Amended SqlSetup resource to output the correct InstallSharedDir value when used with SQL Server 2019 - This failure/omission was identified by the amended integration tests and resolved/fixed as part of this change.
Updated a few other comments to reference SQL Server 2019

This Pull Request (PR) fixes the following issues

Fixes SqlServerDsc: Add a new pipeline job to test SQL Server 2019 family #1310

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

…serverInstance is not obtained

…rrect typo)

…ObtainServerInstance' error message

…nto main

…line/build definition.

…check.

…check. Also added '150', $script:sqlVersion assignment for SQL2019.

…SQL2019) into SSRS, integration tests and configs.

…ration.

…est for 'SqlRs' resource.

…es (will be added back in later).

…ration tests.

…r 'SqlRS' resource, integration tests.

…k in later)

… 'SqlSetup' tests.

…tegration test config.

…ing SQL Server 2019.

…ty support when using SQL Server 2019.

…e-pipelines.yml'

… SQL 2019 functonality.

codecov · 2021-01-24T00:17:01Z

Codecov Report

Merging #1676 (4aebf11) into main (c392042) will not change coverage.
The diff coverage is 100%.

@@         Coverage Diff          @@
##           main   #1676   +/-   ##
====================================
  Coverage    97%     97%           
====================================
  Files        38      38           
  Lines      6259    6259           
====================================
  Hits       6102    6102           
  Misses      157     157

Flag	Coverage Δ
unit	`97% <100%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
source/DSCResources/DSC_SqlRS/DSC_SqlRS.psm1	`100% <ø> (ø)`
...dules/SqlServerDsc.Common/SqlServerDsc.Common.psm1	`97% <ø> (ø)`
source/DSCResources/DSC_SqlSetup/DSC_SqlSetup.psm1	`98% <100%> (ø)`

johlju

Awesome work on these! Just small comments. 😃

Reviewed 33 of 35 files at r1, 2 of 2 files at r2.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @SphenicPaul)

tests/Integration/DSC_SqlRS.config.ps1, line 26 at r2 (raw file):

Quoted 15 lines of code…

    if($script:sqlVersion -eq '150')
    {
        # SQL2019
        $instanceName = 'SSRS'
        $isoImageName = 'SQL2019.iso'
        # Additional variables required as ISO is downloaded via additional EXE
        $downloadExeName = 'SQL2019_Download.exe'
        $downloadIsoName = 'SQLServer2019-x64-ENU-Dev.iso'
    }
    elseif($script:sqlVersion -eq '140')
    {
        # SQL2017
        $instanceName = 'SSRS'
        $isoImageName = 'SQL2017.iso'
    }

I think this is never used. Looking at the test now I think we should change the "dependencies-block" so this is not needed? See comment below.

tests/Integration/DSC_SqlRS.config.ps1, line 62 at r2 (raw file):

                DownloadExePath      = "$env:TEMP\$downloadExeName"
                DownloadIsoPath      = "$env:TEMP\$downloadIsoName"

We can remove this, it looks like it is never used here.

tests/Integration/DSC_SqlRS.config.ps1, line 93 at r2 (raw file):

Quoted 12 lines of code…

        MountImage 'MountIsoMedia'
        {
            ImagePath   = $Node.ImagePath
            DriveLetter = $Node.DriveLetter
            Ensure      = 'Present'
        }
        WaitForVolume 'WaitForMountOfIsoMedia'
        {
            DriveLetter      = $Node.DriveLetter
            RetryIntervalSec = 5
            RetryCount       = 10
        }

This is only needed if $script:sqlVersion -eq '130'. We could move it into the if-block below right before SqlSetup, then we don't need the ISO's for the other versions in this test. What do you think?

tests/Integration/DSC_SqlRSSetup.Integration.Tests.ps1, line 4 at r2 (raw file):

'Integration_SQL2019'

Maybe we should remove this as it downloads October 2017 executable? See next comment.

tests/Integration/DSC_SqlRSSetup.Integration.Tests.ps1, line 41 at r2 (raw file):

        $script:mockSourceMediaDisplayName = 'Microsoft SQL Server Reporting Services (October 2017)'
        $script:mockSourceMediaUrl = 'https://download.microsoft.com/download/E/6/4/E6477A2A-9B58-40F7-8AD6-62BB8491EA78/SQLServerReportingServices.exe'

We could create and issue to add tests for newer (2019) reporting services. I know there are issues reported in the repos with newer RS when used with the resources, so might not be a quick fix adding an additional exe to download.

Also, maybe we should add separate pipeline jobs to test RS 2017 and newer?

This can be done in another PR. Would you mind creating an issue for it so we can track it?

…and 'DownloadIsoPath' within 'SqlRS' integration test configuration.

…soMedia' into $script:sqlVersion -eq '130', if-block within 'SqlRS', integration test configuration.

…n_SQL2019' build.

SphenicPaul

Reviewable status: 33 of 35 files reviewed, 5 unresolved discussions (waiting on @johlju)

tests/Integration/DSC_SqlRS.config.ps1, line 26 at r2 (raw file):