Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pester/Pester

Pester is the ubiquitous test and mock framework for PowerShell.
https://github.com/pester/Pester

assertions bdd bdd-framework mock mocking pester-tests powershell powershell-tests tdd tdd-framework testing

Last synced: about 1 month ago
JSON representation

Pester is the ubiquitous test and mock framework for PowerShell.

Host: GitHub
URL: https://github.com/pester/Pester
Owner: pester
License: other
Created: 2011-01-02T03:33:19.000Z (almost 14 years ago)
Default Branch: main
Last Pushed: 2024-04-29T08:31:33.000Z (8 months ago)
Last Synced: 2024-05-01T16:50:38.491Z (7 months ago)
Topics: assertions, bdd, bdd-framework, mock, mocking, pester-tests, powershell, powershell-tests, tdd, tdd-framework, testing
Language: PowerShell
Homepage: https://pester.dev/
Size: 21.1 MB
Stars: 3,019
Watchers: 155
Forks: 461
Open Issues: 158
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md

Awesome Lists containing this project

awesome-starred-test - pester/Pester - Pester is the ubiquitous test and mock framework for PowerShell. (PowerShell)
jimsghstars - pester/Pester - Pester is the ubiquitous test and mock framework for PowerShell. (PowerShell)

README

        # Pester

> 💵 Please consider sponsoring [nohwnd](https://github.com/sponsors/nohwnd), [fflaten](https://github.com/sponsors/fflaten) or sponsoring [Pester](https://opencollective.com/pester) itself.

> 🌵 Documentation is available at [https://pester.dev/docs/quick-start](https://pester.dev/docs/quick-start).

> 📦🔐 Pester is now signed. `-SkipPublisherCheck` should no longer be used to install from PowerShell Gallery on Windows 10.

> 📦🔐 Upgrading to 5.6.0 will show a "certificate changed" error, this is because a change in Root Certificate, and you have to specify `-SkipPublisherCheck` to update. [More info below.](#signing-certificates)

> 👩👨 We are looking for contributors! All issues labeled [help wanted](https://github.com/pester/Pester/labels/help%20wanted) are up for grabs. They further split up into [good first issue](https://github.com/pester/Pester/labels/good%20first%20issue) that are issues I hope are easy to solve. [Bad first issue](https://github.com/pester/Pester/labels/bad%20first%20issue) where I expect the implementation to be problematic or needs to be proposed and discussed beforehand. And the rest which is somewhere in the middle. If you decide to pick up an issue please comment in the issue thread so others don't waste their time working on the same issue as you.

> There is also [contributor's guide](https://pester.dev/docs/contributing/introduction) that will hopefully help you.

Pester is the ubiquitous test and mock framework for PowerShell.

```powershell

BeforeAll {

    # your function

    function Get-Planet ([string]$Name='*')

    {

        $planets = @(

            @{ Name = 'Mercury' }

            @{ Name = 'Venus'   }

            @{ Name = 'Earth'   }

            @{ Name = 'Mars'    }

            @{ Name = 'Jupiter' }

            @{ Name = 'Saturn'  }

            @{ Name = 'Uranus'  }

            @{ Name = 'Neptune' }

        ) | foreach { [PSCustomObject]$_ }

        $planets | where { $_.Name -like $Name }

    }

}

# Pester tests

Describe 'Get-Planet' {

  It "Given no parameters, it lists all 8 planets" {

    $allPlanets = Get-Planet

    $allPlanets.Count | Should -Be 8

  }

  Context "Filtering by Name" {

    It "Given valid -Name '', it returns ''" -TestCases @(

      @{ Filter = 'Earth'; Expected = 'Earth' }

      @{ Filter = 'ne*'  ; Expected = 'Neptune' }

      @{ Filter = 'ur*'  ; Expected = 'Uranus' }

      @{ Filter = 'm*'   ; Expected = 'Mercury', 'Mars' }

    ) {

      param ($Filter, $Expected)

      $planets = Get-Planet -Name $Filter

      $planets.Name | Should -Be $Expected

    }

    It "Given invalid parameter -Name 'Alpha Centauri', it returns `$null" {

      $planets = Get-Planet -Name 'Alpha Centauri'

      $planets | Should -Be $null

    }

  }

}

```

Save this code example in a file named `Get-Planet.Tests.ps1`, and run `Invoke-Pester Get-Planet.Tests.ps1`, or just press `F5` in VSCode.

Learn how to [start quick with Pester](https://pester.dev/docs/quick-start) in our docs.

The example above also has an [annotated and production ready version here](docs/Examples/Planets).

## Installation

Pester runs on Windows, Linux, MacOS and anywhere else thanks to PowerShell. It is compatible with Windows PowerShell 5.1 and PowerShell 7.2 and newer.

Pester 3 comes pre-installed with Windows 10, but we recommend updating, by running this PowerShell command _as administrator_:

```powershell

Install-Module -Name Pester -Force

```

Not running Windows 10 or facing problems? See the [full installation and update guide](https://pester.dev/docs/introduction/installation).

## Signing certificates

The certificate used for signing the code has changed in 5.6.0. Error is shown when updating the module.

Below is the list of the certificates you can expect to be used when importing the module (going back to 2016)

Version|Authority|Thumbprint

---|---|---

6.0.0-alpha4+|`CN=DigiCert Trusted G4 Code Signing RSA4096 SHA384 2021 CA1, O="DigiCert, Inc.", C=US`|`147C2FD397677DC76DD198E83E7D9D234AA59D1A`

5.6.0+|`CN=DigiCert Trusted G4 Code Signing RSA4096 SHA384 2021 CA1, O="DigiCert, Inc.", C=US`|`2FCC9148EC2C9AB951C6F9654C0D2ED16AF27738`

5.2.0 - 5.5.0|`CN=DigiCert SHA2 Assured ID Code Signing CA, OU=www.digicert.com, O=DigiCert Inc, C=US`|`C7B0582906E5205B8399D92991694A614D0C0B22`

4.10.0 - 5.1.1|`CN=DigiCert SHA2 Assured ID Code Signing CA, OU=www.digicert.com, O=DigiCert Inc, C=US`|`7B9157664392D633EDA2C0248605C1C868EBDE43`

4.4.3 - 4.9.0|`CN=DigiCert SHA2 Assured ID Code Signing CA, OU=www.digicert.com, O=DigiCert Inc, C=US`|`CC1168BAFCDA3B1A5E532DA87E80A4DD69BCAEB1`

3.0.3 - 4.4.2|No Certificate Found|No Certificate Found

3.4.0|`CN=Microsoft Windows Production PCA 2011, O=Microsoft Corporation, L=Redmond, S=Washington, C=US`|`71F53A26BB1625E466727183409A30D03D7923DF`

In all cases, except for version 3.4.0 that was signed directly by Microsoft, the Authenticode issuer for certificate is `CN=Jakub Jareš, O=Jakub Jareš, L=Praha, C=CZ`.

To successfully update the module when certificate changed, you need to provide `-SkipPublisherCheck` to the `Install-Module` command.

## Features

### Test runner

Pester runs your tests and prints a nicely formatted output to the screen.

![test run output](images/readme/output.PNG)

Command line output is not the only output option, Pester also integrates with Visual Studio Code, Visual Studio, and any tool that can consume nUnit XML output.

### Assertions

Pester comes with a suite of assertions that cover a lot of common use cases. Pester assertions range from very versatile, like `Should -Be`, to specialized like `Should -Exists`. Here is how you ensure that a file exists:

```powershell

Describe 'Notepad' {

    It 'Exists in Windows folder' {

        'C:\Windows\notepad.exe' | Should -Exist

    }

}

```

Learn more about assertions in [our documentation](https://pester.dev/docs/assertions/should-command).

### Mocking

Pester has mocking built-in. Using mocks you can easily replace functions with empty implementation to avoid changing the real environment.

```powershell

function Remove-Cache {

    Remove-Item "$env:TEMP\cache.txt"

}

Describe 'Remove-Cache' {

    It 'Removes cached results from temp\cache.text' {

        Mock -CommandName Remove-Item -MockWith {}

        Remove-Cache

        Should -Invoke -CommandName Remove-Item -Times 1 -Exactly

    }

}

```

Learn more [about Mocking here](https://pester.dev/docs/usage/mocking).

### Code coverage

Pester can measure how much of your code is covered by tests and export it to JaCoCo format that is easily understood by build servers.

![JaCoCo code coverage report](images/readme/jacoco.PNG)

Learn more about [code coverage here](https://pester.dev/docs/usage/code-coverage).

### Build server integration

Pester integrates nicely with TFS, AppVeyor, TeamCity, Jenkins and other CI servers.

Testing your scripts, and all pull requests on AppVeyor is extremely simple. Just commit this `appveyor.yml` file to your repository, and select your repository on the AppVeyor website:

```yml

version: 1.0.{build}

image:

  - Visual Studio 2017

  - Ubuntu

install:

  - ps: Install-Module Pester -Force -Scope CurrentUser

build: off

test_script:

  - ps: Invoke-Pester -EnableExit

```

See it [in action here!](https://ci.appveyor.com/project/nohwnd/planets)

If you do not need to test your scripts against PowerShell Core, just simply remove the entire line mentioning Ubuntu.

Pester itself is built on AzureDevOps, and distributed mainly via PowerShell gallery.

[![Build Status](https://nohwnd.visualstudio.com/Pester/_apis/build/status/Pester%20PR?branchName=main)](https://nohwnd.visualstudio.com/Pester/_build/latest?definitionId=6&branchName=main) [![latest version](https://img.shields.io/powershellgallery/v/Pester.svg?label=latest+version)](https://www.powershellgallery.com/packages/Pester) [![downloads](https://img.shields.io/powershellgallery/dt/Pester.svg?label=downloads)](https://www.powershellgallery.com/packages/Pester)

## Further reading

Do you like what you see? Learn how to use Pester with our [quick start guide](https://pester.dev/docs/quick-start).

## Got questions?

Got questions or you just want to get in touch? Use our issues page or one of these channels:

[![Pester Twitter](images/readme/twitter-64.PNG)](https://twitter.com/PSPester) [![Pester on StackOverflow](images/readme/stack-overflow-64.PNG)](https://stackoverflow.com/questions/tagged/pester) [![Testing channel on Powershell Slack](images/readme/slack-64.PNG)](https://powershell.slack.com/messages/C03QKTUCS) [![Testing channel on Powershell Discord](images/readme/discord-64.PNG)](https://discord.gg/powershell) or try github discussions .

## Sponsored by

Pester is sponsored by [Octopus Deploy](https://octopus.com).



As well as all the great folks on [OpenCollective](https://opencollective.com/pester) and [GitHub](https://github.com/users/nohwnd/sponsorship#sponsors).

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [Contribute code](CONTRIBUTING.md).



### Financial Contributors on Open Collective

Become a financial contributor and help us sustain our community. [Contribute to Pester Open Collective](https://opencollective.com/Pester/contribute).

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute](https://opencollective.com/Pester/contribute)