Install-SqlDscServer: Fix bug for PrepareImage (#1961)

- `Install-SqlDscServer` - Now the parameter `InstanceName` can no longer be specified (as per the SQL Server documentation) for the setup action `PrepareImage` (issue #1960).
dsccommunity · Aug 20, 2023 · f3df24b · f3df24b
1 parent 22c4f2d
commit f3df24b
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -42,7 +42,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Fix duplication of SQL Server Browser Firewall Rule when deploying
     Analysis Services feature ([issue #1942](https://github.com/dsccommunity/SqlServerDsc/issues/1942)).
 - SqlLogin
-  - Attempting to disable and already disabled login throws an error ([issue #1952](https://github.com/dsccommunity/SqlServerDsc/issues/1952))
+  - Attempting to disable and already disabled login throws an error ([issue #1952](https://github.com/dsccommunity/SqlServerDsc/issues/1952)).
+- `Install-SqlDscServer`
+  - Now the parameter `InstanceName` can no longer be specified (as per
+    the SQL Server documentation) for the setup action `PrepareImage`
+    ([issue #1960](https://github.com/dsccommunity/SqlServerDsc/issues/1960)).
 
 ## [16.3.1] - 2023-05-06
 

diff --git a/source/Private/Invoke-SetupAction.ps1 b/source/Private/Invoke-SetupAction.ps1
@@ -401,7 +401,7 @@
         Uninstalls the database engine from the named instance MyInstance.
 
     .EXAMPLE
-        Invoke-SetupAction -PrepareImage -AcceptLicensingTerms -InstanceName 'MyInstance' -Features 'SQLENGINE' -InstanceId 'MyInstance' -MediaPath 'E:\'
+        Invoke-SetupAction -PrepareImage -AcceptLicensingTerms -Features 'SQLENGINE' -InstanceId 'MyInstance' -MediaPath 'E:\'
 
         Prepares the server for using the database engine for an instance named 'MyInstance'.
 
@@ -577,7 +577,6 @@ function Invoke-SetupAction
 
         [Parameter(ParameterSetName = 'Install', Mandatory = $true)]
         [Parameter(ParameterSetName = 'Uninstall', Mandatory = $true)]
-        [Parameter(ParameterSetName = 'PrepareImage', Mandatory = $true)]
         [Parameter(ParameterSetName = 'Upgrade', Mandatory = $true)]
         [Parameter(ParameterSetName = 'EditionUpgrade', Mandatory = $true)]
         [Parameter(ParameterSetName = 'Repair', Mandatory = $true)]

diff --git a/source/Public/Install-SqlDscServer.ps1 b/source/Public/Install-SqlDscServer.ps1
@@ -375,7 +375,7 @@
         Installs SQL Server using the configuration file 'MySqlConfig.ini'.
 
     .EXAMPLE
-        Install-SqlDscServer -PrepareImage -AcceptLicensingTerms -InstanceName 'MyInstance' -Features 'SQLENGINE' -InstanceId 'MyInstance' -MediaPath 'E:\'
+        Install-SqlDscServer -PrepareImage -AcceptLicensingTerms -Features 'SQLENGINE' -InstanceId 'MyInstance' -MediaPath 'E:\'
 
         Prepares the server for using the database engine for an instance named 'MyInstance'.
 
@@ -471,7 +471,6 @@ function Install-SqlDscServer
         $MediaPath,
 
         [Parameter(ParameterSetName = 'Install', Mandatory = $true)]
-        [Parameter(ParameterSetName = 'PrepareImage', Mandatory = $true)]
         [Parameter(ParameterSetName = 'Upgrade', Mandatory = $true)]
         [Parameter(ParameterSetName = 'EditionUpgrade', Mandatory = $true)]
         [Parameter(ParameterSetName = 'InstallFailoverCluster', Mandatory = $true)]

diff --git a/tests/Unit/Private/Invoke-SetupAction.Tests.ps1 b/tests/Unit/Private/Invoke-SetupAction.Tests.ps1
@@ -77,7 +77,7 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
         @{
             MockParameterSetName = 'PrepareImage'
             # cSpell: disable-next
-            MockExpectedParameters = '-PrepareImage -AcceptLicensingTerms -MediaPath <string> -InstanceName <string> -Features <string[]> -InstanceId <string> [-IAcknowledgeEntCalLimits] [-Enu] [-UpdateEnabled] [-UpdateSource <string>] [-InstallSharedDir <string>] [-InstanceDir <string>] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
+            MockExpectedParameters = '-PrepareImage -AcceptLicensingTerms -MediaPath <string> -Features <string[]> -InstanceId <string> [-IAcknowledgeEntCalLimits] [-Enu] [-UpdateEnabled] [-UpdateSource <string>] [-InstallSharedDir <string>] [-InstanceDir <string>] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
         }
         @{
             MockParameterSetName = 'CompleteImage'
@@ -3188,7 +3188,6 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         PrepareImage = $true
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
-                        InstanceName = 'INSTANCE'
                         # Intentionally using both upper- and lower-case.
                         Features = 'SqlEngine'
                         InstanceId = 'Instance'
@@ -3205,7 +3204,6 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                             $ArgumentList | Should -MatchExactly '\/ACTION=PrepareImage'
                             $ArgumentList | Should -MatchExactly '\/IACCEPTSQLSERVERLICENSETERMS' # cspell: disable-line
                             $ArgumentList | Should -MatchExactly '\/FEATURES=SQLENGINE'
-                            $ArgumentList | Should -MatchExactly '\/INSTANCENAME="INSTANCE"' # cspell: disable-line
                             $ArgumentList | Should -MatchExactly '\/INSTANCEID="Instance"' # cspell: disable-line
 
                             # Return $true if none of the above throw.
@@ -3224,7 +3222,6 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                             $ArgumentList | Should -MatchExactly '\/ACTION=PrepareImage'
                             $ArgumentList | Should -MatchExactly '\/IACCEPTSQLSERVERLICENSETERMS' # cspell: disable-line
                             $ArgumentList | Should -MatchExactly '\/FEATURES=SQLENGINE'
-                            $ArgumentList | Should -MatchExactly '\/INSTANCENAME="INSTANCE"' # cspell: disable-line
                             $ArgumentList | Should -MatchExactly '\/INSTANCEID="Instance"' # cspell: disable-line
 
                             # Return $true if none of the above throw.
@@ -3307,7 +3304,6 @@ Describe 'Invoke-SetupAction' -Tag 'Private' {
                         PrepareImage = $true
                         AcceptLicensingTerms = $true
                         MediaPath = '\SqlMedia'
-                        InstanceName = 'INSTANCE'
                         # Intentionally using both upper- and lower-case.
                         Features = 'SqlEngine'
                         InstanceId = 'Instance'

diff --git a/tests/Unit/Public/Install-SqlDscServer.Tests.ps1 b/tests/Unit/Public/Install-SqlDscServer.Tests.ps1
@@ -72,7 +72,7 @@ Describe 'Install-SqlDscServer' -Tag 'Public' {
         @{
             MockParameterSetName = 'PrepareImage'
             # cSpell: disable-next
-            MockExpectedParameters = '-PrepareImage -AcceptLicensingTerms -MediaPath <string> -InstanceName <string> -Features <string[]> -InstanceId <string> [-IAcknowledgeEntCalLimits] [-Enu] [-UpdateEnabled] [-UpdateSource <string>] [-InstallSharedDir <string>] [-InstanceDir <string>] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
+            MockExpectedParameters = '-PrepareImage -AcceptLicensingTerms -MediaPath <string> -Features <string[]> -InstanceId <string> [-IAcknowledgeEntCalLimits] [-Enu] [-UpdateEnabled] [-UpdateSource <string>] [-InstallSharedDir <string>] [-InstanceDir <string>] [-PBEngSvcAccount <string>] [-PBEngSvcPassword <securestring>] [-PBEngSvcStartupType <string>] [-PBStartPortRange <ushort>] [-PBEndPortRange <ushort>] [-PBScaleOut] [-Timeout <uint>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]'
         }
         @{
             MockParameterSetName = 'Upgrade'
@@ -2035,7 +2035,6 @@ Describe 'Install-SqlDscServer' -Tag 'Public' {
                     PrepareImage = $true
                     AcceptLicensingTerms = $true
                     MediaPath = '\SqlMedia'
-                    InstanceName = 'INSTANCE'
                     # Intentionally using both upper- and lower-case.
                     Features = 'SqlEngine'
                     InstanceId = 'Instance'
@@ -2050,7 +2049,6 @@ Describe 'Install-SqlDscServer' -Tag 'Public' {
                         $ArgumentList | Should -MatchExactly '\/ACTION=PrepareImage'
                         $ArgumentList | Should -MatchExactly '\/IACCEPTSQLSERVERLICENSETERMS' # cspell: disable-line
                         $ArgumentList | Should -MatchExactly '\/FEATURES=SQLENGINE'
-                        $ArgumentList | Should -MatchExactly '\/INSTANCENAME="INSTANCE"' # cspell: disable-line
                         $ArgumentList | Should -MatchExactly '\/INSTANCEID="Instance"' # cspell: disable-line
 
                         # Return $true if none of the above throw.
@@ -2067,7 +2065,6 @@ Describe 'Install-SqlDscServer' -Tag 'Public' {
                         $ArgumentList | Should -MatchExactly '\/ACTION=PrepareImage'
                         $ArgumentList | Should -MatchExactly '\/IACCEPTSQLSERVERLICENSETERMS' # cspell: disable-line
                         $ArgumentList | Should -MatchExactly '\/FEATURES=SQLENGINE'
-                        $ArgumentList | Should -MatchExactly '\/INSTANCENAME="INSTANCE"' # cspell: disable-line
                         $ArgumentList | Should -MatchExactly '\/INSTANCEID="Instance"' # cspell: disable-line
 
                         # Return $true if none of the above throw.
@@ -2146,7 +2143,6 @@ Describe 'Install-SqlDscServer' -Tag 'Public' {
                     PrepareImage = $true
                     AcceptLicensingTerms = $true
                     MediaPath = '\SqlMedia'
-                    InstanceName = 'INSTANCE'
                     # Intentionally using both upper- and lower-case.
                     Features = 'SqlEngine'
                     InstanceId = 'Instance'