Add integration test for Remove-SqlDscTraceFlag (#2245)

Author: Copilot

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

@@ -6,10 +6,11 @@ applyTo: "**"
 # SqlServerDsc Requirements
 
 ## Build & Test Workflow Requirements
-- Run PowerShell script files from repository root
+- Never use VS Code task, always use PowerShell scripts via terminal, from repository root
 - Setup build and test environment (once per `pwsh` session): `./build.ps1 -Tasks noop`
 - Build project before running tests: `./build.ps1 -Tasks build`
 - Run tests without coverage (wildcards allowed): `Invoke-PesterJob -Path '{tests filepath}' -SkipCodeCoverage`
+- Run tests with coverage (wildcards allowed): `Invoke-PesterJob -Path '{tests filepath}' -EnableSourceLineMapping -FilterCodeCoverageResult '{pattern}'`
 - Run QA tests: `Invoke-PesterJob -Path 'tests/QA' -SkipCodeCoverage`
 - Never run integration tests locally
 

CHANGELOG.md

@@ -7,15 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Added integration tests for `Remove-SqlDscAudit` command to ensure it functions
-  correctly in real environments
-  [issue #2241](https://github.com/dsccommunity/SqlServerDsc/issues/2241).
+- `Remove-SqlDscTraceFlag`
+  - Added missing integration test to ensure command reliability ([issue #2239](https://github.com/dsccommunity/SqlServerDsc/issues/2239)).
+- `Remove-SqlDscAudit`
+  - Added missing integration test to ensure command reliability ([issue #2241](https://github.com/dsccommunity/SqlServerDsc/issues/2241)).
 - Added integration tests for `Test-SqlDscIsRole` command to ensure it functions
   correctly in real environments
   [issue #2229](https://github.com/dsccommunity/SqlServerDsc/issues/2229).
 
 ### Fixed
 
+- `Add-SqlDscTraceFlag` and `Remove-SqlDscTraceFlag`
+  - Fixed parameter binding error when `ErrorAction` was specified both
+    explicitly and via `PSBoundParameters` by using `Remove-CommonParameter`
+    instead of manual parameter removal
+    ([issue #2239](https://github.com/dsccommunity/SqlServerDsc/issues/2239)).
+- `Remove-SqlDscTraceFlag`
+  - Optimized to skip unnecessary Set operations when removal results in no
+    effective change
+    ([issue #2239](https://github.com/dsccommunity/SqlServerDsc/issues/2239)).
 - Updated `.gitattributes` to enforce LF line endings for PowerShell files to
   ensure cross-platform compatibility.
 - Updated GitHub Copilot setup workflow to fix environment variable assignment

azure-pipelines.yml

@@ -333,6 +333,7 @@ stages:
                   'tests/Integration/Commands/Remove-SqlDscDatabase.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscRole.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscLogin.Integration.Tests.ps1'
+                  'tests/Integration/Commands/Remove-SqlDscTraceFlag.Integration.Tests.ps1'
                   # Group 9
                   'tests/Integration/Commands/Uninstall-SqlDscServer.Integration.Tests.ps1'
               )

source/Public/Add-SqlDscTraceFlag.ps1

@@ -96,12 +96,10 @@ function Add-SqlDscTraceFlag
         }
 
         # Copy $PSBoundParameters to keep it intact.
-        $getSqlDscTraceFlagParameters = @{} + $PSBoundParameters
+        $getSqlDscTraceFlagParameters = Remove-CommonParameter -Hashtable $PSBoundParameters
 
-        $commonParameters = [System.Management.Automation.PSCmdlet]::OptionalCommonParameters
-
-        # Remove parameters that Get-SqlDscTraceFLag does not have/support.
-        $commonParameters + @('Force', 'TraceFlag') |
+        # Remove parameters that Get-SqlDscTraceFlag does not have/support.
+        @('Force', 'TraceFlag') |
             ForEach-Object -Process {
                 $getSqlDscTraceFlagParameters.Remove($_)
             }
@@ -132,9 +130,9 @@ function Add-SqlDscTraceFlag
         if ($PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage))
         {
             # Copy $PSBoundParameters to keep it intact.
-            $setSqlDscTraceFlagParameters = @{} + $PSBoundParameters
+            $setSqlDscTraceFlagParameters = Remove-CommonParameter -Hashtable $PSBoundParameters
 
-            $setSqlDscTraceFlagParameters.TraceFLag = $desiredTraceFlags
+            $setSqlDscTraceFlagParameters.TraceFlag = $desiredTraceFlags
 
             $originalErrorActionPreference = $ErrorActionPreference
 

source/Public/Remove-SqlDscTraceFlag.ps1

@@ -96,12 +96,10 @@ function Remove-SqlDscTraceFlag
         }
 
         # Copy $PSBoundParameters to keep it intact.
-        $getSqlDscTraceFlagParameters = @{} + $PSBoundParameters
+        $getSqlDscTraceFlagParameters = Remove-CommonParameter -Hashtable $PSBoundParameters
 
-        $commonParameters = [System.Management.Automation.PSCmdlet]::OptionalCommonParameters
-
-        # Remove parameters that Get-SqlDscTraceFLag does not have/support.
-        $commonParameters + @('Force', 'TraceFlag') |
+        # Remove parameters that Get-SqlDscTraceFlag does not have/support.
+        @('Force', 'TraceFlag') |
             ForEach-Object -Process {
                 $getSqlDscTraceFlagParameters.Remove($_)
             }
@@ -128,16 +126,23 @@ function Remove-SqlDscTraceFlag
                     }
             )
 
+            # Short-circuit if removal results in no effective change
+            if (-not (Compare-Object -ReferenceObject $currentTraceFlags -DifferenceObject $desiredTraceFlags))
+            {
+                Write-Debug -Message $script:localizedData.TraceFlag_Remove_NoChange
+                return
+            }
+
             $verboseDescriptionMessage = $script:localizedData.TraceFlag_Remove_ShouldProcessVerboseDescription -f $InstanceName, ($TraceFlag -join ', ')
             $verboseWarningMessage = $script:localizedData.TraceFlag_Remove_ShouldProcessVerboseWarning -f $InstanceName
             $captionMessage = $script:localizedData.TraceFlag_Remove_ShouldProcessCaption
 
             if ($PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage))
             {
                 # Copy $PSBoundParameters to keep it intact.
-                $setSqlDscTraceFlagParameters = @{} + $PSBoundParameters
+                $setSqlDscTraceFlagParameters = Remove-CommonParameter -Hashtable $PSBoundParameters
 
-                $setSqlDscTraceFlagParameters.TraceFLag = $desiredTraceFlags
+                $setSqlDscTraceFlagParameters.TraceFlag = $desiredTraceFlags
 
                 $originalErrorActionPreference = $ErrorActionPreference
 

source/en-US/SqlServerDsc.strings.psd1

@@ -216,6 +216,7 @@ ConvertFrom-StringData @'
     # This string shall not end with full stop (.) since it is used as a title of ShouldProcess messages.
     TraceFlag_Remove_ShouldProcessCaption = Remove trace flag from instance
     TraceFlag_Remove_NoCurrentTraceFlags = There are no current trace flags on instance. Nothing to remove.
+    TraceFlag_Remove_NoChange = The specified trace flags are not currently set on the instance. No changes needed.
 
     ## Get-SqlDscPreferredModule
     PreferredModule_ModuleVersionFound = Preferred module '{0}' with version '{1}' found.

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

@@ -19,7 +19,7 @@ BeforeDiscovery {
     }
     catch [System.IO.FileNotFoundException]
     {
-        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks build" first.'
+        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
     }
 }
 

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

@@ -19,7 +19,7 @@ BeforeDiscovery {
     }
     catch [System.IO.FileNotFoundException]
     {
-        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks build" first.'
+        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
     }
 }
 

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

@@ -19,7 +19,7 @@ BeforeDiscovery {
     }
     catch [System.IO.FileNotFoundException]
     {
-        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks build" first.'
+        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
     }
 }
 

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

@@ -19,7 +19,7 @@ BeforeDiscovery {
     }
     catch [System.IO.FileNotFoundException]
     {
-        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks build" first.'
+        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
     }
 }