Refactor integration tests to optimize SQL Server service management (#2291)

Author: johlju

.github/instructions/SqlServerDsc-guidelines.instructions.md

@@ -37,7 +37,6 @@ applyTo: "**"
 ## Tests Requirements
 - Unit tests: Add `$env:SqlServerDscCI = $true` in `BeforeAll`, remove in `AfterAll`
 - Integration tests:
-  - If requiring SQL Server DB, start the Windows service in `BeforeAll`, stop it in `AfterAll`.
   - Use `Connect-SqlDscDatabaseEngine` for SQL Server DB session, and always with correct CI credentials
   - Use `Disconnect-SqlDscDatabaseEngine` after `Connect-SqlDscDatabaseEngine`
   - Test config: tests/Integration/Commands/README.md and tests/Integration/Resources/README.md

CHANGELOG.md

@@ -226,6 +226,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Optimized integration test performance by leaving the DSCSQLTEST service running
+  for subsequent tests, significantly improving CI build times.
 - Improved code quality by ensuring all function invocations in the private
   and public functions use named parameters instead of positional parameters.
 - SqlServerDsc

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

@@ -43,9 +43,6 @@ AfterAll {
 
 Describe 'Assert-SqlDscAgentOperator' -Tag 'Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022' {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $mockSqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.
         $mockSqlAdministratorPassword = ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force
 
@@ -63,9 +60,6 @@ Describe 'Assert-SqlDscAgentOperator' -Tag 'Integration_SQL2017', 'Integration_S
 
         # Disconnect from the SQL Server
         Disconnect-SqlDscDatabaseEngine -ServerObject $script:sqlServerObject
-
-        # Stop the named instance SQL Server service to save memory on the build worker.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
     }
 
     Context 'When operator exists' {

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

@@ -31,18 +31,10 @@ BeforeAll {
 
 Describe 'Assert-SqlDscLogin' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $script:instanceName = 'DSCSQLTEST'
         $script:computerName = Get-ComputerName
     }
 
-    AfterAll {
-        # Stop the named instance SQL Server service to save memory on the build worker.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-    }
-
     Context 'When connecting to SQL Server instance' {
         BeforeAll {
             $sqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.

tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

@@ -84,16 +84,6 @@ Describe 'Connect-SqlDscDatabaseEngine' -Tag @('Integration_SQL2017', 'Integrati
     }
 
     Context 'When connecting to a named instance' {
-        BeforeAll {
-            # Starting the named instance SQL Server service prior to running tests.
-            Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-        }
-
-        AfterAll {
-            # Stop the named instance SQL Server service to save memory on the build worker.
-            Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-        }
-
         It 'Should have the named instance SQL Server service started' {
             $getServiceResult = Get-Service -Name 'MSSQL$DSCSQLTEST' -ErrorAction 'Stop'
 

tests/Integration/Commands/ConvertTo-SqlDscDatabasePermission.Integration.Tests.ps1

@@ -31,9 +31,6 @@ BeforeAll {
 
 Describe 'ConvertTo-SqlDscDatabasePermission' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $script:mockInstanceName = 'DSCSQLTEST'
 
         $mockSqlAdministratorUserName = 'SqlAdmin'
@@ -46,23 +43,19 @@ Describe 'ConvertTo-SqlDscDatabasePermission' -Tag @('Integration_SQL2017', 'Int
 
     AfterAll {
         Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject
-
-        # Stop the named instance SQL Server service to save memory on the build worker.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
     }
-
     Context 'When converting empty collection of DatabasePermissionInfo' {
         It 'Should return empty array for empty DatabasePermissionInfo collection' {
             $emptyCollection = [Microsoft.SqlServer.Management.Smo.DatabasePermissionInfo[]] @()
-            
+
             $result = ConvertTo-SqlDscDatabasePermission -DatabasePermissionInfo $emptyCollection
 
             $result | Should -BeNullOrEmpty
         }
 
         It 'Should accept empty collection through pipeline' {
             $emptyCollection = [Microsoft.SqlServer.Management.Smo.DatabasePermissionInfo[]] @()
-            
+
             $result = $emptyCollection | ConvertTo-SqlDscDatabasePermission
 
             $result | Should -BeNullOrEmpty
@@ -80,12 +73,12 @@ Describe 'ConvertTo-SqlDscDatabasePermission' -Tag @('Integration_SQL2017', 'Int
 
                 # Validate the result structure
                 $result | Should -Not -BeNullOrEmpty
-                
+
                 # Each result should have State and Permission properties
                 foreach ($permission in $result) {
                     $permission.State | Should -Not -BeNullOrEmpty
                     $permission.Permission | Should -Not -BeNullOrEmpty
-                    
+
                     # Validate that permission state is one of the expected values
                     $permission.State | Should -BeIn @('Grant', 'Deny', 'GrantWithGrant')
                 }
@@ -102,12 +95,12 @@ Describe 'ConvertTo-SqlDscDatabasePermission' -Tag @('Integration_SQL2017', 'Int
 
                 # Validate the result structure
                 $result | Should -Not -BeNullOrEmpty
-                
+
                 # Each result should have State and Permission properties
                 foreach ($permission in $result) {
                     $permission.State | Should -Not -BeNullOrEmpty
                     $permission.Permission | Should -Not -BeNullOrEmpty
-                    
+
                     # Validate that permission state is one of the expected values
                     $permission.State | Should -BeIn @('Grant', 'Deny', 'GrantWithGrant')
                 }
@@ -126,12 +119,12 @@ Describe 'ConvertTo-SqlDscDatabasePermission' -Tag @('Integration_SQL2017', 'Int
 
                 # Validate the result structure
                 $result | Should -Not -BeNullOrEmpty
-                
+
                 # Each result should have State and Permission properties
                 foreach ($permission in $result) {
                     $permission.State | Should -Not -BeNullOrEmpty
                     $permission.Permission | Should -Not -BeNullOrEmpty
-                    
+
                     # Validate that permission state is one of the expected values
                     $permission.State | Should -BeIn @('Grant', 'Deny', 'GrantWithGrant')
                 }
@@ -151,7 +144,7 @@ Describe 'ConvertTo-SqlDscDatabasePermission' -Tag @('Integration_SQL2017', 'Int
                 if ($result) {
                     # Validate that permissions are properly grouped by state
                     $uniqueStates = $result.State | Sort-Object -Unique
-                    
+
                     foreach ($state in $uniqueStates) {
                         $permissionsForState = $result | Where-Object { $_.State -eq $state }
                         $permissionsForState | Should -HaveCount 1

tests/Integration/Commands/Deny-SqlDscServerPermission.Integration.Tests.ps1

@@ -31,9 +31,6 @@ BeforeAll {
 
 Describe 'Deny-SqlDscServerPermission' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $script:mockInstanceName = 'DSCSQLTEST'
 
         $mockSqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.
@@ -50,9 +47,6 @@ Describe 'Deny-SqlDscServerPermission' -Tag @('Integration_SQL2017', 'Integratio
 
     AfterAll {
         Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject
-
-        # Stop the named instance SQL Server service to save memory on the build worker.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
     }
 
     Context 'When denying server permissions to login' {

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

@@ -43,9 +43,6 @@ AfterAll {
 
 Describe 'Disable-SqlDscAgentOperator' -Tag 'Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022' {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $mockSqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.
         $mockSqlAdministratorPassword = ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force
         $mockSqlAdministratorCredential = [System.Management.Automation.PSCredential]::new($mockSqlAdministratorUserName, $mockSqlAdministratorPassword)
@@ -61,9 +58,6 @@ Describe 'Disable-SqlDscAgentOperator' -Tag 'Integration_SQL2017', 'Integration_
         Set-SqlDscConfigurationOption -ServerObject $script:serverObject -Name 'Agent XPs' -Value 0 -Force -Verbose -ErrorAction 'Stop'
 
         Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject
-
-        # Stopping the named instance SQL Server service after running tests.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
     }
 
     Context 'When disabling an existing agent operator' {

tests/Integration/Commands/Disable-SqlDscAudit.Integration.Tests.ps1

@@ -31,9 +31,6 @@ BeforeAll {
 
 Describe 'Disable-SqlDscAudit' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $script:mockInstanceName = 'DSCSQLTEST'
         $script:mockComputerName = Get-ComputerName
 
@@ -47,9 +44,6 @@ Describe 'Disable-SqlDscAudit' -Tag @('Integration_SQL2017', 'Integration_SQL201
 
     AfterAll {
         Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject
-
-        # Stop the named instance SQL Server service to save memory on the build worker.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
     }
 
     Context 'When disabling an audit using ServerObject parameter set' {
@@ -206,7 +200,7 @@ Describe 'Disable-SqlDscAudit' -Tag @('Integration_SQL2017', 'Integration_SQL201
                 'SqlDscTestMultiDisable1_' + (Get-Random),
                 'SqlDscTestMultiDisable2_' + (Get-Random)
             )
-            
+
             foreach ($auditName in $script:testAuditNames)
             {
                 $null = New-SqlDscAudit -ServerObject $script:serverObject -Name $auditName -LogType 'ApplicationLog' -Force -ErrorAction Stop

tests/Integration/Commands/Disable-SqlDscLogin.Integration.Tests.ps1

@@ -31,9 +31,6 @@ BeforeAll {
 
 Describe 'Disable-SqlDscLogin' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
     BeforeAll {
-        # Starting the named instance SQL Server service prior to running tests.
-        Start-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
-
         $script:mockInstanceName = 'DSCSQLTEST'
 
         $mockSqlAdministratorUserName = 'SqlAdmin' # Using computer name as NetBIOS name throw exception.
@@ -49,9 +46,6 @@ Describe 'Disable-SqlDscLogin' -Tag @('Integration_SQL2017', 'Integration_SQL201
 
     AfterAll {
         Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject
-
-        # Stop the named instance SQL Server service to save memory on the build worker.
-        Stop-Service -Name 'MSSQL$DSCSQLTEST' -Verbose -ErrorAction 'Stop'
     }
 
     Context 'When disabling a login using ServerObject parameter set' {