Assert-Equal

Asserts that two objects are equal.

Syntax

Assert-Equal [[-Expected] <Object>] [[-Actual] <Object>] [[-Message] <String>] [-CaseSensitive] [<CommonParameters>]

Description

Uses PowerShell's -eq operator to test if two objects are equal. To perform a case-sensitive comparison with the -ceq operator, use the -CaseSensitive switch.

Parameters

Name Type Description Required? Pipeline Input Default Value
Expected Object

The expected value.

false false
Actual Object

The actual value.

false false
Message String

A message to show when the assertion fails.

false false
CaseSensitive SwitchParameter

Performs a case-sensitive equality comparison.

false false False

EXAMPLE 1

Assert-Equal 'foo' 'FOO'

Demonstrates that the equality is case-insensitive.

EXAMPLE 2

Assert-Equal 'foo' 'FOO' -CaseSensitive

Demonstrates that the equality is case-insensitive.

EXAMPLE 3

Assert-Equal 'foo' 'bar' 'The bar didn''t foo!'

Demonstrates how to include your own message when the assertion fails.