More Muc Than You Can Handle

PowerShell Pester 2 and 1.2 Released!

After a whirlwind of activity on the Pester codebase I’m happy to announce the latest release of Pester. Versions 1.2 and 2 are identical feature wise except for one subtle difference that I’ll get into soon.

New Expectation and Matcher Syntax

In prior versions of Pester, we have the dot notation expectation and matcher syntax

1
$some_string.should.be("some value")

This required some clever and downright nasty hacks to the PowerShell runtime. This created a few issues for some users and I wanted to get that fixed. It turned out the extension on Object was the root issue so I investigated a pipeline based expectation syntax. Here is the result:

1
2
3
4
5
$deployDir                | Should Be "C:\inetpub\wwwroot\myApp"
"iis:\Sites\myApp"        | Should Exist # this works with any PowerShell provider
"C:\test\rush_albums.txt" | Should Contain 2112
""                        | Should Be NullOrEmpty
{ throw }                 | Should Throw

Negative statements work too:

1
2
3
4
5
2                                   | Should Not Be 1
"C:\temp\deployment_scratch_space"  | Should Not Exist
"C:\test\rush_albums.txt"           | Should Not Contain 5150
1,2,3                               | Should Not Be NullOrEmpty
{ Deploy-Website "superawesome" }   | Should Not Throw

Extending the syntax is simply a matter of adding domain specific expectations, that follow the Pester function naming conventions, to your test suite:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
function PesterBeCanadian($sentence) {
    return ($sentence -match ".*[,\ ]eh.$")
}

function PesterBeCanadianFailureMessage($sentence) {
    return "Expected: {$sentence} to end with 'eh'"
}

function NotPesterBeCanadianFailureMessage($sentence) {
    return "Expected: {$sentence} ended with eh, you hoser!"
}

Describe "a few sentences" {
    Context "when scott says something" {
        It "is Canadian" {
            $what_scott_says = "Good show, eh?"
            $what_scott_says | Should BeCanadian
        }
    }

    Context "when pete hodgson says something" {
        It "is not Canadian" {
            $what_pete_says = "Have you tried testing it with Frank?"
            $what_pete_says | Should Not BeCanadian
        }
    }
}

Pretty cool, eh? I feel that this can lessen the potential bloat of expectations in Pester and allow people to write test suites that fit their infrastructure domain model. The expectations are also very easy to test in isolation. The core matchers are pretty light, but they should be easy to modify now that matchers have test coverage unlike the previous syntax.

Adding your own matcher requires you to add 3 convention following functions. One that is the matcher, and 2 that return failure messages for postive and negative expectations. The biggest problem I see with this method is that if the convention ever changes, I’ll have to be very cautious and make it backwards compatible.

Mocks!

This was released earlier but I didn’t really announce anything. Thanks to Matt Wrock(twitter) Pester has the ability to mock cmdlets. I’m looking forward to trying this out on my next project.

1
2
Mock Get-Location { return "you are home, sir." }
Get-Location | Should Be "you are home, sir."

Description Tagging

Thanks to Rich Siegel, Pester can now run blocks that fit a certain tag.

1
2
3
4
5
6
Describe -Tag "Acceptance" "Website deployment flow" {
    It "..." { ... }
}

# and run it like this:
Invoke-Pester -Tag Acceptance

Xml Reporting

Another contributor is Max Bergmann who added NUnit style xml reporting to Pester runs. We are even using it in Pester’s own CI build. There’s some XML validation bugs that are still being sorted out.

Why 1.2.x and 2.0.x?

The motivation for this release is to fix the issues people have add where a should property is added to every Object. I’m not sure how exactly it was breaking things, but it was messy anyways, and I wanted to get rid of it.

In version 1.2.x, you can disable the old assertions by running Pester with the -DisableLegacyExpectations. This will mean that your test suite has to only use the new pipeline style expectations.

1
2
# version 1.2.x has this switch
Invoke-Pester -DisableLegacyExpectations

For version 2.0.x we disable the old style assertions and you need to explicitly enable them using the -EnableLegacyExpectations switch. In the next significant release we’re going to remove the dot style assertions completely from the codebase.

1
2
# version 2.0.x has this switch
Invoke-Pester -EnableLegacyExpectations

So if you’re upgrading Pester, then you should probably move to 1.2.x first. If you can run your tests with the -DisableLegacyAssertions flag set, then you should be fine to move to 2.0.x. If you’re starting from scratch, then definitely use 2.0.x.

What’s Left To Do?

Lots and lots of documenting. The Get-Help pages need to be updated and I want to get pesterbdd.com up as soon as possible. I think version 2 should be a fairly stable version of Pester.

If you’re interested in contributing to Pester please join the google group.