Housekeeping: lint remaining scripts in bin

Author: gsmith-sas

bin/autogenerate-include.sh

@@ -1,3 +1,4 @@
+# shellcheck disable=SC2148
 # Copyright © 2025, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
@@ -193,6 +194,7 @@ function checkStorageClass {
         log_error "Required parameter not provided.  Either [$storageClassEnvVar] or [STORAGECLASS] MUST be provided."
         exit 1
     else
+        # shellcheck disable=SC2091
         if $(kubectl get storageClass "$storageClass" -o name &>/dev/null); then
             log_debug "The specified StorageClass [$storageClass] exists"
         else

bin/common.sh

@@ -3,7 +3,7 @@
 # Copyright ©2022, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-cd "$(dirname "$BASH_SOURCE")/.."
+cd "$(dirname "$BASH_SOURCE")/.."  || exit
 source logging/bin/common.sh
 
 #TO DO: Should be done in bin/common?

bin/configure_nodeport.sh

@@ -6,12 +6,13 @@
 # This script is not intended to be run directly
 # Assumes bin/common.sh has been sourced
 
-if [ ! $(which helm) ]; then
-  echo "helm not found on the current PATH"
-  exit 1
+if [ ! "$(which helm)" ]; then
+    echo "helm not found on the current PATH"
+    exit 1
 fi
 
 helmVer=$(helm version --short 2>/dev/null)
+# shellcheck disable=SC2116,SC2086,SC2207
 hver=( $(echo ${helmVer//[^0-9]/ }) )
 HELM_VER_MAJOR=${hver[0]}
 HELM_VER_MINOR=${hver[1]}
@@ -25,115 +26,116 @@ if [ "$HELM_VER_MAJOR" == "2" ]; then
 fi
 
 if [ "$V4M_HELM_USE_LATEST"  == "true" ]; then
-  log_warn "******This feature is NOT intended for use outside the project maintainers*******"
-  log_warn "Environment variable V4M_HELM_USE_LATEST set; deploying *latest* version of all Helm charts"
+    log_warn "******This feature is NOT intended for use outside the project maintainers*******"
+    log_warn "Environment variable V4M_HELM_USE_LATEST set; deploying *latest* version of all Helm charts"
 fi
 
 function helm2ReleaseExists {
-  release=$1
-  log_debug "Checking for Helm 2.x release of [$release]"
-  releases=$(kubectl get configmap --all-namespaces -l "OWNER=TILLER" -o name)
-  if [[ $releases =~ configmap/$release\.v[0-9]+ ]]; then
-    log_debug "A Helm 2.x release of [$release] exists"
-    return 0
-  else
-    return 1
-  fi
+    release=$1
+    log_debug "Checking for Helm 2.x release of [$release]"
+    releases=$(kubectl get configmap --all-namespaces -l "OWNER=TILLER" -o name)
+    if [[ $releases =~ configmap/$release\.v[0-9]+ ]]; then
+        log_debug "A Helm 2.x release of [$release] exists"
+        return 0
+    else
+        return 1
+    fi
 }
 
 function helm3ReleaseExists {
-  release=$1
-  namespace=$2
-  log_debug "Checking for Helm 3.x release of [$release]"
-  releases=$(kubectl get secret -n $namespace -l name=$release,owner=helm -o name)
-  if [[ $releases =~ secret/sh\.helm\.release\.v1\.$release\.v[0-9]+ ]]; then
-    log_debug "A Helm 3.x release of [$release] exists"
-    return 0
-  else
-    return 1
-  fi
+    release=$1
+    namespace=$2
+    log_debug "Checking for Helm 3.x release of [$release]"
+    releases=$(kubectl get secret -n "$namespace" -l name="$release",owner=helm -o name)
+    if [[ $releases =~ secret/sh\.helm\.release\.v1\.$release\.v[0-9]+ ]]; then
+        log_debug "A Helm 3.x release of [$release] exists"
+        return 0
+    else
+        return 1
+    fi
 }
 
 function helm2ReleaseCheck {
-  if [ "$HELM_RELEASE_CHECK" != "false" ]; then
-    release=$1
-    if helm2ReleaseExists $release; then
-      log_error "A Helm 2.x release of [$release] already exists"
-      log_error "Helm [$HELM_VER_FULL] cannot manage the Helm 2.x release of [$release]"
-      exit 1
+    if [ "$HELM_RELEASE_CHECK" != "false" ]; then
+        release=$1
+        if helm2ReleaseExists "$release"; then
+        log_error "A Helm 2.x release of [$release] already exists"
+        log_error "Helm [$HELM_VER_FULL] cannot manage the Helm 2.x release of [$release]"
+        exit 1
+        fi
     fi
-  fi
 }
 
 function helmRepoAdd {
-  repo=$1
-  repoURL=$2
-
-  ## If this is an air gap deployment, do nothing
-  if [ "$AIRGAP_DEPLOYMENT" == "true" ]; then
-    return 0
-  fi
-
-  HELM_FORCE_REPO_UPDATE=${HELM_FORCE_REPO_UPDATE:-true}
-  if [[ ! $(helm repo list 2>/dev/null) =~ $repo[[:space:]] ]]; then
-    log_info "Adding [$repo] helm repository"
-    helm repo add $repo $repoURL
-  else
-    log_debug "The helm repo [$repo] already exists"
-    if [ "$HELM_FORCE_REPO_UPDATE" == "true" ]; then
-      log_debug "Forcing update of [$repo] helm repo to [$repoURL]"
-
-      # Helm 3.3.2 changed 'repo add' behavior and added the --force-update flag
-      # https://github.com/helm/helm/releases/tag/v3.3.2
-      if [[  $HELM_VER_MINOR -lt 3 || ( $HELM_VER_MINOR -eq 3 &&  $HELM_VER_PATCH -lt 2) ]]; then
-         helm repo add $repo $repoURL
-      else
-         helm repo add --force-update $repo $repoURL
-      fi
+    repo=$1
+    repoURL=$2
 
+    ## If this is an air gap deployment, do nothing
+    if [ "$AIRGAP_DEPLOYMENT" == "true" ]; then
+        return 0
+    fi
+
+    HELM_FORCE_REPO_UPDATE=${HELM_FORCE_REPO_UPDATE:-true}
+    # shellcheck disable=SC1087
+    if [[ ! $(helm repo list 2>/dev/null) =~ $repo[[:space:]] ]]; then
+        log_info "Adding [$repo] helm repository"
+        helm repo add "$repo" "$repoURL"
+    else
+        log_debug "The helm repo [$repo] already exists"
+        if [ "$HELM_FORCE_REPO_UPDATE" == "true" ]; then
+            log_debug "Forcing update of [$repo] helm repo to [$repoURL]"
+
+            # Helm 3.3.2 changed 'repo add' behavior and added the --force-update flag
+            # https://github.com/helm/helm/releases/tag/v3.3.2
+            if [[  $HELM_VER_MINOR -lt 3 || ( $HELM_VER_MINOR -eq 3 &&  $HELM_VER_PATCH -lt 2) ]]; then
+                helm repo add "$repo" "$repoURL"
+            else
+                helm repo add --force-update "$repo" "$repoURL"
+            fi
+        fi
     fi
-  fi
 }
 
 function get_helmchart_reference {
-  local chart_repository chart_name chart_version
-
-  chart_repository=$1
-  chart_name=$2
-  chart_version=$3
-
-  if [ -z "$chart_repository" ]; then
-     echo "'ERROR: Helm chart repository not specified'"
-     return 1
-  elif [ -z "$chart_name" ]; then
-     echo "'ERROR: Helm chart name not specified'"
-     return 1
-  elif [ -z "$chart_version" ]; then
-     echo "'ERROR: Helm chart version not specified'"
-     return 1
-  else
-     #all parms have values
-     :
-  fi
-
-  if [ "$AIRGAP_HELM_FORMAT"  == "tgz" ]; then
-      echo "${AIRGAP_HELM_REPO}/${chart_name}-${chart_version}.tgz"
-  elif [ "$AIRGAP_HELM_FORMAT"  == "oci" ]; then
-      echo "oci://${AIRGAP_HELM_REPO}/${chart_repository}/${chart_name}"
-  else
-      echo "${chart_repository}/${chart_name}"
-  fi
+    local chart_repository chart_name chart_version
+
+    chart_repository=$1
+    chart_name=$2
+    chart_version=$3
+
+    if [ -z "$chart_repository" ]; then
+        echo "'ERROR: Helm chart repository not specified'"
+        return 1
+    elif [ -z "$chart_name" ]; then
+        echo "'ERROR: Helm chart name not specified'"
+        return 1
+    elif [ -z "$chart_version" ]; then
+        echo "'ERROR: Helm chart version not specified'"
+        return 1
+    else
+        #all parms have values
+        :
+    fi
+
+    if [ "$AIRGAP_HELM_FORMAT"  == "tgz" ]; then
+        echo "${AIRGAP_HELM_REPO}/${chart_name}-${chart_version}.tgz"
+    elif [ "$AIRGAP_HELM_FORMAT"  == "oci" ]; then
+        echo "oci://${AIRGAP_HELM_REPO}/${chart_repository}/${chart_name}"
+    else
+        echo "${chart_repository}/${chart_name}"
+    fi
 }
 function get_helm_versionstring {
     if [ "$V4M_HELM_USE_LATEST"  == "true" ]; then
-       :  # return null string
+        :  # return null string
     else
-       # Explicitly use printf instead of echo to avoid quote issues
-       printf -- "--version %s" "$1"
+        # Explicitly use printf instead of echo to avoid quote issues
+        printf -- "--version %s" "$1"
     fi
 
     return
 }
+
 export HELM_VER_FULL HELM_VER_MAJOR HELM_VER_MINOR HELM_VER_PATCH
 export -f helm2ReleaseExists
 export -f helm3ReleaseExists

bin/helm-include.sh

@@ -1,5 +1,4 @@
-#!/bin/bash
-
+# shellcheck disable=SC2148
 # Copyright © 2024,2020, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 

bin/kube-include.sh

@@ -1,3 +1,4 @@
+# shellcheck disable=SC2148
 # Copyright © 2021, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
@@ -31,26 +32,30 @@ if [ "$LOG_VERBOSE_ENABLE" != "true" ]; then
 fi
 
 function add_notice {
-  echo $* >> $TMP_DIR/notices.txt
+  echo "$*" >> "$TMP_DIR"/notices.txt
 }
 
 function display_notices {
   if [ -f "$TMP_DIR/notices.txt" ]; then
      local IFS=''
-     cat $TMP_DIR/notices.txt | while read line || [[ -n "$line" ]];
+     cat "$TMP_DIR"/notices.txt | while read -r line || [[ -n "$line" ]];
      do
        log_notice "$line"
      done
  fi
 }
 
 function log_notice {
+  local msg
+  msg=$1
   width=$noticeColWidth
-  n=$(($width - $(echo "$1" | wc -c)))
+
+  n=$((width - ${#msg}))
   if [ $n -lt 0 ]; then
      n=0
   fi
   # Fill remaining characters with spaces
+  # shellcheck disable=SC2046
   text="$*$(printf %$(eval 'echo $n')s |tr ' ' ' ')"
 
   if [ "$LOG_COLOR_ENABLE" = "true" ]; then
@@ -96,7 +101,7 @@ function log_info {
 # The value of LOG_VERBOSE_ENABLE determines whether they are displayed
 function log_verbose {
   if [ "$LOG_VERBOSE_ENABLE" == "true" ]; then
-		log_info $* >&3
+		log_info "$*" >&3
   fi
 }