Fix to be compliant with QA tests (#2162)

Author: johlju

CHANGELOG.md

@@ -23,6 +23,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ValidateSet for the Edition property.
 - Fixed commands continuing execution after `Assert-ElevatedUser` elevation
   errors by setting `$ErrorActionPreference = 'Stop'` [issue #2070](https://github.com/dsccommunity/SqlServerDsc/issues/2070)
+- Fixed incorrect array-return syntax in several public `Get-*` commands by
+  removing a leading comma in return statements which could cause incorrect
+  output and ScriptAnalyzer warnings: `Get-SqlDscAudit`,
+  `Get-SqlDscConfigurationOption`, `Get-SqlDscDatabasePermission`,
+  `Get-SqlDscServerPermission`, and `Get-SqlDscTraceFlag`.
+- New-SqlDscDatabase: use `New-ArgumentException` instead of
+  `New-InvalidArgumentException` for parameter validation errors.
 
 ### Added
 
@@ -131,6 +138,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improved markdown, pester, powershell, and changelog instructions.
   - Fixed `Ignore` that seems in edge-cases fail.
   - Improved markdown and changelog instructions.
+- `RequiredModules.psd1`
+  - Updated `DscResource.Test` dependency to `latest` (was pinned to `0.17.2`).
+- Examples
+  - `source/Examples/Resources/SqlSetup/5-InstallNamedInstanceInFailoverClusterSecondNode.ps1`
+    - Removed redundant `$SqlAdministratorCredential` parameter from example
+      configuration.
 
 ## [17.1.0] - 2025-05-22
 

RequiredModules.psd1

@@ -28,7 +28,7 @@
     Sampler                        = 'latest'
     'Sampler.GitHubTasks'          = 'latest'
     MarkdownLinkCheck              = 'latest'
-    'DscResource.Test'             = '0.17.2'
+    'DscResource.Test'             = 'latest'
     xDscResourceDesigner           = 'latest'
 
     # Build dependencies needed for using the module

source/Examples/Resources/SqlSetup/5-InstallNamedInstanceInFailoverClusterSecondNode.ps1

@@ -36,11 +36,6 @@ Configuration Example
         [System.Management.Automation.PSCredential]
         $SqlInstallCredential,
 
-        [Parameter()]
-        [ValidateNotNullOrEmpty()]
-        [System.Management.Automation.PSCredential]
-        $SqlAdministratorCredential = $SqlInstallCredential,
-
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.Management.Automation.PSCredential]

source/Public/Get-SqlDscAudit.ps1

@@ -25,11 +25,11 @@
         Get the audit named **MyFileAudit**.
 
     .OUTPUTS
-        `[Microsoft.SqlServer.Management.Smo.Audit]`
+        `[Microsoft.SqlServer.Management.Smo.Audit[]]`
+        Array of SMO Audit objects from the target SQL Server instance.
 #>
 function Get-SqlDscAudit
 {
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Because the rule does not understands that the command returns [System.String[]] when using , (comma) in the return statement')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]
     [OutputType([Microsoft.SqlServer.Management.Smo.Audit[]])]
     [CmdletBinding()]
@@ -62,7 +62,7 @@ function Get-SqlDscAudit
         {
             $auditObject = $ServerObject.Audits[$Name]
 
-            if (-not $AuditObject)
+            if (-not $auditObject)
             {
                 $missingAuditMessage = $script:localizedData.Audit_Missing -f $Name
 
@@ -81,6 +81,6 @@ function Get-SqlDscAudit
             $auditObject = $ServerObject.Audits
         }
 
-        return , [Microsoft.SqlServer.Management.Smo.Audit[]] $auditObject
+        return [Microsoft.SqlServer.Management.Smo.Audit[]] $auditObject
     }
 }

source/Public/Get-SqlDscConfigurationOption.ps1

@@ -31,10 +31,10 @@
 
     .OUTPUTS
         `[Microsoft.SqlServer.Management.Smo.ConfigProperty[]]`
+        Array of SMO ConfigProperty objects representing server configuration options.
 #>
 function Get-SqlDscConfigurationOption
 {
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Because the rule does not understands that the command returns [System.String[]] when using , (comma) in the return statement')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]
     [OutputType([Microsoft.SqlServer.Management.Smo.ConfigProperty[]])]
     [CmdletBinding()]
@@ -58,12 +58,12 @@ function Get-SqlDscConfigurationOption
         if ($Refresh.IsPresent)
         {
             # Make sure the configuration option values are up-to-date.
-            $serverObject.Configuration.Refresh()
+            $ServerObject.Configuration.Refresh()
         }
 
         if ($PSBoundParameters.ContainsKey('Name'))
         {
-            $configurationOption = $serverObject.Configuration.Properties |
+            $configurationOption = $ServerObject.Configuration.Properties |
                 Where-Object -FilterScript {
                     $_.DisplayName -like $Name
                 }
@@ -84,10 +84,10 @@ function Get-SqlDscConfigurationOption
         }
         else
         {
-            $configurationOption = $serverObject.Configuration.Properties.ForEach({ $_ })
+            $configurationOption = $ServerObject.Configuration.Properties.ForEach({ $_ })
         }
 
-        return , [Microsoft.SqlServer.Management.Smo.ConfigProperty[]] (
+        return [Microsoft.SqlServer.Management.Smo.ConfigProperty[]] (
             $configurationOption |
                 Sort-Object -Property 'DisplayName'
         )

source/Public/Get-SqlDscDatabasePermission.ps1

@@ -36,7 +36,6 @@
 #>
 function Get-SqlDscDatabasePermission
 {
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Because the rule does not understands that the command returns [System.String[]] when using , (comma) in the return statement')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('AvoidThrowOutsideOfTry', '', Justification = 'Because the code throws based on an prior expression')]
     [CmdletBinding()]
@@ -97,6 +96,6 @@ function Get-SqlDscDatabasePermission
             Write-Error -Message $missingDatabaseMessage -Category 'InvalidOperation' -ErrorId 'GSDDP0002' -TargetObject $DatabaseName
         }
 
-        return , [Microsoft.SqlServer.Management.Smo.DatabasePermissionInfo[]] $getSqlDscDatabasePermissionResult
+        return [Microsoft.SqlServer.Management.Smo.DatabasePermissionInfo[]] $getSqlDscDatabasePermissionResult
     }
 }

source/Public/Get-SqlDscServerPermission.ps1

@@ -95,7 +95,6 @@
 #>
 function Get-SqlDscServerPermission
 {
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Because the rule does not understands that the command returns [System.String[]] when using , (comma) in the return statement')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('AvoidThrowOutsideOfTry', '', Justification = 'Because the code throws based on an prior expression')]
     [CmdletBinding(DefaultParameterSetName = 'ByName')]
@@ -196,6 +195,6 @@ function Get-SqlDscServerPermission
             Write-Error -Message $missingPrincipalMessage -Category 'InvalidOperation' -ErrorId 'GSDSP0001' -TargetObject $principalName
         }
 
-        return , [Microsoft.SqlServer.Management.Smo.ServerPermissionInfo[]] $getSqlDscServerPermissionResult
+        return [Microsoft.SqlServer.Management.Smo.ServerPermissionInfo[]] $getSqlDscServerPermissionResult
     }
 }

source/Public/Get-SqlDscTraceFlag.ps1

@@ -45,7 +45,6 @@
 #>
 function Get-SqlDscTraceFlag
 {
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Because the rule does not understands that the command returns [System.UInt32[]] when using , (comma) in the return statement')]
     [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]
     [OutputType([System.UInt32[]])]
     [CmdletBinding(DefaultParameterSetName = 'ByServerName')]
@@ -83,5 +82,5 @@ function Get-SqlDscTraceFlag
         $script:localizedData.TraceFlag_Get_DebugReturningTraceFlags -f $MyInvocation.MyCommand, ($traceFlags -join ', ')
     )
 
-    return , [System.UInt32[]] $traceFlags
+    return [System.UInt32[]] $traceFlags
 }

source/Public/New-SqlDscDatabase.ps1

@@ -139,7 +139,7 @@ function New-SqlDscDatabase
             if ($CompatibilityLevel -notin $supportedCompatibilityLevels.$($ServerObject.VersionMajor))
             {
                 $errorMessage = $script:localizedData.Database_InvalidCompatibilityLevel -f $CompatibilityLevel, $ServerObject.InstanceName
-                New-InvalidArgumentException -ArgumentName 'CompatibilityLevel' -Message $errorMessage
+                New-ArgumentException -ArgumentName 'CompatibilityLevel' -Message $errorMessage
             }
         }
 
@@ -149,7 +149,7 @@ function New-SqlDscDatabase
             if ($Collation -notin $ServerObject.EnumCollations().Name)
             {
                 $errorMessage = $script:localizedData.Database_InvalidCollation -f $Collation, $ServerObject.InstanceName
-                New-InvalidArgumentException -ArgumentName 'Collation' -Message $errorMessage
+                New-ArgumentException -ArgumentName 'Collation' -Message $errorMessage
             }
         }
 

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

@@ -233,7 +233,7 @@ Describe 'Get-SqlDscServerPermission' -Tag @('Integration_SQL2017', 'Integration
                 $result = $loginObjects | Get-SqlDscServerPermission
 
                 $result | Should -Not -BeNullOrEmpty
-                $result | Should -BeOfType [Microsoft.SqlServer.Management.Smo.ServerPermissionInfo[]]
+                $result | Should -BeOfType [Microsoft.SqlServer.Management.Smo.ServerPermissionInfo]
                 $result.Count | Should -BeGreaterThan 1
             }
         }
@@ -271,7 +271,7 @@ Describe 'Get-SqlDscServerPermission' -Tag @('Integration_SQL2017', 'Integration
                 $result = $roleObjects | Get-SqlDscServerPermission
 
                 $result | Should -Not -BeNullOrEmpty
-                $result | Should -BeOfType [Microsoft.SqlServer.Management.Smo.ServerPermissionInfo[]]
+                $result | Should -BeOfType [Microsoft.SqlServer.Management.Smo.ServerPermissionInfo]
                 $result.Count | Should -BeGreaterThan 1
             }
         }