Skipping Individual Framework Tests#

The PSModule framework tests run automatically as part of the Test-Module and Test-SourceCode jobs. While you can skip entire test categories using the configuration settings (e.g., Test.PSModule.Skip), you can also skip individual framework tests on a per-file basis when needed.

How to Skip Tests#

To skip an individual framework test for a specific file, add a special comment at the top of that file:

#SkipTest:<TestID>:<Reason>

<TestID>: The unique identifier of the test to skip (see list below)
<Reason>: A brief explanation of why the test is being skipped

The skip comment will cause the framework to skip that specific test for that file only, and will log a warning in the build output with the reason provided.

Available Framework Tests#

SourceCode Tests#

These tests run against your source code files in the src directory:

Test ID	Description	Example Skip Comment
`NumberOfProcessors`	Enforces use of `[System.Environment]::ProcessorCount` instead of `$env:NUMBER_OF_PROCESSORS`	`#SkipTest:NumberOfProcessors:Legacy code compatibility required`
`Verbose`	Ensures code does not pass `-Verbose` to other commands (which would override user preference), unless explicitly disabled with `-Verbose:$false`	`#SkipTest:Verbose:Required for debugging output`
`OutNull`	Enforces use of `$null = ...` instead of `... \\| Out-Null` for better performance	`#SkipTest:OutNull:Pipeline processing required`
`NoTernary`	Prohibits ternary operators for PowerShell 5.1 compatibility (this test is skipped by default in the framework)	`#SkipTest:NoTernary:PowerShell 7+ only module`
`LowercaseKeywords`	Ensures all PowerShell keywords are lowercase	`#SkipTest:LowercaseKeywords:Generated code`
`FunctionCount`	Ensures each file contains exactly one function	`#SkipTest:FunctionCount:Helper functions included`
`FunctionName`	Ensures the filename matches the function name	`#SkipTest:FunctionName:Legacy naming convention`
`CmdletBinding`	Requires all functions to have `[CmdletBinding()]` attribute	`#SkipTest:CmdletBinding:Simple helper function`
`ParamBlock`	Requires all functions to have a `param()` block	`#SkipTest:ParamBlock:No parameters needed`
`FunctionTest`	Ensures all public functions have corresponding tests	`#SkipTest:FunctionTest:Test in development`

Module Tests#

These tests run against the compiled module in the outputs/module directory:

Module import validation
Module manifest validation

Module tests typically don't need to be skipped as they validate the final built module.

Example Usage#

Here's an example of a function file that skips the FunctionCount test because it includes helper functions:

#SkipTest:FunctionCount:This file contains helper functions for the main function

function Get-ComplexData {
    <#
        .SYNOPSIS
        Retrieves complex data using helper functions.
    #>
    [CmdletBinding()]
    param(
        [Parameter(Mandatory)]
        [string] $Path
    )

    $data = Get-RawData -Path $Path
    $processed = Format-ComplexData -Data $data
    return $processed
}

function Get-RawData {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory)]
        [string] $Path
    )
    # Helper function implementation
}

function Format-ComplexData {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory)]
        $Data
    )
    # Helper function implementation
}

Best Practices#

Use skip comments sparingly: Framework tests exist to maintain code quality and consistency. Only skip tests when absolutely necessary.
Provide clear reasons: Always include a meaningful explanation in the skip comment to help reviewers understand why the test is being skipped.
Consider alternatives: Before skipping a test, consider whether refactoring the code to comply with the test would be better for long-term maintainability.
Document exceptions: If you skip a test, document the reason in your PR description or code comments.

For broader test control, use the configuration file settings:

Skip all framework tests: Test.PSModule.Skip: true
Skip only source code tests: Test.SourceCode.Skip: true
Skip framework tests on specific OS: Test.PSModule.Windows.Skip: true

See the Configuration section for more details.