`Get-CodeCoverageResult`: New command proposal

[johlju]

Details of the scenario you tried and the problem that is occurring

It is very complicated to get the code coverage for a certan function or class through CLI. Suggest adding a command that can make it less difficult:

Invoke-PesterWithCodeCoverage: runs Pester with required configuration and returns a PesterObject. The command should take an optional PesterConfiguration parameter, but use default if not specified.

Get-CodeCoverageResult: The command should take the parameters:

PesterObject (mandatory)
Name (optional, array of class and function names being tested)
AddSource (optional, only applicable when built module using ModuleBuilder)
Type (optional, either Missed, Executed or All - defaults to Missed only)

Should add a new property Type to the resulting objects with Missed or Executed

Returns the CommandsMissed

$config = New-PesterConfiguration
$config.Run.Path = @('<test paths>')
$config.CodeCoverage.Enabled = $true
$config.CodeCoverage.Path = @('./output/builtModule/<ModuleName>')
$config.CodeCoverage.CoveragePercentTarget = 0
$config.Output.Verbosity = 'None'
$config.Run.PassThru = $true
$result = Invoke-Pester -Configuration $config
# After running above, get all commands that was missed with a reference to the SourceLineNumber in SourceFile.
$result.CodeCoverage.CommandsMissed | Where-Object { $_.Function -eq '<FunctionName>' -or $_.Class -eq '<ClassName>' } | Convert-LineNumber -PassThru | Select-Object Class, Function, Command, SourceLineNumber, SourceFile

Steps to reproduce the problem

Expected behavior

Current behavior

Suggested solution to the issue

The operating system the target node is running

Version and build of PowerShell the target node is running

Version of the module that was used

[johlju]

This was incorporated into the command Invoke-PesterJob of the module Viscalyx.Common (which also runs tests in a job to handle class changes etc.):

Invoke-PesterJob -Path 'tests/Unit/Pri*' -EnableSourceLineMapping -FilterCodeCoverageResult '*wildcard-pattern'

[dan-hughes]

Would you like this ported into this module for use in DscCommunity modules?

[johlju]

Not sure, there is more to maintain here if we move that command here, and it might make users to think it is for DscResources only 🤔

I just missed an easy way to get code coverage both for me (and for AI agents)... I thought first to add the suggested command so created the issue, then I realized that my Invoke-PesterJob already had most in place so fixed it there. Not sure we need anything here.

But I'm not against porting it here.