Should-BeSame

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Compares the expected value to actual value, to see if they are the same instance.

SYNTAX

Should-BeSame [[-Actual] <Object>] [-Expected] <Object> [-Because <String>] [<CommonParameters>]

DESCRIPTION

This assertion checks reference equality rather than value equality. Use it with reference types when you need to verify that both variables point to the same instance.

EXAMPLES

EXAMPLE 1

$a = New-Object Object
$a | Should-BeSame $a

This assertion will pass, because the actual value is the same instance as the expected value.

EXAMPLE 2

$a = New-Object Object
$b = New-Object Object
$a | Should-BeSame $b

This assertion will fail, because the actual value is not the same instance as the expected value.

PARAMETERS

-Actual

The actual value.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Expected

The expected value.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Because

The reason why the input should be the expected value.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
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.

INPUTS

OUTPUTS

NOTES

The Should-BeSame assertion is the opposite of the Should-NotBeSame assertion.

Use the -ErrorAction parameter to control soft-assertion behavior for this assertion. -ErrorAction Continue records the failure and lets the rest of the test run (a soft assertion), while -ErrorAction Stop fails the test immediately, for example to guard a precondition before continuing.

When -ErrorAction is not specified, the behavior comes from Should.ErrorAction in the configuration, which defaults to Stop. See https://pester.dev/docs/assertions/soft-assertions for more about soft assertions.

RELATED LINKS

https://pester.dev/docs/commands/Should-BeSame

https://pester.dev/docs/assertions

VERSION

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