feat: add trace

aslafy-z · Apr 11, 2024 · ebd3c26 · ebd3c26
1 parent de064e5
commit ebd3c26
Showing 1 changed file with 42 additions and 2 deletions.
diff --git a/helm-git-plugin.sh b/helm-git-plugin.sh
@@ -16,6 +16,16 @@ if [ "${HELM_GIT_DEBUG:-}" = "1" ]; then
   debug=1
 fi
 
+trace=0
+git_output="/dev/null"
+git_quiet="--quiet"
+if [ "${HELM_GIT_TRACE:-}" = "1" ]; then
+  trace=1
+  debug=1
+  git_output="/dev/stderr"
+  git_quiet=""
+fi
+
 export TMPDIR="${TMPDIR:-/tmp}"
 
 # Cache repos or charts depending on the cache path existing in the environment variables
@@ -36,6 +46,11 @@ debug() {
   return 0
 }
 
+trace() {
+  [ $trace = 1 ] && echo "Trace[$$] in plugin '$bin_name': $*" >&2
+  return 0
+}
+
 error() {
   echo "Error in plugin '$bin_name': $*" >&2
   exit 1
@@ -51,7 +66,7 @@ warning() {
 git_try() {
   _git_repo=$1
 
-  GIT_TERMINAL_PROMPT=0 git ls-remote "$_git_repo" --refs >&2 || return 1
+  GIT_TERMINAL_PROMPT=0 git ls-remote "$_git_repo" --refs "${git_output}" || return 1
 }
 
 #git_fetch_ref(git_repo_path, git_ref)
@@ -230,6 +245,7 @@ helm_inspect_name() {
 
 # main(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
 
@@ -258,32 +274,45 @@ main() {
 
   _uri_scheme=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\1'p")
   readonly _uri_scheme
+  trace "_uri_scheme: $_uri_scheme"
+
   _uri_authority=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\3'p")
   readonly _uri_authority
+  trace "_uri_authority: $_uri_authority"
+
   _uri_path=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\8'p")
   readonly _uri_path
+  trace "_uri_path: $_uri_path"
+
   _uri_query=$(echo "$_raw_uri" | sed -Ene "s'$URI_REGEX'\9'p")
   readonly _uri_query
+  trace "_uri_query: $_uri_query"
 
   git_scheme=$(echo "$_uri_scheme" | sed -e 's/^git+//')
   readonly git_scheme="$git_scheme"
+  trace "git_scheme: $git_scheme"
   string_contains "$allowed_protocols" "$git_scheme" ||
     error "$error_invalid_protocol"
 
   git_repo_path=$(echo "${_uri_path}" | cut -d'@' -f 1)
   readonly git_repo_path
+  trace "git_repo_path: $git_repo_path"
 
   git_file_path=$(echo "${_uri_path}" | cut -d'@' -f 2)
   readonly git_file_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"
 
   git_repo="${git_scheme}://${_uri_authority}/${git_repo_path}"
   readonly git_repo
+  trace "git_repo: $git_repo"
 
   git_ref=$(echo "$_uri_query" | sed '/^.*ref=\([^&#]*\).*$/!d;s//\1/')
   # TODO: Validate git_ref
@@ -292,22 +321,26 @@ main() {
     git_ref="master"
   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"
 
   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}"
-  debug "helm_repo_uri: $helm_repo_uri"
+  trace "helm_repo_uri: $helm_repo_uri"
 
   if ${CACHE_CHARTS}; then
     _request_hash=$(echo "${_raw_uri}" | md5sum | cut -d " " -f1)
@@ -335,8 +368,12 @@ main() {
 
   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"
 
@@ -352,8 +389,11 @@ main() {
   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