Functions/GenXdev.FileSystem/EnsurePester.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.FileSystem Original cmdlet filename : EnsurePester.ps1 Original author : René Vaessen / GenXdev Version : 1.264.2025 ################################################################################ MIT License Copyright 2021-2025 GenXdev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ################################################################################> ############################################################################### <# .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() 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 { # 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 # confirm successful 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 Microsoft.PowerShell.Utility\Write-Error "Failed to install Pester. Error: $PSItem" Microsoft.PowerShell.Utility\Write-Verbose 'Pester installation failed with error.' } } else { # inform that pester is already available Microsoft.PowerShell.Utility\Write-Verbose 'Pester module already installed and imported.' } } end { } } |