get.sh

#!/bin/sh
set -e
set -o noglob

# Usage:
#   curl ... | ENV_VAR=... sh -
#     or
#   ENV_VAR=... ./install.sh
#
# Example:
#   Installing the most recent version:
#   curl ... | INSTALL_ACORN_CHANNEL="latest" sh -
#
# Environment variables:
#   - INSTALL_ACORN_SKIP_DOWNLOAD
#   If set to true will not download acorn hash or binary.
#
#   - INSTALL_ACORN_SYMLINK
#   If set to 'skip' will not create symlinks, 'force' will overwrite,
#   default will symlink if command does not exist in path.
#
#   - INSTALL_ACORN_VERSION
#   Version of acorn to download from github. Will attempt to download from the
#   stable channel if not specified.
#
#   - INSTALL_ACORN_COMMIT
#   Commit of acorn to download from temporary cloud storage.
#   * (for developer & QA use)
#
#   - INSTALL_ACORN_BIN_DIR
#   Directory to install acorn binary, links, and uninstall script to, or use
#   /usr/local/bin as the default
#
#   - INSTALL_ACORN_BIN_DIR_READ_ONLY
#   If set to true will not write files to INSTALL_ACORN_BIN_DIR, forces
#   setting INSTALL_ACORN_SKIP_DOWNLOAD=true
#
#   - INSTALL_ACORN_CHANNEL_URL
#   Channel URL for fetching acorn download URL.
#   Defaults to 'https://update.acrn.io/v1-release/channels'.
#
#   - INSTALL_ACORN_CHANNEL
#   Channel to use for fetching acorn download URL.
#   Defaults to 'stable'.

GITHUB_URL=https://github.com/acorn-io/acorn/releases
STORAGE_URL=https://cdn.acrn.io/cli
DOWNLOADER=
SHA=
ARCH=
SUFFIX=
EXT=
SUDO=sudo

# --- helper functions for logs ---
info() {
  echo '[INFO] ' "$@"
}

warn() {
  echo '[WARN] ' "$@" >&2
}

fatal() {
  echo '[ERROR] ' "$@" >&2
  exit 1
}

# --- define needed environment variables ---
setup_env() {
  # --- don't use sudo if we are already root ---
  if [ $(id -u) -eq 0 ]; then
    SUDO=
  fi

  # --- use binary install directory if defined or create default ---
  if [ -n "${INSTALL_ACORN_BIN_DIR}" ]; then
    BIN_DIR=${INSTALL_ACORN_BIN_DIR}
  else
    # --- use /usr/local/bin if root can write to it, otherwise use /opt/bin if it exists
    BIN_DIR=/usr/local/bin
    if ! $SUDO sh -c "touch ${BIN_DIR}/acorn-ro-test && rm -rf ${BIN_DIR}/acorn-ro-test"; then
      if [ -d /opt/bin ]; then
        BIN_DIR=/opt/bin
      fi
    fi
  fi

  # --- if bin directory is read only skip download ---
  if [ "${INSTALL_ACORN_BIN_DIR_READ_ONLY}" = true ]; then
    INSTALL_ACORN_SKIP_DOWNLOAD=true
  fi

  INSTALL_ACORN_CHANNEL_URL=${INSTALL_ACORN_CHANNEL_URL:-'https://update.acrn.io/v1-release/channels'}
  INSTALL_ACORN_CHANNEL=${INSTALL_ACORN_CHANNEL:-'latest'}
}

# --- check if skip download environment variable set ---
can_skip_download() {
  if [ "${INSTALL_ACORN_SKIP_DOWNLOAD}" != true ]; then
    return 1
  fi
}

# --- verify an executable acorn binary is installed ---
verify_acorn_is_executable() {
  if [ ! -x ${BIN_DIR}/acorn ]; then
    fatal "Executable acorn binary not found at ${BIN_DIR}/acorn"
  fi
}

# --- set arch and suffix, fatal if architecture not supported ---
setup_verify_arch() {
  if [ -z "$ARCH" ]; then
    PLATFORM=$(uname)
    EXT=".tar.gz"

    case $PLATFORM in
      Linux)
        PLATFORM="linux"
        ;;
      Darwin)
        PLATFORM="macOS"
        ARCH=universal
        ;;
      Windows)
        PLATFORM="windows"
        EXT=".zip"
        ;;
      *)
        fatal "Unsupported platform $PLATFORM"
    esac
  fi

  if [ -z "$ARCH" ]; then
    ARCH=$(uname -m)

    case $ARCH in
      amd64)
        ARCH=amd64
        ;;
      x86_64)
        ARCH=amd64
        ;;
      arm64)
        ARCH=arm64
        ;;
      aarch64)
        ARCH=arm64
        ;;
      *)
        fatal "Unsupported architecture $ARCH"
    esac
  fi

  SUFFIX=-${PLATFORM}-${ARCH}
}

# --- verify existence of network downloader executable ---
verify_downloader() {
  # Return failure if it doesn't exist or is no executable
  [ -x "$(command -v $1)" ] || return 1

  # Set verified executable as our downloader program and return success
  DOWNLOADER=$1
  return 0
}

verify_sha() {
  # Return failure if it doesn't exist or is no executable
  [ -x "$(command -v $1)" ] || return 1

  # Set verified executable as our sha program and return success
  SHA=$1
  return 0
}

get_sha() {
  if [ "${SHA}" = "shasum" ]; then
    $SHA -a 256 $1
  else
    $SHA $1
  fi
}

# --- create temporary directory and cleanup when done ---
setup_tmp() {
  TMP_DIR=$(mktemp -d -t acorn-install.XXXXXXXXXX)
  TMP_HASH=${TMP_DIR}/acorn.hash
  TMP_ARCHIVE=${TMP_DIR}/acorn${EXT}
  cleanup() {
    code=$?
    set +e
    trap - EXIT
    rm -rf ${TMP_DIR}
    exit $code
  }
  trap cleanup INT EXIT
}

# --- use desired acorn version if defined or find version from channel ---
get_release_version() {
  if [ -n "${INSTALL_ACORN_COMMIT}" ]; then
    VERSION_ACORN="commit ${INSTALL_ACORN_COMMIT}"
  elif [ -n "${INSTALL_ACORN_VERSION}" ]; then
    VERSION_ACORN=${INSTALL_ACORN_VERSION}
  else
    info "Finding release for channel ${INSTALL_ACORN_CHANNEL}"
    version_url="${INSTALL_ACORN_CHANNEL_URL}/${INSTALL_ACORN_CHANNEL}"
    case $DOWNLOADER in
      curl)
        VERSION_ACORN=$(curl -w '%{url_effective}' -L -s -S ${version_url} -o /dev/null | sed -e 's|.*/||')
        ;;
      wget)
        VERSION_ACORN=$(wget -SqO /dev/null ${version_url} 2>&1 | grep -i Location | sed -e 's|.*/||')
        ;;
      *)
        fatal "Incorrect downloader executable '$DOWNLOADER'"
        ;;
    esac
  fi
  info "Using ${VERSION_ACORN} as release"
}

# --- download from github url ---
download() {
  [ $# -eq 2 ] || fatal 'download needs exactly 2 arguments'

  case $DOWNLOADER in
    curl)
      curl -o $1 -sfL $2
      ;;
    wget)
      wget -qO $1 $2
      ;;
    *)
      fatal "Incorrect executable '$DOWNLOADER'"
      ;;
  esac

  # Abort if download command failed
  [ $? -eq 0 ] || fatal 'Download failed'
}

# --- download hash from github url ---
download_hash() {
  if [ -n "${INSTALL_ACORN_COMMIT}" ]; then
    HASH_URL=${STORAGE_URL}/acorn${SUFFIX}-${INSTALL_ACORN_COMMIT}.sha256sum
  else
    HASH_URL=${GITHUB_URL}/download/${VERSION_ACORN}/checksums.txt
  fi
  info "Downloading hash ${HASH_URL}"
  download ${TMP_HASH} ${HASH_URL}
  HASH_EXPECTED=$(grep " acorn-${VERSION_ACORN}${SUFFIX}${EXT}" ${TMP_HASH})
  HASH_EXPECTED=${HASH_EXPECTED%%[[:blank:]]*}
}

# --- check hash against installed version ---
installed_hash_matches() {
  if [ -x ${BIN_DIR}/acorn ]; then
    HASH_INSTALLED=$(get_sha "${BIN_DIR}/acorn")
    HASH_INSTALLED=${HASH_INSTALLED%%[[:blank:]]*}
    if [ "${HASH_EXPECTED}" = "${HASH_INSTALLED}" ]; then
      return
    fi
  fi
  return 1
}

# --- download archive from github url ---
download_archive() {
  if [ -n "${INSTALL_ACORN_COMMIT}" ]; then
    ARCHIVE_URL=${STORAGE_URL}/acorn${SUFFIX}-${INSTALL_ACORN_COMMIT}${EXT}
  else
    ARCHIVE_URL=${GITHUB_URL}/download/${VERSION_ACORN}/acorn-${VERSION_ACORN}${SUFFIX}${EXT}
  fi
  info "Downloading archive ${ARCHIVE_URL}"
  download ${TMP_ARCHIVE} ${ARCHIVE_URL}
}

# --- verify downloaded archive hash ---
verify_archive() {
  info "Verifying binary download"
  HASH_BIN=$(get_sha $TMP_ARCHIVE)
  HASH_BIN=${HASH_BIN%%[[:blank:]]*}
  if [ "${HASH_EXPECTED}" != "${HASH_BIN}" ]; then
    fatal "Download sha256 does not match ${HASH_EXPECTED}, got ${HASH_BIN}"
  fi
}

expand_archive() {
  if [ "${EXT}" = ".zip" ]; then
    unzip ${TMP_ARCHIVE} -d ${TMP_DIR}
  else
    tar xzf ${TMP_ARCHIVE} -C ${TMP_DIR}
  fi

  TMP_BIN=${TMP_DIR}/acorn
}

# --- setup permissions and move binary to system directory ---
setup_binary() {
  chmod 755 ${TMP_BIN}
  info "Installing acorn to ${BIN_DIR}/acorn"
  $SUDO chown root ${TMP_BIN}
  $SUDO mv -f ${TMP_BIN} ${BIN_DIR}/acorn
}

# --- download and verify acorn ---
download_and_verify() {
  if can_skip_download; then
     info 'Skipping acorn download and verify'
     verify_acorn_is_executable
     return
  fi

  setup_verify_arch
  verify_downloader curl || verify_downloader wget || fatal 'Can not find curl or wget for downloading files'
  verify_sha sha256sum || verify_sha shasum || fatal 'Can not find sha256sum or shasum for verifying files'
  setup_tmp
  get_release_version
  download_hash

  if installed_hash_matches; then
    info 'Skipping binary downloaded, installed acorn matches hash'
    return
  fi

  download_archive
  verify_archive
  expand_archive
  setup_binary
}

# --- run the install process --
{
  setup_env "$@"
  download_and_verify
}