helm-git-plugin.sh

#!/usr/bin/env sh

# See Helm plugins documentation: https://docs.helm.sh/using_helm/#downloader-plugins

set -eu

# Mark this shell
# shellcheck disable=SC2034
HELM_GIT_SOURCE=1

bin_name="helm-git"
readonly bin_name
allowed_protocols="https http file ssh"
readonly allowed_protocols
url_prefix="git+"
readonly url_prefix
error_invalid_prefix="Git url should start with '$url_prefix'. Please check helm-git usage."
readonly error_invalid_prefix
error_invalid_protocol="Protocol not allowed, it should match one of theses: $allowed_protocols."
readonly error_invalid_protocol

# Debug & trace output configuration
debug=0
trace=0
cleanup=1
git_output="/dev/null"
git_quiet="--quiet"
if [ "${HELM_GIT_DEBUG:-}" = "1" ]; then
  debug=1
fi
if [ "${HELM_GIT_TRACE:-}" = "1" ]; then
  trace=1
  debug=1
  cleanup=0
  git_output="/dev/stderr"
  git_quiet=""
fi
readonly debug
readonly trace
readonly cleanup
readonly git_output
readonly git_quiet

# Set default value for TMPDIR
export TMPDIR="${TMPDIR:-/tmp}"

# Cache repos or charts depending on the cache path existing in the environment variables
cache_repos_enabled=0
if [ -n "${HELM_GIT_REPO_CACHE:-}" ]; then
  cache_repos_enabled=1
fi
readonly cache_repos_enabled
cache_charts_enabled=0
if [ -n "${HELM_GIT_CHART_CACHE:-}" ]; then
  cache_charts_enabled=1
  cache_charts_strategy="${HELM_GIT_CHART_CACHE_STRATEGY:-}"
else
  cache_charts_strategy=""
fi
readonly cache_charts_enabled
readonly cache_charts_strategy

## Tooling

string_starts() { [ "$(echo "$1" | cut -c 1-${#2})" = "$2" ]; }
string_ends() { [ "$(echo "$1" | cut -c $((${#1} - ${#2} + 1))-${#1})" = "$2" ]; }
string_contains() { echo "$1" | grep -q "$2"; }
path_join() { echo "${1:+$1/}$2" | sed 's#//#/#g'; }

## Logging

debug() {
  [ $debug = 1 ] && echo "Debug[$$] in plugin '$bin_name': $*" >&2
  return 0
}

trace() {
  [ $trace = 1 ] && echo "Trace[$$] in plugin '$bin_name': $*" >&2
  return 0
}

error() {
  echo "Error in plugin '$bin_name': $*" >&2
  exit 1
}

warning() {
  echo "Warning in plugin '$bin_name': $*" >&2
}

## Functions

# git_try(git_repo)
git_try() {
  _git_repo=$1

  GIT_TERMINAL_PROMPT=0 git ls-remote "$_git_repo" --refs >"${git_output}" 2>&1 || return 1
}

#git_get_default_branch(git_repo_path)
git_get_default_branch() {
  _git_repo="${1?Missing git_repo as first parameter}"

  # Fetch default branch from remote
  _git_symref=$(GIT_TERMINAL_PROMPT=0  git ls-remote --symref "${_git_repo}" origin HEAD 2>"${git_output}") || return
  echo "$_git_symref" | awk '/^ref:/ {sub(/refs\/heads\//, "", $2); print $2}' || return
}

#git_fetch_ref(git_repo_path, git_ref)
git_fetch_ref() {
  _git_repo_path="${1?Missing git_repo_path as first parameter}"
  _git_ref="${2?Mising git_ref as second parameter}"

  # Fetches any kind of ref to its right place, tags, annotated tags, branches and commit refs
  GIT_DIR="${_git_repo_path}" git fetch -u --depth=1 origin "refs/*/${_git_ref}:refs/*/${_git_ref}" "${_git_ref}" >"${git_output}" 2>&1
}

#git_cache_intercept(git_repo, git_ref)
git_cache_intercept() {
  _git_repo="${1?Missing git_repo as first parameter}"
  _git_ref="${2?Missing git_ref as second parameter}"
  debug "Trying to intercept for ${_git_repo}#${_git_ref}"
  repo_tokens=$(echo "${_git_repo}" | sed -E -e 's/[^/]+\/\/([^@]*@)?([^/]+)\/(.+)$/\2 \3/' -e 's/\.git$//g')
  repo_host=$(echo "${repo_tokens}" | cut -d " " -f1)
  repo_repo=$(echo "${repo_tokens}" | cut -d " " -f2)
  if [ ! -d "${HELM_GIT_REPO_CACHE}" ]; then
    debug "HELM_GIT_REPO_CACHE:${HELM_GIT_REPO_CACHE} is not a directory, cannot cache"
    return 1
  fi

  repo_path="${HELM_GIT_REPO_CACHE}/${repo_host}/${repo_repo}"
  debug "Calculated cache path for repo ${_git_repo} is ${repo_path}"

  if [ ! -d "${repo_path}" ]; then
    debug "First time I see ${_git_repo}, setting it up at into ${repo_path}"
    {
      mkdir -p "${repo_path}" &&
        cd "${repo_path}" &&
        git init --bare ${git_quiet} >"${git_output}" 2>&1 &&
        git remote add origin "${_git_repo}" >"${git_output}" 2>&1
    } >&2 || debug "Could not setup ${_git_repo}" && return 1
  else
    debug "${_git_repo} exists in cache"
  fi
  debug "Making sure we have the requested ref #${_git_ref}"
  if [ -z "$(GIT_DIR="${repo_path}" git tag -l "${_git_ref}" 2>"${git_output}")" ]; then
    debug "Did not find ${_git_ref} in our cache for ${_git_repo}, fetching...."
    # This fetches properly tags, annotated tags, branches and commits that match the name and leave them at the right place
    git_fetch_ref "${repo_path}" "${_git_ref}" ||
      debug "Could not fetch ${_git_ref}" && return 1
  else
    debug "Ref ${_git_ref} was already cached for ${_git_repo}"
  fi
  debug "Tags in the repo: $(GIT_DIR="${repo_path}" git tag -l 2>"${git_output}")"

  new_git_repo="file://${repo_path}"
  debug "Returning cached repo at ${new_git_repo}"
  echo "${new_git_repo}"
}

# git_checkout(sparse, target_path, git_repo, git_ref, git_path)
git_checkout() {
  _sparse=$1
  _target_path=$2
  _git_repo=$3
  _git_ref=$4
  _git_path=$5

  if [ "$cache_repos_enabled" = 1 ]; then
    _intercepted_repo=$(git_cache_intercept "${_git_repo}" "${_git_ref}") && _git_repo="${_intercepted_repo}"
  fi

  {
    cd "$_target_path"
    git init ${git_quiet} >"${git_output}" 2>&1
    git config pull.ff only >"${git_output}" 2>&1
    git remote add origin "$_git_repo" >"${git_output}" 2>&1
  }
  if [ "$_sparse" = "1" ] && [ -n "$_git_path" ]; then
    git config core.sparseCheckout true >"${git_output}" 2>&1
    mkdir -p .git/info
    echo "$_git_path/*" >.git/info/sparse-checkout
  fi
  git_fetch_ref "${PWD}/.git" "${_git_ref}" ||
    error "Unable to fetch remote. Check your Git url."
  git checkout ${git_quiet} "${_git_ref}" >"${git_output}" 2>&1 ||
    error "Unable to checkout ref. Check your Git ref ($_git_ref) and path ($_git_path)."
  # shellcheck disable=SC2010,SC2012
  if [ "$(ls -A | grep -v '^.git$' -c)" = "0" ]; then
    error "No files have been checked out. Check your Git ref ($_git_ref) and path ($_git_path)."
  fi
}

# helm_v2()
helm_v2() {
  "$HELM_BIN" version -c --short | grep -q v2
}

# helm_init(helm_home)
helm_init() {
  if ! helm_v2; then return 0; fi
  _helm_home=$1
  "$HELM_BIN" init --client-only --stable-repo-url https://charts.helm.sh/stable --home "$_helm_home" >/dev/null
  HELM_HOME=$_helm_home
  export HELM_HOME
}

# helm_package(target_path, source_path, chart_name)
helm_package() {
  _target_path=${1?First parameter should be the target path}
  _source_path=${2?Second parameter should be the source path}
  _chart_name=${3?Third parameter should be the chart name}

  # Ensure exists at least empty
  helm_args=${helm_args:-}

  tmp_target="$(mktemp -d "$TMPDIR/helm-git.XXXXXX")"
  cp -rL "$_source_path" "$tmp_target/$_chart_name"
  _source_path="$tmp_target/$_chart_name"
  cd "$_target_path" >&2

  package_args=$helm_args
  helm_v2 && package_args="$package_args --save=false"
  # shellcheck disable=SC2086
  "$HELM_BIN" package $package_args "$_source_path" >/dev/null
  ret=$?

  rm -rf "$tmp_target"

  # forward return code
  return $ret
}

# helm_dependency_update(target_path)
helm_dependency_update() {
  _target_path=${1?First argument should be the target path}

  # Ensure exists at least empty
  helm_args=${helm_args:-}

  # Prevent infinity loop when calling helm-git plugin
  if ${HELM_GIT_DEPENDENCY_CIRCUITBREAKER:-false}; then
    # shellcheck disable=SC2086
    "$HELM_BIN" dependency update $helm_args --skip-refresh "$_target_path" >/dev/null
    ret=$?
  else
    export HELM_GIT_DEPENDENCY_CIRCUITBREAKER=true
    # shellcheck disable=SC2086
    "$HELM_BIN" dependency update $helm_args "$_target_path" >/dev/null
    ret=$?
  fi

  # forward return code
  return $ret
}

# helm_index(target_path, base_url)
helm_index() {
  _target_path=$1
  _base_url=$2

  # Ensure exists at least empty
  helm_args=${helm_args:-}

  # shellcheck disable=SC2086
  "$HELM_BIN" repo index $helm_args --url="$_base_url" "$_target_path" >/dev/null
}

# helm_inspect_name(source_path)
helm_inspect_name() {
  _source_path=${1?First parameter should be the source path}

  # Ensure exists at least empty
  helm_args=${helm_args:-}

  # shellcheck disable=SC2086
  output=$("$HELM_BIN" inspect chart $helm_args "$_source_path")
  name=$(echo "$output" | grep -e '^name: ' | cut -d' ' -f2)
  echo "$name"
  [ -n "$name" ]
}

# parse_uri(raw_uri)
# sets git_repo, git_ref, helm_dir, helm_file, git_sparse, helm_depupdate, helm_package
parse_uri() {
  _raw_uri=$1

  # Parse URI
  string_starts "$_raw_uri" "$url_prefix" ||
    error "Invalid format, got '$_raw_uri'. $error_invalid_prefix"

  # Thanks goes to https://stackoverflow.com/a/63993578
  readonly URI_REGEX='^([^:/?#]+):(//((([^/?#]+)@)?([^/?#]+)?))?(/([^?#]*))(\?([^#]*))?(#(.*))?$'

  _uri_scheme=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\1'p")
  trace "_uri_scheme: $_uri_scheme"

  _uri_authority=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\3'p")
  trace "_uri_authority: $_uri_authority"

  _uri_path=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\8'p")
  trace "_uri_path: $_uri_path"

  _uri_query=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\9'p")
  trace "_uri_query: $_uri_query"

  _git_scheme=$(echo "$_uri_scheme" | sed -e 's/^git+//')
  trace "_git_scheme: $_git_scheme"
  string_contains "$allowed_protocols" "$_git_scheme" ||
    error "$error_invalid_protocol"

  _git_path=$(echo "${_uri_path}" | awk -F'@' '{print $1}')
  _git_file_path=$(echo "${_uri_path}" | awk -F'@' '{print $2}')
  if [ -z "$_git_file_path" ]; then
    _git_file_path=$(basename "$_git_path")
    _git_path=$(dirname "$_git_path")
  fi
  trace "_git_path: $_git_path"
  trace "_git_file_path: $_git_file_path"

  helm_dir=$(dirname "${_git_file_path}" | sed -r '/^[\.|/]$/d')
  readonly helm_dir
  trace "helm_dir: $helm_dir"

  helm_file=$(basename "${_git_file_path}")
  readonly helm_file
  trace "helm_file: $helm_file"

  helm_chart_name=$(echo "$helm_file" | sed -r 's/-[^-]+.tgz$//')
  readonly helm_chart_name
  trace "helm_chart_name: $helm_chart_name"

  git_repo="${_git_scheme}://${_uri_authority}/${_git_path}"
  readonly git_repo
  trace "git_repo: $git_repo"

  git_ref=$(echo "$_uri_query" | sed '/^.*ref=\([^&#]*\).*$/!d;s//\1/')
  # TODO: Validate git_ref
  if [ -z "$git_ref" ]; then
    warning "git_ref was not given, trying to discover default branch from remote. Prefer to pin GIT ref in URI."
    git_ref=$(git_get_default_branch "$git_repo")
    if [ -z "$git_ref" ]; then
      warning "git_ref could not be discovered from remote. Defaulting to 'master'. Prefer to pin GIT ref in URI."
      git_ref="master"
    else
      debug "Discovered default branch from remote: '$git_ref'. Prefer to pin GIT ref in URI."
    fi
  fi
  readonly git_ref
  trace "git_ref: $git_ref"

  git_sparse=$(echo "$_uri_query" | sed '/^.*sparse=\([^&#]*\).*$/!d;s//\1/')
  [ -z "$git_sparse" ] && git_sparse=1
  readonly git_sparse
  trace "git_sparse: $git_sparse"

  helm_depupdate=$(echo "$_uri_query" | sed '/^.*depupdate=\([^&#]*\).*$/!d;s//\1/')
  [ -z "$helm_depupdate" ] && helm_depupdate=1
  readonly helm_depupdate
  trace "helm_depupdate: $helm_depupdate"

  helm_package=$(echo "$_uri_query" | sed '/^.*package=\([^&#]*\).*$/!d;s//\1/')
  [ -z "$helm_package" ] && helm_package=1
  readonly helm_package
  trace "helm_package: $helm_package"
}

# main(cert_file, key_file, ca_file, raw_uri)
main() {
  trace "args: $*"
  helm_args="" # "$1 $2 $3"
  _raw_uri=$4  # eg: git+https://git.com/user/repo@path/to/charts/index.yaml?ref=master

  # If defined, use $HELM_GIT_HELM_BIN as $HELM_BIN.
  if [ -n "${HELM_GIT_HELM_BIN:-}" ]; then
    export HELM_BIN="${HELM_GIT_HELM_BIN}"
  # If not, use $HELM_BIN after sanitizing it or default to 'helm'.
  elif
    [ -z "$HELM_BIN" ] ||
      # terraform-provider-helm: https://github.com/aslafy-z/helm-git/issues/101
      echo "$HELM_BIN" | grep -q "terraform-provider-helm" ||
      # helm-diff plugin: https://github.com/aslafy-z/helm-git/issues/107
      echo "$HELM_BIN" | grep -q "diff"
  then
    export HELM_BIN="helm"
  fi

  parse_uri "$_raw_uri"

  debug "repo: ${git_repo} ref: ${git_ref} path: ${helm_dir} file: ${helm_file} sparse: ${git_sparse} depupdate: ${helm_depupdate} package: ${helm_package}"
  readonly helm_repo_uri="git+${git_repo}@${helm_dir}?ref=${git_ref}&sparse=${git_sparse}&depupdate=${helm_depupdate}&package=${helm_package}"
  trace "helm_repo_uri: $helm_repo_uri"

  if [ "$cache_charts_enabled" = 1 ]; then
    if [ "$cache_charts_strategy" = "repo" ]; then
      _request_hash=$(echo "${helm_repo_uri}" | md5sum | cut -d " " -f1)
    else
      _request_hash=$(echo "${_raw_uri}" | md5sum | cut -d " " -f1)
    fi

    _cache_folder="${HELM_GIT_CHART_CACHE}/${_request_hash}"

    _cached_file="${_cache_folder}/${helm_file}"
    if [ -f "${_cached_file}" ]; then
      debug "Returning cached helm request for ${_raw_uri}: ${_cached_file}"
      cat "${_cached_file}"
      return 0
    else
      debug "Helm request not found in cache ${_cached_file}"
      mkdir -p "${_cache_folder}"
    fi
  fi

  # Setup exit trap
  # shellcheck disable=SC2317
  exit_trap() {
    [ "$cleanup" = 1 ] || return 0
    rm -rf "$git_root_path" "${helm_home_target_path:-}"
    [ "$cache_charts_enabled" = 1 ] || rm -rf "${helm_target_path:-}"
  }
  trap exit_trap EXIT

  git_root_path="$(mktemp -d "$TMPDIR/helm-git.XXXXXX")"
  readonly git_root_path="$git_root_path"
  trace "git_root_path: $git_root_path"

  git_sub_path=$(path_join "$git_root_path" "$helm_dir")
  readonly git_sub_path="$git_sub_path"
  trace "git_sub_path: $git_sub_path"

  git_checkout "$git_sparse" "$git_root_path" "$git_repo" "$git_ref" "$helm_dir" ||
    error "Error while git_sparse_checkout"

  if [ -f "$helm_dir/$helm_file" ]; then
    cat "$helm_dir/$helm_file"
    return
  fi

  if [ "$cache_charts_enabled" = 1 ]; then
    helm_target_path="${_cache_folder}"
  else
    helm_target_path="$(mktemp -d "$TMPDIR/helm-git.XXXXXX")"
  fi

  readonly helm_target_path="$helm_target_path"
  trace "helm_target_path: $helm_target_path"

  helm_target_file="$(path_join "$helm_target_path" "$helm_file")"
  readonly helm_target_file="$helm_target_file"
  trace "helm_target_file: $helm_target_file"

  # Set helm home
  if helm_v2; then
    debug "helm2 detected. initializing helm home"
    helm_home=$("$HELM_BIN" home)
    if [ -z "$helm_home" ]; then
      helm_home_target_path="$(mktemp -d "$TMPDIR/helm-git.XXXXXX")"
      readonly helm_home_target_path="$helm_home_target_path"
      helm_init "$helm_home_target_path" || error "Couldn't init helm"
      helm_home="$helm_home_target_path"
    fi
    helm_args="$helm_args --home=$helm_home"
  fi

  chart_search_root="$git_sub_path"

  if [ "$helm_chart_name" != "index.yaml" ] && [ "$cache_charts_enabled" = "1" ] && [ "$cache_charts_strategy" = "chart" ]; then
    chart_search=$(find "$chart_search_root" -maxdepth 2 -name "Chart.yaml" -exec grep -lE "name:\s*('|\")?${helm_chart_name}('|\")?(\s+|$)" {} +)
  else
    chart_search=$(find "$chart_search_root" -maxdepth 2 -name "Chart.yaml" -print)
  fi

  chart_search_count=$(echo "$chart_search" | wc -l)

  echo "$chart_search" | {
    while IFS='' read -r chart_yaml_file; do
      chart_path=$(dirname "$chart_yaml_file")
      chart_name=$(helm_inspect_name "$chart_path")

      if [ "$helm_depupdate" = "1" ]; then
        helm_dependency_update "$chart_path" ||
          error "Error while helm_dependency_update"
      fi
      if [ "$helm_package" = "1" ]; then
        helm_package "$helm_target_path" "$chart_path" "$chart_name" ||
          error "Error while helm_package"
      fi
    done
  }

  [ "$chart_search_count" -eq "0" ] &&
    error "No charts have been found"

  helm_index "$helm_target_path" "$helm_repo_uri" ||
    error "Error while helm_index"

  debug "Returning target: $helm_target_file"
  cat "$helm_target_file"
}