Skip to main content
Version: v6

Should-BeCollection

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS​

Compares collections for equality, by comparing their sizes and each item in them. It does not compare the types of the input collections.

SYNTAX​

Expected​

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

Count​

Should-BeCollection [[-Actual] <Object>] [-Because <String>] [-Count <Int32>] [<CommonParameters>]

DESCRIPTION​

This assertion verifies that both values are collections and compares their contents rather than their collection types. When you use -Count, it only checks the number of items.

EXAMPLES​

EXAMPLE 1​

1, 2, 3 | Should-BeCollection @(1, 2, 3)
@(1) | Should-BeCollection @(1)
1 | Should-BeCollection 1

This assertion will pass, because the collections have the same size and the items are equal.

EXAMPLE 2​

1, 2, 3, 4 | Should-BeCollection @(1, 2, 3)
1, 2, 3, 4 | Should-BeCollection @(5, 6, 7, 8)
@(1) | Should-BeCollection @(2)
1 | Should-BeCollection @(2)

The assertions will fail because the collections are not equal.

PARAMETERS​

-Actual​

A collection of items.

Type: Object
Parameter Sets: (All)
Aliases:

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

-Expected​

A collection of items.

Type: Object
Parameter Sets: Expected
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

-Count​

Checks if the collection has the expected number of items.

Type: Int32
Parameter Sets: Count
Aliases:

Required: False
Position: Named
Default value: 0
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​

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.

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

https://pester.dev/docs/assertions

VERSION​

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