Make InstanceId parameter mandatory in Complete-SqlDscImage and update related tests

johlju · johlju · commit ab147244e819 · 2025-10-19T15:41:31.000+02:00
diff --git a/source/Private/Invoke-SetupAction.ps1 b/source/Private/Invoke-SetupAction.ps1
@@ -712,7 +712,7 @@ function Invoke-SetupAction
         [Parameter(ParameterSetName = 'Install')]
         [Parameter(ParameterSetName = 'InstallRole')]
         [Parameter(ParameterSetName = 'PrepareImage', Mandatory = $true)]
-        [Parameter(ParameterSetName = 'CompleteImage')]
+        [Parameter(ParameterSetName = 'CompleteImage', Mandatory = $true)]
         [Parameter(ParameterSetName = 'Upgrade')]
         [Parameter(ParameterSetName = 'InstallFailoverCluster')]
         [Parameter(ParameterSetName = 'PrepareFailoverCluster')]
diff --git a/source/Public/Complete-SqlDscImage.ps1 b/source/Public/Complete-SqlDscImage.ps1
@@ -194,7 +194,7 @@ function Complete-SqlDscImage
         [System.Management.Automation.SwitchParameter]
         $Enu,
 
-        [Parameter()]
+        [Parameter(Mandatory = $true)]
         [System.String]
         $InstanceId,
 
diff --git a/tests/Integration/Commands/Complete-SqlDscImage.Integration.Tests.ps1 b/tests/Integration/Commands/Complete-SqlDscImage.Integration.Tests.ps1
@@ -44,6 +44,8 @@ Describe 'Complete-SqlDscImage' -Tag @('Integration_SQL2017', 'Integration_SQL20
                 AcceptLicensingTerms  = $true
                 InstanceName          = 'DSCSQLTEST'
                 InstanceId            = 'DSCSQLTEST'
+                SqlSvcAccount         = '{0}\svc-SqlPrimary' -f $computerName
+                SqlSvcPassword        = ConvertTo-SecureString -String 'yig-C^Equ3' -AsPlainText -Force
                 MediaPath             = $env:IsoDrivePath
                 Verbose               = $true
                 ErrorAction           = 'Stop'
@@ -140,6 +142,11 @@ Describe 'Complete-SqlDscImage' -Tag @('Integration_SQL2017', 'Integration_SQL20
                 AcceptLicensingTerms  = $true
                 InstanceName          = 'DSCSQLTEST'
                 InstanceId            = 'DSCSQLTEST'
+                SqlSvcAccount         = '{0}\svc-SqlPrimary' -f $computerName
+                SqlSvcPassword        = ConvertTo-SecureString -String 'yig-C^Equ3' -AsPlainText -Force
+                SqlSysAdminAccounts   = @(
+                    ('{0}\SqlAdmin' -f $computerName)
+                )
                 InstallSqlDataDir     = 'C:\Program Files\Microsoft SQL Server\MSSQL\Data'
                 SqlBackupDir          = 'C:\Program Files\Microsoft SQL Server\MSSQL\Backup'
                 SqlTempDbDir          = 'C:\Program Files\Microsoft SQL Server\MSSQL\Data'
diff --git a/tests/Unit/Private/Invoke-SetupAction.Tests.ps1 b/tests/Unit/Private/Invoke-SetupAction.Tests.ps1
@@ -82,7 +82,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
         @{
             MockParameterSetName = 'CompleteImage'
             # cSpell: disable-next
-            MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> [-InstanceName <string>] [-Enu] [-InstanceId <string>] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <string>] [-AgtSvcAccount <string>] [-AgtSvcPassword <securestring>] [-AgtSvcStartupType <string>] [-BrowserSvcStartupType <string>] [-EnableRanU] [-InstallSqlDataDir <string>] [-SqlBackupDir <string>] [-SecurityMode <string>] [-SAPwd <securestring>] [-SqlCollation <string>] [-SqlSvcAccount <string>] [-SqlSvcPassword <securestring>] [-SqlSvcStartupType <string>] [-SqlSysAdminAccounts <string[]>] [-SqlTempDbDir <string>] [-SqlTempDbLogDir <string>] [-SqlTempDbFileCount <ushort>] [-SqlTempDbFileSize <ushort>] [-SqlTempDbFileGrowth <ushort>] [-SqlTempDbLogFileSize <ushort>] [-SqlTempDbLogFileGrowth <ushort>] [-SqlUserDbDir <string>] [-SqlUserDbLogDir <string>] [-FileStreamLevel <ushort>] [-FileStreamShareName <string>] [-NpEnabled] [-TcpEnabled] [-RsInstallMode <string>] [-RSSvcAccount <string>] [-RSSvcPassword <securestring>] [-RSSvcStartupType <string>] [-ProductCoveredBySA] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
+            MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> -InstanceId <string> [-InstanceName <string>] [-Enu] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <string>] [-AgtSvcAccount <string>] [-AgtSvcPassword <securestring>] [-AgtSvcStartupType <string>] [-BrowserSvcStartupType <string>] [-EnableRanU] [-InstallSqlDataDir <string>] [-SqlBackupDir <string>] [-SecurityMode <string>] [-SAPwd <securestring>] [-SqlCollation <string>] [-SqlSvcAccount <string>] [-SqlSvcPassword <securestring>] [-SqlSvcStartupType <string>] [-SqlSysAdminAccounts <string[]>] [-SqlTempDbDir <string>] [-SqlTempDbLogDir <string>] [-SqlTempDbFileCount <ushort>] [-SqlTempDbFileSize <ushort>] [-SqlTempDbFileGrowth <ushort>] [-SqlTempDbLogFileSize <ushort>] [-SqlTempDbLogFileGrowth <ushort>] [-SqlUserDbDir <string>] [-SqlUserDbLogDir <string>] [-FileStreamLevel <ushort>] [-FileStreamShareName <string>] [-NpEnabled] [-TcpEnabled] [-RsInstallMode <string>] [-RSSvcAccount <string>] [-RSSvcPassword <securestring>] [-RSSvcStartupType <string>] [-ProductCoveredBySA] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
         }
         @{
             MockParameterSetName = 'Upgrade'
@@ -3221,6 +3221,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         CompleteImage = $true
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
+                        InstanceId = 'MSSQLSERVER'
                     }
                 }
             }
@@ -3277,6 +3278,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         CompleteImage = $true
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
+                        InstanceId = 'MSSQLSERVER'
                         Force = $true
                         PBStartPortRange = 16450
                         PBEndPortRange = 16460
@@ -3500,6 +3502,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         CompleteImage = $true
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
+                        InstanceId = 'MSSQLSERVER'
                         Force = $true
                     }
                 }
diff --git a/tests/Unit/Public/Complete-SqlDscImage.Tests.ps1 b/tests/Unit/Public/Complete-SqlDscImage.Tests.ps1
@@ -52,7 +52,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
         @{
             MockParameterSetName   = '__AllParameterSets'
             # cSpell: disable-next
-            MockExpectedParameters = '[-MediaPath] <string> [[-InstanceName] <string>] [[-InstanceId] <string>] [[-PBEngSvcAccount] <string>] [[-PBEngSvcPassword] <securestring>] [[-PBEngSvcStartupType] <string>] [[-PBStartPortRange] <ushort>] [[-PBEndPortRange] <ushort>] [[-ProductKey] <string>] [[-AgtSvcAccount] <string>] [[-AgtSvcPassword] <securestring>] [[-AgtSvcStartupType] <string>] [[-BrowserSvcStartupType] <string>] [[-InstallSqlDataDir] <string>] [[-SqlBackupDir] <string>] [[-SecurityMode] <string>] [[-SAPwd] <securestring>] [[-SqlCollation] <string>] [[-SqlSvcAccount] <string>] [[-SqlSvcPassword] <securestring>] [[-SqlSvcStartupType] <string>] [[-SqlSysAdminAccounts] <string[]>] [[-SqlTempDbDir] <string>] [[-SqlTempDbLogDir] <string>] [[-SqlTempDbFileCount] <ushort>] [[-SqlTempDbFileSize] <ushort>] [[-SqlTempDbFileGrowth] <ushort>] [[-SqlTempDbLogFileSize] <ushort>] [[-SqlTempDbLogFileGrowth] <ushort>] [[-SqlUserDbDir] <string>] [[-SqlUserDbLogDir] <string>] [[-FileStreamLevel] <ushort>] [[-FileStreamShareName] <string>] [[-RsInstallMode] <string>] [[-RSSvcAccount] <string>] [[-RSSvcPassword] <securestring>] [[-RSSvcStartupType] <string>] [[-Timeout] <uint>] -AcceptLicensingTerms [-Enu] [-PBScaleOut] [-EnableRanU] [-NpEnabled] [-TcpEnabled] [-ProductCoveredBySA] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
+            MockExpectedParameters = '[-MediaPath] <string> [[-InstanceName] <string>] [-InstanceId] <string> [[-PBEngSvcAccount] <string>] [[-PBEngSvcPassword] <securestring>] [[-PBEngSvcStartupType] <string>] [[-PBStartPortRange] <ushort>] [[-PBEndPortRange] <ushort>] [[-ProductKey] <string>] [[-AgtSvcAccount] <string>] [[-AgtSvcPassword] <securestring>] [[-AgtSvcStartupType] <string>] [[-BrowserSvcStartupType] <string>] [[-InstallSqlDataDir] <string>] [[-SqlBackupDir] <string>] [[-SecurityMode] <string>] [[-SAPwd] <securestring>] [[-SqlCollation] <string>] [[-SqlSvcAccount] <string>] [[-SqlSvcPassword] <securestring>] [[-SqlSvcStartupType] <string>] [[-SqlSysAdminAccounts] <string[]>] [[-SqlTempDbDir] <string>] [[-SqlTempDbLogDir] <string>] [[-SqlTempDbFileCount] <ushort>] [[-SqlTempDbFileSize] <ushort>] [[-SqlTempDbFileGrowth] <ushort>] [[-SqlTempDbLogFileSize] <ushort>] [[-SqlTempDbLogFileGrowth] <ushort>] [[-SqlUserDbDir] <string>] [[-SqlUserDbLogDir] <string>] [[-FileStreamLevel] <ushort>] [[-FileStreamShareName] <string>] [[-RsInstallMode] <string>] [[-RSSvcAccount] <string>] [[-RSSvcPassword] <securestring>] [[-RSSvcStartupType] <string>] [[-Timeout] <uint>] -AcceptLicensingTerms [-Enu] [-PBScaleOut] [-EnableRanU] [-NpEnabled] [-TcpEnabled] [-ProductCoveredBySA] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
         }
     ) {
         $result = (Get-Command -Name 'Complete-SqlDscImage').ParameterSets |
@@ -94,6 +94,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                 $mockDefaultParameters = @{
                     AcceptLicensingTerms = $true
                     MediaPath            = '\SqlMedia'
+                    InstanceId           = 'MSSQLSERVER'
                     ErrorAction          = 'Stop'
                 }
             }
@@ -142,6 +143,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                 $completeSqlDscImageParameters = @{
                     AcceptLicensingTerms = $true
                     MediaPath            = '\SqlMedia'
+                    InstanceId           = 'MSSQLSERVER'
                     Force                = $true
                     PBStartPortRange     = 16450
                     PBEndPortRange       = 16460
@@ -360,6 +362,7 @@ Describe 'Complete-SqlDscImage' -Tag 'Public' {
                 $mockDefaultParameters = @{
                     AcceptLicensingTerms = $true
                     MediaPath            = '\SqlMedia'
+                    InstanceId           = 'MSSQLSERVER'
                     Force                = $true
                     ErrorAction          = 'Stop'
                 }

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`82`	`82`	`@{`
`83`	`83`	`MockParameterSetName = 'CompleteImage'`
`84`	`84`	`# cSpell: disable-next`
`85`		- MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> [-InstanceName <string>] [-Enu] [-InstanceId <string>] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <string>] [-AgtSvcAccount <string>] [-AgtSvcPassword <securestring>] [-AgtSvcStartupType <string>] [-BrowserSvcStartupType <string>] [-EnableRanU] [-InstallSqlDataDir <string>] [-SqlBackupDir <string>] [-SecurityMode <string>] [-SAPwd <securestring>] [-SqlCollation <string>] [-SqlSvcAccount <string>] [-SqlSvcPassword <securestring>] [-SqlSvcStartupType <string>] [-SqlSysAdminAccounts <string[]>] [-SqlTempDbDir <string>] [-SqlTempDbLogDir <string>] [-SqlTempDbFileCount <ushort>] [-SqlTempDbFileSize <ushort>] [-SqlTempDbFileGrowth <ushort>] [-SqlTempDbLogFileSize <ushort>] [-SqlTempDbLogFileGrowth <ushort>] [-SqlUserDbDir <string>] [-SqlUserDbLogDir <string>] [-FileStreamLevel <ushort>] [-FileStreamShareName <string>] [-NpEnabled] [-TcpEnabled] [-RsInstallMode <string>] [-RSSvcAccount <string>] [-RSSvcPassword <securestring>] [-RSSvcStartupType <string>] [-ProductCoveredBySA] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
	`85`	+ MockExpectedParameters = '-CompleteImage -AcceptLicensingTerms -MediaPath <string> -InstanceId <string> [-InstanceName <string>] [-Enu] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-ProductKey <string>] [-AgtSvcAccount <string>] [-AgtSvcPassword <securestring>] [-AgtSvcStartupType <string>] [-BrowserSvcStartupType <string>] [-EnableRanU] [-InstallSqlDataDir <string>] [-SqlBackupDir <string>] [-SecurityMode <string>] [-SAPwd <securestring>] [-SqlCollation <string>] [-SqlSvcAccount <string>] [-SqlSvcPassword <securestring>] [-SqlSvcStartupType <string>] [-SqlSysAdminAccounts <string[]>] [-SqlTempDbDir <string>] [-SqlTempDbLogDir <string>] [-SqlTempDbFileCount <ushort>] [-SqlTempDbFileSize <ushort>] [-SqlTempDbFileGrowth <ushort>] [-SqlTempDbLogFileSize <ushort>] [-SqlTempDbLogFileGrowth <ushort>] [-SqlUserDbDir <string>] [-SqlUserDbLogDir <string>] [-FileStreamLevel <ushort>] [-FileStreamShareName <string>] [-NpEnabled] [-TcpEnabled] [-RsInstallMode <string>] [-RSSvcAccount <string>] [-RSSvcPassword <securestring>] [-RSSvcStartupType <string>] [-ProductCoveredBySA] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
`86`	`86`	`}`
`87`	`87`	`@{`
`88`	`88`	`MockParameterSetName = 'Upgrade'`
`@@ -3221,6 +3221,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`3221`	`3221`	`CompleteImage = $true`
`3222`	`3222`	`AcceptLicensingTerms = $true`
`3223`	`3223`	`MediaPath = '\SqlMedia'`
	`3224`	`+ InstanceId = 'MSSQLSERVER'`
`3224`	`3225`	`}`
`3225`	`3226`	`}`
`3226`	`3227`	`}`
`@@ -3277,6 +3278,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`3277`	`3278`	`CompleteImage = $true`
`3278`	`3279`	`AcceptLicensingTerms = $true`
`3279`	`3280`	`MediaPath = '\SqlMedia'`
	`3281`	`+ InstanceId = 'MSSQLSERVER'`
`3280`	`3282`	`Force = $true`
`3281`	`3283`	`PBStartPortRange = 16450`
`3282`	`3284`	`PBEndPortRange = 16460`
`@@ -3500,6 +3502,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {`
`3500`	`3502`	`CompleteImage = $true`
`3501`	`3503`	`AcceptLicensingTerms = $true`
`3502`	`3504`	`MediaPath = '\SqlMedia'`
	`3505`	`+ InstanceId = 'MSSQLSERVER'`
`3503`	`3506`	`Force = $true`
`3504`	`3507`	`}`
`3505`	`3508`	`}`