Linting (round 2)

Author: gsmith-sas

bin/airgap-include.sh

@@ -8,7 +8,7 @@
 
 if [ "$AIRGAP_SOURCED" == "" ]; then
     ## Check for AIRGAP_REGISTRY, if null/empty, error out.  Otherwise set and create HELM_URL_BASE.
-    if [ -z $AIRGAP_REGISTRY ]; then
+    if [ -z "$AIRGAP_REGISTRY" ]; then
         log_error "AIRGAP_REGISTRY has not been set"
         log_error "Please provide the URL for the private image registry and try again"
         exit 1
@@ -17,7 +17,7 @@ if [ "$AIRGAP_SOURCED" == "" ]; then
         AIRGAP_IMAGE_PULL_SECRET_NAME=${AIRGAP_IMAGE_PULL_SECRET_NAME:-"v4m-image-pull-secret"}
 
         # Check for the image pull secret for the air gap environment
-        if [ -z "$(kubectl get secret -n $V4M_NS $AIRGAP_IMAGE_PULL_SECRET_NAME -o name --ignore-not-found)" ]; then
+        if [ -z "$(kubectl get secret -n "$V4M_NS" "$AIRGAP_IMAGE_PULL_SECRET_NAME" -o name --ignore-not-found)" ]; then
             log_error "The image pull secret, [$AIRGAP_IMAGE_PULL_SECRET_NAME], was not detected"
             log_error "Please add the image pull secret to the [$V4M_NS] namespace and run the deployment script again"
             exit 1
@@ -40,7 +40,7 @@ if [ "$AIRGAP_SOURCED" == "" ]; then
     log_info "Deploying into an 'air-gapped' cluster from private registry [$AIRGAP_REGISTRY]"
 
     airgapDir="$TMP_DIR/airgap"
-    mkdir -p $airgapDir
+    mkdir -p "$airgapDir"
 
     export AIRGAP_SOURCED=true
 fi

bin/autogenerate-include.sh

@@ -36,8 +36,8 @@ function create_ingress_certs {
     if [ -f "$certFile" ] && [ -f "$keyFile" ]; then
         kubectl delete secret "$secretName" --namespace "$namespace" --ignore-not-found
         kubectl create secret tls "$secretName" --namespace "$namespace" --key="$keyFile" --cert="$certFile"
-        kubectl -n $namespace label secret $secretName  managed-by="v4m-es-script"
-    elif [ ! -z "$certFile$keyFile" ]; then
+        kubectl -n "$namespace" label secret "$secretName"  managed-by="v4m-es-script"
+    elif [  -n "$certFile$keyFile" ]; then
         log_warn "Missing Ingress certificate file; specified Ingress cert [$certFile] and/or key [$keyFile] file is missing."
         log_warn "Create the missing Kubernetes secrets after deployment; use command: kubectl -create secret tls $secretName --namespace $namespace --key=cert_key_file --cert=cert_file"
     fi
@@ -71,8 +71,12 @@ if [ -z "$AUTOGENERATE_SOURCED" ]; then
             exit 1
         fi
 
-        #validate required inputs
-        BASE_DOMAIN="${BASE_DOMAIN}"
+        #validate required inputs:
+        #   BASE_DOMAIN
+        #   ROUTING
+        #   INGRESS_CERT
+        #   INGRESS_KEY
+
         if [ -z "$BASE_DOMAIN" ]; then
             log_error "Required parameter [BASE_DOMAIN] not provided"
             exit 1
@@ -88,8 +92,6 @@ if [ -z "$AUTOGENERATE_SOURCED" ]; then
             exit 1
         fi
 
-        INGRESS_CERT="${INGRESS_CERT}"
-        INGRESS_KEY="${INGRESS_KEY}"
         if [ "$INGRESS_CERT/$INGRESS_KEY" != "/" ]; then
             if [ ! -f "$INGRESS_CERT" ] || [ ! -f "$INGRESS_KEY" ]; then
                 # Only WARN b/c missing cert doesn't prevent deployment and it can be created afterwards

bin/common.sh

@@ -18,7 +18,7 @@ function trap_add() {
          printf '%s\n' "${cmd_to_add}"
          # helper fn to get existing trap command from output
          # of trap -p
-         # shellcheck disable=SC2329
+         # shellcheck disable=SC2329,SC2317
          extract_trap_cmd() { printf '%s\n' "$3"; }
          # print existing trap command with newline
          eval "extract_trap_cmd $(trap -p "${signal}")"

bin/log-include.sh

@@ -37,11 +37,7 @@ function add_notice {
 
 function display_notices {
   if [ -f "$TMP_DIR/notices.txt" ]; then
-     local IFS=''
-     cat "$TMP_DIR"/notices.txt | while read -r line || [[ -n "$line" ]];
-     do
-       log_notice "$line"
-     done
+     while IFS= read -r line || [[ -n "$line" ]]; do log_notice "$line"; done <"$TMP_DIR"/notices.txt
  fi
 }
 

bin/service-url-include.sh

@@ -29,10 +29,10 @@ function get_k8s_info {
     object=$2
     jsonpath=$3
 
-    info=$(kubectl -n "$namespace" get "$object" -o=jsonpath=$jsonpath 2>/dev/null)
+    info=$(kubectl -n "$namespace" get "$object" -o=jsonpath="$jsonpath" 2>/dev/null)
     rc=$?
 
-    if [ ! -z  "$info" ]; then
+    if [ -n  "$info" ]; then
         echo "$info"
     else
         v4m_rc=1
@@ -162,7 +162,7 @@ function get_nodeport_url {
         protocol=http
     fi
 
-    if [ ! -z "$port" ]; then
+    if [ -n "$port" ]; then
         porttxt=":$port"
     fi
 

bin/show_app_url.sh

@@ -3,7 +3,7 @@
 # Copyright © 2021, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-cd "$(dirname $BASH_SOURCE)/.." || exit
+cd "$(dirname "$BASH_SOURCE")/.." || exit
 source bin/common.sh
 source bin/service-url-include.sh
 
@@ -86,7 +86,7 @@ do
 
    # Print URLs
    # add_notice "*** $service ***"
-   if [ ! -z "$service_url" ]; then
+   if [ -n "$service_url" ]; then
         add_notice "  You can access $service via the following URL:"
         add_notice "    $service_url"
         add_notice ""

bin/version-include.sh

@@ -36,18 +36,18 @@ function populateValuesYAML() {
 
         # Top-level user.env contents
         if [ -f "$USER_DIR/user.env" ]; then
-        echo '  "user.env": |' >> "$v4mValuesYAML"
-        cat "$USER_DIR/user.env" | sed 's/^/      /' >> "$v4mValuesYAML"
+            echo '  "user.env": |' >> "$v4mValuesYAML"
+            sed 's/^/      /' "$USER_DIR/user.env" >> "$v4mValuesYAML"
         fi
         # Monitoring user.env contents
         if [ -f "$USER_DIR/monitoring/user.env" ]; then
-        echo '  "monitoring_user.env": |' >> "$v4mValuesYAML"
-        cat "$USER_DIR/monitoring/user.env" | sed 's/^/      /' >> "$v4mValuesYAML"
+            echo '  "monitoring_user.env": |' >> "$v4mValuesYAML"
+            sed 's/^/      /' "$USER_DIR/monitoring/user.env" >> "$v4mValuesYAML"
         fi
         # Logging user.env contents
         if [ -f "$USER_DIR/logging/user.env" ]; then
-        echo '  "logging_user.env": |' >> "$v4mValuesYAML"
-        cat "$USER_DIR/logging/user.env" | sed 's/^/      /' >> "$v4mValuesYAML"
+            echo '  "logging_user.env": |' >> "$v4mValuesYAML"
+            sed 's/^/      /' "$USER_DIR/logging/user.env" >> "$v4mValuesYAML"
         fi
     fi
 
@@ -92,7 +92,7 @@ function removeV4MInfo() {
         return 1
     fi
 
-    if [ ! -z "$(helm list -n "$NS" --filter "^$releaseName\$" -q)" ]; then
+    if [ -n "$(helm list -n "$NS" --filter "^$releaseName\$" -q)" ]; then
         log_info "Removing SAS Viya Monitoring for Kubernetes version information"
         helm uninstall -n "$NS" "$releaseName"
     fi