-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an
install.ps1 script for Windows. (#93)
The `install.sh` script can still be used with Git bash, but hopefully this native PowerShell script is a bit more friendly for Windows users. Fixes #91
- Loading branch information
Showing
4 changed files
with
229 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| #!/usr/bin/env pwsh | ||
| # Copyright 2024 Science project contributors. | ||
| # Licensed under the Apache License, Version 2.0 (see LICENSE). | ||
|
|
||
| <# | ||
| .SYNOPSIS | ||
| Installs the `science.exe` executable. | ||
| .DESCRIPTION | ||
| Downloads and installs the latest version of the science executable by default. | ||
| The download is first verified against the published checksum before being installed. | ||
| The install process will add the science executable to your user PATH environment variable | ||
| if needed as well as to the current shell session PATH for immediate use. | ||
| .PARAMETER Help | ||
| Display this help message. | ||
| .PARAMETER BinDir | ||
| The directory to install the science binary in. | ||
| .PARAMETER NoModifyPath | ||
| Do not automatically add -BinDir to the PATH. | ||
| .PARAMETER Version | ||
| The version of the science binary to install, the latest version by default. | ||
| The available versions can be seen at: | ||
| https://github.com/a-scie/lift/releases | ||
| .PARAMETER Debug | ||
| Enable debug logging. | ||
| .INPUTS | ||
| None | ||
| .OUTPUTS | ||
| The path of the installed science executable. | ||
| .LINK | ||
| Docs https://science.scie.app | ||
| .LINK | ||
| Chat https://scie.app/discord | ||
| .LINK | ||
| Source https://github.com/a-scie/lift | ||
| #> | ||
|
|
||
| param ( | ||
| [Alias('h')] | ||
| [switch]$Help, | ||
|
|
||
| [Alias('d')] | ||
| [string]$BinDir = ( | ||
| # N.B.: PowerShell>=6 supports varargs, but to retain compatibility with older PowerShell, we | ||
| # just Join-Path twice. | ||
| # See: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/join-path?view=powershell-7.4#-additionalchildpath | ||
| Join-Path ( | ||
| Join-Path ([Environment]::GetFolderPath('LocalApplicationData')) 'Programs' | ||
| ) 'Science' | ||
| ), | ||
|
|
||
| [switch]$NoModifyPath, | ||
|
|
||
| [Alias('V')] | ||
| [string]$Version = 'latest/download', | ||
|
|
||
| [switch]$Debug | ||
| ) | ||
|
|
||
| $ErrorActionPreference = 'Stop' | ||
| $DebugPreference = if ($Debug) { 'Continue' } else { 'SilentlyContinue' } | ||
|
|
||
| $ExitActions = @() | ||
|
|
||
| function AtExit( | ||
| [ScriptBlock]$Action, | ||
|
|
||
| [Parameter(ValueFromRemainingArguments=$true)] | ||
| [array]$ArgList = @() | ||
| ) { | ||
| $script:ExitActions += @{ Action = $Action; Args = $ArgList } | ||
| } | ||
|
|
||
| function RunWithAtExit([ScriptBlock]$Action) { | ||
| try { | ||
| & $Action | ||
| } finally { | ||
| foreach ($exitAction in $script:ExitActions) { | ||
| & $exitAction.Action $exitAction.Args | ||
| } | ||
| } | ||
| } | ||
|
|
||
| function Green($Message) { | ||
| Write-Host $Message -ForegroundColor Green | ||
| } | ||
|
|
||
| function Die($Message) { | ||
| Write-Host $Message -ForegroundColor Red | ||
| exit 1 | ||
| } | ||
|
|
||
| function TemporaryDirectory { | ||
| $Tmp = [IO.Path]::GetTempPath() | ||
| $Unique = (New-Guid).ToString('N') | ||
| $TempDir = New-Item -ItemType Directory -Path (Join-Path $Tmp "science-install.$Unique") | ||
| AtExit { param($Dir) Remove-Item -Recurse -Force $Dir; Write-Debug "Removed $Dir" } $TempDir | ||
| $TempDir | ||
| } | ||
|
|
||
| function Fetch([string]$Url, [string]$DestFile) { | ||
| $IrmArgs = @{ Uri = $Url; OutFile = $DestFile } | ||
|
|
||
| # Support for protocol pinning has not always been available. | ||
| # See: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-restmethod?view=powershell-7.4#-sslprotocol | ||
| if ($Host.Version -ge [Version]::new(7, 1)) { | ||
| $IrmArgs["SslProtocol"] = "Tls12,Tls13" | ||
| } elseif ($Host.Version.Major -ge 6) { | ||
| $IrmArgs["SslProtocol"] = "Tls12" | ||
| } | ||
| Invoke-RestMethod @IrmArgs | ||
| } | ||
|
|
||
| function InstallFromUrl([string]$Url) { | ||
| $Sha256Url = "$Url.sha256" | ||
|
|
||
| $Workdir = TemporaryDirectory | ||
| $ScienceExeFile = Join-Path $Workdir 'science.exe' | ||
| $Sha256File = Join-Path $Workdir 'science.exe.sha256' | ||
|
|
||
| Fetch -Url $Url -DestFile $ScienceExeFile | ||
| Fetch -Url $Sha256Url -DestFile $Sha256File | ||
| Green 'Download completed successfully' | ||
|
|
||
| $ExpectedHash = ((Get-Content $Sha256File).Trim().ToLower() -Split '\s+',2)[0] | ||
| $ActualHash = (Get-FileHash $ScienceExeFile -Algorithm SHA256).Hash.ToLower() | ||
| if ($ActualHash -eq $ExpectedHash) { | ||
| Green "Download matched it's expected sha256 fingerprint, proceeding" | ||
| } else { | ||
| Die "Download from $Url did not match the fingerprint at $Sha256Url" | ||
| } | ||
|
|
||
| if (!(Test-Path $BinDir)) { | ||
| New-Item $BinDir -ItemType Directory | Out-Null | ||
| } | ||
| Move-Item $ScienceExeFile $BinDir -Force | ||
| Join-Path $BinDir 'science.exe' | ||
| } | ||
|
|
||
| function Main { | ||
| if ($Help) { | ||
| Get-Help -Detailed $PSCommandPath | ||
| exit 0 | ||
| } | ||
|
|
||
| $Version = switch ($Version) { | ||
| 'latest/download' { 'latest/download' } | ||
| default { "download/v$Version" } | ||
| } | ||
|
|
||
| $Arch = switch -Wildcard ((Get-CimInstance Win32_operatingsystem).OSArchitecture) { | ||
| 'arm*' { 'aarch64' } | ||
| default { 'x86_64' } | ||
| } | ||
|
|
||
| $DownloadURL = "https://github.com/a-scie/lift/releases/$Version/science-fat-windows-$Arch.exe" | ||
|
|
||
| Green "Download URL is: $DownloadURL" | ||
| $ScienceExe = InstallFromUrl -Url $DownloadURL | ||
|
|
||
| $User = [EnvironmentVariableTarget]::User | ||
| $Path = [Environment]::GetEnvironmentVariable('Path', $User) | ||
| if (!(";$Path;".ToLower() -like "*;$BinDir;*".ToLower())) { | ||
| if ($NoModifyPath) { | ||
| Write-Warning @" | ||
| $BinDir is not detected on `$PATH | ||
| You'll either need to invoke $ScienceExe explicitly or else add $BinDir to your PATH. | ||
| "@ | ||
| } else { | ||
| [Environment]::SetEnvironmentVariable('Path', "$Path;$BinDir", $User) | ||
| $Env:Path += ";$BinDir" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| RunWithAtExit { | ||
| Main | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters