Make installer work on any os/arch

install.sh

@@ -14,7 +14,7 @@ usage() {
   fi
 
   cath << EOF
-Installs code-server for Linux, macOS and FreeBSD.
+Installs code-server.
 It tries to use the system package manager if possible.
 After successful installation it explains how to start using code-server.
 
@@ -48,24 +48,23 @@ Usage:
   --rsh <bin>
       Specifies the remote shell for remote installation. Defaults to ssh.
 
-- For Debian, Ubuntu and Raspbian it will install the latest deb package.
+The detection method works as follows:
-- For Fedora, CentOS, RHEL and openSUSE it will install the latest rpm package.
+  - Debian, Ubuntu, Raspbian: install the deb package from GitHub.
-- For Arch Linux it will install the AUR package.
+  - Fedora, CentOS, RHEL, openSUSE: install the rpm package from GitHub.
-- For any unrecognized Linux operating system it will install the latest standalone
+  - Arch Linux: install from the AUR (which pulls releases from GitHub).
-  release into ~/.local
+  - FreeBSD, Alpine: install from yarn/npm.
+  - macOS: install using Homebrew if installed otherwise install from GitHub.
+  - All others: install the release from GitHub.
 
-- For macOS it will install the Homebrew package.
+We only build releases on GitHub for amd64 and arm64 on Linux and amd64 for
-  - If Homebrew is not installed it will install the latest standalone release
+macOS. When the detection method tries to pull a release from GitHub it will
-    into ~/.local
+fall back to installing from npm when there is no matching release for the
+system's operating system and architecture.
 
-- For FreeBSD or Alpine, it will install the npm package with yarn or npm.
+The standalone method will force installion using GitHub releases. It will not
+fall back to npm so on architectures without pre-built releases this will error.
 
-- If ran on an architecture with no releases, it will install the
+The installer will cache all downloaded assets into ~/.cache/code-server
-  npm package with yarn or npm.
-  - We only have releases for amd64 and arm64 presently.
-  - The npm package builds the native modules on postinstall.
-
-It will cache all downloaded assets into ~/.cache/code-server
 
 More installation docs are at https://coder.com/docs/code-server/v3.10.2/install
 EOF
@@ -82,10 +81,11 @@ echo_latest_version() {
 echo_npm_postinstall() {
   echoh
   cath << EOF
-The npm package has been installed successfully!
+npm package has been installed.
-Please extend your path to use code-server:
+
+Extend your path to use code-server:
   PATH="$NPM_BIN_DIR:\$PATH"
-Please run with:
+Then run with:
   code-server
 EOF
 }
@@ -94,9 +94,20 @@ echo_standalone_postinstall() {
   echoh
   cath << EOF
 Standalone release has been installed into $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION
-Please extend your path to use code-server:
+
+Extend your path to use code-server:
   PATH="$STANDALONE_INSTALL_PREFIX/bin:\$PATH"
-Then you can run:
+Then run with:
+  code-server
+EOF
+}
+
+echo_brew_postinstall() {
+  echoh
+  cath << EOF
+Brew release has been installed.
+
+Run with:
   code-server
 EOF
 }
@@ -104,6 +115,8 @@ EOF
 echo_systemd_postinstall() {
   echoh
   cath << EOF
+$1 package has been installed.
+
 To have systemd start code-server now and restart on boot:
   sudo systemctl enable --now code-server@\$USER
 Or, if you don't want/need a background service you can run:
@@ -120,7 +133,6 @@ main() {
     DRY_RUN \
     METHOD \
     STANDALONE_INSTALL_PREFIX \
-    VERSION \
     OPTIONAL \
     ALL_FLAGS \
     RSH_ARGS \
@@ -198,80 +210,70 @@ main() {
     return
   fi
 
-  VERSION="${VERSION-$(echo_latest_version)}"
   METHOD="${METHOD-detect}"
   if [ "$METHOD" != detect ] && [ "$METHOD" != standalone ]; then
     echoerr "Unknown install method \"$METHOD\""
     echoerr "Run with --help to see usage."
     exit 1
   fi
-  STANDALONE_INSTALL_PREFIX="${STANDALONE_INSTALL_PREFIX-$HOME/.local}"
 
-  OS="$(os)"
+  # These are used by the various install_* functions that make use of GitHub
-  if [ ! "$OS" ]; then
+  # releases in order to download and unpack the right release.
-    echoerr "Unsupported OS $(uname)."
+  CACHE_DIR=$(echo_cache_dir)
-    exit 1
+  STANDALONE_INSTALL_PREFIX=${STANDALONE_INSTALL_PREFIX:-$HOME/.local}
-  fi
+  VERSION=${VERSION:-$(echo_latest_version)}
+  # These can be overridden for testing but shouldn't normally be used as it can
+  # result in a broken code-server.
+  OS=${OS:-$(os)}
+  ARCH=${ARCH:-$(arch)}
 
   distro_name
 
-  ARCH="$(arch)"
+  # Standalone installs by pulling pre-built releases from GitHub.
-  if [ ! "$ARCH" ]; then
-    if [ "$METHOD" = standalone ]; then
-      echoerr "No precompiled releases for $(uname -m)."
-      echoerr 'Please rerun without the "--method standalone" flag to install from npm.'
-      exit 1
-    fi
-    echoh "No precompiled releases for $(uname -m)."
-    install_npm
-    return
-  fi
-
-  if [ "$OS" = "freebsd" ]; then
-    if [ "$METHOD" = standalone ]; then
-      echoerr "No precompiled releases available for $OS."
-      echoerr 'Please rerun without the "--method standalone" flag to install from npm.'
-      exit 1
-    fi
-    echoh "No precompiled releases available for $OS."
-    install_npm
-    return
-  fi
-
-  if [ "$OS" = "linux" ] && [ "$(distro)" = "alpine" ]; then
-    if [ "$METHOD" = standalone ]; then
-      echoerr "No precompiled releases available for alpine."
-      echoerr 'Please rerun without the "--method standalone" flag to install from npm.'
-      exit 1
-    fi
-    echoh "No precompiled releases available for alpine."
-    install_npm
-    return
-  fi
-
-  CACHE_DIR="$(echo_cache_dir)"
-
   if [ "$METHOD" = standalone ]; then
+    if has_standalone; then
       install_standalone
-    return
+      exit 0
+    else
+      echoerr "There are no standalone releases for $ARCH"
+      echoerr "Please try again without '--method standalone'"
+      exit 1
+    fi
   fi
 
-  case "$(distro)" in
+  # DISTRO can be overridden for testing but shouldn't normally be used as it
+  # can result in a broken code-server.
+  DISTRO=${DISTRO:-$(distro)}
+
+  case $DISTRO in
+    # macOS uses brew when available and falls back to standalone. We only have
+    # amd64 for macOS so for anything else use npm.
     macos)
-      install_macos
+      BREW_PATH="${BREW_PATH-brew}"
-      ;;
+      if command_exists "$BREW_PATH"; then
-    debian)
+        install_brew
-      install_deb
+      else
-      ;;
+        echoh "Homebrew not installed."
-    fedora | opensuse)
+        echoh "Falling back to standalone installation."
-      install_rpm
+        npm_fallback install_standalone
-      ;;
+      fi
-    arch)
-      install_aur
       ;;
+    # The .deb and .rpm files are pulled from GitHub and we only have amd64 and
+    # arm64 there and need to fall back to npm otherwise.
+    debian) npm_fallback install_deb ;;
+    fedora | opensuse) npm_fallback install_rpm ;;
+    # Arch uses the AUR package which only supports amd64 and arm64 since it
+    # pulls releases from GitHub so we need to fall back to npm.
+    arch) npm_fallback install_aur ;;
+    # We don't have GitHub releases that work on Alpine or FreeBSD so we have no
+    # choice but to use npm here.
+    alpine | freebsd) install_npm ;;
+    # For anything else we'll try to install standalone but fall back to npm if
+    # we don't have releases for the architecture.
     *)
       echoh "Unsupported package manager."
-      install_standalone
+      echoh "Falling back to standalone installation."
+      npm_fallback install_standalone
       ;;
   esac
 }
@@ -326,45 +328,39 @@ fetch() {
   sh_c mv "$FILE.incomplete" "$FILE"
 }
 
-install_macos() {
+install_brew() {
-  if command_exists brew; then
+  echoh "Installing latest from Homebrew."
-    echoh "Installing from Homebrew."
   echoh
 
-    sh_c brew install code-server
+  sh_c "$BREW_PATH" install code-server
 
-    return
+  echo_brew_postinstall
-  fi
-
-  echoh "Homebrew not installed."
-
-  install_standalone
 }
 
 install_deb() {
-  echoh "Installing v$VERSION deb package from GitHub releases."
+  echoh "Installing v$VERSION of the $ARCH deb package from GitHub."
   echoh
 
   fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server_${VERSION}_$ARCH.deb" \
     "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb"
   sudo_sh_c dpkg -i "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb"
 
-  echo_systemd_postinstall
+  echo_systemd_postinstall deb
 }
 
 install_rpm() {
-  echoh "Installing v$VERSION rpm package from GitHub releases."
+  echoh "Installing v$VERSION of the $ARCH rpm package from GitHub."
   echoh
 
   fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-$ARCH.rpm" \
     "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm"
   sudo_sh_c rpm -i "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm"
 
-  echo_systemd_postinstall
+  echo_systemd_postinstall rpm
 }
 
 install_aur() {
-  echoh "Installing from the AUR."
+  echoh "Installing latest from the AUR."
   echoh
 
   sh_c mkdir -p "$CACHE_DIR/code-server-aur"
@@ -375,11 +371,11 @@ install_aur() {
   fi
   sh_c makepkg -si
 
-  echo_systemd_postinstall
+  echo_systemd_postinstall AUR
 }
 
 install_standalone() {
-  echoh "Installing standalone release archive v$VERSION from GitHub releases."
+  echoh "Installing v$VERSION of the $ARCH release from GitHub."
   echoh
 
   fetch "https://github.com/cdr/code-server/releases/download/v$VERSION/code-server-$VERSION-$OS-$ARCH.tar.gz" \
@@ -406,50 +402,74 @@ install_standalone() {
 }
 
 install_npm() {
-  if command_exists yarn; then
+  echoh "Installing latest from npm."
+  echoh
+
+  YARN_PATH="${YARN_PATH-yarn}"
+  NPM_PATH="${YARN_PATH-npm}"
+  if command_exists "$YARN_PATH"; then
     sh_c="sh_c"
-    if [ ! -w "$(yarn global bin)" ]; then
+    if [ ! "${DRY_RUN-}" ] && [ ! -w "$($YARN_PATH global bin)" ]; then
       sh_c="sudo_sh_c"
     fi
     echoh "Installing with yarn."
     echoh
-    "$sh_c" yarn global add code-server --unsafe-perm
+    "$sh_c" "$YARN_PATH" global add code-server --unsafe-perm
-    NPM_BIN_DIR="$(yarn global bin)" echo_npm_postinstall
+    NPM_BIN_DIR="\$($YARN_PATH global bin)" echo_npm_postinstall
     return
-  elif command_exists npm; then
+  elif command_exists "$NPM_PATH"; then
     sh_c="sh_c"
-    if [ ! -w "$(npm config get prefix)" ]; then
+    if [ ! "${DRY_RUN-}" ] && [ ! -w "$(NPM_PATH config get prefix)" ]; then
       sh_c="sudo_sh_c"
     fi
     echoh "Installing with npm."
     echoh
-    "$sh_c" npm install -g code-server --unsafe-perm
+    "$sh_c" "$NPM_PATH" install -g code-server --unsafe-perm
-    NPM_BIN_DIR="$(npm bin -g)" echo_npm_postinstall
+    NPM_BIN_DIR="\$($NPM_PATH bin -g)" echo_npm_postinstall
     return
   fi
-  echoh
   echoerr "Please install npm or yarn to install code-server!"
   echoerr "You will need at least node v12 and a few C dependencies."
   echoerr "See the docs https://coder.com/docs/code-server/v3.10.2/install#yarn-npm"
+
   exit 1
 }
 
-os() {
+# Run $1 if we have a standalone otherwise run install_npm.
-  case "$(uname)" in
+npm_fallback() {
-    Linux)
+  if has_standalone; then
-      echo linux
+    $1
-      ;;
+  else
-    Darwin)
+    echoh "No standalone releases for $ARCH."
-      echo macos
+    echoh "Falling back to installation from npm."
-      ;;
+    install_npm
-    FreeBSD)
+  fi
-      echo freebsd
+}
+
+# Determine if we have standalone releases on GitHub for the system's arch.
+has_standalone() {
+  case $ARCH in
+    amd64) return 0 ;;
+    # We only have amd64 for macOS.
+    arm64)
+      [ "$(distro)" != macos ]
+      return
       ;;
+    *) return 1 ;;
   esac
 }
 
-# distro prints the detected operating system including linux distros.
+os() {
-# Also parses ID_LIKE for common distro bases.
+  uname="$(uname)"
+  case $uname in
+    Linux) echo linux ;;
+    Darwin) echo macos ;;
+    FreeBSD) echo freebsd ;;
+    *) echo "$uname" ;;
+  esac
+}
+
+# Print the detected Linux distro, otherwise print the OS name.
 #
 # Example outputs:
 # - macos -> macos
@@ -486,7 +506,7 @@ distro() {
   fi
 }
 
-# os_name prints a pretty human readable name for the OS/Distro.
+# Print a human-readable name for the OS/distro.
 distro_name() {
   if [ "$(uname)" = "Darwin" ]; then
     echo "macOS v$(sw_vers -productVersion)"
@@ -506,20 +526,16 @@ distro_name() {
 }
 
 arch() {
-  case "$(uname -m)" in
+  uname_m=$(uname -m)
-    aarch64)
+  case $uname_m in
-      echo arm64
+    aarch64) echo arm64 ;;
-      ;;
+    x86_64) echo amd64 ;;
-    x86_64)
+    *) echo "$uname_m" ;;
-      echo amd64
-      ;;
-    amd64) # FreeBSD.
-      echo amd64
-      ;;
   esac
 }
 
 command_exists() {
+  if [ ! "$1" ]; then return 1; fi
   command -v "$@" > /dev/null
 }