Get-FunctionTestCoverage
SYNOPSIS
Gets test coverage information for the specified function.
SYNTAX
Get-FunctionTestCoverage [-FunctionDefinition] <FunctionDefinitionAst> [[-TestsPath] <String>]
[<CommonParameters>]
DESCRIPTION
Gets test coverage information for the specified function.
This includes 2 pieces of information :
- Code coverage percentage (lines of code that are exercized by unit tests)
- Missed Commands (lines of codes or commands not being exercized by unit tests)
It uses Pester with its CodeCoverage parameter.
EXAMPLES
EXAMPLE 1
Get-FunctionTestCoverage -FunctionDefinition $MyFunctionAst -TestsPath $MyModule.ModuleBase
Gets test coverage information for the function $MyFunctionAst given the tests found in the module's parent directory.
PARAMETERS
-FunctionDefinition
To specify the function definition to analyze.
Type: FunctionDefinitionAst
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TestsPath
To specify the file or directory where the Pester tests are located. If a directory is specified, the directory and all subdirectories will be searched recursively for tests. If not specified, the directory of the file containing the specified function, and all subdirectories will be searched for tests.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).