update install scripts & ci action

Author: ross-weir

.github/workflows/install_ci.yaml

@@ -0,0 +1,29 @@
+# test that install scripts work on all operating systems
+# currently only triggered manually, could be added to the main `ci.yaml`
+# and use a filter to only run jobs if any scripts under `./scripts/install`
+# have been modified.
+name: install_ci
+
+on:
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: tests shell
+        shell: bash
+        run: ./scripts/install/install_test.sh
+      - name: tests powershell
+        if: matrix.os == 'windows-latest'
+        shell: powershell
+        run: ./scripts/install/install_test.ps1
+      - name: tests powershell core
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
+        run: ./scripts/install/install_test.ps1

scripts/install/install.ps1

@@ -0,0 +1,44 @@
+#!/usr/bin/env pwsh
+# Inspired by https://github.com/denoland/deno_install
+
+$ErrorActionPreference = 'Stop'
+
+if ($v) {
+  $Version = "v${v}"
+}
+if ($Args.Length -eq 1) {
+  $Version = $Args.Get(0)
+}
+
+$ErgomaticInstall = $env:ERGOMATIC_INSTALL
+$BinDir = if ($ErgomaticInstall) {
+  "${ErgomaticInstall}\bin"
+} else {
+  "${Home}\.ergomatic\bin"
+}
+
+$ErgomaticExe = "$BinDir\ergomatic.exe"
+$Target = 'x86_64-pc-windows-msvc'
+
+$DownloadUrl = if (!$Version) {
+  "https://github.com/nautls/ergomatic/releases/latest/download/ergomatic-${Target}.exe"
+} else {
+  "https://github.com/nautls/ergomatic/releases/download/${Version}/ergomatic-${Target}.exe"
+}
+
+if (!(Test-Path $BinDir)) {
+  New-Item $BinDir -ItemType Directory | Out-Null
+}
+
+curl.exe -Lo $ErgomaticExe $DownloadUrl
+
+$User = [System.EnvironmentVariableTarget]::User
+$Path = [System.Environment]::GetEnvironmentVariable('Path', $User)
+if (!(";${Path};".ToLower() -like "*;${BinDir};*".ToLower())) {
+  [System.Environment]::SetEnvironmentVariable('Path', "${Path};${BinDir}", $User)
+  $Env:Path += ";${BinDir}"
+}
+
+Write-Output "Ergomatic was installed successfully to ${ErgomaticExe}"
+Write-Output "Run 'ergomatic --help' to get started"
+echo "Stuck? Join the Ergo Platform discord https://discord.gg/ergo-platform-668903786361651200"

scripts/install/install.sh

@@ -1,12 +1,8 @@
 #!/bin/sh
+# Inspired by https://github.com/denoland/deno_install
 
 set -e
 
-if ! command -v unzip >/dev/null; then
-	echo "Error: unzip is required to install Ergomatic" 1>&2
-	exit 1
-fi
-
 if [ "$OS" = "Windows_NT" ]; then
 	target="x86_64-pc-windows-msvc"
 else
@@ -21,10 +17,16 @@ else
 	esac
 fi
 
+if [ "$OS" = "Windows_NT" ]; then
+  ext=".exe"
+else
+  ext=""
+fi
+
 if [ $# -eq 0 ]; then
-	ergomatic_uri="https://github.com/nautls/ergomatic/releases/latest/download/ergomatic-${target}.zip"
+	ergomatic_uri="https://github.com/nautls/ergomatic/releases/latest/download/ergomatic-${target}${ext}"
 else
-	ergomatic_uri="https://github.com/nautls/ergomatic/releases/download/${1}/ergomatic-${target}.zip"
+	ergomatic_uri="https://github.com/nautls/ergomatic/releases/download/${1}/ergomatic-${target}${ext}"
 fi
 
 ergomatic_install="${ERGOMATIC_INSTALL:-$HOME/.ergomatic}"
@@ -35,10 +37,8 @@ if [ ! -d "$bin_dir" ]; then
 	mkdir -p "$bin_dir"
 fi
 
-curl --fail --location --progress-bar --output "$exe.zip" "$ergomatic_uri"
-unzip -d "$bin_dir" -o "$exe.zip"
+curl --fail --location --progress-bar --output "$exe" "$ergomatic_uri"
 chmod +x "$exe"
-rm "$exe.zip"
 
 echo "Ergomatic was installed successfully to $exe"
 if command -v ergomatic >/dev/null; then

scripts/install/install_test.ps1

@@ -0,0 +1,27 @@
+#!/usr/bin/env pwsh
+
+$ErrorActionPreference = 'Stop'
+
+# Test that we can install the latest version at the default location.
+Remove-Item "~\.ergomatic" -Recurse -Force -ErrorAction SilentlyContinue
+$env:ERGOMATIC_INSTALL = ""
+$v = $null; .\scripts\install\install.ps1
+~\.ergomatic\bin\ergomatic.exe --version
+
+# Test that we can install a specific version at a custom location.
+Remove-Item "~\ergomatic-0.0.1" -Recurse -Force -ErrorAction SilentlyContinue
+$env:ERGOMATIC_INSTALL = "$Home\ergomatic-0.0.1"
+$v = "0.0.1"; .\scripts\install\install.ps1
+$ErgomaticVersion = ~\ergomatic-0.0.1\bin\ergomatic.exe --version
+if (!($ErgomaticVersion -like '*0.0.1*')) {
+  throw $ErgomaticVersion
+}
+
+# Test that we can install at a relative custom location.
+Remove-Item "bin" -Recurse -Force -ErrorAction SilentlyContinue
+$env:ERGOMATIC_INSTALL = "."
+$v = "0.0.1"; .\install.ps1
+$ErgomaticVersion = bin\ergomatic.exe --version
+if (!($ErgomaticVersion -like '*0.0.1*')) {
+  throw $ErgomaticVersion
+}

scripts/install/install_test.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+set -e
+
+# Test that we can install the latest version at the default location.
+rm -f ~/.ergomatic/bin/ergomatic
+unset ERGOMATIC_INSTALL
+sh ./scripts/install/install.sh
+~/.ergomatic/bin/ergomatic --version
+
+# Test that we can install a specific version at a custom location.
+rm -rf ~/ergomatic-0.0.1
+export ERGOMATIC_INSTALL="$HOME/ergomatic-0.0.1"
+./scripts/install/install.sh v0.0.1
+~/ergomatic-0.0.1/bin/ergomatic --version | grep 0.0.1
+
+# Test that we can install at a relative custom location.
+export ERGOMATIC_INSTALL="."
+./scripts/install/install.sh v0.0.1
+bin/ergomatic --version | grep 0.0.1