mirror of
https://github.com/github/awesome-copilot.git
synced 2026-07-14 01:51:02 +00:00
Add pester-should-migration skill (experimental) (#2164)
* Add pester-should-migration skill (experimental) Companion to the pester-migration skill. Focuses on the optional move from the classic v5 `Should -Be` assertion syntax to the new v6 `Should-*` assertions (e.g. `Should -Be` -> `Should-Be`). Includes a full operator-by-operator mapping and the behavioral gotchas (negation as a separate command, BeExactly -> Should-BeString -CaseSensitive, truthy/falsy vs strict bool, BeNullOrEmpty split, collections, pipeline unwrapping). Marked experimental/preview: verified against Pester 6.0.0-rc2; the new Should-* assertions may still change before the 6.0 release. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Trim experimental status callout in pester-should-migration Address review feedback: drop the time-based, human-oriented preview guidance (release-candidate timing, "as of mid-2026", release-notes link) from the status callout, keeping a lean experimental marker. The agent has no concept of time, so that prose is just extra tokens. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Awesome Copilot Community <awesome-copilot-community@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Aaron Powell <me@aaron-powell.com>
This commit is contained in:
Jakub Jareš
GitHub
@@ -270,6 +270,7 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-skills) for guidelines on how to
|
||||
| [penpot-uiux-design](../skills/penpot-uiux-design/SKILL.md)<br />`gh skills install github/awesome-copilot penpot-uiux-design` | Comprehensive guide for creating professional UI/UX designs in Penpot using MCP tools. Use this skill when: (1) Creating new UI/UX designs for web, mobile, or desktop applications, (2) Building design systems with components and tokens, (3) Designing dashboards, forms, navigation, or landing pages, (4) Applying accessibility standards and best practices, (5) Following platform guidelines (iOS, Android, Material Design), (6) Reviewing or improving existing Penpot designs for usability. Triggers: "design a UI", "create interface", "build layout", "design dashboard", "create form", "design landing page", "make it accessible", "design system", "component library". | `references/accessibility.md`<br />`references/component-patterns.md`<br />`references/platform-guidelines.md`<br />`references/setup-troubleshooting.md` |
|
||||
| [performance-review-writer](../skills/performance-review-writer/SKILL.md)<br />`gh skills install github/awesome-copilot performance-review-writer` | Draft performance reviews, self-assessments, peer reviews, and upward feedback in your own voice. Analyzes your contributions, emails, and meeting history via WorkIQ, then produces honest, impact-focused drafts using the STAR format. USE FOR: write my performance review, draft self-assessment, peer review, 360 feedback, annual review, mid-year review, upward feedback, write review for colleague, performance appraisal. | None |
|
||||
| [pester-migration](../skills/pester-migration/SKILL.md)<br />`gh skills install github/awesome-copilot pester-migration` | Experimental (preview) Pester migration skill for upgrading PowerShell Pester test suites across major versions — v3→v4, v4→v5, and v5→v6. The v5→v6 path tracks Pester 6, which is still a release candidate, so that guidance may change. Covers the Discovery/Run two-phase model, moving setup into BeforeAll, $PSScriptRoot vs $MyInvocation, mock changes (Assert-MockCalled → Should -Invoke, removed fall-through), Invoke-Pester parameters → PesterConfiguration, data-driven -ForEach/-TestCases, and the v6 breaking changes. Use when the user asks to upgrade, migrate, or modernize Pester tests, fix *.Tests.ps1 files that broke after bumping the Pester version, or convert legacy Should / Invoke-Pester syntax. | `references/v3-to-v4.md`<br />`references/v4-to-v5.md`<br />`references/v5-to-v6.md` |
|
||||
| [pester-should-migration](../skills/pester-should-migration/SKILL.md)<br />`gh skills install github/awesome-copilot pester-should-migration` | Experimental (preview) Pester skill for migrating classic Should -Be (v5) assertion syntax to the new Should-* (v6) assertions (note the hyphen, no space), e.g. `Should -Be` -> `Should-Be`, `Should -Not -Be` -> `Should-NotBe`. Tracks Pester 6, which is still a release candidate, so this guidance may change; verified against Pester 6.0.0-rc2. Use when converting Pester v5 assertions to Pester v6 Should-* operators, modernizing a Pester test suite, or when a user asks to migrate, convert, or rewrite `Should -...` calls in .Tests.ps1 / PowerShell files. | `references/assertion-map.md` |
|
||||
| [phoenix-cli](../skills/phoenix-cli/SKILL.md)<br />`gh skills install github/awesome-copilot phoenix-cli` | Debug LLM applications using the Phoenix CLI. Fetch traces, analyze errors, structure trace review with open coding and axial coding, inspect datasets, review experiments, query annotation configs, and use the GraphQL API. Use whenever the user is analyzing traces or spans, investigating LLM/agent failures, deciding what to do after instrumenting an app, building failure taxonomies, choosing what evals to write, or asking "what's going wrong", "what kinds of mistakes", or "where do I focus" — even without naming a technique. | `references/axial-coding.md`<br />`references/open-coding.md` |
|
||||
| [phoenix-evals](../skills/phoenix-evals/SKILL.md)<br />`gh skills install github/awesome-copilot phoenix-evals` | Build and run evaluators for AI/LLM applications using Phoenix. | `references/axial-coding.md`<br />`references/common-mistakes-python.md`<br />`references/error-analysis-multi-turn.md`<br />`references/error-analysis.md`<br />`references/evaluate-dataframe-python.md`<br />`references/evaluators-code-python.md`<br />`references/evaluators-code-typescript.md`<br />`references/evaluators-custom-templates.md`<br />`references/evaluators-llm-python.md`<br />`references/evaluators-llm-typescript.md`<br />`references/evaluators-overview.md`<br />`references/evaluators-pre-built.md`<br />`references/evaluators-rag.md`<br />`references/experiments-datasets-python.md`<br />`references/experiments-datasets-typescript.md`<br />`references/experiments-overview.md`<br />`references/experiments-running-python.md`<br />`references/experiments-running-typescript.md`<br />`references/experiments-synthetic-python.md`<br />`references/experiments-synthetic-typescript.md`<br />`references/fundamentals-anti-patterns.md`<br />`references/fundamentals-model-selection.md`<br />`references/fundamentals.md`<br />`references/observe-sampling-python.md`<br />`references/observe-sampling-typescript.md`<br />`references/observe-tracing-setup.md`<br />`references/production-continuous.md`<br />`references/production-guardrails.md`<br />`references/production-overview.md`<br />`references/setup-python.md`<br />`references/setup-typescript.md`<br />`references/validation-evaluators-python.md`<br />`references/validation-evaluators-typescript.md`<br />`references/validation.md` |
|
||||
| [phoenix-tracing](../skills/phoenix-tracing/SKILL.md)<br />`gh skills install github/awesome-copilot phoenix-tracing` | OpenInference semantic conventions and instrumentation for Phoenix AI observability. Use when implementing LLM tracing, creating custom spans, or deploying to production. | `README.md`<br />`references/annotations-overview.md`<br />`references/annotations-python.md`<br />`references/annotations-typescript.md`<br />`references/fundamentals-flattening.md`<br />`references/fundamentals-overview.md`<br />`references/fundamentals-required-attributes.md`<br />`references/fundamentals-universal-attributes.md`<br />`references/instrumentation-auto-python.md`<br />`references/instrumentation-auto-typescript.md`<br />`references/instrumentation-manual-python.md`<br />`references/instrumentation-manual-typescript.md`<br />`references/metadata-python.md`<br />`references/metadata-typescript.md`<br />`references/production-python.md`<br />`references/production-typescript.md`<br />`references/projects-python.md`<br />`references/projects-typescript.md`<br />`references/sessions-python.md`<br />`references/sessions-typescript.md`<br />`references/setup-python.md`<br />`references/setup-typescript.md`<br />`references/span-agent.md`<br />`references/span-chain.md`<br />`references/span-embedding.md`<br />`references/span-evaluator.md`<br />`references/span-guardrail.md`<br />`references/span-llm.md`<br />`references/span-reranker.md`<br />`references/span-retriever.md`<br />`references/span-tool.md` |
|
||||
|
||||
@@ -0,0 +1,148 @@
|
||||
---
|
||||
name: pester-should-migration
|
||||
description: 'Experimental (preview) Pester skill for migrating classic Should -Be (v5) assertion syntax to the new Should-* (v6) assertions (note the hyphen, no space), e.g. `Should -Be` -> `Should-Be`, `Should -Not -Be` -> `Should-NotBe`. Tracks Pester 6, which is still a release candidate, so this guidance may change; verified against Pester 6.0.0-rc2. Use when converting Pester v5 assertions to Pester v6 Should-* operators, modernizing a Pester test suite, or when a user asks to migrate, convert, or rewrite `Should -...` calls in .Tests.ps1 / PowerShell files.'
|
||||
argument-hint: "File, folder, or test suite to migrate"
|
||||
---
|
||||
|
||||
# Pester `Should -*` → `Should-*` Migration
|
||||
|
||||
Convert classic Pester v5 assertions (`Should -Be`, space then parameter) to the
|
||||
new Pester v6 `Should-*` assertions (`Should-Be`, hyphen, no space).
|
||||
|
||||
> **Status: experimental / preview.** Verified against Pester 6.0.0-rc2. The classic
|
||||
> `Should -Be` style still works in v6, so migrate incrementally and keep the suite green.
|
||||
|
||||
> **Companion skill.** This skill covers the *optional* move to the new `Should-*` operators.
|
||||
> To upgrade a suite across major Pester versions (v3→v4→v5→v6 — the runtime, mocks, and config),
|
||||
> use the separate **pester-migration** skill. In v6 the classic `Should -Be` keeps working, so
|
||||
> adopting `Should-*` is independent of any version bump.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Modernizing a Pester suite to the v6 `Should-*` assertions.
|
||||
- A user asks to migrate / convert / rewrite `Should -...` calls.
|
||||
- You want clearer, type-aware failure messages from the new assertions.
|
||||
|
||||
## Know This First
|
||||
|
||||
- **Both syntaxes work side by side in Pester v6.** Migration is optional and can
|
||||
be done one test (or one file) at a time. Nothing breaks if you leave some classic.
|
||||
- **Requires Pester v6+.** The `Should-*` commands do not exist in v5.
|
||||
- **Negation is a separate command**, not a `-Not` switch: `Should -Not -Be` →
|
||||
`Should-NotBe`. There is no `-Not` parameter on the new assertions.
|
||||
- **The actual value still comes from the pipeline** (`$x | Should-Be 1`) or from
|
||||
`-Actual` (`Should-Be -Actual $x -Expected 1`). `-Because` carries over unchanged.
|
||||
- **Most renames are mechanical**, but several have behavior changes you must check
|
||||
by hand — see [Gotchas](#step-3--check-the-behavioral-gotchas-do-not-skip).
|
||||
|
||||
## Procedure
|
||||
|
||||
### Step 1 — Find the classic assertions
|
||||
|
||||
Search the target for the classic space-separated syntax (the tell is `Should -`,
|
||||
or `Should` followed by `-Not`):
|
||||
|
||||
```
|
||||
Should - # any classic operator
|
||||
Should -Not - # negated classic operator
|
||||
Assert-MockCalled # also removed in v6 -> Should-Invoke
|
||||
```
|
||||
|
||||
Limit the scope to PowerShell test files (`*.Tests.ps1`, `*.ps1`).
|
||||
|
||||
### Step 2 — Apply the mapping
|
||||
|
||||
Most-used conversions (full list in [references/assertion-map.md](references/assertion-map.md)):
|
||||
|
||||
| Classic (v5) | New (v6) |
|
||||
|---|---|
|
||||
| `$x \| Should -Be 1` | `$x \| Should-Be 1` |
|
||||
| `$x \| Should -Not -Be 1` | `$x \| Should-NotBe 1` |
|
||||
| `$x \| Should -BeExactly 'A'` | `$x \| Should-BeString 'A' -CaseSensitive` |
|
||||
| `$x \| Should -BeGreaterOrEqual 2` | `$x \| Should-BeGreaterThanOrEqual 2` |
|
||||
| `$x \| Should -BeLessOrEqual 2` | `$x \| Should-BeLessThanOrEqual 2` |
|
||||
| `$x \| Should -BeLike 'a*'` | `$x \| Should-BeLikeString 'a*'` |
|
||||
| `$x \| Should -Match 're'` | `$x \| Should-MatchString 're'` |
|
||||
| `$x \| Should -BeOfType [int]` | `$x \| Should-HaveType ([int])` |
|
||||
| `$x \| Should -BeNullOrEmpty` | depends — see gotchas (no single equivalent) |
|
||||
| `$c \| Should -HaveCount 3` | `$c \| Should-BeCollection -Count 3` |
|
||||
| `$c \| Should -Contain 2` | `$c \| Should-ContainCollection 2` |
|
||||
| `{ ... } \| Should -Throw 'msg'` | `{ ... } \| Should-Throw -ExceptionMessage 'msg'` |
|
||||
| `Should -Invoke Get-Thing` | `Should-Invoke Get-Thing` |
|
||||
| `Should -InvokeVerifiable` | `Should-Invoke -Verifiable` |
|
||||
|
||||
### Step 3 — Check the behavioral gotchas (do NOT skip)
|
||||
|
||||
These do **not** translate by a plain rename. Read each before converting:
|
||||
|
||||
1. **Case sensitivity.** Classic `Should -Be` is case-insensitive on strings; so is
|
||||
`Should-Be`. But classic `Should -BeExactly` (case-sensitive) has **no** plain
|
||||
equivalent — use `Should-BeString -CaseSensitive`. (`Should-Be` is never
|
||||
case-sensitive.) Same pattern for `BeLikeExactly` → `Should-BeLikeString -CaseSensitive`
|
||||
and `MatchExactly` → `Should-MatchString -CaseSensitive`.
|
||||
2. **Truthy vs. true.** Classic `Should -BeTrue` / `-BeFalse` accept any *truthy* /
|
||||
*falsy* value (`1`, `'x'`, `0`, `''`, `$null`, `@()`). The new `Should-BeTrue` /
|
||||
`Should-BeFalse` are **strict** (exactly `$true` / `$false`). To preserve the old
|
||||
loose behavior use `Should-BeTruthy` / `Should-BeFalsy`. Only use the strict ones
|
||||
when the value really is a boolean.
|
||||
3. **`BeNullOrEmpty` has no single equivalent.** Pick by intent: `$null` →
|
||||
`Should-BeNull`; empty string → `Should-BeEmptyString`; empty collection →
|
||||
`Should-BeCollection -Count 0`; broad "falsy" → `Should-BeFalsy`. The negation
|
||||
`Should -Not -BeNullOrEmpty` similarly splits into `Should-NotBeNull` /
|
||||
`Should-NotBeEmptyString` / `Should-NotBeWhiteSpaceString`.
|
||||
4. **Collections.** Classic `Should -Be` also compares arrays; the new `Should-Be` is
|
||||
a *value* assertion and **errors** if `-Expected` is a collection ("You provided a
|
||||
collection to the -Expected parameter"). Use `Should-BeCollection` to compare arrays.
|
||||
`Should -Contain` (single-item membership) → `Should-ContainCollection`. The new
|
||||
command also takes a **collection** of expected items and checks they are all present,
|
||||
in the right order (`1, 2, 3 | Should-ContainCollection @(1, 2)`). For exact,
|
||||
whole-collection equality use `Should-BeCollection` instead.
|
||||
5. **Pipeline unwrapping.** The pipeline unwraps input: a value assertion sees `@(1)`
|
||||
as `1` and `@()` as `$null`, and a typed collection (`[int[]]`) is re-collected as
|
||||
`[object[]]`. When the exact value or concrete collection type matters (e.g.
|
||||
`Should-HaveType`), pass it with `-Actual` instead of piping.
|
||||
6. **No `Should-*` equivalent.** `Should -Exist` and the `Should -FileContentMatch*`
|
||||
family have no new counterpart. Either keep the classic assertion, or rewrite with
|
||||
PowerShell: `Test-Path $p | Should-BeTrue`, `(Get-Content $p -Raw) | Should-MatchString 're'`.
|
||||
7. **`Should -BeIn` direction.** No `Should-BeIn`. Reverse the operands:
|
||||
`$value | Should -BeIn $collection` → `$collection | Should-ContainCollection $value`
|
||||
(note the actual/expected swap), or keep the classic form.
|
||||
|
||||
### Step 4 — Verify
|
||||
|
||||
Run the suite and confirm it's still green — the new messages differ, but passes
|
||||
must stay passes:
|
||||
|
||||
```powershell
|
||||
Invoke-Pester -Path ./tests
|
||||
```
|
||||
|
||||
If a converted assertion newly fails, re-check the gotchas above (most often #2
|
||||
truthy/falsy, #3 null-or-empty, or #4 collections).
|
||||
|
||||
### Step 5 — (Optional) Enforce the new style
|
||||
|
||||
Once a suite is fully migrated, switch off the classic syntax so it can't creep back:
|
||||
|
||||
```powershell
|
||||
$config = New-PesterConfiguration
|
||||
$config.Should.DisableV5 = $true
|
||||
```
|
||||
|
||||
With this set, any remaining `Should -Be` throws and points at the `Should-Be` form.
|
||||
|
||||
## Output
|
||||
|
||||
Summarize what changed: files touched, count of assertions converted, any classic
|
||||
assertions intentionally left (e.g. `Should -Exist`), and any conversions that need
|
||||
a human decision (truthy/falsy, null-or-empty, collection semantics).
|
||||
|
||||
## Reference
|
||||
|
||||
- [references/assertion-map.md](references/assertion-map.md) — full operator-by-operator
|
||||
table with before/after examples and workarounds.
|
||||
- Live command reference: `https://pester.dev/docs/commands/Should-Be` (swap in any
|
||||
`Should-*` name) for exact parameters and examples.
|
||||
- Concepts: `https://pester.dev/docs/assertions/should-command` (value vs. collection
|
||||
assertions, pipeline vs. `-Actual`).
|
||||
- v5→v6 upgrade guide: `https://pester.dev/docs/migrations/v5-to-v6`.
|
||||
@@ -0,0 +1,187 @@
|
||||
# Pester `Should -*` → `Should-*` full assertion map
|
||||
|
||||
Complete operator-by-operator mapping from classic Pester v5 assertions to the
|
||||
Pester v6 `Should-*` assertions. Every signature here was taken from the Pester v6
|
||||
command reference. For the authoritative, always-current parameters and examples,
|
||||
open `https://pester.dev/docs/commands/<Name>` (e.g. `.../Should-Be`).
|
||||
|
||||
Conventions used below:
|
||||
- `$x` = the actual value (piped, or passed with `-Actual`).
|
||||
- A plain rename means: change `Should -Operator` to `Should-Operator` and keep the
|
||||
pipeline/arguments. Anything else is called out.
|
||||
|
||||
---
|
||||
|
||||
## Equality / comparison
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `$x \| Should -Be 1` | `$x \| Should-Be 1` | Case-insensitive on strings in both (`-eq` semantics). |
|
||||
| `$x \| Should -Not -Be 1` | `$x \| Should-NotBe 1` | Negation is its own command. |
|
||||
| `$x \| Should -BeExactly 'A'` | `$x \| Should-BeString 'A' -CaseSensitive` | `Should-Be` is **not** case-sensitive; use `Should-BeString -CaseSensitive`. |
|
||||
| `$x \| Should -Not -BeExactly 'A'` | `$x \| Should-NotBeString 'A' -CaseSensitive` | |
|
||||
| `$x \| Should -BeGreaterThan 1` | `$x \| Should-BeGreaterThan 1` | Plain rename. |
|
||||
| `$x \| Should -BeGreaterOrEqual 1` | `$x \| Should-BeGreaterThanOrEqual 1` | **Renamed** (`...ThanOrEqual`). |
|
||||
| `$x \| Should -BeLessThan 1` | `$x \| Should-BeLessThan 1` | Plain rename. |
|
||||
| `$x \| Should -BeLessOrEqual 1` | `$x \| Should-BeLessThanOrEqual 1` | **Renamed** (`...ThanOrEqual`). |
|
||||
|
||||
There is no negated comparison command (e.g. no `Should-NotBeGreaterThan`). Invert
|
||||
the logic with the opposite operator (`Should-BeLessThanOrEqual`) when needed.
|
||||
|
||||
---
|
||||
|
||||
## Strings (pattern / regex / whitespace)
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `$x \| Should -BeLike 'a*'` | `$x \| Should-BeLikeString 'a*'` | Wildcard match, case-insensitive default. |
|
||||
| `$x \| Should -BeLikeExactly 'a*'` | `$x \| Should-BeLikeString 'a*' -CaseSensitive` | |
|
||||
| `$x \| Should -Not -BeLike 'a*'` | `$x \| Should-NotBeLikeString 'a*'` | |
|
||||
| `$x \| Should -Match 're'` | `$x \| Should-MatchString 're'` | Regex match, case-insensitive default. |
|
||||
| `$x \| Should -MatchExactly 're'` | `$x \| Should-MatchString 're' -CaseSensitive` | |
|
||||
| `$x \| Should -Not -Match 're'` | `$x \| Should-NotMatchString 're'` | |
|
||||
|
||||
`Should-BeString` also offers `-IgnoreWhitespace` and `-TrimWhitespace`, plus the
|
||||
dedicated `Should-BeEmptyString`, `Should-NotBeEmptyString`, and
|
||||
`Should-NotBeWhiteSpaceString` for empty/whitespace checks (no v5 equivalents — they
|
||||
replace `BeNullOrEmpty`-style checks on strings).
|
||||
|
||||
---
|
||||
|
||||
## Boolean / truthiness
|
||||
|
||||
Classic `BeTrue`/`BeFalse` are **truthy/falsy** checks. The new same-named commands
|
||||
are **strict** (`$true`/`$false` only). Choose deliberately:
|
||||
|
||||
| Classic v5 | Pester v6 (preserve behavior) | Pester v6 (strict bool) |
|
||||
|---|---|---|
|
||||
| `$x \| Should -BeTrue` | `$x \| Should-BeTruthy` | `$x \| Should-BeTrue` |
|
||||
| `$x \| Should -BeFalse` | `$x \| Should-BeFalsy` | `$x \| Should-BeFalse` |
|
||||
|
||||
`Should-BeFalsy` passes for `$false`, `0`, `''`, `$null`, `@()`. If the value under
|
||||
test is genuinely a boolean, prefer the strict `Should-BeTrue` / `Should-BeFalse`.
|
||||
|
||||
---
|
||||
|
||||
## Null / empty
|
||||
|
||||
`Should -BeNullOrEmpty` collapses several checks into one; v6 splits them. Pick by
|
||||
what the value actually is:
|
||||
|
||||
| Intent | Classic v5 | Pester v6 |
|
||||
|---|---|---|
|
||||
| value is `$null` | `$x \| Should -BeNullOrEmpty` | `$x \| Should-BeNull` |
|
||||
| empty string | `'' \| Should -BeNullOrEmpty` | `'' \| Should-BeEmptyString` |
|
||||
| empty collection | `@() \| Should -BeNullOrEmpty` | `@() \| Should-BeCollection -Count 0` |
|
||||
| any falsy value | `$x \| Should -BeNullOrEmpty` | `$x \| Should-BeFalsy` |
|
||||
| not null | `$x \| Should -Not -BeNullOrEmpty` | `$x \| Should-NotBeNull` |
|
||||
| not empty string | `$x \| Should -Not -BeNullOrEmpty` | `$x \| Should-NotBeEmptyString` |
|
||||
| not null/empty/whitespace | `$x \| Should -Not -BeNullOrEmpty` | `$x \| Should-NotBeWhiteSpaceString` |
|
||||
|
||||
When in doubt and the type is mixed, `Should-BeFalsy` / `Should-NotBeNull` are the
|
||||
closest broad equivalents — but a type-specific assertion gives a better message.
|
||||
|
||||
---
|
||||
|
||||
## Type
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `$x \| Should -BeOfType [int]` | `$x \| Should-HaveType ([int])` | |
|
||||
| `$x \| Should -BeOfType 'System.Int32'` | `$x \| Should-HaveType ([System.Int32])` | New form needs a **type literal**, not a string type name. |
|
||||
| `$x \| Should -Not -BeOfType [int]` | `$x \| Should-NotHaveType ([int])` | |
|
||||
|
||||
For a typed collection, pipe-unwrapping turns `[int[]]` into `[object[]]`. Use
|
||||
`-Actual` to keep the real type: `Should-HaveType -Actual ([int[]](1,2)) -Expected ([int[]])`.
|
||||
|
||||
---
|
||||
|
||||
## Collections
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `$c \| Should -Be @(1,2,3)` | `$c \| Should-BeCollection @(1,2,3)` | `Should-Be` errors on a collection `-Expected`; use `Should-BeCollection` for arrays. |
|
||||
| `$c \| Should -HaveCount 3` | `$c \| Should-BeCollection -Count 3` | |
|
||||
| `$c \| Should -Contain 2` | `$c \| Should-ContainCollection 2` | Membership. Pass one item, or a collection (`@(1, 2)`) to require several present, in order. |
|
||||
| `$c \| Should -Not -Contain 2` | `$c \| Should-NotContainCollection 2` | |
|
||||
| `$v \| Should -BeIn $c` | `$c \| Should-ContainCollection $v` | No `Should-BeIn`; operands swap (actual becomes the collection). |
|
||||
|
||||
`Should-ContainCollection` checks that the expected item(s) are present in the actual
|
||||
collection, in the right order. Pass a single item (`$c | Should-ContainCollection 2`)
|
||||
or a collection to require several at once (`1, 2, 3 | Should-ContainCollection @(1, 2)`).
|
||||
For exact, whole-collection equality use `Should-BeCollection`.
|
||||
|
||||
New combinator assertions have no v5 equivalent but are handy in migrations:
|
||||
`$c | Should-All { $_ | Should-BeGreaterThan 0 }` and `$c | Should-Any { ... }`.
|
||||
|
||||
---
|
||||
|
||||
## Exceptions
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `{ ... } \| Should -Throw` | `{ ... } \| Should-Throw` | Plain rename. |
|
||||
| `{ ... } \| Should -Throw 'msg'` | `{ ... } \| Should-Throw -ExceptionMessage 'msg'` | Param **renamed** from `-ExpectedMessage`. `-like` wildcards supported. |
|
||||
| `{ ... } \| Should -Throw -ErrorId 'X'` | `{ ... } \| Should-Throw -FullyQualifiedErrorId 'X'` | Param **renamed**. |
|
||||
| `{ ... } \| Should -Throw -ExceptionType ([T])` | `{ ... } \| Should-Throw -ExceptionType ([T])` | Same. |
|
||||
| `{ ... } \| Should -Not -Throw` | `{ ... }; <no throw assertion needed>` | There is no `Should-NotThrow`; a script block that must not throw simply runs. Assert on its result instead, or keep the classic `Should -Not -Throw`. |
|
||||
|
||||
`Should-Throw` adds `-AllowNonTerminatingError` and returns the error record for
|
||||
further assertions: `$err = { throw 'boom' } | Should-Throw; $err.Exception.Message | Should-BeString '*boom*'`.
|
||||
|
||||
---
|
||||
|
||||
## Mocks
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `Should -Invoke Get-Thing` | `Should-Invoke Get-Thing` | Plain rename. |
|
||||
| `Should -Invoke Get-Thing -Times 2 -Exactly` | `Should-Invoke Get-Thing -Times 2 -Exactly` | Same parameters. |
|
||||
| `Should -Invoke Get-Thing -ParameterFilter { ... }` | `Should-Invoke Get-Thing -ParameterFilter { ... }` | Same. |
|
||||
| `Should -Not -Invoke Get-Thing` | `Should-NotInvoke Get-Thing` | Separate command. |
|
||||
| `Should -InvokeVerifiable` | `Should-Invoke -Verifiable` | Folded into a `-Verifiable` parameter set. |
|
||||
|
||||
`Assert-MockCalled` / `Assert-VerifiableMock` were removed in v6 entirely — map them
|
||||
to `Should-Invoke` / `Should-Invoke -Verifiable` as well.
|
||||
|
||||
---
|
||||
|
||||
## Command metadata
|
||||
|
||||
| Classic v5 | Pester v6 | Notes |
|
||||
|---|---|---|
|
||||
| `Get-Command f \| Should -HaveParameter X -Mandatory` | `Get-Command f \| Should-HaveParameter X -Mandatory` | Plain rename. |
|
||||
| `... \| Should -HaveParameter X -Type String` | `... \| Should-HaveParameter X -Type ([String])` | Prefer a type literal. |
|
||||
| `... \| Should -HaveParameter X -DefaultValue 8` | `... \| Should-HaveParameter X -DefaultValue 8` | Same. |
|
||||
| `... \| Should -Not -HaveParameter X` | `... \| Should-NotHaveParameter X` | Separate command. |
|
||||
|
||||
---
|
||||
|
||||
## No `Should-*` equivalent (keep classic or rewrite)
|
||||
|
||||
These v5 operators have **no** new assertion. Leave them as classic `Should -...`
|
||||
(both syntaxes coexist), or rewrite with PowerShell + a new assertion:
|
||||
|
||||
| Classic v5 | Workaround in v6 |
|
||||
|---|---|
|
||||
| `$p \| Should -Exist` | `Test-Path $p \| Should-BeTrue` |
|
||||
| `$p \| Should -FileContentMatch 're'` | `(Get-Content $p -Raw) \| Should-MatchString 're'` |
|
||||
| `$p \| Should -FileContentMatchExactly 're'` | `(Get-Content $p -Raw) \| Should-MatchString 're' -CaseSensitive` |
|
||||
| `$p \| Should -FileContentMatchMultiline 're'` | `(Get-Content $p -Raw) \| Should-MatchString 're'` |
|
||||
| `$p \| Should -FileContentMatchMultilineExactly 're'` | `(Get-Content $p -Raw) \| Should-MatchString 're' -CaseSensitive` |
|
||||
|
||||
(With `Get-Content -Raw`, `^` and `$` in the regex match the start/end of the whole
|
||||
file, matching the multiline operators' behavior.)
|
||||
|
||||
---
|
||||
|
||||
## New v6 assertions with no v5 counterpart
|
||||
|
||||
Worth reaching for when migrating; they often replace awkward classic combinations:
|
||||
|
||||
- `Should-BeSame` / `Should-NotBeSame` — reference equality (same instance).
|
||||
- `Should-BeEquivalent` — recursive, property-by-property object comparison.
|
||||
- `Should-BeHashtable` — assert hashtable/ordered dict shape, keys, and count.
|
||||
- `Should-BeBefore` / `Should-BeAfter` — `[datetime]` ordering.
|
||||
- `Should-BeFasterThan` / `Should-BeSlowerThan` — `[timespan]` / `[scriptblock]` timing.
|
||||
- `Should-All` / `Should-Any` — run a filter or nested `Should-*` over every item.
|
||||
Reference in New Issue
Block a user