Merge pull request #21 from ChrisLGardner/pester-v5-support

Pester v5 support

Author: ChrisLGardner

Extension/task/HelperModule.psm1 Extension/PesterTask/PesterV10/HelperModule.psm1

@@ -51,7 +51,7 @@ function Import-Pester {
         }
 
         if ($Version -eq "latest") {
-            $NewestPester = Find-Module -Name Pester | Sort-Object Version -Descending | Select-Object -First 1
+            $NewestPester = Find-Module -Name Pester -MinimumVersion 5.0.0 | Sort-Object Version -Descending | Select-Object -First 1
 
             If ((Get-Module Pester -ListAvailable | Sort-Object Version -Descending| Select-Object -First 1).Version -lt $NewestPester.Version) {
                 Install-Module -Name Pester -RequiredVersion $NewestPester.Version -Scope CurrentUser -Force -Repository $NewestPester.Repository -SkipPublisherCheck

Extension/PesterTask/PesterV10/Pester.ps1

@@ -0,0 +1,147 @@
+[CmdletBinding()]
+param
+(
+    [Parameter(Mandatory)]
+    $TestFolder,
+
+    [Parameter(Mandatory)]
+    [ValidateScript( {
+            if ((Test-Path (Split-Path $_ -Parent)) -and ($_.split('.')[-1] -eq 'xml')) {
+                $true
+            }
+            else {
+                Throw "Path is invalid or results file does not end in .xml ($_)"
+            }
+        })]
+    [string]$resultsFile,
+
+    [string]$run32Bit,
+
+    [string]$additionalModulePath,
+
+    [string[]]$Tag,
+
+    [String[]]$ExcludeTag,
+
+    [validateScript( {
+            if ([string]::IsNullOrWhiteSpace($_)) {
+                $true
+            }
+            else {
+                if (-not($_.Split('.')[-1] -eq 'xml')) {
+                    throw "Extension must be XML"
+                }
+                $true
+            }
+        })]
+    [string]$CodeCoverageOutputFile,
+
+    [string]$CodeCoverageFolder,
+
+    [string]$ScriptBlock,
+
+    [string]$TargetPesterVersion = "latest"
+)
+
+if ($TargetPesterVersion -match '^4') {
+    Write-Host "##vso[task.logissue type=error]This version of the task does not support Pester V4, please use task version 9."
+    exit 1
+}
+
+Write-Host "TestFolder $TestFolder"
+Write-Host "resultsFile $resultsFile"
+Write-Host "run32Bit $run32Bit"
+Write-Host "additionalModulePath $additionalModulePath"
+Write-Host "tag $Tag"
+Write-Host "ExcludeTag $ExcludeTag"
+Write-Host "CodeCoverageOutputFile $CodeCoverageOutputFile"
+Write-Host "CodeCoverageFolder $CodeCoverageFolder"
+Write-Host "ScriptBlock $ScriptBlock"
+
+Import-Module -Name (Join-Path $PSScriptRoot "HelperModule.psm1") -Force
+Import-Pester -Version $TargetPesterVersion
+
+if ($run32Bit -eq $true -and $env:Processor_Architecture -ne "x86") {
+    Write-Warning "32bit support is considered deprecated in this version of the task and will be removed in a future major version."
+    # Get the command parameters
+    $args = $myinvocation.BoundParameters.GetEnumerator() | ForEach-Object {
+        if (-not([string]::IsNullOrWhiteSpace($_.Value))) {
+            If ($_.Value -eq 'True' -and $_.Key -ne 'run32Bit' -and $_.Key -ne 'ForceUseOfPesterInTasks') {
+                "-$($_.Key)"
+            }
+            else {
+                "-$($_.Key)"
+                "$($_.Value)"
+            }
+        }
+
+    }
+    write-warning "Re-launching in x86 PowerShell with $($args -join ' ')"
+    &"$env:windir\syswow64\windowspowershell\v1.0\powershell.exe" -noprofile -executionpolicy bypass -file $myinvocation.Mycommand.path $args
+    exit
+}
+Write-Host "Running in $($env:Processor_Architecture) PowerShell"
+
+if ($PSBoundParameters.ContainsKey('additionalModulePath')) {
+    Write-Host "Adding additional module path [$additionalModulePath] to `$env:PSModulePath"
+    $env:PSModulePath = $additionalModulePath + ';' + $env:PSModulePath
+}
+
+$PesterConfig = @{
+
+    Run = @{
+        Path = $TestFolder
+        Exit = $true
+    }
+    TestResult = @{
+        Enabled = $true
+        OutputFormat = 'NUnit2.5'
+        OutputPath = $resultsFile
+    }
+}
+
+$Filter = @{}
+if ($Tag) {
+    $Tag = $Tag.Split(',').Replace('"', '').Replace("'", "")
+    $Filter.Add('Tag', $Tag)
+}
+if ($ExcludeTag) {
+    $ExcludeTag = $ExcludeTag.Split(',').Replace('"', '').Replace("'", "")
+    $Filter.Add('ExcludeTag', $ExcludeTag)
+}
+
+$PesterConfig['Filter'] = $Filter
+
+$CodeCoverage = @{}
+if ($CodeCoverageOutputFile) {
+    $CodeCoverage['Enabled'] = $True
+    $CodeCoverage['OutputFormat'] = "JaCoCo"
+
+    if (-not $PSBoundParameters.ContainsKey('CodeCoverageFolder')) {
+        $CodeCoverageFolder = $TestFolder
+    }
+    $Files = Get-ChildItem -Path $CodeCoverageFolder -include *.ps1, *.psm1 -Exclude *.Tests.ps1 -Recurse |
+        Select-object -ExpandProperty Fullname
+
+    if ($Files) {
+        $CodeCoverage.Add('Path', $Files)
+        $CodeCoverage.Add('OutputPath', $CodeCoverageOutputFile)
+    }
+    else {
+        Write-Warning -Message "No PowerShell files found under [$CodeCoverageFolder] to analyse for code coverage."
+    }
+}
+
+$PesterConfig['CodeCoverage'] = $CodeCoverage
+
+if (-not([String]::IsNullOrWhiteSpace($ScriptBlock))) {
+    $ScriptBlockObject = [ScriptBlock]::Create($ScriptBlock)
+
+    $ScriptBlockObject.Invoke()
+}
+
+$result = Invoke-Pester -Configuration  ([PesterConfiguration]$PesterConfig)
+
+if ($result.failedCount -ne 0) {
+    Write-Error "Pester returned errors"
+}

Extension/task/icon.png Extension/PesterTask/PesterV10/icon.png

@@ -0,0 +1,157 @@
+{
+  "id": "cca5462b-887d-4617-bf3f-dcf0d3c622e9",
+  "name": "Pester",
+  "friendlyName": "Pester Test Runner",
+  "description": "Run Pester tests by either installing the latest version of Pester at run time (if possible) or using the version shipped with the task (5.0.0)",
+  "helpMarkDown": "Version: #{Build.BuildNumber}#. [More Information](https://github.com/pester/AzureDevOpsExtension)",
+  "category": "Test",
+  "visibility": [
+    "Build",
+    "Release"
+  ],
+  "author": "Pester",
+  "version": {
+    "Major": 1,
+    "Minor": 1,
+    "Patch": 0
+  },
+  "demands": [],
+  "minimumAgentVersion": "1.82.0",
+  "groups": [
+    {
+      "name": "tags",
+      "displayName": "Tags",
+      "isExpanded": false
+    },
+    {
+      "name": "advanced",
+      "displayName": "Advanced",
+      "isExpanded": false
+    }
+  ],
+  "inputs": [
+    {
+      "name": "TestFolder",
+      "aliases": [
+        "scriptFolder"
+      ],
+      "type": "string",
+      "label": "Tests Folder",
+      "defaultValue": "$(System.DefaultWorkingDirectory)\\*",
+      "required": true,
+      "helpMarkDown": "Folder containing tests to run from e.g $(System.DefaultWorkingDirectory)\\*"
+    },
+    {
+      "name": "resultsFile",
+      "type": "string",
+      "label": "Results File",
+      "defaultValue": "$(System.DefaultWorkingDirectory)\\Test-Pester.XML",
+      "required": true,
+      "helpMarkDown": "Results File (nUnit format)"
+    },
+    {
+      "name": "CodeCoverageOutputFile",
+      "type": "string",
+      "label": "Code Coverage Output File",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "Code coverage output file (JaCoCo format) - Requires Pester version 4.0.4+"
+    },
+    {
+      "name": "tag",
+      "type": "string",
+      "label": "Tags",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "Tags used to filter which tests to run.",
+      "groupName": "tags"
+    },
+    {
+      "name": "excludeTag",
+      "type": "string",
+      "label": "Exclude Tag",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "Tags to exclude when running tests.",
+      "groupName": "tags"
+    },
+    {
+      "name": "usePSCore",
+      "type": "boolean",
+      "label": "Use PowerShell Core (Windows Only)",
+      "defaultValue": "False",
+      "required": true,
+      "helpMarkDown": "On a Windows agent, if set will run Pester tests with 'pwsh', if false will use 'PowerShell.exe'. On Non-Windows agents 'pwsh' always used",
+      "groupName": "advanced"
+    },
+    {
+      "name": "additionalModulePath",
+      "type": "string",
+      "label": "Path to additional PowerShell modules",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "Adds a path to PSModulePath before running the tests, for dependencies or generated modules",
+      "groupName": "advanced"
+    },
+    {
+      "name": "CodeCoverageFolder",
+      "type": "string",
+      "label": "Code Coverage Folder",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "Path to the folder or file to run coverage against. Requires CodeCoverageOutputFile.",
+      "groupName": "advanced"
+    },
+    {
+      "name": "run32Bit",
+      "type": "boolean",
+      "label": "Run in 32bit",
+      "defaultValue": "False",
+      "required": false,
+      "helpMarkDown": "Run in 32bit, only applicable on Windows agents",
+      "groupName": "advanced",
+      "visibleRule": "usePSCore = False"
+    },
+    {
+      "name": "PesterVersion",
+      "type": "radio",
+      "label": "Pester Version",
+      "defaultValue": "LatestVersion",
+      "required": false,
+      "options": {
+          "LatestVersion": "Latest Available version",
+          "OtherVersion": "Specify other version"
+      },
+      "groupName": "advanced",
+      "helpMarkDown": "Choose which version of Pester to use for your tests, the version specified will be downloaded from an available PS Gallery. If no gallery is available then it will fall back to the version shipped with the task, currently 4.10.1"
+    },
+    {
+        "name": "TargetPesterVersion",
+        "aliases": [
+            "preferredPesterVersion"
+        ],
+        "type": "string",
+        "label": "Preferred Pester PowerShell Version",
+        "defaultValue": "",
+        "required": true,
+        "visibleRule": "PesterVersion = OtherVersion",
+        "groupName": "advanced",
+        "helpMarkDown": "Speicify version of Pester to install if not latest. This will download it from whichever PS Gallery has it available. If it's not available then the task will fail."
+    },
+    {
+      "name": "ScriptBlock",
+      "type": "string",
+      "label": "Pre-Test Scriptblock",
+      "required": false,
+      "helpMarkDown": "A scriptblock to run before tests are executed. This will be run in the scope of the task where Invoke-Pester is run.",
+      "groupName": "advanced"
+    }
+   ],
+  "instanceNameFormat": "Pester Test Runner",
+  "execution": {
+    "Node": {
+      "target": "pesterV10.js",
+      "argumentFormat": ""
+    }
+  }
+}

Extension/PesterTask/PesterV10/task.json

@@ -0,0 +1,73 @@
+function Get-HashtableFromString
+{
+    param
+    (
+        [string]$lineInput
+    )
+
+    # check for empty first
+    If ([String]::IsNullOrEmpty($lineInput.trim(';'))) {
+        return @{}
+    }
+
+    Foreach ($line in ($lineInput -split '(?<=}\s*),')) {
+        $Hashtable = [System.Management.Automation.Language.Parser]::ParseInput($line, [Ref]$null, [Ref]$null).Find({
+            $args[0] -is [System.Management.Automation.Language.HashtableAst]
+        }, $false)
+
+        if ($PSVersionTable.PSVersion.Major -ge 5) {
+            # Use the language parser to safely parse the hashtable string into a real hashtable.
+            $Hashtable.SafeGetValue()
+        }
+        else {
+            Write-Warning -Message "PowerShell Version lower than 5 detected. Performing Unsafe hashtable conversion. Please update to version 5 or above when possible for safe conversion of hashtable."
+            Invoke-Expression -Command $Hashtable.Extent
+        }
+    }
+}
+
+function Import-Pester {
+    [cmdletbinding()]
+    param (
+        [string]$Version
+    )
+
+
+    if ((Get-Module -Name PowerShellGet -ListAvailable) -and
+        (Get-Command Install-Module).Parameters.ContainsKey('SkipPublisherCheck') -and
+        (Get-PSRepository)) {
+
+        try {
+            $null = Get-PackageProvider -Name NuGet -ErrorAction Stop
+        }
+        catch {
+            try {
+                Install-PackageProvider -Name Nuget -RequiredVersion 2.8.5.201 -Scope CurrentUser -Force -Confirm:$false -ErrorAction Stop
+            }
+            catch {
+                Write-Host "##vso[task.logissue type=warning]Falling back to version of Pester shipped with extension. To use a newer version please update the version of PowerShellGet available on this machine."
+                Import-Module -Name (Join-Path $PSScriptRoot "4.10.1\Pester.psd1") -Force -Verbose:$false -Global
+            }
+        }
+
+        if ($Version -eq "latest") {
+            $NewestPester = Find-Module -Name Pester -MaximumVersion 4.99.99 | Sort-Object Version -Descending | Select-Object -First 1
+
+            If ((Get-Module Pester -ListAvailable | Sort-Object Version -Descending| Select-Object -First 1).Version -lt $NewestPester.Version) {
+                Install-Module -Name Pester -RequiredVersion $NewestPester.Version -Scope CurrentUser -Force -Repository $NewestPester.Repository -SkipPublisherCheck
+            }
+        }
+        else {
+            $NewestPester = Find-Module -Name Pester -RequiredVersion $Version | Select-Object -First 1
+
+            Install-Module -Name Pester -RequiredVersion $NewestPester.Version -Scope CurrentUser -Force -Repository $NewestPester.Repository -SkipPublisherCheck
+        }
+
+        Import-Module -Name Pester -RequiredVersion $NewestPester.Version -Verbose:$false -Global
+    }
+    else {
+        Write-Host "##vso[task.logissue type=warning]Falling back to version of Pester shipped with extension. To use a newer version please update the version of PowerShellGet available on this machine."
+        Import-Module -Name (Join-Path $PSScriptRoot "4.10.1\Pester.psd1") -Force -Verbose:$false -Global
+    }
+
+}

Extension/task/4.10.1/Dependencies/Axiom/Axiom.psm1 Extension/PesterTask/PesterV9/4.10.1/Dependencies/Axiom/Axiom.psm1

@@ -43,6 +43,10 @@ param
     [string]$TargetPesterVersion = "latest"
 )
 
+if ($TargetPesterVersion -match '^5') {
+    Write-Host "##vso[task.logissue type=error]This version of the task does not support Pester V5, please use task version 10 or higher."
+    exit 1
+}
 Write-Host "scriptFolder $scriptFolder"
 Write-Host "resultsFile $resultsFile"
 Write-Host "run32Bit $run32Bit"