Functions/GenXdev.Software/EnsurePester.ps1
|
<############################################################################## Part of PowerShell module : GenXdev.Software Original cmdlet filename : EnsurePester.ps1 Original author : René Vaessen / GenXdev Version : 3.28.2026 ################################################################################ Copyright (c) 2026 René Vaessen / GenXdev Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ################################################################################> ############################################################################### <# .SYNOPSIS Ensures Pester testing framework is available for use. .DESCRIPTION This function verifies if the Pester module is installed in the current PowerShell environment. If not found, it automatically installs it from the PowerShell Gallery and imports it into the current session. This ensures that Pester testing capabilities are available when needed. .EXAMPLE EnsurePester This ensures Pester is installed and ready for use #> function EnsurePester { [CmdletBinding()] param( ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Automatically consent to Pester installation ' + 'and set persistent flag.') )] [switch] $AutoConsent, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Automatically consent to third-party software ' + 'installation and set persistent flag for all packages.') )] [switch] $AutoConsentAllPackages, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ('Only auto consent during session') )] [switch]$SessionOnly ####################################################################### ) begin { # inform user that we're checking pester installation Microsoft.PowerShell.Utility\Write-Verbose 'Checking for Pester module installation...' } process { # attempt silent import of pester to check if it's available Microsoft.PowerShell.Core\Import-Module -Name Pester -ErrorAction SilentlyContinue $found = (Microsoft.PowerShell.Core\Get-Module -Name Pester -ErrorAction SilentlyContinue); # verify if pester module is now loaded in the current session if ((-not $found) -or ($found.Version -lt '5.7.0')) { # notify about installation attempt through verbose and regular output Microsoft.PowerShell.Utility\Write-Verbose 'Pester module not found, attempting installation...' Microsoft.PowerShell.Utility\Write-Host 'Pester not found. Installing Pester...' try { # confirm installation consent before installing Pester $pesterConsent = GenXdev\Confirm-InstallationConsent ` -ApplicationName 'Pester' ` -Source 'PowerShell Gallery' ` -Description 'PowerShell unit testing framework for automated test execution' ` -Publisher 'Pester Team' ` -AutoConsent:$AutoConsent ` -AutoConsentAllPackages:$AutoConsentAllPackages if (-not $pesterConsent) { throw 'Installation consent denied for Pester module' } # install pester module from the powershell gallery $null = PowerShellGet\Install-Module -Name Pester ` -Force ` -SkipPublisherCheck # load the newly installed pester module $null = Microsoft.PowerShell.Core\Import-Module -Name Pester -Force # verify Pester was installed successfully $found = Microsoft.PowerShell.Core\Get-Module -Name Pester -ErrorAction SilentlyContinue if ((-not $found) -or ($found.Version -lt '5.7.0')) { throw 'Pester installation verification failed — module not loaded after installation.' } Microsoft.PowerShell.Utility\Write-Host 'Pester installed successfully.' Microsoft.PowerShell.Utility\Write-Verbose 'Pester module installation and import completed.' } catch { # report any installation failures throw "Failed to install Pester. Error: ${PSItem}" } } else { # inform that pester is already available Microsoft.PowerShell.Utility\Write-Verbose 'Pester module already installed and imported.' } } end { } } |