Public/Install-OriAzBopPrerequisite.ps1

<#
.SYNOPSIS
    Install modules required from PSGallery
.DESCRIPTION
    Install modules required from PSGallery
 
.PARAMETER Name
    Specifies the exact names of modules to install from the online gallery. The module name must match the module name in the repository.
 
.PARAMETER Guid
    GUID of the module
 
.PARAMETER MaximumVersion
    Maximum module version
 
.PARAMETER RequiredVersion
    Required module version
 
.PARAMETER Version
    Most likely minimum module version
 
.PARAMETER PreRelease
    Name of PreRelease
     
.PARAMETER SkipImport
    When is set Import-Module will be skipped
 
.PARAMETER AllowClobber
    When is set AllowClobber will be used
 
.PARAMETER SkipPublisherCheck
    When is set SkipPublisherCheck will be used
 
.PARAMETER SkipPublisherCheck
    When is set SkipPublisherCheck will be used
 
.PARAMETER AllowPrerelease
    When is set AllowPrerelease will be used
.PARAMETER Proxy
    Use it when is required to use proxy while accessing the repository
.PARAMETER ProxyCredential
    Use it when is required to use proxy with credential
 
.EXAMPLE
    Install-OriAzBopPrerequisite -Name PowerShellGet -MinimumVersion 2.2.3
#>

function Install-OriAzBopPrerequisite {
    [CmdLetBinding()]
    param (
        [Parameter(Mandatory = $true, HelpMessage = "Exact name of the module")]
        [String] $Name,

        [Parameter(Mandatory = $false, HelpMessage = "GUID of the mmodule")]
        [string] $Guid,
    
        [Parameter(Mandatory = $false, HelpMessage = "Maximum module version")]
        [Version] $MaximumVersion,
    
        [Parameter(Mandatory = $false, HelpMessage = "Required module version")]
        [Version] $RequiredVersion,
    
        [Parameter(Mandatory = $false, HelpMessage = "Minimum module version")]
        [Alias('Version')]
        [Version] $MinimumVersion,

        [Parameter(Mandatory = $false, HelpMessage = "Name of PreRelease")]
        [String] $PreRelease,        

        [Parameter(Mandatory = $false, HelpMessage = "When is set import-module will be skipped.")]
        [switch] $SkipImport,

        [Parameter(Mandatory = $false, HelpMessage = "When is set AllowClobber will be used.")]
        [switch] $AllowClobber,
        
        [Parameter(Mandatory = $false, HelpMessage = "When is set SkipPublisherCheck will be used.")]
        [switch] $SkipPublisherCheck,
        
        [Parameter(Mandatory = $false, HelpMessage = "When is set AllowPrerelease will be used.")]
        [switch] $AllowPrerelease,

        [Parameter(Mandatory = $false, HelpMessage = "Use it when is required to use proxy while accessing the repository")]
        [Uri] $Proxy = $null,
    
        [Parameter(Mandatory = $false, HelpMessage = "Use it when is required to use proxy with credential")]
        [PSCredential] $ProxyCredential = $null
    
    )
    $ErrorActionPreference = 'Stop'
    Write-Verbose -Message ("[ START: {0}:{1} (v.{2}) ]" -f $Local:MyInvocation.MyCommand.Source, $Local:MyInvocation.MyCommand.Name, $Local:MyInvocation.MyCommand.Version)
    foreach ($arg in $PSBoundParameters.GetEnumerator()) {
        if ([string]::IsNullOrEmpty($arg.Value)) {
            Write-Debug -Message ("[null] {0}: {1}" -f $arg.Key, $arg.Value) -ErrorAction SilentlyContinue 
        }
        else {
            Write-Debug -Message ("[{2}] {0}: {1}" -f $arg.Key, $arg.Value, $arg.Value.GetType().Name) -ErrorAction SilentlyContinue 
        }
    }

    if ($SkipImport.IsPresent) {
        Write-Verbose "SkipImport: true"
    }
    else {
        Write-Verbose "SkipImport: false"
    }
    if ($AllowClobber.IsPresent) {
        Write-Verbose "AllowClobber: true"
    }
    else {
        Write-Verbose "AllowClobber: false"
    }
    if ($SkipPublisherCheck.IsPresent) {
        Write-Verbose "SkipPublisherCheck: true"
    }
    else {
        Write-Verbose "SkipPublisherCheck: false"
    }
    if ($AllowPrerelease.IsPresent) {
        Write-Verbose "AllowPrerelease: true"
    }
    else {
        Write-Verbose "AllowPrerelease: false"
    }

    $InstallParam = @{ 
        Name = $Name 
    }

    if (![string]::IsNullOrEmpty($Proxy)) {
        $InstallParam += @{ Proxy = $Proxy }
    }
    if (![string]::IsNullOrEmpty($ProxyCredential)) {
        $InstallParam += @{ ProxyCredential = $ProxyCredential }
    }

    if (![string]::IsNullOrEmpty($RequiredVersion)) {
        if ([string]::IsNullOrEmpty($PreRelease)) {
            $InstallParam += @{ RequiredVersion = $RequiredVersion }
        }
        else {
            $InstallParam += @{ RequiredVersion = '{0}-{1}' -f $RequiredVersion, $PreRelease }
        }
    }

    if (![string]::IsNullOrEmpty($MaximumVersion)) {
        $InstallParam += @{ MaximumVersion = $MaximumVersion }
    }
    if (![string]::IsNullOrEmpty($MinimumVersion)) {
        $InstallParam += @{ MinimumVersion = $MinimumVersion }
    }

    [bool] $installRequired = $false

    [array] $AllInstalled = Get-Module -Name $Name -ListAvailable | Sort-Object -Property Version -Descending 
    if ($AllInstalled.Count -eq 0) {
        Write-Debug "The module $Name is not installed."
        $installRequired = $true
    }
    else {
        [string] $ListOfInstalledVersions = $AllInstalled.Version -join ','
        Write-Debug "The module $Name is installed once or multiple times [$ListOfInstalledVersions]."

        # Evaluate the installed version vs required version + PreRelease
        $MatchingVersion = $AllInstalled | Where-Object { `
            ([string]::IsNullOrEmpty($RequiredVersion) -or $_.Version -eq $RequiredVersion) `
                -and `
            ([string]::IsNullOrEmpty($PreRelease) -or $_.PrivateData.PSData.Prerelease -eq $PreRelease) `
                -and `
            ([string]::IsNullOrEmpty($MaximumVersion) -or $_.Version -le $MaximumVersion) `
                -and `
            ([string]::IsNullOrEmpty($MinimumVersion) -or $_.Version -ge $MinimumVersion)
        } | Sort-Object Version -Descending
        if ($MatchingVersion.Count -eq 0) {
            Write-Debug "The module $Name does not have a matching required version [$RequiredVersion] PreRelease[$PreRelease], MaximumVersion [$MaximumVersion], MinimumVersion [$MinimumVersion]."
            $installRequired = $true
        }
        else {
            [PSCustomObject[]] $InstalledVersions = $MatchingVersion `
            | ForEach-Object {
                [string] $xVersion = $_.Version
                [string] $xPreRelease = ""
                if (![string]::IsNullOrEmpty($_.PrivateData) `
                        -and ![string]::IsNullOrEmpty($_.PrivateData.PSData) `
                        -and ![string]::IsNullOrEmpty($_.PrivateData.PSData.Prerelease)) {
                    $xPreRelease = $_.PrivateData.PSData.Prerelease
                }
                
                return [PSCustomObject]@{
                    Version    = $xVersion
                    PreRelease = $xPreRelease
                }
            }
            
            [string[]] $InstalledVersionsArrToPrint = $InstalledVersions `
            | ForEach-Object { 
                [string] $toReturn = $_.Version
                if (![string]::IsNullOrEmpty($_.PreRelease)) {
                    $toReturn = $_.Version + "-" + $_.PreRelease 
                }
                return $toReturn
            }

            [string] $InstalledVersionsToPrint = $InstalledVersionsArrToPrint -join ', '
            
            Write-Debug "The module $Name is installed in version [$InstalledVersionsToPrint] and meets the required [$RequiredVersion] PreRelease[$PreRelease] version constraints."
        }
    }

    # The SkipPublisherCheck has been added due to new version of PowerShellGet 2.2.4 with dependency on PackageManagement 1.4.6
    # The PackageManagement 1.4.6 is quite every where and has been already required while installation of PowerShellGet 2.2.3
    # However while the installation process is the PackageManagement 1.4.6 already loaded
    # and is not possible to override PackageManagement (it is cycle)
    # The solution is the SkipPublisherCheck flag
    if ($SkipPublisherCheck.IsPresent) {
        $InstallParam += @{ 
            SkipPublisherCheck = $True 
        }
    }
    if ($AllowClobber.IsPresent) {
        $InstallParam += @{ 
            AllowClobber = $True 
        }
    }
    if ($AllowPrerelease.IsPresent) {
        $InstallParam += @{ 
            AllowPrerelease = $True 
        }
    }
    

    if ($installRequired) {
        Invoke-OriAzExrExceptionRetry `
            -ListedExceptions @('Access to the path*is denied.') `
            -ScriptBlockToRun {
            Install-Module `
                @InstallParam `
                -Repository PSGallery `
                -Force `
                -Confirm:$false `
                -Verbose:$VerbosePreference `
                -Debug:$DebugPreference 
        }
    }
    
    if ($SkipImport.IsPresent) {
        Write-Debug "Skip of Import-Module"
    }
    else {
        $ImportedParam = @{ 
            ModuleName = $Name 
        }
        $ImportParam = @{
            Name = $Name
        }
        if (![string]::IsNullOrEmpty($MinimumVersion)) {
            $ImportedParam += @{ ModuleVersion = $MinimumVersion }
        }
        if (![string]::IsNullOrEmpty($MaximumVersion)) {
            $ImportedParam += @{ MaximumVersion = $MaximumVersion }
        }
        if (![string]::IsNullOrEmpty($RequiredVersion)) {
            $ImportedParam += @{ RequiredVersion = $RequiredVersion }
        }

        Write-Debug "Load of imported modules [$(ConvertTo-Json -InputObject $ImportedParam)] "

        if ($ImportedParam.ContainsKey("ModuleName") -and $ImportedParam.Count -gt 1) {
            [Microsoft.PowerShell.Commands.ModuleSpecification] $FullyQualifiedName = $ImportedParam
            $LoadedModules = Get-Module -FullyQualifiedName $FullyQualifiedName
        }
        else {
            $LoadedModules = Get-Module -Name $Name
        }

        if (-not([string]::IsNullOrEmpty($LoadedModules))) {
            Write-Debug "The required module is already loaded. Import skipped."
        }
        else {
            Write-Debug "Load of imported modules at least with same name. [$Name]"
            $LoadedAtLeastModuleName = Get-Module -Name $Name
            Write-Debug "LoadedAtLeastModuleName [$(ConvertTo-Json -InputObject $LoadedAtLeastModuleName -Depth 1)] "
            if (-not([string]::IsNullOrEmpty($LoadedAtLeastModuleName))) {
                Write-Warning "The required module is already loaded, but in different version Name:[$($LoadedAtLeastModuleName.Name)], Version:[$($LoadedAtLeastModuleName.Version)]. Required FullyQualifiedName filter [$(ConvertTo-Json -InputObject $ImportedParam -Depth 3)]. Import skipped."
            }
            else {
                $ImportParam = @{
                    Name = $Name
                }
                if (![string]::IsNullOrEmpty($MinimumVersion)) {
                    $ImportParam += @{ MinimumVersion = $MinimumVersion }
                }
                if (![string]::IsNullOrEmpty($MaximumVersion)) {
                    $ImportParam += @{ MaximumVersion = $MaximumVersion }
                }
                if (![string]::IsNullOrEmpty($RequiredVersion)) {
                    $ImportParam += @{ RequiredVersion = $RequiredVersion }
                }
                Write-Debug "Import paramters ImportParam: [$(ConvertTo-Json -InputObject $ImportParam)]"
                Import-Module @ImportParam `
                    -ErrorAction SilentlyContinue `
                    -Verbose:$VerbosePreference `
                    -Debug:$DebugPreference 
            }
        }

        

    }

    
    Write-Verbose -Message ("[ END: {0} ]" -f $Local:MyInvocation.MyCommand.Name)
}