Add SQL Server 2025 to integration tests (#2435)

Author: johlju

CHANGELOG.md

@@ -9,12 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - SqlServerDsc.Common
   - Moved functions into individual files and use ModuleBuilder to assemble.
-
 - SqlServerDsc
   - Refactor integration tests for _SQL Server Reporting Services_ and _Power BI_
     _Report Server_ ([issue #2431](https://github.com/dsccommunity/SqlServerDsc/issues/2431)).
   - `Connect-Sql` create connection and server objects as per documentation.
   - `Invoke-SqlDscQuery` remove disconnect as there is not an explicit connect.
+  - Add SQL Server 2025 to integration tests ([issue #2427](https://github.com/dsccommunity/SqlServerDsc/issues/2427)).
 
 ### Fixed
 

CONTRIBUTING.md

@@ -282,8 +282,7 @@ To make sure a integration tests is run in the correct order the integration
 tests are grouped in the file `azure-pipelines.yml` in the integration tests
 jobs.
 
-There are three, separate, integration tests jobs that each, independently, test
-SQL Server 2016, SQL Server 2017 and SQL Server 2019.
+There are multiple, separate integration test jobs that independently test SQL Server 2017, SQL Server 2019, SQL Server 2022 and SQL Server 2025.
 
 ### Testing of examples files
 

azure-pipelines.yml

@@ -283,6 +283,9 @@ stages:
             SQL2022_WIN2025:
               JOB_VMIMAGE: 'windows-2025'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2025_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2025'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: '0'
@@ -452,6 +455,9 @@ stages:
             SQL2022_WIN2025:
               JOB_VMIMAGE: 'windows-2025'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2025_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2025'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: '0'
@@ -846,6 +852,9 @@ stages:
             SQL2022_WIN2025:
               JOB_VMIMAGE: 'windows-2025'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2025_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2025'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: '0'
@@ -938,6 +947,9 @@ stages:
             SQL2022_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2025_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2025'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: '0'
@@ -1254,6 +1266,9 @@ stages:
             SQL2022_WIN2022:
               JOB_VMIMAGE: 'windows-2022'
               TEST_CONFIGURATION: 'Integration_SQL2022'
+            SQL2025_WIN2025:
+              JOB_VMIMAGE: 'windows-2025'
+              TEST_CONFIGURATION: 'Integration_SQL2025'
         pool:
           vmImage: $(JOB_VMIMAGE)
         timeoutInMinutes: 0

source/Classes/020.SqlDatabase.ps1

@@ -337,7 +337,7 @@ class SqlDatabase : SqlResourceBase
     $Collation
 
     [DscProperty()]
-    [ValidateSet('Version80', 'Version90', 'Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160')]
+    [ValidateSet('Version80', 'Version90', 'Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160', 'Version170')]
     [System.String]
     $CompatibilityLevel
 
@@ -745,7 +745,21 @@ class SqlDatabase : SqlResourceBase
             # Only set CompatibilityLevel if it's a valid non-zero value
             if ($databaseObject.CompatibilityLevel -gt 0)
             {
-                $currentState.CompatibilityLevel = $databaseObject.CompatibilityLevel.ToString()
+                $compatValue = $databaseObject.CompatibilityLevel.ToString()
+
+                <#
+                    SMO may return numeric values (e.g. 170 for SQL Server 2025).
+                    Convert purely-numeric values to the 'Version' prefixed form
+                    so they match the ValidateSet values (Version80..Version170).
+                #>
+                if ($compatValue -match '^[0-9]+$')
+                {
+                    $currentState.CompatibilityLevel = 'Version{0}' -f $compatValue
+                }
+                else
+                {
+                    $currentState.CompatibilityLevel = $compatValue
+                }
             }
 
             $currentState.RecoveryModel = $databaseObject.RecoveryModel.ToString()

source/DSCResources/DSC_SqlReplication/DSC_SqlReplication.psm1

@@ -287,7 +287,8 @@ function Set-TargetResource
             Install-RemoteDistributor `
                 -ReplicationServer $localReplicationServer `
                 -RemoteDistributor $RemoteDistributor `
-                -AdminLinkCredentials $AdminLinkCredentials
+                -AdminLinkCredentials $AdminLinkCredentials `
+                -InstanceName $InstanceName
         }
     }
     else #'Absent'
@@ -437,7 +438,7 @@ function New-ServerConnection
         $SqlServerName
     )
 
-    if ($SqlMajorVersion -eq 16)
+    if ($SqlMajorVersion -in @(16, 17))
     {
         <#
             For SQL Server 2022 the object must be created with New-Object and
@@ -598,6 +599,9 @@ function New-DistributionPublisher
     .PARAMETER AdminLinkCredentials
         AdminLink password to be used when setting up publisher distributor
         relationship.
+
+    .PARAMETER InstanceName
+        SQL Server instance name where replication distribution will be configured.
 #>
 function Install-RemoteDistributor
 {
@@ -614,22 +618,50 @@ function Install-RemoteDistributor
 
         [Parameter(Mandatory = $true)]
         [System.Management.Automation.PSCredential]
-        $AdminLinkCredentials
+        $AdminLinkCredentials,
+
+        [Parameter(Mandatory = $true)]
+        [System.String]
+        $InstanceName
     )
 
     Write-Verbose -Message (
         $script:localizedData.InstallRemoteDistributor -f $RemoteDistributor
     )
 
-    try
+    $serverObject = Connect-SqlDscDatabaseEngine -InstanceName $InstanceName -ErrorAction 'Stop'
+
+    $sqlMajorVersion = $serverObject.VersionMajor
+
+    if ($sqlMajorVersion -eq 17)
     {
-        $ReplicationServer.InstallDistributor($RemoteDistributor, $AdminLinkCredentials.Password)
+        $clearTextPassword = $AdminLinkCredentials.GetNetworkCredential().Password
+
+        <#
+            Need to execute stored procedure sp_adddistributor for SQL Server 2025.
+            Workaround for issue: https://github.com/dsccommunity/SqlServerDsc/pull/2435#issuecomment-3796616952
+
+            TODO: Should support encrypted connection in the future, then we could
+                  probably go back to using InstallDistributor(), another option is
+                  to move to stored procedures for all of the Replication logic.
+        #>
+        $query = "EXECUTE sys.sp_adddistributor @distributor = N'$RemoteDistributor', @password = N'$clearTextPassword', @encrypt_distributor_connection = 'optional', @trust_distributor_certificate = 'yes';"
+
+        # TODO: This need to pass a credential in the future, now connects using the one resource is run as.
+        Invoke-SqlDscQuery -ServerObject $serverObject -DatabaseName 'master' -Query $query -RedactText $clearTextPassword -Force -ErrorAction 'Stop'
     }
-    catch
+    else
     {
-        $errorMessage = $script:localizedData.FailedInFunction -f 'Install-RemoteDistributor'
+        try
+        {
+            $ReplicationServer.InstallDistributor($RemoteDistributor, $AdminLinkCredentials.Password)
+        }
+        catch
+        {
+            $errorMessage = $script:localizedData.FailedInFunction -f 'Install-RemoteDistributor'
 
-        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+            New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+        }
     }
 }
 

source/DSCResources/DSC_SqlSetup/DSC_SqlSetup.psm1

@@ -1119,7 +1119,7 @@ function Set-TargetResource
     # If SQL shared components already installed, clear InstallShared*Dir variables
     switch ($SqlVersion)
     {
-        { $_ -in ('10', '11', '12', '13', '14', '15', '16') }
+        { $_ -in ('10', '11', '12', '13', '14', '15', '16', '17') }
         {
             if ((Get-Variable -Name 'InstallSharedDir' -ErrorAction SilentlyContinue) -and (Get-ItemProperty 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Installer\UserData\S-1-5-18\Components\FEE2E540D20152D4597229B6CFBC0A69' -ErrorAction SilentlyContinue))
             {
@@ -3387,7 +3387,7 @@ function Get-SqlSharedPaths
 
     switch ($SqlServerMajorVersion)
     {
-        { $_ -in ('10', '11', '12', '13', '14', '15', '16') }
+        { $_ -in ('10', '11', '12', '13', '14', '15', '16', '17') }
         {
             $registryKeySharedDir = 'FEE2E540D20152D4597229B6CFBC0A69'
             $registryKeySharedWOWDir = 'A79497A344129F64CA7D69C56F5DD8B4'

source/Public/New-SqlDscDatabase.ps1

@@ -368,7 +368,7 @@ function New-SqlDscDatabase
         $CatalogCollation,
 
         [Parameter(ParameterSetName = 'Database')]
-        [ValidateSet('Version80', 'Version90', 'Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160')]
+        [ValidateSet('Version80', 'Version90', 'Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160', 'Version170')]
         [System.String]
         $CompatibilityLevel,
 
@@ -738,6 +738,7 @@ function New-SqlDscDatabase
                 14 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140')
                 15 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150')
                 16 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160')
+                17 = @('Version100', 'Version110', 'Version120', 'Version130', 'Version140', 'Version150', 'Version160', 'Version170')
             }
 
             if ($CompatibilityLevel -notin $supportedCompatibilityLevels.$($ServerObject.VersionMajor))

tests/Integration/Commands/Add-SqlDscFileGroup.Integration.Tests.ps1

@@ -31,7 +31,7 @@ BeforeAll {
     Import-Module -Name $script:moduleName -ErrorAction 'Stop'
 }
 
-Describe 'Add-SqlDscFileGroup' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
+Describe 'Add-SqlDscFileGroup' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022', 'Integration_SQL2025') {
     BeforeAll {
         $script:mockInstanceName = 'DSCSQLTEST'
         $script:mockComputerName = Get-ComputerName

tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1

@@ -31,7 +31,7 @@ BeforeAll {
     Import-Module -Name $script:moduleName -ErrorAction 'Stop'
 }
 
-Describe 'Add-SqlDscTraceFlag' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
+Describe 'Add-SqlDscTraceFlag' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022', 'Integration_SQL2025') {
     BeforeAll {
         $script:mockInstanceName = 'DSCSQLTEST'
         $script:mockComputerName = Get-ComputerName

tests/Integration/Commands/Assert-SqlDscAgentOperator.Integration.Tests.ps1

@@ -40,7 +40,7 @@ AfterAll {
     $null = Remove-Item -Path 'Env:\SqlServerDscCI' -ErrorAction 'Stop'
 }
 
-Describe 'Assert-SqlDscAgentOperator' -Tag 'Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022' {
+Describe 'Assert-SqlDscAgentOperator' -Tag 'Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022', 'Integration_SQL2025' {
     BeforeAll {
         $mockSqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.
         $mockSqlAdministratorPassword = ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force