Merge pull request kubernetes#73746 from mrbobbytables/kubemark-shellcheck

Fix shellcheck lint errors in Kubemark scripts

Author: k8s-ci-robot

cluster/kubemark/gce/config-default.sh

@@ -19,6 +19,8 @@
 # gce/util.sh script which assumes config filename), but if some things that
 # are enabled by default should not run in hollow clusters, they should be disabled here.
 
+# shellcheck disable=SC2034 # Variables sourced in other scripts.
+
 source "${KUBE_ROOT}/cluster/gce/config-common.sh"
 
 GCLOUD=gcloud
@@ -115,7 +117,7 @@ ENABLE_KUBEMARK_CLUSTER_AUTOSCALER="${ENABLE_KUBEMARK_CLUSTER_AUTOSCALER:-false}
 # (e.g. kubemark master, Heapster) enough resources to handle maximum cluster size.
 if [[ "${ENABLE_KUBEMARK_CLUSTER_AUTOSCALER}" == "true" ]]; then
   NUM_REPLICAS=1
-  if [[ ! -z "$NUM_NODES" ]]; then
+  if [[ -n "$NUM_NODES" ]]; then
     echo "WARNING: Using Cluster Autoscaler, ignoring NUM_NODES parameter. Set KUBEMARK_AUTOSCALER_MAX_NODES to specify maximum size of the cluster."
   fi
 fi

cluster/kubemark/iks/config-default.sh

@@ -16,6 +16,7 @@
 
 # Cloud information
 RANDGEN=$(dd if=/dev/urandom bs=64 count=1 2>/dev/null | base64 | tr -d "=+/" | dd bs=16 count=1 2>/dev/null | sed 's/[A-Z]//g')
+# shellcheck disable=2034 # Variable sourced in other scripts.
 KUBE_NAMESPACE="kubemark_${RANDGEN}"
 KUBEMARK_IMAGE_TAG="${KUBEMARK_IMAGE_TAG:-2}"
 KUBEMARK_IMAGE_LOCATION="${KUBEMARK_IMAGE_LOCATION:-${KUBE_ROOT}/cluster/images/kubemark}"

cluster/kubemark/util.sh

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-KUBE_ROOT=$(dirname "${BASH_SOURCE}")/../..
-source ${KUBE_ROOT}/test/kubemark/cloud-provider-config.sh
-source ${KUBE_ROOT}/cluster/${CLOUD_PROVIDER}/util.sh
-source ${KUBE_ROOT}/cluster/kubemark/${CLOUD_PROVIDER}/config-default.sh
+KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/../..
+source "${KUBE_ROOT}/test/kubemark/cloud-provider-config.sh"
+source "${KUBE_ROOT}/cluster/${CLOUD_PROVIDER}/util.sh"
+source "${KUBE_ROOT}/cluster/kubemark/${CLOUD_PROVIDER}/config-default.sh"

hack/.shellcheck_failures

@@ -18,9 +18,6 @@
 ./cluster/gce/upgrade.sh
 ./cluster/gce/util.sh
 ./cluster/images/conformance/run_e2e.sh
-./cluster/kubemark/gce/config-default.sh
-./cluster/kubemark/iks/config-default.sh
-./cluster/kubemark/util.sh
 ./cluster/log-dump/log-dump.sh
 ./cluster/pre-existing/util.sh
 ./cluster/restore-from-backup.sh
@@ -133,16 +130,6 @@
 ./test/images/volume/rbd/create_block.sh
 ./test/images/volume/rbd/mon.sh
 ./test/images/volume/rbd/osd.sh
-./test/kubemark/common/util.sh
-./test/kubemark/gce/util.sh
-./test/kubemark/iks/shutdown.sh
-./test/kubemark/iks/startup.sh
-./test/kubemark/iks/util.sh
-./test/kubemark/master-log-dump.sh
-./test/kubemark/resources/start-kubemark-master.sh
-./test/kubemark/run-e2e-tests.sh
-./test/kubemark/start-kubemark.sh
-./test/kubemark/stop-kubemark.sh
 ./third_party/forked/shell2junit/sh2ju.sh
 ./third_party/intemp/intemp.sh
 ./third_party/multiarch/qemu-user-static/register/qemu-binfmt-conf.sh

test/kubemark/common/util.sh

@@ -17,7 +17,7 @@
 # Running cmd $RETRIES times in case of failures.
 function run-cmd-with-retries {
   RETRIES="${RETRIES:-3}"
-  for attempt in $(seq 1 ${RETRIES}); do
+  for attempt in $(seq 1 "${RETRIES}"); do
     local ret_val=0
     exec 5>&1 # Duplicate &1 to &5 for use below.
     # We don't use 'local' to declare result as then ret_val always gets value 0.
@@ -26,19 +26,24 @@ function run-cmd-with-retries {
     if [[ "${ret_val:-0}" -ne "0" ]]; then
       if [[ $(echo "${result}" | grep -c "already exists") -gt 0 ]]; then
         if [[ "${attempt}" == 1 ]]; then
+          # shellcheck disable=SC2154 # Color defined in sourced script
           echo -e "${color_red}Failed to $1 $2 ${3:-} as the resource hasn't been deleted from a previous run.${color_norm}" >& 2
           exit 1
         fi
+        # shellcheck disable=SC2154 # Color defined in sourced script
         echo -e "${color_yellow}Succeeded to $1 $2 ${3:-} in the previous attempt, but status response wasn't received.${color_norm}"
         return 0
       fi
+      # shellcheck disable=SC2154 # Color defined in sourced script
       echo -e "${color_yellow}Attempt $attempt failed to $1 $2 ${3:-}. Retrying.${color_norm}" >& 2
-      sleep $(($attempt * 5))
+      sleep $((attempt * 5))
     else
+      # shellcheck disable=SC2154 # Color defined in sourced script
       echo -e "${color_green}Succeeded to $1 $2 ${3:-}.${color_norm}"
       return 0
     fi
   done
+  # shellcheck disable=SC2154 # Color defined in sourced script
   echo -e "${color_red}Failed to $1 $2 ${3:-}.${color_norm}" >& 2
   exit 1
 }

test/kubemark/gce/util.sh

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-KUBE_ROOT=$(dirname "${BASH_SOURCE}")/../../..
+KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/../../..
 
 source "${KUBE_ROOT}/test/kubemark/common/util.sh"
 
@@ -47,7 +47,7 @@ function get-or-create-master-ip {
 }
 
 function create-master-instance-with-resources {
-  GCLOUD_COMMON_ARGS="--project ${PROJECT} --zone ${ZONE}"
+  GCLOUD_COMMON_ARGS=(--project "${PROJECT}" --zone "${ZONE}")
   # Override the master image project to cos-cloud for COS images staring with `cos` string prefix.
   DEFAULT_GCI_PROJECT=google-containers
   if [[ "${GCI_VERSION}" == "cos"* ]]; then
@@ -56,13 +56,13 @@ function create-master-instance-with-resources {
   MASTER_IMAGE_PROJECT=${KUBE_GCE_MASTER_PROJECT:-${DEFAULT_GCI_PROJECT}}
 
   run-gcloud-compute-with-retries disks create "${MASTER_NAME}-pd" \
-    ${GCLOUD_COMMON_ARGS} \
+    "${GCLOUD_COMMON_ARGS[@]}" \
     --type "${MASTER_DISK_TYPE}" \
     --size "${MASTER_DISK_SIZE}" &
 
   if [ "${EVENT_PD:-}" == "true" ]; then
     run-gcloud-compute-with-retries disks create "${MASTER_NAME}-event-pd" \
-      ${GCLOUD_COMMON_ARGS} \
+      "${GCLOUD_COMMON_ARGS[@]}" \
       --type "${MASTER_DISK_TYPE}" \
       --size "${MASTER_DISK_SIZE}" &
   fi
@@ -72,7 +72,7 @@ function create-master-instance-with-resources {
   wait
 
   run-gcloud-compute-with-retries instances create "${MASTER_NAME}" \
-    ${GCLOUD_COMMON_ARGS} \
+    "${GCLOUD_COMMON_ARGS[@]}" \
     --address "${MASTER_IP}" \
     --machine-type "${MASTER_SIZE}" \
     --image-project="${MASTER_IMAGE_PROJECT}" \
@@ -84,13 +84,13 @@ function create-master-instance-with-resources {
     --disk "name=${MASTER_NAME}-pd,device-name=master-pd,mode=rw,boot=no,auto-delete=no"
 
   run-gcloud-compute-with-retries instances add-metadata "${MASTER_NAME}" \
-    ${GCLOUD_COMMON_ARGS} \
+    "${GCLOUD_COMMON_ARGS[@]}" \
     --metadata-from-file startup-script="${KUBE_ROOT}/test/kubemark/resources/start-kubemark-master.sh" &
 
   if [ "${EVENT_PD:-}" == "true" ]; then
     echo "Attaching ${MASTER_NAME}-event-pd to ${MASTER_NAME}"
     run-gcloud-compute-with-retries instances attach-disk "${MASTER_NAME}" \
-    ${GCLOUD_COMMON_ARGS} \
+   "${GCLOUD_COMMON_ARGS[@]}" \
     --disk "${MASTER_NAME}-event-pd" \
     --device-name="master-event-pd" &
   fi
@@ -112,20 +112,20 @@ function execute-cmd-on-master-with-retries() {
 }
 
 function copy-files() {
-	run-gcloud-compute-with-retries scp --recurse --zone="${ZONE}" --project="${PROJECT}" $@
+	run-gcloud-compute-with-retries scp --recurse --zone="${ZONE}" --project="${PROJECT}" "$@"
 }
 
 function delete-master-instance-and-resources {
-  GCLOUD_COMMON_ARGS="--project ${PROJECT} --zone ${ZONE} --quiet"
+  GCLOUD_COMMON_ARGS=(--project "${PROJECT}" --zone "${ZONE}" --quiet)
 
   gcloud compute instances delete "${MASTER_NAME}" \
-      ${GCLOUD_COMMON_ARGS} || true
+      "${GCLOUD_COMMON_ARGS[@]}" || true
 
   gcloud compute disks delete "${MASTER_NAME}-pd" \
-      ${GCLOUD_COMMON_ARGS} || true
+      "${GCLOUD_COMMON_ARGS[@]}" || true
 
   gcloud compute disks delete "${MASTER_NAME}-event-pd" \
-      ${GCLOUD_COMMON_ARGS} &> /dev/null || true
+      "${GCLOUD_COMMON_ARGS[@]}" &> /dev/null || true
 
   gcloud compute addresses delete "${MASTER_NAME}-ip" \
       --project "${PROJECT}" \
@@ -138,9 +138,9 @@ function delete-master-instance-and-resources {
 
   if [ "${SEPARATE_EVENT_MACHINE:-false}" == "true" ]; then
 	  gcloud compute instances delete "${EVENT_STORE_NAME}" \
-    	  ${GCLOUD_COMMON_ARGS} || true
+    	  "${GCLOUD_COMMON_ARGS[@]}" || true
 
 	  gcloud compute disks delete "${EVENT_STORE_NAME}-pd" \
-    	  ${GCLOUD_COMMON_ARGS} || true
+        "${GCLOUD_COMMON_ARGS[@]}" || true
   fi
 }

test/kubemark/iks/shutdown.sh

@@ -24,6 +24,7 @@ RESOURCE_DIRECTORY="${KUBEMARK_DIRECTORY}/resources"
 complete-login
 
 # Remove resources created for kubemark
+# shellcheck disable=SC2154 # Color defined in sourced script
 echo -e "${color_yellow}REMOVING RESOURCES${color_norm}"
 spawn-config
 "${KUBECTL}" delete -f "${RESOURCE_DIRECTORY}/addons" &> /dev/null || true
@@ -35,8 +36,9 @@ rm -rf "${RESOURCE_DIRECTORY}/addons"
 # Remove clusters, namespaces, and deployments
 delete-clusters
 if [[ -f "${RESOURCE_DIRECTORY}/iks-namespacelist.sh" ]] ; then
-  bash ${RESOURCE_DIRECTORY}/iks-namespacelist.sh
-  rm -f ${RESOURCE_DIRECTORY}/iks-namespacelist.sh
+  bash "${RESOURCE_DIRECTORY}/iks-namespacelist.sh"
+  rm -f "${RESOURCE_DIRECTORY}/iks-namespacelist.sh"
 fi
+# shellcheck disable=SC2154 # Color defined in sourced script
 echo -e "${color_blue}EXECUTION COMPLETE${color_norm}"
 exit 0