Pester v5

.azure-pipelines-ci/templates/test-powershell.yaml

@@ -15,5 +15,5 @@ steps:
 - task: PublishTestResults@2
   inputs:
     testRunner: NUnit
-    testResultsFiles: 'TestResults.xml'
+    testResultsFiles: 'testResults.xml'
   condition: succeededOrFailed()

README.md

@@ -108,7 +108,7 @@ Note: the PSScriptAnalyzer Chocolatey package is provided and supported by the c
 #### Requirements
 
 * [.NET Core 3.1.102 SDK](https://www.microsoft.com/net/download/dotnet-core/3.1#sdk-3.1.102) or newer patch release
-* [Pester v4 PowerShell module, available on PowerShell Gallery](https://github.com/pester/Pester)
+* [Pester v5 PowerShell module, available on PowerShell Gallery](https://github.com/pester/Pester)
 * [PlatyPS PowerShell module, available on PowerShell Gallery](https://github.com/PowerShell/platyPS/releases)
 * Optionally but recommended for development: [Visual Studio 2017/2019](https://www.visualstudio.com/downloads/)
 

Tests/DisabledRules/UseTypeAtVariableAssignment.tests.ps1

@@ -1,5 +1,4 @@
-Import-Module -Verbose PSScriptAnalyzer
-$violationMessage = [regex]::Escape('Specify type at the assignment of variable $test')
+$violationMessage = [regex]::Escape('Specify type at the assignment of variable $test')
 $violationName = "PSUseTypeAtVariableAssignment"
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
 $violations = Invoke-ScriptAnalyzer $directory\UseTypeAtVariableAssignment.ps1 | Where-Object {$_.RuleName -eq $violationName}

Tests/Engine/CorrectionExtent.tests.ps1

@@ -1,8 +1,10 @@
-Describe "Correction Extent" {
-    $type = [Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent]
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
 
+Describe "Correction Extent" {
     Context "Object construction" {
         It "creates the object with correct properties" {
+            $type = [Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent]
             $correctionExtent = $obj = New-Object -TypeName $type -ArgumentList 1, 1, 1, 3, "get-childitem", "newfile", "cool description"
 
             $correctionExtent.StartLineNumber | Should -Be 1

Tests/Engine/CustomizedRule.tests.ps1

@@ -1,23 +1,27 @@
-if (-not $IsCoreCLR)
-{
-	# Force Get-Help not to prompt for interactive input to download help using Update-Help
-	# By adding this registry key we turn off Get-Help interactivity logic during ScriptRule parsing
-	$null,"Wow6432Node" | ForEach-Object {
-		try
-		{
-			Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force -ErrorAction SilentlyContinue
-		}
-		catch
-		{
-			# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+BeforeAll {
+	if (-not $IsCoreCLR)
+	{
+		# Force Get-Help not to prompt for interactive input to download help using Update-Help
+		# By adding this registry key we turn off Get-Help interactivity logic during ScriptRule parsing
+		$null,"Wow6432Node" | ForEach-Object {
+			try
+			{
+				Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force -ErrorAction SilentlyContinue
+			}
+			catch
+			{
+				# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
+			}
 		}
 	}
+	$message = "this is help"
+	$measure = "Measure-RequiresRunAsAdministrator"
 }
 
 
-$message = "this is help"
-$measure = "Measure-RequiresRunAsAdministrator"
-
 Describe "Test importing customized rules with null return results" {
     Context "Test Get-ScriptAnalyzer with customized rules" {
         It "will not terminate the engine" {
@@ -38,40 +42,40 @@ Describe "Test importing customized rules with null return results" {
 
 Describe "Test importing correct customized rules" {
 
-	if(-not $IsCoreCLR)
-	{
-		Context "Test Get-Help functionality in ScriptRule parsing logic" {
-			It "ScriptRule help section must be correctly processed when Get-Help is called for the first time" {
-
-				# Force Get-Help to prompt for interactive input to download help using Update-Help
-				# By removing this registry key we force to turn on Get-Help interactivity logic during ScriptRule parsing
-				$null,"Wow6432Node" | ForEach-Object {
-					try
-					{
-						Remove-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -ErrorAction Stop
-					} catch {
-						#Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
-					}
+	# if(-not ([bool] $IsCoreCLR))
+	# {
+	Context "Test Get-Help functionality in ScriptRule parsing logic" -Skip:$IsCoreCLR {
+		It "ScriptRule help section must be correctly processed when Get-Help is called for the first time" {
+
+			# Force Get-Help to prompt for interactive input to download help using Update-Help
+			# By removing this registry key we force to turn on Get-Help interactivity logic during ScriptRule parsing
+			$null,"Wow6432Node" | ForEach-Object {
+				try
+				{
+					Remove-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -ErrorAction Stop
+				} catch {
+					#Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
 				}
+			}
 
-				$customizedRulePath = Invoke-ScriptAnalyzer $PSScriptRoot\TestScript.ps1 -CustomizedRulePath $PSScriptRoot\samplerule\samplerule.psm1 | Where-Object {$_.Message -eq $message}
-				$customizedRulePath.Count | Should -Be 1
+			$customizedRulePath = Invoke-ScriptAnalyzer $PSScriptRoot\TestScript.ps1 -CustomizedRulePath $PSScriptRoot\samplerule\samplerule.psm1 | Where-Object {$_.Message -eq $message}
+			$customizedRulePath.Count | Should -Be 1
 
-				# Force Get-Help not to prompt for interactive input to download help using Update-Help
-				# By adding this registry key we turn off Get-Help interactivity logic during ScriptRule parsing
-				$null,"Wow6432Node" | ForEach-Object {
-					try
-					{
-						Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force -EA SilentlyContinue
-					}
-					catch
-					{
-						# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
-					}
+			# Force Get-Help not to prompt for interactive input to download help using Update-Help
+			# By adding this registry key we turn off Get-Help interactivity logic during ScriptRule parsing
+			$null,"Wow6432Node" | ForEach-Object {
+				try
+				{
+					Set-ItemProperty -Name "DisablePromptToUpdateHelp" -Path "HKLM:\SOFTWARE\$($_)\Microsoft\PowerShell" -Value 1 -Force -EA SilentlyContinue
+				}
+				catch
+				{
+					# Ignore for cases when tests are running in non-elevated more or registry key does not exist or not accessible
 				}
 			}
 		}
 	}
+	# }
 
     Context "Test Get-ScriptAnalyzer with customized rules" {
         It "will show the custom rule" {
@@ -197,8 +201,9 @@ Describe "Test importing correct customized rules" {
             $violations[0].RuleSuppressionID   | Should -Be "MyRuleSuppressionID"
         }
 
-        if (!$testingLibraryUsage)
-		{
+        # if (!$testingLibraryUsage)
+		# {
+		Context "Test Invoke-ScriptAnalyzer with customized rules - Advanced test cases" -Skip:$testingLibraryUsage {
             It "will show the custom rule in the results when given a rule folder path with trailing backslash" {
 				# needs fixing for Linux
 				if (!$IsLinux -and !$IsMacOS)

Tests/Engine/EditableText.tests.ps1

@@ -1,7 +1,12 @@
-$testRootDirectory = Split-Path -Parent $PSScriptRoot
-Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
-$editableTextType = "Microsoft.Windows.PowerShell.ScriptAnalyzer.EditableText"
-$textEditType = "Microsoft.Windows.PowerShell.ScriptAnalyzer.TextEdit"
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+BeforeAll {
+    $testRootDirectory = Split-Path -Parent $PSScriptRoot
+    Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
+    $editableTextType = "Microsoft.Windows.PowerShell.ScriptAnalyzer.EditableText"
+    $textEditType = "Microsoft.Windows.PowerShell.ScriptAnalyzer.TextEdit"
+}
 
 Describe "EditableText class" {
     Context "When a single edit is given for application" {

Tests/Engine/Extensions.tests.ps1

@@ -1,30 +1,36 @@
-$testRootDirectory = Split-Path -Parent $PSScriptRoot
-Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
-
-function Get-Extent {
-    param($line, $startLineNum, $startColumnNum, $endLineNum, $endColumnNum)
-    $scriptPositionType = 'System.Management.Automation.Language.ScriptPosition'
-    $scriptExtentType = 'System.Management.Automation.Language.ScriptExtent'
-    $extentStartPos = New-Object -TypeName $scriptPositionType -ArgumentList $null, $startLineNum, $startColumnNum, $line
-    $extentEndPos = New-Object -TypeName $scriptPositionType -ArgumentList $null, $endLineNum, $endColumnNum, $line
-    New-Object -TypeName $scriptExtentType -ArgumentList $extentStartPos, $extentEndPos
-}
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+BeforeAll {
+    $testRootDirectory = Split-Path -Parent $PSScriptRoot
+    Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
+
+    function Get-Extent {
+        param($line, $startLineNum, $startColumnNum, $endLineNum, $endColumnNum)
+        $scriptPositionType = 'System.Management.Automation.Language.ScriptPosition'
+        $scriptExtentType = 'System.Management.Automation.Language.ScriptExtent'
+        $extentStartPos = New-Object -TypeName $scriptPositionType -ArgumentList $null, $startLineNum, $startColumnNum, $line
+        $extentEndPos = New-Object -TypeName $scriptPositionType -ArgumentList $null, $endLineNum, $endColumnNum, $line
+        New-Object -TypeName $scriptExtentType -ArgumentList $extentStartPos, $extentEndPos
+    }
+
+    function Test-Extent {
+        param(
+            $translatedExtent,
+            $expectedStartLineNumber,
+            $expectedStartColumnNumber,
+            $expectedEndLineNumber,
+            $expectedEndColumnNumber)
+
+        $translatedExtent.StartLineNumber | Should -Be $expectedStartLineNumber
+        $translatedExtent.StartColumnNumber | Should -Be $expectedStartColumnNumber
+        $translatedExtent.EndLineNumber | Should -Be $expectedEndLineNumber
+        $translatedExtent.EndColumnNumber | Should -Be $expectedEndColumnNumber
+    }
 
-function Test-Extent {
-    param(
-        $translatedExtent,
-        $expectedStartLineNumber,
-        $expectedStartColumnNumber,
-        $expectedEndLineNumber,
-        $expectedEndColumnNumber)
-
-    $translatedExtent.StartLineNumber | Should -Be $expectedStartLineNumber
-    $translatedExtent.StartColumnNumber | Should -Be $expectedStartColumnNumber
-    $translatedExtent.EndLineNumber | Should -Be $expectedEndLineNumber
-    $translatedExtent.EndColumnNumber | Should -Be $expectedEndColumnNumber
+    $extNamespace = [Microsoft.Windows.PowerShell.ScriptAnalyzer.Extensions.Extensions]
 }
 
-$extNamespace = [Microsoft.Windows.PowerShell.ScriptAnalyzer.Extensions.Extensions]
 
 Describe "String extension methods" {
     Context "When a text is given to GetLines" {

Tests/Engine/GetScriptAnalyzerRule.tests.ps1

@@ -1,14 +1,20 @@
-$testRootDirectory = Split-Path -Parent $PSScriptRoot
-Import-Module (Join-Path $testRootDirectory 'PSScriptAnalyzerTestHelper.psm1')
-$sa = Get-Command Get-ScriptAnalyzerRule
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
 
-$singularNouns = "PSUseSingularNouns" # this rule does not exist for coreclr version
-$approvedVerbs = "PSUseApprovedVerbs"
-$cmdletAliases = "PSAvoidUsingCmdletAliases"
-$dscIdentical = "PSDSCUseIdenticalParametersForDSC"
+BeforeAll {
+    $sa = Get-Command Get-ScriptAnalyzerRule
+
+    $singularNouns = "PSUseSingularNouns" # this rule does not exist for coreclr version
+    $approvedVerbs = "PSUseApprovedVerbs"
+    $cmdletAliases = "PSAvoidUsingCmdletAliases"
+    $dscIdentical = "PSDSCUseIdenticalParametersForDSC"
+}
 
 Describe "Test available parameters" {
-    $params = $sa.Parameters
+    BeforeAll {
+        $params = $sa.Parameters
+    }
+
     Context "Name parameter" {
         It "has a RuleName parameter" {
             $params.ContainsKey("Name") | Should -BeTrue
@@ -32,7 +38,6 @@ Describe "Test available parameters" {
 			$params.CustomRulePath.Aliases.Contains("CustomizedRulePath") | Should -BeTrue
 		}
     }
-
 }
 
 Describe "Test Name parameters" {
@@ -59,7 +64,7 @@ Describe "Test Name parameters" {
         It "get Rules with no parameters supplied" {
             $defaultRules = Get-ScriptAnalyzerRule
             $expectedNumRules = 64
-            if ((Test-PSEditionCoreClr) -or (Test-PSVersionV3) -or (Test-PSVersionV4))
+            if ($IsCoreCLR -or ($PSVersionTable.PSVersion.Major -eq 3) -or ($PSVersionTable.PSVersion.Major -eq 4))
             {
                 # for PSv3 PSAvoidGlobalAliases is not shipped because
                 # it uses StaticParameterBinder.BindCommand which is
@@ -94,15 +99,16 @@ Describe "Test Name parameters" {
 }
 
 Describe "Test RuleExtension" {
-    $community = "CommunityAnalyzerRules"
-    $measureRequired = "Measure-RequiresModules"
     Context "When used correctly" {
-
-		$expectedNumCommunityRules = 10
-		if ($PSVersionTable.PSVersion -ge [Version]'4.0.0')
-		{
-			$expectedNumCommunityRules = 12
-		}
+        BeforeAll {
+            $community = "CommunityAnalyzerRules"
+            $measureRequired = "Measure-RequiresModules"
+            $expectedNumCommunityRules = 10
+            if ($PSVersionTable.PSVersion -ge [Version]'4.0.0')
+            {
+                $expectedNumCommunityRules = 12
+            }
+        }
         It "with the module folder path" {
             $ruleExtension = Get-ScriptAnalyzerRule -CustomizedRulePath $PSScriptRoot\CommunityAnalyzerRules | Where-Object {$_.SourceName -eq $community}
             $ruleExtension.Count | Should -Be $expectedNumCommunityRules

Tests/Engine/GlobalSuppression.test.ps1

@@ -1,15 +1,12 @@
-# Check if PSScriptAnalyzer is already loaded so we don't
-# overwrite a test version of Invoke-ScriptAnalyzer by
-# accident
-if (!(Get-Module PSScriptAnalyzer) -and !$testingLibraryUsage)
-{
-	Import-Module -Verbose PSScriptAnalyzer
-}
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
 
-$violations = Invoke-ScriptAnalyzer "$PSScriptRoot\GlobalSuppression.ps1"
-$violationsUsingScriptDefinition = Invoke-ScriptAnalyzer -ScriptDefinition (Get-Content -Raw "$PSScriptRoot\GlobalSuppression.ps1")
-$suppression = Invoke-ScriptAnalyzer "$PSScriptRoot\GlobalSuppression.ps1" -Profile "$PSScriptRoot\Profile.ps1"
-$suppressionUsingScriptDefinition = Invoke-ScriptAnalyzer -ScriptDefinition (Get-Content -Raw "$PSScriptRoot\GlobalSuppression.ps1") -Profile "$PSScriptRoot\Profile.ps1"
+BeforeAll {
+    $violations = Invoke-ScriptAnalyzer "$PSScriptRoot\GlobalSuppression.ps1"
+    $violationsUsingScriptDefinition = Invoke-ScriptAnalyzer -ScriptDefinition (Get-Content -Raw "$PSScriptRoot\GlobalSuppression.ps1")
+    $suppression = Invoke-ScriptAnalyzer "$PSScriptRoot\GlobalSuppression.ps1" -Profile "$PSScriptRoot\Profile.ps1"
+    $suppressionUsingScriptDefinition = Invoke-ScriptAnalyzer -ScriptDefinition (Get-Content -Raw "$PSScriptRoot\GlobalSuppression.ps1") -Profile "$PSScriptRoot\Profile.ps1"
+}
 
 Describe "GlobalSuppression" {
     Context "Exclude Rule" {

Tests/Engine/Helper.tests.ps1

@@ -1,15 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 Describe "Test Directed Graph" {
     Context "When a graph is created" {
-        $digraph = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.DiGraph[string]'
-        $digraph.AddVertex('v1');
-        $digraph.AddVertex('v2');
-        $digraph.AddVertex('v3');
-        $digraph.AddVertex('v4');
-        $digraph.AddVertex('v5');
+        BeforeAll {
+            $digraph = New-Object -TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.DiGraph[string]'
+            $digraph.AddVertex('v1');
+            $digraph.AddVertex('v2');
+            $digraph.AddVertex('v3');
+            $digraph.AddVertex('v4');
+            $digraph.AddVertex('v5');
 
-        $digraph.AddEdge('v1', 'v2');
-        $digraph.AddEdge('v1', 'v5');
-        $digraph.AddEdge('v2', 'v4');
+            $digraph.AddEdge('v1', 'v2');
+            $digraph.AddEdge('v1', 'v5');
+            $digraph.AddEdge('v2', 'v4');
+        }
 
         It "correctly adds the vertices" {
             $digraph.NumVertices | Should -Be 5

Tests/Engine/InvokeFormatter.tests.ps1

@@ -1,5 +1,10 @@
-$testRootDirectory = Split-Path -Parent $PSScriptRoot
-Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+BeforeAll {
+    $testRootDirectory = Split-Path -Parent $PSScriptRoot
+    Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
+}
 
 Describe "Invoke-Formatter Cmdlet" {
     Context "Cmdlet cleans up and has no knock on effect" {