[DO NOT MERGE] Pester 6.0.0 release candidate update

Build.ps1

@@ -1,7 +1,7 @@
 #requires -Version 5
 
 [CmdletBinding()]
 Param
 (
     $RootProjectDir,
     $Configuration = 'Release',
@@ -30,11 +30,11 @@
         'powershell-yaml'  = $null
         'ps1xmlgen'        = $null
         'PlatyPS'          = $null
-        'Pester'           = @{ MinimumVersion = '5.0' }
+        'Pester'           = @{ RequiredVersion = '6.0.0-rc4'; AllowPrerelease = $true }
     }
 }
 
 Function Assert-DotNetSdk {
     $dotnet = Get-Command dotnet -ErrorAction SilentlyContinue
     if (-not $dotnet) {
         throw "dotnet SDK not found. Please install .NET SDK 8 or later from https://dotnet.microsoft.com/download"
@@ -53,7 +53,7 @@
     Write-Verbose "dotnet SDK $sdkVersion found"
 }
 
 Function Install-Dependencies {
     Write-Verbose "Restoring missing dependencies"
 
     $dotNetTools = $script:DependencyVersions.DotNetTools
@@ -77,7 +77,7 @@
     }
 }
 
 Function Install-DotNetTool($Tool, $Version) {
     Write-Verbose "Restoring dotnet local tool $Tool $Version"
 
     # Ensure a tool manifest exists
@@ -102,7 +102,7 @@
     dotnet tool install --local $Tool --version $Version *>&1 | Write-Verbose
 }
 
 Function Install-NugetPackage($Package, $Version, $OutputDirectory = 'packages') {
     Write-Verbose "Restoring NuGet package $Package"
 
     $pkgDir = Join-Path $RootProjectDir "$OutputDirectory/$Package"
@@ -118,15 +118,19 @@
     dotnet nuget @addArgs *>&1 | Write-Verbose
 }
 
 Function Install-PsModule($Module, $Version) {
     Write-Verbose "Restoring module $Module"
 
     $minVersion = if ($Version -is [hashtable]) { $Version['MinimumVersion'] } else { $null }
-    $exactVersion = if ($Version -is [hashtable]) { $null } else { $Version }
+    $exactVersion = if ($Version -is [hashtable]) { $Version['RequiredVersion'] } else { $Version }
+    $allowPrerelease = ($Version -is [hashtable]) -and $Version['AllowPrerelease']
 
     $existing = Get-Module $Module -ListAvailable | Sort-Object Version -Descending | Select-Object -First 1
     if ($existing) {
-        if ($exactVersion -and $existing.Version -ne [version]$exactVersion) { <# fall through to install #> }
+        $existingVersion = $existing.Version.ToString()
+        if ($existing.PrivateData.PSData.Prerelease) { $existingVersion = "$existingVersion-$($existing.PrivateData.PSData.Prerelease)" }
+
+        if ($exactVersion -and $existingVersion -ne $exactVersion) { <# fall through to install #> }
         elseif ($minVersion -and $existing.Version -lt [version]$minVersion) { <# fall through to install #> }
         else {
             Write-Verbose "PowerShell module $Module found; Skipping..."
@@ -140,8 +144,9 @@
     }
 
     $installArgs = @{ Name = $Module; Scope = 'CurrentUser'; Force = $true; AllowClobber = $true }
-    if ($exactVersion)  { $installArgs['RequiredVersion'] = $exactVersion }
-    if ($minVersion)    { $installArgs['MinimumVersion']  = $minVersion }
+    if ($exactVersion)     { $installArgs['RequiredVersion'] = $exactVersion }
+    if ($minVersion)       { $installArgs['MinimumVersion']  = $minVersion }
+    if ($allowPrerelease)  { $installArgs['AllowPrerelease'] = $true }
     Install-Module @installArgs | Write-Verbose
 }
 
@@ -200,6 +205,8 @@
 
     $pesterSpec = $script:DependencyVersions.PsModules['Pester']
     $pesterMinVersion = if ($pesterSpec -is [hashtable]) { $pesterSpec['MinimumVersion'] } else { $null }
+    $pesterRequiredVersion = if ($pesterSpec -is [hashtable]) { $pesterSpec['RequiredVersion'] } else { $pesterSpec }
+    $pesterAllowPrerelease = ($pesterSpec -is [hashtable]) -and $pesterSpec['AllowPrerelease']
 
     Invoke-Psake -Nologo -BuildFile $psakeScript -TaskList $Targets -Verbose:$IsVerbose -ErrorAction SilentlyContinue `
         -Parameters @{
@@ -210,12 +217,14 @@
         ModuleDescription = $ModuleDescription
         BuildName         = $BuildName
         BuildNumber       = $ProjectBuildNumber
         VersionMetadata   = $VersionMetadata 
         SkipTests         = $SkipTests.IsPresent
         SkipReleaseNotes  = $SkipReleaseNotes.IsPresent
         Incremental       = $Incremental.IsPresent
         IsCI              = $isCI
-        PesterMinVersion  = $pesterMinVersion
+        PesterMinVersion      = $pesterMinVersion
+        PesterRequiredVersion = $pesterRequiredVersion
+        PesterAllowPrerelease = $pesterAllowPrerelease
     }
 
     Write-Verbose "=== END PSAKE ==="

psake.ps1

@@ -30,7 +30,7 @@
     $CompatiblePSEditions = @('Desktop', 'Core')
     $TfsPackageNames = @('Microsoft.TeamFoundationServer.ExtendedClient', 'Microsoft.VisualStudio.Services.ServiceHooks.WebApi', 'Microsoft.VisualStudio.Services.Release.Client')
     $Copyright = "(c) 2014 ${ModuleAuthor}. All rights reserved."
 
     # Nuget packaging
     $NugetExePath = Join-Path $RootProjectDir 'BuildTools/nuget.exe'
     $NugetPackagesDir = Join-Path $RootProjectDir 'Packages'
@@ -57,6 +57,8 @@
 
     # Test dependencies
     $PesterMinVersion = $null
+    $PesterRequiredVersion = $null
+    $PesterAllowPrerelease = $false
 }
 
 Task Rebuild -Depends Clean, Build {
@@ -74,8 +76,8 @@
 Task CleanOutputDir -PreCondition { -not $Incremental } {
 
     Write-Verbose "Cleaning output path $ModuleDir"
 
     if (Test-Path $ModuleDir -PathType Container) { 
         Remove-Item $ModuleDir -Recurse -Force -ErrorAction SilentlyContinue | Out-Null
     }
 
@@ -113,7 +115,7 @@
     exec { & $xmldocExePath $assemblyFile -out $helpFile -rootUrl $RootUrl | Write-Verbose }
 
     $helpContents = (Get-Content $helpFile -Raw -Encoding utf8)
     $helpTokens = (Invoke-Expression (Get-Content (Join-Path $RootProjectDir 'Docs/CommonHelpText.psd1') -Raw -Encoding utf8))
 
     foreach ($token in $helpTokens.GetEnumerator()) {
         $helpContents = $helpContents -replace $token.Key, $token.Value
@@ -178,22 +180,22 @@
 
 Task UpdateModuleManifest {
 
     Function GetExportedFunctionsList {
         $modulePath = (Join-Path $SolutionDir "TfsCmdlets/bin/$Configuration/$($TargetFrameworks.Desktop)/TfsCmdlets.dll")
         Get-Module TfsCmdlets | Remove-Module
         Import-Module $modulePath
         return @(
             Get-Command -Module TfsCmdlets -ErrorAction SilentlyContinue | 
             Where-Object { $_.Visibility -eq 'Public' } | 
             Sort-Object -Property Name |
             Select-Object -ExpandProperty Name)
 
     }
 
     Function GetFileList {
         return (
             Get-ChildItem -Path $ModuleDir -File -Recurse -Exclude *.resources.dll | 
             Select-Object -ExpandProperty FullName | 
             ForEach-Object { "$($_.SubString($ModuleDir.Length+1))" })
     }
 
@@ -247,15 +249,21 @@
 
     try {
         Write-Output ' == PowerShell Core =='
-        if ($PesterMinVersion) {
+        if ($PesterRequiredVersion) {
+            $allowPrereleaseArg = if ($PesterAllowPrerelease) { '-AllowPrerelease' } else { '' }
+            Exec { pwsh.exe -NonInteractive -NoLogo -Command "if (-not (Get-Module Pester -ListAvailable | Where-Object { `$version = `$_.Version.ToString(); if (`$_.PrivateData.PSData.Prerelease) { `$version = `$version + '-' + `$_.PrivateData.PSData.Prerelease }; `$version -eq '$PesterRequiredVersion' })) { Install-Module Pester -RequiredVersion $PesterRequiredVersion $allowPrereleaseArg -Force -Scope CurrentUser -SkipPublisherCheck -AllowClobber }" }
+        } elseif ($PesterMinVersion) {
             Exec { pwsh.exe -NonInteractive -NoLogo -Command "if (-not (Get-Module Pester -ListAvailable | Where-Object { `$_.Version -ge [version]'$PesterMinVersion' })) { Install-Module Pester -MinimumVersion $PesterMinVersion -Force -Scope CurrentUser -SkipPublisherCheck -AllowClobber }" }
         }
         Exec { pwsh.exe -NonInteractive -NoLogo -Command "`$cfg = New-PesterConfiguration; `$cfg.Run.Exit = `$true; `$cfg.TestResult.Enabled = `$true; `$cfg.Output.Verbosity = '$outputLevel'; `$cfg.Filter.ExcludeTag = @('Desktop', 'Server'); Invoke-Pester -Configuration `$cfg" }
         Move-Item 'testResults.xml' -Destination $OutDir/TestResults-Pester-Core.xml -Force
         Move-Item 'coverage.xml' -Destination $OutDir/Coverage-Pester-Core.xml -Force
 
         Write-Output ' == PowerShell Desktop =='
-        if ($PesterMinVersion) {
+        if ($PesterRequiredVersion) {
+            $allowPrereleaseArg = if ($PesterAllowPrerelease) { '-AllowPrerelease' } else { '' }
+            Exec { powershell.exe -NonInteractive -NoLogo -Command "if (-not (Get-Module Pester -ListAvailable | Where-Object { `$version = `$_.Version.ToString(); if (`$_.PrivateData.PSData.Prerelease) { `$version = `$version + '-' + `$_.PrivateData.PSData.Prerelease }; `$version -eq '$PesterRequiredVersion' })) { Install-Module Pester -RequiredVersion $PesterRequiredVersion $allowPrereleaseArg -Force -Scope CurrentUser -SkipPublisherCheck -AllowClobber }" }
+        } elseif ($PesterMinVersion) {
             Exec { powershell.exe -NonInteractive -NoLogo -Command "if (-not (Get-Module Pester -ListAvailable | Where-Object { `$_.Version -ge [version]'$PesterMinVersion' })) { Install-Module Pester -MinimumVersion $PesterMinVersion -Force -Scope CurrentUser -SkipPublisherCheck -AllowClobber }" }
         }
         Exec { powershell.exe -NonInteractive -NoLogo -Command "`$cfg = New-PesterConfiguration; `$cfg.Run.Exit = `$true; `$cfg.TestResult.Enabled = `$true; `$cfg.Output.Verbosity = '$outputLevel'; `$cfg.Filter.ExcludeTag = @('Core', 'Server'); Invoke-Pester -Configuration `$cfg" }
@@ -269,10 +277,10 @@
 
 Task RemoveEmptyFolders {
 
     Get-ChildItem $ModuleDir -Recurse -Force -Directory | 
     Sort-Object -Property FullName -Descending |
     Where-Object { $($_ | Get-ChildItem -Force | Select-Object -First 1).Count -eq 0 } |
     Remove-Item | Write-Verbose
 }
 
 Task Clean {
@@ -290,7 +298,7 @@
     Get-ChildItem (Join-Path $SolutionDir '*/bin') -Directory | Remove-Item -Recurse
     Get-ChildItem (Join-Path $SolutionDir '*/obj') -Directory | Remove-Item -Recurse
 
 } 
 
 Task ValidateReleaseNotes -PreCondition { -not $SkipReleaseNotes }  {
 
@@ -317,7 +325,7 @@
 
     Write-Verbose "Command line: [$cmdLine]"
 
     Invoke-Expression $cmdLine *>&1 | Write-Verbose
 }
 
 Task PackageChocolatey -Depends PackageNuget, GenerateLicenseFile, GenerateVerificationFile {
@@ -339,14 +347,14 @@
     <projectSourceUrl>$($nuspecXml.package.metadata.projectUrl)</projectSourceUrl>
     <packageSourceUrl>$($nuspecXml.package.metadata.projectUrl)</packageSourceUrl>
 "@
 
     Set-Content $NugetSpecPath -Encoding utf8 -Value ($nuspec.Replace('<!-- choco-extras -->', $chocoExtras))
 
     $cmdLine = "$ChocolateyPath Pack $ChocolateySpecPath -OutputDirectory $ChocolateyDir --Version $ThreePartVersion"
 
     Write-Verbose "Command line: [$cmdLine]"
 
     Invoke-Expression $cmdLine *>&1 | Write-Verbose
 }
 
 Task PackageMsi { #-Depends Build {
@@ -357,7 +365,7 @@
     Copy-Item -Path $WixProjectDir\License.rtf -Destination $ModuleDir -Force
     Copy-Item -Path $RootProjectDir\Assets\*.bmp -Destination $ModuleDir -Force
 
     exec { 
         dotnet build $WixProjectFileName -o $WixOutputPath -v d `
             -p WixSourceDir=$ModuleDir\ `
             -p WixProductVersion=$ThreePartVersion `
@@ -378,7 +386,7 @@
             -p TargetPath=$WixOutputPath\$ModuleName-$ThreePartVersion.msi `
         *>&1 | Write-Verbose
     }
 
     if (-not (Test-Path $MSIDir)) { New-Item $MSIDir -ItemType Directory | Out-Null }
 
     Copy-Item "$WixOutputPath\*.msi" -Destination $MSIDir -Force
@@ -386,19 +394,19 @@
 
 Task PackageWinget -Depends PackageMsi {
 
     Function GetMsiProperty($Path, $Property) {
         try {
             $windowsInstaller = New-Object -ComObject 'WindowsInstaller.Installer'
             $database = $windowsInstaller.GetType().InvokeMember('OpenDatabase', 'InvokeMethod', $null, $windowsInstaller, @((Get-Item -Path $Path).FullName, 0))
             $view = $database.GetType().InvokeMember('OpenView', 'InvokeMethod', $null, $database, ("SELECT Value FROM Property WHERE Property = '$Property'"))
             $view.GetType().InvokeMember('Execute', 'InvokeMethod', $null, $view, $null)
             $record = $view.GetType().InvokeMember('Fetch', 'InvokeMethod', $null, $view, $null)
             $value = ($record.GetType().InvokeMember('StringData', 'GetProperty', $null, $record, 1) -Join '').Replace(' ', '')
 
             $view.GetType().InvokeMember('Close', 'InvokeMethod', $null, $view, $null)
 
             return $value
         } 
         catch {
             Write-Error -Message $_.ToString()
         }
@@ -421,7 +429,7 @@
 
     foreach ($f in (Get-ChildItem $WinGetProjectDir -File)) {
         $outputPath = (Join-Path $WinGetOutDir $f.Name)
         Get-Content $f.FullName -Raw | Invoke-Expression | Out-File $outputPath -Force
     }
 }
 
@@ -458,7 +466,7 @@
         <description>$($SourceManifest.Description)</description>
         <releaseNotes><![CDATA[$($SourceManifest.ReleaseNotes)]]></releaseNotes>
         <copyright>$($SourceManifest.Copyright)</copyright>
         <tags>$($SourceManifest.Tags -Join ' ')</tags>
         <!-- choco-extras -->
     </metadata>
 </package>
@@ -468,13 +476,13 @@
 }
 
 Task GenerateLicenseFile {
 
     $outLicenseFile = Join-Path $ChocolateyToolsDir 'LICENSE.txt'
 
     if (-not (Test-Path $ChocolateyToolsDir -PathType Container)) {
         New-Item $ChocolateyToolsDir -Force -ItemType Directory | Write-Verbose
     }
 
     Copy-Item $RootProjectDir\LICENSE.md $outLicenseFile -Force -Recurse
 
     $specFiles = Get-ChildItem $NugetPackagesDir -Include *.nuspec -Recurse
@@ -539,7 +547,7 @@
 
 }
 
 Function _IsUpToDate($Inputs, $Output) {
     if (-not $Incremental -or (-not (Test-Path $Output))) {
         return $false
     }
@@ -547,10 +555,10 @@
     if ($Output -isnot [System.IO.FileSystemInfo]) {
         $Output = Get-ChildItem $Output
     }
 
     foreach ($input in $Inputs) {
         if ($input -isnot [System.IO.FileSystemInfo]) {
             $input = Get-ChildItem $input
         }
 
         if ($input.LastWriteTimeUtc -gt $Output.LastWriteTimeUtc) {