Replace Should -Not -Throw with direct invocation in all test files

[coderabbitai]

Description

Throughout the project's test files, there are instances where commands are wrapped with assertions. According to the project's coding guidelines, this pattern should be avoided.

Current Issue

Tests currently use patterns like:

{
    Some-Command -ErrorAction 'Stop'
} | Should -Not -Throw

Required Change

Replace with direct invocation:

$null = Some-Command -ErrorAction 'Stop'

Scope

This affects all test files matching the pattern:

• tests/Unit/**/*.Tests.ps1
• tests/Integration/**/*.Integration.Tests.ps1

Guidelines Reference

From the project's test guidelines: "Do not use Should -Not -Throw; invoke commands directly"

Background

This issue was identified during review of PR #2245 where the pattern was found in the new integration test file tests/Integration/Commands/Remove-SqlDscTraceFlag.Integration.Tests.ps1.

Backlinks

• PR: Add integration test for Remove-SqlDscTraceFlag #2245
• Comment: Add integration test for Remove-SqlDscTraceFlag #2245 (comment)
• Requested by: @johlju

[dan-hughes]

@johlju, is this applicable to just 'Command' integration tests or is this a wider pattern that needs to be adopted?

[johlju]

This is necessary to be able to convert to Pester 6 as there are not a Should-NotThrow in Pester 6 and there are no plan to be one either as the It-block handles this. One thing is that we should always make sure to assign to $null if we don’t want the result in the Pester object being returned.

That is why it was added to the AI instructions. This issue is just to for the repo to be compliant with AI instructions and when AI look at existing patterns in the repo it will see the correct one.

I created a module PesterConverter that will convert this to Pester 6 syntax. So it is not necessary this convert this now.