1"use strict";(self.webpackChunkpester_docs=self.webpackChunkpester_docs||[]).push([["266"],{6164(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"v6","banner":null,"badge":true,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"category","label":"Documentation","collapsible":false,"items":[{"type":"category","label":"Introduction","items":[{"type":"link","href":"/docs/quick-start","label":"Quick Start","docId":"quick-start","unlisted":false},{"type":"link","href":"/docs/introduction/installation","label":"Installation","docId":"introduction/installation","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Usage","items":[{"type":"link","href":"/docs/usage/file-placement-and-naming","label":"File placement and naming","docId":"usage/file-placement-and-naming","unlisted":false},{"type":"link","href":"/docs/usage/importing-tested-functions","label":"Importing tested functions","docId":"usage/importing-tested-functions","unlisted":false},{"type":"link","href":"/docs/usage/test-file-structure","label":"Test file structure","docId":"usage/test-file-structure","unlisted":false},{"type":"link","href":"/docs/usage/discovery-and-run","label":"Discovery and Run","docId":"usage/discovery-and-run","unlisted":false},{"type":"link","href":"/docs/usage/parallel","label":"Parallel execution","docId":"usage/parallel","unlisted":false},{"type":"link","href":"/docs/usage/shuffle","label":"Shuffled test order","docId":"usage/shuffle","unlisted":false},{"type":"link","href":"/docs/usage/data-driven-tests","label":"Data driven tests","docId":"usage/data-driven-tests","unlisted":false},{"type":"link","href":"/docs/usage/setup-and-teardown","label":"Setup and teardown","docId":"usage/setup-and-teardown","unlisted":false},{"type":"link","href":"/docs/usage/tags","label":"Tags","docId":"usage/tags","unlisted":false},{"type":"link","href":"/docs/usage/skip","label":"Skip","docId":"usage/skip","unlisted":false},{"type":"link","href":"/docs/usage/mocking","label":"Mocking","docId":"usage/mocking","unlisted":false},{"type":"link","href":"/docs/usage/modules","label":"Modules","docId":"usage/modules","unlisted":false},{"type":"link","href":"/docs/usage/testdrive","label":"TestDrive","docId":"usage/testdrive","unlisted":false},{"type":"link","href":"/docs/usage/testregistry","label":"TestRegistry","docId":"usage/testregistry","unlisted":false},{"type":"link","href":"/docs/usage/test-results","label":"Test Results","docId":"usage/test-results","unlisted":false},{"type":"link","href":"/docs/usage/code-coverage","label":"Code Coverage","docId":"usage/code-coverage","unlisted":false},{"type":"link","href":"/docs/usage/configuration","label":"Configuration","docId":"usage/configuration","unlisted":false},{"type":"link","href":"/docs/usage/output","label":"Output","docId":"usage/output","unlisted":false},{"type":"link","href":"/docs/usage/result-object","label":"Result Object","docId":"usage/result-object","unlisted":false},{"type":"link","href":"/docs/usage/vscode","label":"Visual Studio Code","docId":"usage/vscode","unlisted":false},{"type":"link","href":"/docs/usage/troubleshooting","label":"Troubleshooting","docId":"usage/troubleshooting","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Assertions","items":[{"type":"link","href":"/docs/assertions/should-command","label":"Should-* assertions (v6)","docId":"assertions/should-command","unlisted":false},{"type":"link","href":"/docs/assertions/should-beequivalent","label":"Should-BeEquivalent","docId":"assertions/should-beequivalent","unlisted":false},{"type":"link","href":"/docs/assertions/soft-assertions","label":"Soft assertions","docId":"assertions/soft-assertions","unlisted":false},{"type":"link","href":"/docs/assertions/writing-assertions","label":"Writing your own assertions (v6)","docId":"assertions/writing-assertions","unlisted":false},{"type":"link","href":"/docs/assertions/","label":"Classic assertions (v5)","docId":"assertions/assertions","unlisted":false},{"type":"link","href":"/docs/assertions/custom-assertions","label":"Custom assertions (v5)","docId":"assertions/custom-assertions","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Migration Guides","items":[{"type":"link","href":"/docs/migrations/v5-to-v6","label":"Pester v5 to v6","docId":"migrations/v5-to-v6","unlisted":false},{"type":"link","href":"/docs/migrations/v4-to-v5","label":"Pester v4 to v5","docId":"migrations/v4-to-v5","unlisted":false},{"type":"link","href":"/docs/migrations/breaking-changes-in-v5","label":"Breaking changes in v5","docId":"migrations/breaking-changes-in-v5","unlisted":false},{"type":"link","href":"/docs/migrations/v3-to-v4","label":"Pester v3 to v4","docId":"migrations/v3-to-v4","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Additional Resources","items":[{"type":"link","href":"/docs/additional-resources/articles","label":"Articles","docId":"additional-resources/articles","unlisted":false},{"type":"link","href":"/docs/additional-resources/courses","label":"Courses","docId":"additional-resources/courses","unlisted":false},{"type":"link","href":"/docs/additional-resources/misc","label":"Misc","docId":"additional-resources/misc","unlisted":false},{"type":"link","href":"/docs/additional-resources/projects","label":"Projects","docId":"additional-resources/projects","unlisted":false},{"type":"link","href":"/docs/additional-resources/videos","label":"Videos","docId":"additional-resources/videos","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contributing","items":[{"type":"link","href":"/docs/contributing/introduction","label":"Introduction","docId":"contributing/introduction","unlisted":false},{"type":"link","href":"/docs/contributing/reporting-issues","label":"Reporting Issues","docId":"contributing/reporting-issues","unlisted":false},{"type":"link","href":"/docs/contributing/feature-requests","label":"Feature Requests","docId":"contributing/feature-requests","unlisted":false},{"type":"link","href":"/docs/contributing/pull-requests","label":"Pull Requests","docId":"contributing/pull-requests","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsed":false}],"commands":[{"type":"category","label":"Command Reference","items":[{"type":"link","href":"/docs/commands/Add-ShouldOperator","label":"Add-ShouldOperator","docId":"commands/Add-ShouldOperator","unlisted":false},{"type":"link","href":"/docs/commands/AfterAll","label":"AfterAll","docId":"commands/AfterAll","unlisted":false},{"type":"link","href":"/docs/commands/AfterEach","label":"AfterEach","docId":"commands/AfterEach","unlisted":false},{"type":"link","href":"/docs/commands/BeforeAll","label":"BeforeAll","docId":"commands/BeforeAll","unlisted":false},{"type":"link","href":"/docs/commands/BeforeDiscovery","label":"BeforeDiscovery","docId":"commands/BeforeDiscovery","unlisted":false},{"type":"link","href":"/docs/commands/BeforeEach","label":"BeforeEach","docId":"commands/BeforeEach","unlisted":false},{"type":"link","href":"/docs/commands/Context","label":"Context","docId":"commands/Context","unlisted":false},{"type":"link","href":"/docs/commands/ConvertTo-JUnitReport","label":"ConvertTo-JUnitReport","docId":"commands/ConvertTo-JUnitReport","unlisted":false},{"type":"link","href":"/docs/commands/ConvertTo-NUnitReport","label":"ConvertTo-NUnitReport","docId":"commands/ConvertTo-NUnitReport","unlisted":false},{"type":"link","href":"/docs/commands/ConvertTo-Pester4Result","label":"ConvertTo-Pester4Result","docId":"commands/ConvertTo-Pester4Result","unlisted":false},{"type":"link","href":"/docs/commands/Describe","label":"Describe","docId":"commands/Describe","unlisted":false},{"type":"link","href":"/docs/commands/Export-JUnitReport","label":"Export-JUnitReport","docId":"commands/Export-JUnitReport","unlisted":false},{"type":"link","href":"/docs/commands/Export-NUnitReport","label":"Export-NUnitReport","docId":"commands/Export-NUnitReport","unlisted":false},{"type":"link","href":"/docs/commands/Get-ShouldOperator","label":"Get-ShouldOperator","docId":"commands/Get-ShouldOperator","unlisted":false},{"type":"link","href":"/docs/commands/InModuleScope","label":"InModuleScope","docId":"commands/InModuleScope","unlisted":false},{"type":"link","href":"/docs/commands/Invoke-Pester","label":"Invoke-Pester","docId":"commands/Invoke-Pester","unlisted":false},{"type":"link","href":"/docs/commands/It","label":"It","docId":"commands/It","unlisted":false},{"type":"link","href":"/docs/commands/Mock","label":"Mock","docId":"commands/Mock","unlisted":false},{"type":"link","href":"/docs/commands/New-Fixture","label":"New-Fixture","docId":"commands/New-Fixture","unlisted":false},{"type":"link","href":"/docs/commands/New-MockObject","label":"New-MockObject","docId":"commands/New-MockObject","unlisted":false},{"type":"link","href":"/docs/commands/New-PesterConfiguration","label":"New-PesterConfiguration","docId":"commands/New-PesterConfiguration","unlisted":false},{"type":"link","href":"/docs/commands/New-PesterContainer","label":"New-PesterContainer","docId":"commands/New-PesterContainer","unlisted":false},{"type":"link","href":"/docs/commands/New-ShouldAssertion","label":"New-ShouldAssertion","docId":"commands/New-ShouldAssertion","unlisted":false},{"type":"link","href":"/docs/commands/Set-ItResult","label":"Set-ItResult","docId":"commands/Set-ItResult","unlisted":false},{"type":"link","href":"/docs/commands/Should","label":"Should","docId":"commands/Should","unlisted":false},{"type":"link","href":"/docs/commands/Should-All","label":"Should-All","docId":"commands/Should-All","unlisted":false},{"type":"link","href":"/docs/commands/Should-Any","label":"Should-Any","docId":"commands/Should-Any","unlisted":false},{"type":"link","href":"/docs/commands/Should-Be","label":"Should-Be","docId":"commands/Should-Be","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeAfter","label":"Should-BeAfter","docId":"commands/Should-BeAfter","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeBefore","label":"Should-BeBefore","docId":"commands/Should-BeBefore","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeCollection","label":"Should-BeCollection","docId":"commands/Should-BeCollection","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeEmptyString","label":"Should-BeEmptyString","docId":"commands/Should-BeEmptyString","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeEquivalent","label":"Should-BeEquivalent","docId":"commands/Should-BeEquivalent","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeFalse","label":"Should-BeFalse","docId":"commands/Should-BeFalse","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeFalsy","label":"Should-BeFalsy","docId":"commands/Should-BeFalsy","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeFasterThan","label":"Should-BeFasterThan","docId":"commands/Should-BeFasterThan","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeGreaterThan","label":"Should-BeGreaterThan","docId":"commands/Should-BeGreaterThan","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeGreaterThanOrEqual","label":"Should-BeGreaterThanOrEqual","docId":"commands/Should-BeGreaterThanOrEqual","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeHashtable","label":"Should-BeHashtable","docId":"commands/Should-BeHashtable","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeLessThan","label":"Should-BeLessThan","docId":"commands/Should-BeLessThan","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeLessThanOrEqual","label":"Should-BeLessThanOrEqual","docId":"commands/Should-BeLessThanOrEqual","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeLikeString","label":"Should-BeLikeString","docId":"commands/Should-BeLikeString","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeNull","label":"Should-BeNull","docId":"commands/Should-BeNull","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeSame","label":"Should-BeSame","docId":"commands/Should-BeSame","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeSlowerThan","label":"Should-BeSlowerThan","docId":"commands/Should-BeSlowerThan","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeString","label":"Should-BeString","docId":"commands/Should-BeString","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeTrue","label":"Should-BeTrue","docId":"commands/Should-BeTrue","unlisted":false},{"type":"link","href":"/docs/commands/Should-BeTruthy","label":"Should-BeTruthy","docId":"commands/Should-BeTruthy","unlisted":false},{"type":"link","href":"/docs/commands/Should-ContainCollection","label":"Should-ContainCollection","docId":"commands/Should-ContainCollection","unlisted":false},{"type":"link","href":"/docs/commands/Should-HaveParameter","label":"Should-HaveParameter","docId":"commands/Should-HaveParameter","unlisted":false},{"type":"link","href":"/docs/commands/Should-HaveType","label":"Should-HaveType","docId":"commands/Should-HaveType","unlisted":false},{"type":"link","href":"/docs/commands/Should-Invoke","label":"Should-Invoke","docId":"commands/Should-Invoke","unlisted":false},{"type":"link","href":"/docs/commands/Should-MatchString","label":"Should-MatchString","docId":"commands/Should-MatchString","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBe","label":"Should-NotBe","docId":"commands/Should-NotBe","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBeEmptyString","label":"Should-NotBeEmptyString","docId":"commands/Should-NotBeEmptyString","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBeLikeString","label":"Should-NotBeLikeString","docId":"commands/Should-NotBeLikeString","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBeNull","label":"Should-NotBeNull","docId":"commands/Should-NotBeNull","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBeSame","label":"Should-NotBeSame","docId":"commands/Should-NotBeSame","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBeString","label":"Should-NotBeString","docId":"commands/Should-NotBeString","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotBeWhiteSpaceString","label":"Should-NotBeWhiteSpaceString","docId":"commands/Should-NotBeWhiteSpaceString","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotContainCollection","label":"Should-NotContainCollection","docId":"commands/Should-NotContainCollection","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotHaveParameter","label":"Should-NotHaveParameter","docId":"commands/Should-NotHaveParameter","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotHaveType","label":"Should-NotHaveType","docId":"commands/Should-NotHaveType","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotInvoke","label":"Should-NotInvoke","docId":"commands/Should-NotInvoke","unlisted":false},{"type":"link","href":"/docs/commands/Should-NotMatchString","label":"Should-NotMatchString","docId":"commands/Should-NotMatchString","unlisted":false},{"type":"link","href":"/docs/commands/Should-Throw","label":"Should-Throw","docId":"commands/Should-Throw","unlisted":false}],"collapsible":false,"collapsed":false}]},"docs":{"additional-resources/articles":{"id":"additional-resources/articles","title":"Articles","description":"Published articles about using Pester for testing PowerShell code, infrastru
1cture and more","sidebar":"docs"},"additional-resources/courses":{"id":"additional-resources/courses","title":"Courses","description":"List of known courses about learning and using Pester for testing PowerShell","sidebar":"docs"},"additional-resources/misc":{"id":"additional-resources/misc","title":"Miscellaneous","description":"Integrations, books and other resources about using Pester","sidebar":"docs"},"additional-resources/projects":{"id":"additional-resources/projects","title":"Projects","description":"List of third-party modules and projects that extend or compliment Pester","sidebar":"docs"},"additional-resources/videos":{"id":"additional-resources/videos","title":"Videos","description":"List of videos about using Pester and PowerShell testing provided by the community","sidebar":"docs"},"assertions/assertions":{"id":"assertions/assertions","title":"Classic assertions (v5)","description":"Introduction to the built-in assertion operators in Pester to get you started with the most common scenarios","sidebar":"docs"},"assertions/custom-assertions":{"id":"assertions/custom-assertions","title":"Custom assertions (v5)","description":"A guide for creating your own custom operators for more advanced or user-specific assertion needs","sidebar":"docs"},"assertions/should-beequivalent":{"id":"assertions/should-beequivalent","title":"Should-BeEquivalent","description":"Recursively compare objects, hashtables, PSCustomObjects, nested structures, and collections by value with Should-BeEquivalent, including -ExcludePath, -ExcludePathsNotOnExpected and -Comparator.","sidebar":"docs"},"assertions/should-command":{"id":"assertions/should-command","title":"Should-* assertions (v6)","description":"The Should-* assertions introduced in Pester v6, how they render output, the input-shape hints, and the classic Should -Be syntax.","sidebar":"docs"},"assertions/soft-assertions":{"id":"assertions/soft-assertions","title":"Soft assertions","description":"Soft assertions let Pester collect every assertion failure in a test instead of stopping at the first one. Enable them globally with Should.ErrorAction = \'Continue\'.","sidebar":"docs"},"assertions/writing-assertions":{"id":"assertions/writing-assertions","title":"Writing your own assertions (v6)","description":"How to write your own Should-* assertion in Pester v6 using New-ShouldAssertion, so it collects pipeline input, formats values and fails exactly like a built-in assertion.","sidebar":"docs"},"commands/Add-ShouldOperator":{"id":"commands/Add-ShouldOperator","title":"Add-ShouldOperator","description":"Help for Pester command \'Add-ShouldOperator\'. Register a Should Operator with Pester","sidebar":"commands"},"commands/AfterAll":{"id":"commands/AfterAll","title":"AfterAll","description":"Help for Pester command \'AfterAll\'. Defines a series of steps to perform at the end of the current container, Context or Describe block.","sidebar":"commands"},"commands/AfterEach":{"id":"commands/AfterEach","title":"AfterEach","description":"Help for Pester command \'AfterEach\'. Defines a series of steps to perform at the end of every It block within the current Context or Describe block.","sidebar":"commands"},"commands/BeforeAll":{"id":"commands/BeforeAll","title":"BeforeAll","description":"Help for Pester command \'BeforeAll\'. Defines a series of steps to perform at the beginning of the current container, Context or Describe block.","sidebar":"commands"},"commands/BeforeDiscovery":{"id":"commands/BeforeDiscovery","title":"BeforeDiscovery","description":"Help for Pester command \'BeforeDiscovery\'. Runs setup code that is used during Discovery phase.","sidebar":"commands"},"commands/BeforeEach":{"id":"commands/BeforeEach","title":"BeforeEach","description":"Help for Pester command \'BeforeEach\'. Defines a series of steps to perform at the beginning of every It block within the current Context or Describe block.","sidebar":"commands"},"commands/Context":{"id":"commands/Context","title":"Context","description":"Help for Pester command \'Context\'. Provides logical grouping of It blocks within a single Describe block.","sidebar":"commands"},"commands/ConvertTo-JUnitReport":{"id":"commands/ConvertTo-JUnitReport","title":"ConvertTo-JUnitReport","description":"Help for Pester command \'ConvertTo-JUnitReport\'. Converts a Pester result-object to an JUnit-compatible XML report","sidebar":"commands"},"commands/ConvertTo-NUnitReport":{"id":"commands/ConvertTo-NUnitReport","title":"ConvertTo-NUnitReport","description":"Help for Pester command \'ConvertTo-NUnitReport\'. Converts a Pester result-object to an NUnit 2.5 or 3-compatible XML-report","sidebar":"commands"},"commands/ConvertTo-Pester4Result":{"id":"commands/ConvertTo-Pester4Result","title":"ConvertTo-Pester4Result","description":"Help for Pester command \'ConvertTo-Pester4Result\'. Converts a Pester 5 result-object to an Pester 4-compatible object","sidebar":"commands"}
1,"commands/Describe":{"id":"commands/Describe","title":"Describe","description":"Help for Pester command \'Describe\'. Creates a logical group of tests.","sidebar":"commands"},"commands/Export-JUnitReport":{"id":"commands/Export-JUnitReport","title":"Export-JUnitReport","description":"Help for Pester command \'Export-JUnitReport\'. Exports a Pester result-object to an JUnit-compatible XML-report","sidebar":"commands"},"commands/Export-NUnitReport":{"id":"commands/Export-NUnitReport","title":"Export-NUnitReport","description":"Help for Pester command \'Export-NUnitReport\'. Exports a Pester result-object to an NUnit-compatible XML-report","sidebar":"commands"},"commands/Get-ShouldOperator":{"id":"commands/Get-ShouldOperator","title":"Get-ShouldOperator","description":"Help for Pester command \'Get-ShouldOperator\'. Display the assertion operators available for use with Should.","sidebar":"commands"},"commands/InModuleScope":{"id":"commands/InModuleScope","title":"InModuleScope","description":"Help for Pester command \'InModuleScope\'. Allows you to execute parts of a test script within the scope of a PowerShell script or manifest module.","sidebar":"commands"},"commands/Invoke-Pester":{"id":"commands/Invoke-Pester","title":"Invoke-Pester","description":"Help for Pester command \'Invoke-Pester\'. Runs Pester tests","sidebar":"commands"},"commands/It":{"id":"commands/It","title":"It","description":"Help for Pester command \'It\'. Validates the results of a test inside of a Describe block.","sidebar":"commands"},"commands/Mock":{"id":"commands/Mock","title":"Mock","description":"Help for Pester command \'Mock\'. Mocks the behavior of an existing command with an alternate implementation.","sidebar":"commands"},"commands/New-Fixture":{"id":"commands/New-Fixture","title":"New-Fixture","description":"Help for Pester command \'New-Fixture\'. This function generates two scripts, one that defines a function and another one that contains its tests.","sidebar":"commands"},"commands/New-MockObject":{"id":"commands/New-MockObject","title":"New-MockObject","description":"Help for Pester command \'New-MockObject\'. This function instantiates a .NET object from a type.","sidebar":"commands"},"commands/New-PesterConfiguration":{"id":"commands/New-PesterConfiguration","title":"New-PesterConfiguration","description":"Help for Pester command \'New-PesterConfiguration\'. Creates a new PesterConfiguration object for advanced configuration of Invoke-Pester.","sidebar":"commands"},"commands/New-PesterContainer":{"id":"commands/New-PesterContainer","title":"New-PesterContainer","description":"Help for Pester command \'New-PesterContainer\'. Generates ContainerInfo-objects used as for Invoke-Pester -Container","sidebar":"commands"},"commands/New-ShouldAssertion":{"id":"commands/New-ShouldAssertion","title":"New-ShouldAssertion","description":"Help for Pester command \'New-ShouldAssertion\'. Creates the assertion helper object used to author custom `Should-*` assertions.","sidebar":"commands"},"commands/Set-ItResult":{"id":"commands/Set-ItResult","title":"Set-ItResult","description":"Help for Pester command \'Set-ItResult\'. Set-ItResult is used inside the It block to explicitly set the test result","sidebar":"commands"},"commands/Should":{"id":"commands/Should","title":"Should","description":"Help for Pester command \'Should\'. Should is a keyword that is used to define an assertion inside an It block.","sidebar":"commands"},"commands/Should-All":{"id":"commands/Should-All","title":"Should-All","description":"Help for Pester command \'Should-All\'. Compares all items in a collection to a filter script. If the filter returns true, or does not throw for all the items in the collection, the assertion passes.","sidebar":"commands"},"commands/Should-Any":{"id":"commands/Should-Any","title":"Should-Any","description":"Help for Pester command \'Should-Any\'. Compares all items in a collection to a filter script. If the filter returns true, or does not throw for any of the items in the collection, the assertion passes.","sidebar":"commands"},"commands/Should-Be":{"id":"commands/Should-Be","title":"Should-Be","description":"Help for Pester command \'Should-Be\'. Compares the expected value to actual value, to see if they are equal.","sidebar":"commands"},"commands/Should-BeAfter":{"id":"commands/Should-BeAfter","title":"Should-BeAfter","description":"Help for Pester command \'Should-BeAfter\'. Asserts that the provided [datetime] is after the expected [datetime].","sidebar":"commands"}
1,"commands/Should-BeBefore":{"id":"commands/Should-BeBefore","title":"Should-BeBefore","description":"Help for Pester command \'Should-BeBefore\'. Asserts that the provided [datetime] is before the expected [datetime].","sidebar":"commands"},"commands/Should-BeCollection":{"id":"commands/Should-BeCollection","title":"Should-BeCollection","description":"Help for Pester command \'Should-BeCollection\'. Compares collections for equality, by comparing their sizes and each item in them. It does not compare the types of the input collections.","sidebar":"commands"},"commands/Should-BeEmptyString":{"id":"commands/Should-BeEmptyString","title":"Should-BeEmptyString","description":"Help for Pester command \'Should-BeEmptyString\'. Ensures that input is an empty string.","sidebar":"commands"},"commands/Should-BeEquivalent":{"id":"commands/Should-BeEquivalent","title":"Should-BeEquivalent","description":"Help for Pester command \'Should-BeEquivalent\'. Compares two objects for equivalency, by recursively comparing their properties for equivalency.","sidebar":"commands"},"commands/Should-BeFalse":{"id":"commands/Should-BeFalse","title":"Should-BeFalse","description":"Help for Pester command \'Should-BeFalse\'. Compares the actual value to a boolean $false. It does not convert input values to boolean, and will fail for any value that is not $false.","sidebar":"commands"},"commands/Should-BeFalsy":{"id":"commands/Should-BeFalsy","title":"Should-BeFalsy","description":"Help for Pester command \'Should-BeFalsy\'. Compares the actual value to a boolean $false or a falsy value: 0, \\"\\", $null or @(). It converts the input value to a boolean.","sidebar":"commands"},"commands/Should-BeFasterThan":{"id":"commands/Should-BeFasterThan","title":"Should-BeFasterThan","description":"Help for Pester command \'Should-BeFasterThan\'. Asserts that the provided [timespan] or [scriptblock] is faster than the expected [timespan].","sidebar":"commands"},"commands/Should-BeGreaterThan":{"id":"commands/Should-BeGreaterThan","title":"Should-BeGreaterThan","description":"Help for Pester command \'Should-BeGreaterThan\'. Compares the expected value to actual value, to see if the actual value is greater than the expected value.","sidebar":"commands"},"commands/Should-BeGreaterThanOrEqual":{"id":"commands/Should-BeGreaterThanOrEqual","title":"Should-BeGreaterThanOrEqual","description":"Help for Pester command \'Should-BeGreaterThanOrEqual\'. Compares the expected value to actual value, to see if the actual value is greater than or equal to the expected value.","sidebar":"commands"},"commands/Should-BeHashtable":{"id":"commands/Should-BeHashtable","title":"Should-BeHashtable","description":"Help for Pester command \'Should-BeHashtable\'. Asserts that the input is a hashtable or dictionary, and optionally checks the number of entries, whether it is ordered, and that it contains specific keys.","sidebar":"commands"},"commands/Should-BeLessThan":{"id":"commands/Should-BeLessThan","title":"Should-BeLessThan","description":"Help for Pester command \'Should-BeLessThan\'. Compares the expected value to actual value, to see if the actual value is less than the expected value.","sidebar":"commands"},"commands/Should-BeLessThanOrEqual":{"id":"commands/Should-BeLessThanOrEqual","title":"Should-BeLessThanOrEqual","description":"Help for Pester command \'Should-BeLessThanOrEqual\'. Compares the expected value to actual value, to see if the actual value is less than or equal to the expected value.","sidebar":"commands"},"commands/Should-BeLikeString":{"id":"commands/Should-BeLikeString","title":"Should-BeLikeString","description":"Help for Pester command \'Should-BeLikeString\'. Asserts that the actual value is like the expected value.","sidebar":"commands"},"commands/Should-BeNull":{"id":"commands/Should-BeNull","title":"Should-BeNull","description":"Help for Pester command \'Should-BeNull\'. Asserts that the input is `$null`.","sidebar":"commands"},"commands/Should-BeSame":{"id":"commands/Should-BeSame","title":"Should-BeSame","description":"Help for Pester command \'Should-BeSame\'. Compares the expected value to actual value, to see if they are the same instance.","sidebar":"commands"},"commands/Should-BeSlowerThan":{"id":"commands/Should-BeSlowerThan","title":"Should-BeSlowerThan","description":"Help for Pester command \'Should-BeSlowerThan\'. Asserts that the provided [timespan] is slower than the expected [timespan].","sidebar":"commands"}
1,"commands/Should-BeString":{"id":"commands/Should-BeString","title":"Should-BeString","description":"Help for Pester command \'Should-BeString\'. Asserts that the actual value is equal to the expected value.","sidebar":"commands"},"commands/Should-BeTrue":{"id":"commands/Should-BeTrue","title":"Should-BeTrue","description":"Help for Pester command \'Should-BeTrue\'. Compares the actual value to a boolean $true. It does not convert input values to boolean, and will fail for any value is not $true.","sidebar":"commands"},"commands/Should-BeTruthy":{"id":"commands/Should-BeTruthy","title":"Should-BeTruthy","description":"Help for Pester command \'Should-BeTruthy\'. Compares the actual value to a boolean $true. It converts input values to boolean, and will fail for any value is not $true, or truthy.","sidebar":"commands"},"commands/Should-ContainCollection":{"id":"commands/Should-ContainCollection","title":"Should-ContainCollection","description":"Help for Pester command \'Should-ContainCollection\'. Checks that the expected collection is present in the actual collection as an ordered subsequence. It does not compare the types of the input collections.","sidebar":"commands"},"commands/Should-HaveParameter":{"id":"commands/Should-HaveParameter","title":"Should-HaveParameter","description":"Help for Pester command \'Should-HaveParameter\'. Asserts that a command has the expected parameter.","sidebar":"commands"},"commands/Should-HaveType":{"id":"commands/Should-HaveType","title":"Should-HaveType","description":"Help for Pester command \'Should-HaveType\'. Asserts that the input is of the expected type.","sidebar":"commands"},"commands/Should-Invoke":{"id":"commands/Should-Invoke","title":"Should-Invoke","description":"Help for Pester command \'Should-Invoke\'. Checks if a Mocked command has been called a certain number of times and throws an exception if it has not.","sidebar":"commands"},"commands/Should-MatchString":{"id":"commands/Should-MatchString","title":"Should-MatchString","description":"Help for Pester command \'Should-MatchString\'. Tests whether a string matches a regular expression pattern.","sidebar":"commands"},"commands/Should-NotBe":{"id":"commands/Should-NotBe","title":"Should-NotBe","description":"Help for Pester command \'Should-NotBe\'. Compares the expected value to actual value, to see if they are not equal.","sidebar":"commands"},"commands/Should-NotBeEmptyString":{"id":"commands/Should-NotBeEmptyString","title":"Should-NotBeEmptyString","description":"Help for Pester command \'Should-NotBeEmptyString\'. Ensures that the input is a string, and that the input is not $null or empty string.","sidebar":"commands"},"commands/Should-NotBeLikeString":{"id":"commands/Should-NotBeLikeString","title":"Should-NotBeLikeString","description":"Help for Pester command \'Should-NotBeLikeString\'. Asserts that the actual value is not like the expected value.","sidebar":"commands"},"commands/Should-NotBeNull":{"id":"commands/Should-NotBeNull","title":"Should-NotBeNull","description":"Help for Pester command \'Should-NotBeNull\'. Asserts that the input is not `$null`.","sidebar":"commands"},"commands/Should-NotBeSame":{"id":"commands/Should-NotBeSame","title":"Should-NotBeSame","description":"Help for Pester command \'Should-NotBeSame\'. Compares the expected value to actual value, to see if the actual value is not the same instance as the expected value.","sidebar":"commands"},"commands/Should-NotBeString":{"id":"commands/Should-NotBeString","title":"Should-NotBeString","description":"Help for Pester command \'Should-NotBeString\'. Asserts that the actual value is not equal to the expected value.","sidebar":"commands"},"commands/Should-NotBeWhiteSpaceString":{"id":"commands/Should-NotBeWhiteSpaceString","title":"Should-NotBeWhiteSpaceString","description":"Help for Pester command \'Should-NotBeWhiteSpaceString\'. Ensures that the input is a string, and that the input is not $null, empty, or whitespace only string.","sidebar":"commands"},"commands/Should-NotContainCollection":{"id":"commands/Should-NotContainCollection","title":"Should-NotContainCollection","description":"Help for Pester command \'Should-NotContainCollection\'. Checks that the expected collection is not present in the actual collection as an ordered subsequence. It does not compare the types of the input collections.","sidebar":"commands"},"commands/Should-NotHaveParameter":{"id":"commands/Should-NotHaveParameter","title":"Should-NotHaveParameter","description":"Help for Pester command \'Should-NotHaveParameter\'. Asserts that a command has does not have the parameter.","sidebar":"commands"},"commands/Should-NotHaveType":{"id":"commands/Should-NotHaveType","title":"Should-NotHaveType","description":"Help for Pester command \'Should-NotHaveType\'. Asserts that the input is not of the expected type.","sidebar":"commands"},"commands/Should-NotInvoke":{"id":"commands/Should-NotInvoke","title":"Should-NotInvoke","description":"Help for Pester command \'Should-NotInvoke\'. Checks that mocked command was not called and throws exception if it was.","sidebar":"commands"}
1,"commands/Should-NotMatchString":{"id":"commands/Should-NotMatchString","title":"Should-NotMatchString","description":"Help for Pester command \'Should-NotMatchString\'. Tests whether a string does not match a regular expression pattern.","sidebar":"commands"},"commands/Should-Throw":{"id":"commands/Should-Throw","title":"Should-Throw","description":"Help for Pester command \'Should-Throw\'. Asserts that a script block throws an exception.","sidebar":"commands"},"contributing/feature-requests":{"id":"contributing/feature-requests","title":"Feature Requests","description":"How to suggest a new feature or improvement to the Pester PowerShell-module","sidebar":"docs"},"contributing/introduction":{"id":"contributing/introduction","title":"Introduction for contributors","description":"There are many ways to contribute to the Pester project and community. Check out this short introduction for how to get started","sidebar":"docs"},"contributing/pull-requests":{"id":"contributing/pull-requests","title":"Submitting Pull Requests","description":"Introduction on how to start contributing to the Pester project either by filing a bug, feature requests, support or submitting a pull request","sidebar":"docs"},"contributing/reporting-issues":{"id":"contributing/reporting-issues","title":"Reporting Issues","description":"Found an issue with Pester? Check out this guide for how to create an issue and provide us feedback so we can help you","sidebar":"docs"},"introduction/installation":{"id":"introduction/installation","title":"Installation and Update","description":"Pester is a cross-platform PowerShell module for testing your PowerShell code. Follow these steps to install or update your Pester-module to get started today","sidebar":"docs"},"migrations/breaking-changes-in-v5":{"id":"migrations/breaking-changes-in-v5","title":"Breaking changes in v5","description":"Pester v5 included an all-new runtime which lead to some breaking changes in syntax and features for existing users. See this list of breaking changes when upgrading to Pester v5","sidebar":"docs"},"migrations/v3-to-v4":{"id":"migrations/v3-to-v4","title":"Migrating from Pester v3 to v4","description":"Migration from Pester v3 to v4 may require minor changes to your test code. See this guide to get help understanding and making the necessary changes to be compatible with Pester v4","sidebar":"docs"},"migrations/v4-to-v5":{"id":"migrations/v4-to-v5","title":"Migrating from Pester v4 to v5","description":"Pester v5 introduced some fundamental changes compared with Pester v4. See this guide to get help understanding and making the necessary changes to be compatible with Pester v5","sidebar":"docs"},"migrations/v5-to-v6":{"id":"migrations/v5-to-v6","title":"Migrating from Pester v5 to v6","description":"See this guide for how to update your tests to be compatible with Pester v6.","sidebar":"docs"},"quick-start":{"id":"quick-start","title":"Quick Start","description":"Get started using Pester to test your PowerShell scripts, functions and modules","sidebar":"docs"},"usage/code-coverage":{"id":"usage/code-coverage","title":"Generating Code Coverage Metrics","description":"Pester can generate code coverage metrics to help you understand how many lines of your PowerShell code that is actually covered by your Pester-tests. Use this to increase confidence in your tests","sidebar":"docs"},"usage/configuration":{"id":"usage/configuration","title":"Configuration","description":"Documentation about how to configure the behavior, options and features in Pester","sidebar":"docs"},"usage/data-driven-tests":{"id":"usage/data-driven-tests","title":"Data driven tests","description":"Pester can generate tests based on data. This can range from providing multiple examples on a single `It`, to generating whole set of tests based on an external configuration file","sidebar":"docs"},"usage/discovery-and-run":{"id":"usage/discovery-and-run","title":"Discovery and Run","description":"Pester runs your test files in two phases, Discovery and Run. This introduction explains how they work and how it affects the way you structure and write your tests","sidebar":"docs"}
1,"usage/file-placement-and-naming":{"id":"usage/file-placement-and-naming","title":"File placement and naming","description":"Tips on how to name and structure your Pester test files and categorize your tests","sidebar":"docs"},"usage/importing-tested-functions":{"id":"usage/importing-tested-functions","title":"Importing tested functions","description":"Importing your PowerShell-code is essential to being able to test it. See how to import functions from your code to make them available for your tests","sidebar":"docs"},"usage/mocking":{"id":"usage/mocking","title":"Mocking with Pester","description":"Pester provides a set of Mocking functions making it easy to fake dependencies and also to verify behavior. Using these mocking functions can allow you to \\"shim\\" a data layer or mock other complex functions that already have their own tests","sidebar":"docs"},"usage/modules":{"id":"usage/modules","title":"Unit Testing within Modules","description":"PowerShell code in modules run in their own module state. This requires special attention when writing tests for internal functions or when mocking dependencies used by code in a module","sidebar":"docs"},"usage/output":{"id":"usage/output","title":"Output","description":"Pester uses customizable console output to show tests results, errors and summary. See how you can customize this output to fit your preference","sidebar":"docs"},"usage/parallel":{"id":"usage/parallel","title":"Parallel execution","description":"Pester v6 can run test files in parallel, each file in its own runspace, to cut the wall-clock time of large suites. This experimental feature is enabled with a single configuration option.","sidebar":"docs"},"usage/result-object":{"id":"usage/result-object","title":"The Result Object","description":"Pester can return a rich result object describing the whole run - containers, blocks, tests, counts, durations and errors. Learn its shape and how it behaves under the experimental parallel runner.","sidebar":"docs"},"usage/setup-and-teardown":{"id":"usage/setup-and-teardown","title":"Setup and teardown","description":"Pester offers multiple ways to run code before, and after your tests to set them up, and clean up after them","sidebar":"docs"},"usage/shuffle":{"id":"usage/shuffle","title":"Shuffled test order","description":"Pester v6 can shuffle the order test files, blocks and tests run in, so hidden dependencies between tests surface instead of staying lucky. The order is driven by a seed, so a failing run can be repeated exactly.","sidebar":"docs"},"usage/skip":{"id":"usage/skip","title":"Skip","description":"Skipping tests can be useful in many scenarios or when certain conditions are not met like OS-compatibility. Read about how to control this in Pester tests","sidebar":"docs"},"usage/tags":{"id":"usage/tags","title":"Tags","description":"Use tags on tests and blocks to categorize code and easily choose which tests to run with simple parameters","sidebar":"docs"},"usage/test-file-structure":{"id":"usage/test-file-structure","title":"Test file structure","description":"Pester uses special keywords and blocks to structure your tests like Describe, Context, It, BeforeAll/-Each etc. See this to learn how they relate and fit together","sidebar":"docs"},"usage/test-results":{"id":"usage/test-results","title":"Showing Test Results in CI","description":"Pester can output tests results to NUnit and JUnit XML reports that can be consumed by test reporting tools and CI-solutions","sidebar":"docs"},"usage/testdrive":{"id":"usage/testdrive","title":"Isolating File Operations using the TestDrive","description":"TestDrive is a PowerShell PSDrive where you can create temporary files used in your tests that are automatically cleaned up after your tests are finished","sidebar":"docs"},"usage/testregistry":{"id":"usage/testregistry","title":"Isolating Windows Registry Operations using the TestRegistry","description":"TestRegistry is a PowerShell PSDrive (Windows only) to help your store temporary values used in your tests in the Windows Registry that are automatically cleaned up after your tests are finished","sidebar":"docs"}
1,"usage/troubleshooting":{"id":"usage/troubleshooting","title":"Troubleshooting","description":"Introduction to useful logging for troubleshooting your tests or Pester itself","sidebar":"docs"},"usage/vscode":{"id":"usage/vscode","title":"Visual Studio Code","description":"See how Visual Studio Code and its extensions helps you run and debug your Pester tests directly inside the editor","sidebar":"docs"}}}}')}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.