diff --git a/docs/commands/Add-ShouldOperator.mdx b/docs/commands/Add-ShouldOperator.mdx index a7616251..b56e1445 100644 --- a/docs/commands/Add-ShouldOperator.mdx +++ b/docs/commands/Add-ShouldOperator.mdx @@ -166,4 +166,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/AfterAll.mdx b/docs/commands/AfterAll.mdx index 00ec9147..66f2e673 100644 --- a/docs/commands/AfterAll.mdx +++ b/docs/commands/AfterAll.mdx @@ -107,4 +107,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/AfterEach.mdx b/docs/commands/AfterEach.mdx index bcc7ec03..49b971e8 100644 --- a/docs/commands/AfterEach.mdx +++ b/docs/commands/AfterEach.mdx @@ -104,4 +104,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Assert-MockCalled.mdx b/docs/commands/Assert-MockCalled.mdx index 3a9b0937..5e22780c 100644 --- a/docs/commands/Assert-MockCalled.mdx +++ b/docs/commands/Assert-MockCalled.mdx @@ -184,4 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Assert-VerifiableMock.mdx b/docs/commands/Assert-VerifiableMock.mdx index d98951ae..0d38d159 100644 --- a/docs/commands/Assert-VerifiableMock.mdx +++ b/docs/commands/Assert-VerifiableMock.mdx @@ -61,4 +61,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/BeforeAll.mdx b/docs/commands/BeforeAll.mdx index d46e0352..2f43f3c0 100644 --- a/docs/commands/BeforeAll.mdx +++ b/docs/commands/BeforeAll.mdx @@ -116,4 +116,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/BeforeDiscovery.mdx b/docs/commands/BeforeDiscovery.mdx index 94fce6d0..9d58752d 100644 --- a/docs/commands/BeforeDiscovery.mdx +++ b/docs/commands/BeforeDiscovery.mdx @@ -94,4 +94,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/BeforeEach.mdx b/docs/commands/BeforeEach.mdx index eb48a8bc..88015aaf 100644 --- a/docs/commands/BeforeEach.mdx +++ b/docs/commands/BeforeEach.mdx @@ -101,4 +101,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Context.mdx b/docs/commands/Context.mdx index 90238fcc..4b2013ba 100644 --- a/docs/commands/Context.mdx +++ b/docs/commands/Context.mdx @@ -125,7 +125,9 @@ Accept wildcard characters: False ### -Skip -[Switch] $Focus, +Use this parameter to explicitly mark the block to be skipped. +This is preferable to temporarily +commenting out a block, because it remains listed in the output. ```yaml Type: SwitchParameter @@ -181,4 +183,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/ConvertTo-JUnitReport.mdx b/docs/commands/ConvertTo-JUnitReport.mdx index 13013d92..09fb6e61 100644 --- a/docs/commands/ConvertTo-JUnitReport.mdx +++ b/docs/commands/ConvertTo-JUnitReport.mdx @@ -23,7 +23,7 @@ Converts a Pester result-object to an JUnit-compatible XML report ## SYNTAX ```powershell -ConvertTo-JUnitReport [-Result] [-AsString] [] +ConvertTo-JUnitReport [-Result] [-AsString] [] ``` ## DESCRIPTION @@ -73,7 +73,7 @@ This can be retrieved using Invoke-Pester -Passthru or by using the Run.PassThru configuration-option. ```yaml -Type: Object +Type: Run Parameter Sets: (All) Aliases: @@ -118,4 +118,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/ConvertTo-NUnitReport.mdx b/docs/commands/ConvertTo-NUnitReport.mdx index d05e32b9..6850dd87 100644 --- a/docs/commands/ConvertTo-NUnitReport.mdx +++ b/docs/commands/ConvertTo-NUnitReport.mdx @@ -23,7 +23,7 @@ Converts a Pester result-object to an NUnit 2.5 or 3-compatible XML-report ## SYNTAX ```powershell -ConvertTo-NUnitReport [-Result] [-AsString] [[-Format] ] [] +ConvertTo-NUnitReport [-Result] [-AsString] [[-Format] ] [] ``` ## DESCRIPTION @@ -84,7 +84,7 @@ This can be retrieved using Invoke-Pester -Passthru or by using the Run.PassThru configuration-option. ```yaml -Type: Object +Type: Run Parameter Sets: (All) Aliases: @@ -145,4 +145,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/ConvertTo-Pester4Result.mdx b/docs/commands/ConvertTo-Pester4Result.mdx index bebe1010..d515ed7e 100644 --- a/docs/commands/ConvertTo-Pester4Result.mdx +++ b/docs/commands/ConvertTo-Pester4Result.mdx @@ -86,4 +86,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Describe.mdx b/docs/commands/Describe.mdx index 6424bfcb..fcf82020 100644 --- a/docs/commands/Describe.mdx +++ b/docs/commands/Describe.mdx @@ -135,7 +135,9 @@ Accept wildcard characters: False ### -Skip -[Switch] $Focus, +Use this parameter to explicitly mark the block to be skipped. +This is preferable to temporarily +commenting out a block, because it remains listed in the output. ```yaml Type: SwitchParameter @@ -191,4 +193,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Export-JUnitReport.mdx b/docs/commands/Export-JUnitReport.mdx index b721722a..74665c5c 100644 --- a/docs/commands/Export-JUnitReport.mdx +++ b/docs/commands/Export-JUnitReport.mdx @@ -23,7 +23,7 @@ Exports a Pester result-object to an JUnit-compatible XML-report ## SYNTAX ```powershell -Export-JUnitReport [-Result] [-Path] [] +Export-JUnitReport [-Result] [-Path] [] ``` ## DESCRIPTION @@ -60,7 +60,7 @@ This can be retrieved using Invoke-Pester -Passthru or by using the Run.PassThru configuration-option. ```yaml -Type: Object +Type: Run Parameter Sets: (All) Aliases: @@ -73,7 +73,7 @@ Accept wildcard characters: False ### -Path -The path where the XML-report should to the ou the XML report as string. +The path where the XML-report should be saved. ```yaml Type: String @@ -105,4 +105,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Export-NUnitReport.mdx b/docs/commands/Export-NUnitReport.mdx index ed341847..7f0b487c 100644 --- a/docs/commands/Export-NUnitReport.mdx +++ b/docs/commands/Export-NUnitReport.mdx @@ -23,7 +23,7 @@ Exports a Pester result-object to an NUnit-compatible XML-report ## SYNTAX ```powershell -Export-NUnitReport [-Result] [-Path] [[-Format] ] [] +Export-NUnitReport [-Result] [-Path] [[-Format] ] [] ``` ## DESCRIPTION @@ -60,7 +60,7 @@ This can be retrieved using Invoke-Pester -Passthru or by using the Run.PassThru configuration-option. ```yaml -Type: Object +Type: Run Parameter Sets: (All) Aliases: @@ -73,7 +73,7 @@ Accept wildcard characters: False ### -Path -The path where the XML-report should to the ou the XML report as string. +The path where the XML-report should be saved. ```yaml Type: String @@ -121,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Get-ShouldOperator.mdx b/docs/commands/Get-ShouldOperator.mdx index 38170ca8..1b9b5769 100644 --- a/docs/commands/Get-ShouldOperator.mdx +++ b/docs/commands/Get-ShouldOperator.mdx @@ -94,4 +94,4 @@ standard PowerShell discovery patterns (like `Get-Help Should -Parameter *`). ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/InModuleScope.mdx b/docs/commands/InModuleScope.mdx index c3ed49a5..8a1afbe6 100644 --- a/docs/commands/InModuleScope.mdx +++ b/docs/commands/InModuleScope.mdx @@ -204,4 +204,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Invoke-Pester.mdx b/docs/commands/Invoke-Pester.mdx index b05b4210..59c7806f 100644 --- a/docs/commands/Invoke-Pester.mdx +++ b/docs/commands/Invoke-Pester.mdx @@ -653,4 +653,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/It.mdx b/docs/commands/It.mdx index 12ba8775..54712351 100644 --- a/docs/commands/It.mdx +++ b/docs/commands/It.mdx @@ -58,7 +58,7 @@ the expectation of the test. In addition to using your own logic to test expectations and throw exceptions, you may also use Pester's Should command to perform assertions in plain language. -You can intentionally mark It block result as inconclusive by using Set-TestInconclusive +You can intentionally mark It block result as inconclusive by using Set-ItResult -Inconclusive command as the first tested statement in the It block. ## EXAMPLES @@ -227,8 +227,6 @@ Accept wildcard characters: False Use this parameter to explicitly mark the test to be skipped. This is preferable to temporarily commenting out a test, because the test remains listed in the output. -Use the Strict parameter -of Invoke-Pester to force all skipped tests to fail. ```yaml Type: SwitchParameter @@ -264,4 +262,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Mock.mdx b/docs/commands/Mock.mdx index 3c023d30..5b75de86 100644 --- a/docs/commands/Mock.mdx +++ b/docs/commands/Mock.mdx @@ -339,4 +339,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-Fixture.mdx b/docs/commands/New-Fixture.mdx index e540a248..2fde74ae 100644 --- a/docs/commands/New-Fixture.mdx +++ b/docs/commands/New-Fixture.mdx @@ -142,4 +142,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-MockObject.mdx b/docs/commands/New-MockObject.mdx index 5943fc2c..5cf702a9 100644 --- a/docs/commands/New-MockObject.mdx +++ b/docs/commands/New-MockObject.mdx @@ -194,4 +194,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-PesterConfiguration.mdx b/docs/commands/New-PesterConfiguration.mdx index d02bc640..1ce368fc 100644 --- a/docs/commands/New-PesterConfiguration.mdx +++ b/docs/commands/New-PesterConfiguration.mdx @@ -272,4 +272,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-PesterContainer.mdx b/docs/commands/New-PesterContainer.mdx index f4fcb9d3..127f5249 100644 --- a/docs/commands/New-PesterContainer.mdx +++ b/docs/commands/New-PesterContainer.mdx @@ -152,4 +152,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Set-ItResult.mdx b/docs/commands/Set-ItResult.mdx index 4faa46af..3728c807 100644 --- a/docs/commands/Set-ItResult.mdx +++ b/docs/commands/Set-ItResult.mdx @@ -57,6 +57,9 @@ backwards compatible ```powershell Describe "Example" { + It "Inconclusive test" { + Set-ItResult -Inconclusive -Because "we want it to be inconclusive" + } It "Skipped test" { Set-ItResult -Skipped -Because "we want it to be skipped" } @@ -66,16 +69,18 @@ Describe "Example" { the output should be ``` -[!] Skipped test is skipped, because we want it to be skipped -Tests completed in 0ms -Tests Passed: 0, Failed: 0, Skipped: 0, Pending: 0, Inconclusive 1 +Describing Example + [?] Inconclusive test is inconclusive, because we want it to be inconclusive 35ms (32ms|3ms) + [!] Skipped test is skipped, because we want it to be skipped 3ms (2ms|1ms) +Tests completed in 78ms +Tests Passed: 0, Failed: 0, Skipped: 1, Inconclusive: 1, NotRun: 0 ``` ## PARAMETERS ### -Inconclusive -**DEPRECATED** Sets the test result to inconclusive. +Sets the test result to inconclusive. Cannot be used at the same time as -Pending or -Skipped ```yaml @@ -158,4 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/Should.mdx b/docs/commands/Should.mdx index 3a134260..2f5fef43 100644 --- a/docs/commands/Should.mdx +++ b/docs/commands/Should.mdx @@ -810,12 +810,9 @@ Accept wildcard characters: False ### -FileContentMatchMultiline -As opposed to FileContentMatch and FileContentMatchExactly operators, -FileContentMatchMultiline presents content of the file being tested as one string object, -so that the expression you are comparing it to can consist of several lines. +As opposed to FileContentMatch and FileContentMatchExactly operators, FileContentMatchMultiline presents content of the file being tested as one string object, so that the expression you are comparing it to can consist of several lines. -When using FileContentMatchMultiline operator, '^' and '$' represent the beginning and end -of the whole file, instead of the beginning and end of a line. +When using FileContentMatchMultiline operator, '^' and '$' represent the beginning and end of the whole file, instead of the beginning and end of a line ```yaml Type: SwitchParameter @@ -831,12 +828,9 @@ Accept wildcard characters: False ### -FileContentMatchMultilineExactly -As opposed to FileContentMatch and FileContentMatchExactly operators, -FileContentMatchMultilineExactly presents content of the file being tested as one string object, -so that the case sensitive expression you are comparing it to can consist of several lines. +As opposed to FileContentMatch and FileContentMatchExactly operators, FileContentMatchMultilineExactly presents content of the file being tested as one string object, so that the case sensitive expression you are comparing it to can consist of several lines. -When using FileContentMatchMultilineExactly operator, '^' and '$' represent the beginning and end -of the whole file, instead of the beginning and end of a line. +When using FileContentMatchMultilineExactly operator, '^' and '$' represent the beginning and end of the whole file, instead of the beginning and end of a line. ```yaml Type: SwitchParameter @@ -1187,4 +1181,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## VERSION -*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).* +*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).* diff --git a/docs/commands/docusaurus.sidebar.js b/docs/commands/docusaurus.sidebar.js index f723acd6..9e69da4f 100644 --- a/docs/commands/docusaurus.sidebar.js +++ b/docs/commands/docusaurus.sidebar.js @@ -1,7 +1,7 @@ /** * Import this file in your Docusaurus `sidebars.js` file. * - * Auto-generated by Alt3.Docusaurus.Powershell 1.0.34. + * Auto-generated by Alt3.Docusaurus.Powershell 1.0.36. * * Copyright (c) 2019-present, ALT3 B.V. *