Public/Authentication/Update-JCModule.ps1
|
Function Update-JCModule { Param( [Parameter(HelpMessage = 'Skips the "Uninstall-Module" step that will uninstall old version of the module.')][Switch]$SkipUninstallOld , [Parameter(HelpMessage = 'ByPasses user prompts.')][Switch]$Force ) Begin { $ModuleName = 'JumpCloud' # Get the version of the module installed locally $InstalledModulePreUpdate = Get-InstalledModule -Name:($ModuleName) -AllVersions -ErrorAction:('Ignore') # Get module info from GitHub - This should not impact the auto update ability, only the banner message $ModuleBanner = Get-ModuleBanner $ModuleChangeLog = Get-ModuleChangeLog # To change update dependency from PowerShell Gallery to Github flip the commented code below ###### $UpdateTrigger = $ModuleBanner.'Latest Version' $UpdateTrigger = (Find-Module -Name:($ModuleName)).Version # Get the release notes for a specific version $ModuleChangeLogLatestVersion = $ModuleChangeLog | Where-Object { $_.Version -eq $UpdateTrigger } # To change update dependency from PowerShell Gallery to Github flip the commented code below ###### $LatestVersionReleaseDate = $ModuleChangeLogLatestVersion.'RELEASE DATE' $LatestVersionReleaseDate = (Find-Module -Name:($ModuleName) | ForEach-Object { $_.Version + ' (' + (Get-Date $_.PublishedDate).ToString('MMMM dd, yyyy') + ')' }) # Build welcome page $WelcomePage = New-Object -TypeName:('PSCustomObject') | Select-Object ` @{Name = 'MESSAGE'; Expression = { $ModuleBanner.'Banner Current' } } ` , @{Name = 'INSTALLED VERSION(S)'; Expression = { $InstalledModulePreUpdate | ForEach-Object { $_.Version + ' (' + (Get-Date $_.PublishedDate).ToString('MMMM dd, yyyy') + ')' } } } ` , @{Name = 'LATEST VERSION'; Expression = { $UpdateTrigger + ' (' + (Get-Date $LatestVersionReleaseDate).ToString('MMMM dd, yyyy') + ')' } } ` , @{Name = 'RELEASE NOTES'; Expression = { $ModuleChangeLogLatestVersion.'RELEASE NOTES' } } ` , @{Name = 'FEATURES'; Expression = { $ModuleChangeLogLatestVersion.'FEATURES' } } ` , @{Name = 'IMPROVEMENTS'; Expression = { $ModuleChangeLogLatestVersion.'IMPROVEMENTS' } } ` , @{Name = 'BUG FIXES'; Expression = { $ModuleChangeLogLatestVersion.'BUG FIXES' } } ` , @{Name = 'Learn more about the ' + $ModuleName + ' PowerShell module here'; Expression = { 'https://github.com/TheJumpCloud/support/wiki' } } } Process { # Load color scheme $JCColorConfig = Get-JCColorConfig Try { # Check to see if module is already installed If ([System.String]::IsNullOrEmpty($InstalledModulePreUpdate)) { Write-Error ('The ' + $ModuleName + ' PowerShell module is not currently installed. To install the module please run the following command: Install-Module -Name ' + $ModuleName + ' -force;' ) } Else { # Populate status message $Status = If ($UpdateTrigger -notin $InstalledModulePreUpdate.Version) { 'An update is available for the ' + $ModuleName + ' PowerShell module.' } ElseIf ($UpdateTrigger -in $InstalledModulePreUpdate.Version) { 'The ' + $ModuleName + ' PowerShell module is up to date.' } Else { Write-Error ('Unable to determine ' + $ModuleName + ' PowerShell module install status.') } $WelcomePage = $WelcomePage | Select-Object @{Name = 'STATUS'; Expression = { $Status } }, * # Display message $WelcomePage.PSObject.Properties.Name | ForEach-Object { If (-not [System.String]::IsNullOrEmpty($WelcomePage.($_))) { Write-Host (($_) + ': ') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Header) $WelcomePage.($_).Trim() -split ("`n") | ForEach-Object { If (-not [System.String]::IsNullOrEmpty(($_))) { Write-Host ($JCColorConfig.IndentChar) -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Indentation) -NoNewline If (($_) -like '*http*' -or ($_) -like '*www.*' -or ($_) -like '*.com*') { Write-Host (($_).Trim())-BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Url) } ElseIf (($_) -like '*!!!*') { Write-Host (($_).Replace('!!!', '').Trim())-BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Important) } Else { Write-Host (($_).Trim())-BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Body) } } } } } # Check to see if the module version on the PowerShell Gallery does not match the local module version begin the update process (update existing module) If ($UpdateTrigger -notin $InstalledModulePreUpdate.Version) { # Ask user if they want to update the module If (!($Force)) { Do { Write-Host ('Enter ''Y'' to update the ' + $ModuleName + ' PowerShell module to the latest version or enter ''N'' to cancel:') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_UserPrompt) -NoNewline Write-Host (' ') -NoNewLine $UserInput = Read-Host } Until ($UserInput.ToUpper() -in ('Y', 'N')) } Else { $UserInput = 'Y' } If ($UserInput.ToUpper() -eq 'N') { Write-Host ('Exiting the ' + $ModuleName + ' PowerShell module update process.') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Action) } Else { # Update the module to the latest version Write-Host ('Updating ' + $ModuleName + ' module to version: ') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Action) -NoNewline Write-Host ($UpdateTrigger) -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Body) $InstalledModulePreUpdate | Update-Module -Force # Remove existing module from the session Get-Module -Name:($ModuleName) -ListAvailable -All | Remove-Module -Force # Uninstall previous versions If (!($SkipUninstallOld)) { $InstalledModulePreUpdate | ForEach-Object { Write-Host ('Uninstalling ' + $_.Name + ' module version: ') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Action) -NoNewline Write-Host ($_.Version) -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Body) $_ | Uninstall-Module -Force } } # Validate install $InstalledModulePostUpdate = Get-InstalledModule -Name:($ModuleName) -AllVersions # Check to see if the module version on the PowerShell gallery does not match the local module version If ($UpdateTrigger -in $InstalledModulePostUpdate.Version) { # Load new module Import-Module -Name:($ModuleName) -Scope:('Global') -Force # Confirm to user module update has been successful Write-Host ('STATUS:') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Header) Write-Host ($JCColorConfig.IndentChar) -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Indentation) -NoNewline Write-Host ('The ' + $ModuleName + ' PowerShell module has successfully been updated!') -BackgroundColor:($JCColorConfig.BackgroundColor) -ForegroundColor:($JCColorConfig.ForegroundColor_Body) } Else { Write-Error ('Failed to update the ' + $ModuleName + ' PowerShell module to the latest version.') } } } } } Catch { Write-Error ($_) } } End { } } |