PowerShell Module: PSPesterTest

Few weeks ago, the customer I was working for has a requirement that all the PowerShell scripts and in-house written modules must be validated against PSScriptAnalyzer as part of the build pipelines before it is implemented to their Azure environments in release pipelines. The validation must be performed using Pester so the test results can be easily consumed in the VSTS projects (i.e. dashboards).

Luckily, I found this blog post: https://blog.kilasuit.org/2016/03/29/invoking-psscriptanalyzer-in-pester-tests-for-each-rule/, so I used this post as the starting point, and created a PowerShell module that performs pester test by invoking PS Script Analyzer rules. I named this module PSPesterTest.

This module contains 2 functions:

  • Test-ImportModule
  • Test-PSScriptAnalyzerRule

Test-ImportModule

This function tests if the module can be imported successfully.

image

Test-PSScriptAnalyzerRule

This function performs Pester Test to test PowerShell scripts using PowerShell Script Analzyer. By default, it tests against all the rules included in the PSScriptAnalyzer module. You can also run additional rules by specifying the –CustomRulePath parameter (i.e. the CommunityAnalyzerRules). By default, the Pester test will flag the test is failed if the Script Analyzer rule is marked as error. There are 3 severity levels: Information, Warning and Error. You can change the minimum level by using the –MinimumSeverityLevel parameter. i.e. if you specify “Information” as the minimum level, any rules that are flagged as Information, Warning and Error will be flagged as failed in the Pester Test.

image

This module really simplified the testing and code validation process in my VSTS pipelines. I started using it not only in the pipelines for PowerShell modules (which I will blog it in the coming days), but also in any Azure related pipelines that include PowerShell scripts (such as automation accounts and runbooks). i.e. when you publish a module to PowerShell Gallery, your code will be tested against PSScriptAnalyzer. So you should ensure PSScriptAnalyzer does not have any error flagged for your module. Using this module, it is a one liner, and when using it in VSTS pipelines, you can also create a widget displaying your test result:

image

The PSPesterTest module has been published on PowerShell Gallery, and the source code is in GitHub:

PSGallery: https://www.powershellgallery.com/packages/PSPesterTest

GitHub: https://github.com/tyconsulting/PSPesterTest-PSModule

Both functions in this module is fully documented in the help file. You can use Get-Help cmdlet to access the help content.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: