Skip to main content
Version: v6

Add-ShouldOperator

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Register a Should Operator with Pester

SYNTAX​

Add-ShouldOperator [-Name] <string> [-Test] <scriptblock> [[-Alias] <string[]>]
 [[-InternalName] <string>] [-SupportsArrayInput]

DESCRIPTION​

This function allows you to create custom Should assertions.

EXAMPLES​

EXAMPLE 1​

function BeAwesome($ActualValue, [switch] $Negate) {
    [bool] $succeeded = $ActualValue -eq 'Awesome'
    if ($Negate) { $succeeded = -not $succeeded }

    if (-not $succeeded) {
        if ($Negate) {
            $failureMessage = "{$ActualValue} is Awesome"
        }
        else {
            $failureMessage = "{$ActualValue} is not Awesome"
        }
    }

    return [PSCustomObject]@{
        Succeeded      = $succeeded
        FailureMessage = $failureMessage
    }
}

Add-ShouldOperator -Name BeAwesome `
    -Test $function:BeAwesome `
    -Alias 'BA'

PS C:\> "bad" | Should -BeAwesome
{bad} is not Awesome

Example of how to create a simple custom assertion that checks if the input string is 'Awesome'

PARAMETERS​

-Alias​

A list of aliases for the Named Parameter.

Type: System.String[]
DefaultValue: '@()'
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InternalName​

If -Name is different from the actual function name, record the actual function name here. Used by Get-ShouldOperator to pull function help.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 3
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name​

The name of the assertion. This will become a Named Parameter of Should.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SupportsArrayInput​

Does the test function support the passing an array of values to test.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Test​

The test function. The function must return a PSObject with a [Bool]succeeded and a [string]failureMessage property.

Type: System.Management.Automation.ScriptBlock
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

VERSION​

This page was generated using comment-based help in Pester 6.0.0.