Tests - Report Query() calls whose value goes to the output - #10798

Part of #10794: the check that keeps new bare Query() calls out, now that the fixes are in. #10791, #10795, #10796 and #10797 are merged, and development is merged into this branch (1431760). The scan finds exactly the 19 listed sites, and dbatools.Tests.ps1 passes in the lab (87 passed, 6 skipped, 0 failed, Windows PowerShell 5.1).

What it checks

The Query() script methods of the SMO Server and Database objects return $null for a batch without a result set, and a call whose value nothing takes writes that $null into the output of the command. The new test in the "command structure" Describe (Compliance tag, no SQL Server needed) reports every .Query(...) call in public/ and private/functions/ whose value reaches its function.

Get-DbaBareQueryFinding in tests/dbatools.CommandStructure.ps1 follows the value up the syntax tree, the way PowerShell passes it on:

So $items | ForEach-Object { $server.Query("DROP ...") } is reported, while $rows = if ($x) { $server.Query($sql) } and foreach ($row in @($db.Query($sql))) are not. The last one is the false positive the scan in the issue had (Get-EncryptedObjectImageValue).

The exceptions

19 calls return the rows of a SELECT as their output on purpose (Get-DbaConnection, Get-DbaPermission, Read-DbaTransactionLog, the helpers of Get-DbaDatabase, ...). They are listed next to the rule 1 exceptions with file, function, exact number of sites and reason, and the comparison is shared: a new site in a listed function, or a listed one that is gone, fails the check until the entry is updated. The rule 1 messages are unchanged.

Fixtures in the "command structure analyzer" Describe cover both columns of the table above, a helper function inside a command, and the method name in any spelling.

tests/CLAUDE.md

"Array Operations" recommended $results.Status.Count for counting. That skips a $null in the output, and it is how these $null went unnoticed: it now says to count the output itself with @($results).Count, or to assert that it holds no $null. The section on the structural checks describes the new one.

Tests

PowerShell 5.1 and 7.6, the two "command structure" Describes:

• this branch alone (development 900ba03): the new test fails with exactly the 86 sites that Cleanup, output and -WhatIf - Fix the side findings of the progress work in 10 commands #10791, Copy commands - Stop writing $null into the output of 17 commands #10795, Instance level commands - Stop writing $null into the output of 19 commands #10796 and Database level commands - Stop writing $null into the output of 9 commands #10797 fix, everything else passes
• this branch with the four PRs merged: 61 passed, 0 failed
• the style Describe passes

Merge order

After #10791, #10795, #10796 and #10797. If a bare Query() comes into development before that, this check reports it as well.

🤖 Generated with Claude Code