Asserts that two objects are equal.
Assert-Equal [[-Expected] <Object>] [[-Actual] <Object>] [[-Message] <String>] [-CaseSensitive] [<CommonParameters>]
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.
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 |
Assert-Equal 'foo' 'FOO'
Demonstrates that the equality is case-insensitive.
Assert-Equal 'foo' 'FOO' -CaseSensitive
Demonstrates that the equality is case-insensitive.
Assert-Equal 'foo' 'bar' 'The bar didn''t foo!'
Demonstrates how to include your own message when the assertion fails.