Add integration test for Get-SqlDscStartupParameter command

CHANGELOG.md

@@ -16,6 +16,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added integration tests for `Remove-SqlDscAudit` command to ensure it functions
   correctly in real environments
   [issue #2241](https://github.com/dsccommunity/SqlServerDsc/issues/2241).
+- Added integration tests for `Get-SqlDscStartupParameter` command to ensure it
+  functions correctly in real environments
+  [issue #2217](https://github.com/dsccommunity/SqlServerDsc/issues/2217).
 - Added integration tests for `Get-SqlDscPreferredModule` command to ensure it
   functions correctly in real environments
   [issue #2218](https://github.com/dsccommunity/SqlServerDsc/issues/2218).

azure-pipelines.yml

@@ -315,6 +315,7 @@ stages:
                   'tests/Integration/Commands/Test-SqlDscIsLoginEnabled.Integration.Tests.ps1'
                   'tests/Integration/Commands/New-SqlDscRole.Integration.Tests.ps1'
                   'tests/Integration/Commands/Get-SqlDscRole.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Get-SqlDscStartupParameter.Integration.Tests.ps1'
                   'tests/Integration/Commands/Test-SqlDscIsRole.Integration.Tests.ps1'
                   'tests/Integration/Commands/Grant-SqlDscServerPermission.Integration.Tests.ps1'
                   'tests/Integration/Commands/Get-SqlDscServerPermission.Integration.Tests.ps1'

tests/Integration/Commands/Get-SqlDscStartupParameter.Integration.Tests.ps1

@@ -0,0 +1,176 @@
+[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
+param ()
+
+BeforeDiscovery {
+    try
+    {
+        if (-not (Get-Module -Name 'DscResource.Test'))
+        {
+            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
+            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
+            {
+                # Redirect all streams to $null, except the error stream (stream 2)
+                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
+            }
+
+            # If the dependencies have not been resolved, this will throw an error.
+            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
+        }
+    }
+    catch [System.IO.FileNotFoundException]
+    {
+        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
+    }
+}
+
+BeforeAll {
+    $script:moduleName = 'SqlServerDsc'
+
+    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
+}
+
+# cSpell: ignore DSCSQLTEST
+Describe 'Get-SqlDscStartupParameter' -Tag @('Integration_SQL2017', 'Integration_SQL2019', 'Integration_SQL2022') {
+    BeforeAll {
+        Write-Verbose -Message ('Running integration test as user ''{0}''.' -f $env:UserName) -Verbose
+
+        $script:mockInstanceName = 'DSCSQLTEST'
+        $script:mockServerName = Get-ComputerName
+    }
+
+    Context 'When using parameter set ByServerName' {
+        Context 'When getting startup parameters with default parameters' {
+            It 'Should return a StartupParameters object for the test instance' {
+                $result = Get-SqlDscStartupParameter -InstanceName $script:mockInstanceName -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([StartupParameters])
+                $result.DataFilePath | Should -Not -BeNullOrEmpty
+                $result.LogFilePath | Should -Not -BeNullOrEmpty
+                $result.ErrorLogPath | Should -Not -BeNullOrEmpty
+            }
+        }
+
+        Context 'When getting startup parameters for a specific instance' {
+            It 'Should return a StartupParameters object for the specified instance' {
+                $result = Get-SqlDscStartupParameter -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([StartupParameters])
+                $result.DataFilePath | Should -Not -BeNullOrEmpty
+                $result.LogFilePath | Should -Not -BeNullOrEmpty
+                $result.ErrorLogPath | Should -Not -BeNullOrEmpty
+            }
+        }
+
+        Context 'When getting startup parameters for a specific server name' {
+            It 'Should return a StartupParameters object for the specified server' {
+                $result = Get-SqlDscStartupParameter -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([StartupParameters])
+                $result.DataFilePath | Should -Not -BeNullOrEmpty
+                $result.LogFilePath | Should -Not -BeNullOrEmpty
+                $result.ErrorLogPath | Should -Not -BeNullOrEmpty
+            }
+        }
+
+        Context 'When getting startup parameters for a non-existent instance' {
+            It 'Should throw an error when the instance does not exist' {
+                {
+                    Get-SqlDscStartupParameter -ServerName $script:mockServerName -InstanceName 'NonExistentInstance' -ErrorAction 'Stop'
+                } | Should -Throw -ErrorId 'GSDSP0001,Get-SqlDscStartupParameter'
+            }
+        }
+    }
+
+    Context 'When using parameter set ByServiceObject' {
+        BeforeAll {
+            $script:serviceObject = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ServiceType 'DatabaseEngine' -ErrorAction 'Stop'
+        }
+
+        Context 'When getting startup parameters using a service object' {
+            It 'Should return a StartupParameters object for the service object' {
+                $result = Get-SqlDscStartupParameter -ServiceObject $script:serviceObject -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([StartupParameters])
+                $result.DataFilePath | Should -Not -BeNullOrEmpty
+                $result.LogFilePath | Should -Not -BeNullOrEmpty
+                $result.ErrorLogPath | Should -Not -BeNullOrEmpty
+            }
+        }
+
+        Context 'When getting startup parameters using pipeline input' {
+            It 'Should accept ServiceObject from pipeline and return StartupParameters' {
+                $result = $script:serviceObject | Get-SqlDscStartupParameter -ErrorAction 'Stop'
+
+                $result | Should -Not -BeNullOrEmpty
+                $result | Should -BeOfType ([StartupParameters])
+                $result.DataFilePath | Should -Not -BeNullOrEmpty
+                $result.LogFilePath | Should -Not -BeNullOrEmpty
+                $result.ErrorLogPath | Should -Not -BeNullOrEmpty
+            }
+        }
+
+        Context 'When passing wrong service type' {
+            BeforeAll {
+                # Get a non-DatabaseEngine service for testing
+                $script:wrongServiceObject = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ServiceType 'SqlServerAgent' -ErrorAction 'Stop'
+            }
+
+            It 'Should throw an error when the service type is not DatabaseEngine' {
+                {
+                    Get-SqlDscStartupParameter -ServiceObject $script:wrongServiceObject -ErrorAction 'Stop'
+                } | Should -Throw
+            }
+        }
+    }
+
+    Context 'When validating output properties' {
+        BeforeAll {
+            $script:result = Get-SqlDscStartupParameter -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ErrorAction 'Stop'
+        }
+
+        It 'Should return an object with expected DataFilePath property' {
+            $script:result.DataFilePath | Should -Not -BeNullOrEmpty
+            $script:result.DataFilePath | Should -BeOfType ([System.String[]])
+            $script:result.DataFilePath[0] | Should -Match '\.mdf$'
+        }
+
+        It 'Should return an object with expected LogFilePath property' {
+            $script:result.LogFilePath | Should -Not -BeNullOrEmpty
+            $script:result.LogFilePath | Should -BeOfType ([System.String[]])
+            $script:result.LogFilePath[0] | Should -Match '\.ldf$'
+        }
+
+        It 'Should return an object with expected ErrorLogPath property' {
+            $script:result.ErrorLogPath | Should -Not -BeNullOrEmpty
+            $script:result.ErrorLogPath | Should -BeOfType ([System.String[]])
+            $script:result.ErrorLogPath[0] | Should -Match 'ERRORLOG$'
+        }
+
+        It 'Should return TraceFlag property as an array' {
+            $script:result.TraceFlag | Should -BeOfType ([System.UInt32[]])
+        }
+
+        It 'Should return InternalTraceFlag property as an array' {
+            $script:result.InternalTraceFlag | Should -BeOfType ([System.UInt32[]])
+        }
+    }
+
+    Context 'When comparing results from different parameter sets' {
+        It 'Should return the same results for ByServerName and ByServiceObject parameter sets' {
+            $resultByServerName = Get-SqlDscStartupParameter -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ErrorAction 'Stop'
+
+            $serviceObject = Get-SqlDscManagedComputerService -ServerName $script:mockServerName -InstanceName $script:mockInstanceName -ServiceType 'DatabaseEngine' -ErrorAction 'Stop'
+            $resultByServiceObject = Get-SqlDscStartupParameter -ServiceObject $serviceObject -ErrorAction 'Stop'
+
+            $resultByServerName.DataFilePath | Should -Be $resultByServiceObject.DataFilePath
+            $resultByServerName.LogFilePath | Should -Be $resultByServiceObject.LogFilePath
+            $resultByServerName.ErrorLogPath | Should -Be $resultByServiceObject.ErrorLogPath
+            $resultByServerName.TraceFlag | Should -Be $resultByServiceObject.TraceFlag
+            $resultByServerName.InternalTraceFlag | Should -Be $resultByServiceObject.InternalTraceFlag
+        }
+    }
+}

tests/Integration/Commands/README.md

@@ -69,6 +69,7 @@ Test-SqlDscIsLogin | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTES
 Test-SqlDscIsLoginEnabled | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
 New-SqlDscRole | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | SqlDscIntegrationTestRole_Persistent role
 Get-SqlDscRole | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
+Get-SqlDscStartupParameter | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
 Test-SqlDscIsRole | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -
 Grant-SqlDscServerPermission | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | Grants CreateEndpoint permission to role
 Get-SqlDscServerPermission | 2 | 1 (Install-SqlDscServer), 0 (Prerequisites) | DSCSQLTEST | -