Resolved shell check issues (#14)

Co-authored-by: ipsita-npg <[email protected]>
Co-authored-by: yvuppalx <[email protected]>

Author: 3 people

.github/workflows/auto-close.yml

@@ -4,8 +4,8 @@
 
 name: Stale Pull Requests
 
-# After 30 days of no activity on a PR, the PR should be marked as stale, 
-# a comment made on the PR informing the author of the new status, 
+# After 30 days of no activity on a PR, the PR should be marked as stale,
+# a comment made on the PR informing the author of the new status,
 # and closed after 15 days if there is no further activity from the change to stale state.
 on:
   schedule:
@@ -23,7 +23,7 @@ jobs:
       - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639  # v9.1.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-pr-message: 'This pull request is stale because it has been open 30 days with no activity. Make a comment or update the PR to avoid closing PR after 15 days.'
+          stale-pr-message: "This pull request is stale because it has been open 30 days with no activity. Make a comment or update the PR to avoid closing PR after 15 days."
           days-before-pr-stale: 30
           days-before-pr-close: 15
           remove-pr-stale-when-updated: 'true'

.github/workflows/pre-merge.yml

@@ -82,7 +82,8 @@ jobs:
       run_test: false
       run_validate_clean_folder: false
       run_docker_build: true
-      run_artifact: false
+      run_artifact: true
+      artifacts_path: "standalone-node/shellcheck_report.txt"
       prefix_tag_separator: "/"
       project_folder: ${{ matrix.project_folder }}
       trivy_image_skip:  "postgres:16.4"

common.mk

@@ -41,10 +41,10 @@ $(VENV_NAME): requirements.txt
 
 #### Lint and Validator Targets ####
 # https://github.com/koalaman/shellcheck
-SH_FILES := $(shell find . -type f \( -name '*.sh' \) -print )
+SH_FILES := $(shell find . -type f \( -name '*.sh' \) ! -path './cluster_installers/install.sh' -print)
 shellcheck: ## lint shell scripts with shellcheck
 	shellcheck --version
-	shellcheck -x -S style $(SH_FILES)
+	shellcheck -x -S style $(SH_FILES) >> shellcheck_report.txt
 
 # https://pypi.org/project/reuse/
 license: $(VENV_NAME) ## Check licensing with the reuse tool
@@ -86,4 +86,4 @@ help: ## Print help for each target
 	@echo "-------------------- ---------------- -----------------------------------------"
 	@grep -H -n '^[[:alnum:]_-]*:.* ##' $(MAKEFILE_LIST) \
     | sort -t ":" -k 3 \
-    | awk 'BEGIN  {FS=":"}; {sub(".* ## ", "", $$4)}; {printf "%-20s %-16s %s\n", $$3, $$1 ":" $$2, $$4};'
+    | awk 'BEGIN  {FS=":"}; {sub(".* ## ", "", $$4)}; {printf "%-20s %-16s %s\n", $$3, $$1 ":" $$2, $$4};'

standalone-node/Makefile

@@ -45,7 +45,7 @@ configure:
 	echo 'socks_proxy=$(socks_proxy)' >> hook_os/config
 	echo 'no_proxy=$(no_proxy)' >> hook_os/config
 
-lint: license yamllint mdlint
+lint: license yamllint mdlint shellcheck
 
 build: configure
 	@# Help: Runs build stage

standalone-node/cluster_installers/build_package.sh

@@ -1,7 +1,7 @@
+#!/bin/bash
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-#!/bin/bash
 
 if [ "$1" == "--no-ext-image" ]; then
     tar --exclude './extensions-templates' --exclude './docs' --exclude './charts' --exclude './download_charts_and_images.sh' --exclude './cleanup-artifacts.sh' --exclude 'build_package.sh' --exclude './sen-uninstall-rke2.sh' --exclude './images' -cvf sen-rke2-package.tar.gz ./*

standalone-node/cluster_installers/cleanup-artifacts.sh

@@ -1,7 +1,7 @@
+#!/bin/bash
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-#!/bin/bash
 
 # Remove RKE2 artifacts from directory
 rm -rf ./rke2* ./images ./charts ./sha256sum-amd64.txt ./install.sh ./sen-rke2-package.tar.gz 

standalone-node/cluster_installers/download_charts_and_images.sh

@@ -1,7 +1,7 @@
+#!/bin/bash
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-#!/bin/bash
 
 IMG_DIR=./images
 CHRT_DIR=./charts
@@ -84,28 +84,28 @@ download_extension_charts () {
 		url=$(echo "${chart}" | awk -F':' '{print $3":"$4}')
 		version=$(echo "${chart}" | awk -F':' '{print $5}')
 
-		if [ ${repo} == "intel-rs" ]; then
-			echo Fetching ${name} chart
-			helm fetch -d ${CHRT_DIR} ${url}/${name} --version ${version}
-			base64 -w 0 ${CHRT_DIR}/${name}-$version.tgz > ${CHRT_DIR}/$name.base64
+		if [ "${repo}" == "intel-rs" ]; then
+			echo Fetching "${name}" chart
+			helm fetch -d ${CHRT_DIR} "${url}"/"${name}" --version "${version}"
+			base64 -w 0 ${CHRT_DIR}/"${name}"-"$version".tgz > ${CHRT_DIR}/"$name".base64
 
 		else
-			echo Fetching ${name} chart
-			helm repo add ${repo} ${url}
-			helm fetch -d ${CHRT_DIR} ${repo}/${name} --version ${version}
-			if [ ${name} == "cert-manager" ]; then version="v${version}"; fi
-			if [ ${name} == "node-feature-discovery" ]; then version="chart-${version}"; fi
-			base64 -w 0 ${CHRT_DIR}/${name}-${version}.tgz > ${CHRT_DIR}/${name}.base64
+			echo Fetching "${name}" chart
+			helm repo add "${repo}" "${url}"
+			helm fetch -d ${CHRT_DIR} "${repo}"/"${name}" --version "${version}"
+			if [ "${name}" == "cert-manager" ]; then version="v${version}"; fi
+			if [ "${name}" == "node-feature-discovery" ]; then version="chart-${version}"; fi
+			base64 -w 0 ${CHRT_DIR}/"${name}"-"${version}".tgz > ${CHRT_DIR}/"${name}".base64
 		fi
 		# Remove unnecessary files from kube-prometheus-stack, reason:  then base encoded file becomes to big and cannot be consumed when installing via add-on on RKE2
-		if [ ${name} == "kube-prometheus-stack" ]; then
-			tar -xzf ${CHRT_DIR}/${name}-${version}.tgz -C ${CHRT_DIR}
-			rm -rf ${CHRT_DIR}/${name}-${version}.tgz
-			rm ${CHRT_DIR}/${name}/README.md
-			rm ${CHRT_DIR}/${name}/templates/grafana/dashboards-1.14/*windows*
-			rm -rf ${CHRT_DIR}/${name}/templates/thanos-ruler
-			tar -cf ${CHRT_DIR}/${name}-${version}.tgz --use-compress-program="gzip -9" -C ${CHRT_DIR} ${name}
-			base64 -w 0 ${CHRT_DIR}/${name}-${version}.tgz > ${CHRT_DIR}/${name}.base64
+		if [ "${name}" == "kube-prometheus-stack" ]; then
+			tar -xzf ${CHRT_DIR}/"${name}"-"${version}".tgz -C ${CHRT_DIR}
+			rm -rf ${CHRT_DIR}/"${name}"-"${version}".tgz
+			rm ${CHRT_DIR}/"${name}"/README.md
+			rm ${CHRT_DIR}/"${name}"/templates/grafana/dashboards-1.14/*windows*
+			rm -rf ${CHRT_DIR}/"${name}"/templates/thanos-ruler
+			tar -cf ${CHRT_DIR}/"${name}"-"${version}".tgz --use-compress-program="gzip -9" -C ${CHRT_DIR} "${name}"
+			base64 -w 0 ${CHRT_DIR}/"${name}"-"${version}".tgz > ${CHRT_DIR}/"${name}".base64
 		fi
 		# Template HelmChart addon manifets using the base64 chart
 		awk "/chartContent:/ {printf \"  chartContent: \"; while ((getline line < \"${CHRT_DIR}/${name}.base64\") > 0) printf \"%s\", line; close(\"${CHRT_DIR}/${name}.base64\"); print \"\"; next} 1" "${TPL_DIR}/${name}.yaml" > "${EXT_DIR}/${name}.yaml"
@@ -122,15 +122,15 @@ download_extension_images () {
 	echo "Downloading container images"
 	mkdir -p ${IMG_DIR}
 	for image in "${images[@]}" ; do
-		podman pull ${image}
-		img_name=$(echo ${image##*/} | tr ':' '-')
+		podman pull "${image}"
+		img_name=$(echo "${image##*/}" | tr ':' '-')
 		DEST=${IMG_DIR}/${TAR_PRX}-${img_name}.${TAR_SFX}
-		podman image save --output ${DEST}.tmp ${image}
-		bsdtar -c -f ${DEST} --include=manifest.json --include=repositories @${DEST}.tmp
-		bsdtar -r -f ${DEST} --exclude=manifest.json --exclude=repositories @${DEST}.tmp
-		rm -f ${DEST}.tmp
-		zstd -T0 -16 -f --long=25 --no-progress ${DEST} -o ${IMG_DIR}/${TAR_PRX}-${img_name}.${TAR_SFX}.zst
-		rm -f ${DEST}
+		podman image save --output "${DEST}".tmp "${image}"
+		bsdtar -c -f "${DEST}" --include=manifest.json --include=repositories @"${DEST}".tmp
+		bsdtar -r -f "${DEST}" --exclude=manifest.json --exclude=repositories @"${DEST}".tmp
+		rm -f "${DEST}".tmp
+		zstd -T0 -16 -f --long=25 --no-progress "${DEST}" -o ${IMG_DIR}/${TAR_PRX}-"${img_name}".${TAR_SFX}.zst
+		rm -f "${DEST}"
 	done
 }
 # Download K8s dashboard

standalone-node/cluster_installers/sen-rke2-installer.sh

@@ -1,7 +1,7 @@
+#!/bin/bash
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-#!/bin/bash
 
 RKE_INSTALLER_PATH=/"${1:-/tmp/rke2-artifacts}"
 # for basic testing on a coder setup
@@ -96,7 +96,7 @@ EOF'
 
 # Install RKE2
 echo "$(date): Installing RKE2 2/13" | sudo tee -a /var/log/cluster-init.log | sudo tee /dev/tty0
-sudo INSTALL_RKE2_ARTIFACT_PATH=${RKE_INSTALLER_PATH} sh install.sh
+sudo INSTALL_RKE2_ARTIFACT_PATH="${RKE_INSTALLER_PATH}" sh install.sh
 
 # Copy the cni tarballs
 echo "$(date): Copying images and extensions 3/13" | sudo tee -a /var/log/cluster-init.log | sudo tee /dev/tty0
@@ -126,7 +126,7 @@ until sudo -E KUBECONFIG=/etc/rancher/rke2/rke2.yaml /var/lib/rancher/rke2/bin/k
 echo "$(date): RKE2 started 6/13" | sudo tee -a /var/log/cluster-init.log | sudo tee /dev/tty0
 # Label node as a worker
 hostname=$(hostname | tr '[:upper:]' '[:lower:]')
-sudo -E KUBECONFIG=/etc/rancher/rke2/rke2.yaml /var/lib/rancher/rke2/bin/kubectl label node $hostname node-role.kubernetes.io/worker=true
+sudo -E KUBECONFIG=/etc/rancher/rke2/rke2.yaml /var/lib/rancher/rke2/bin/kubectl label node "$hostname" node-role.kubernetes.io/worker=true
 
 # Wait for the deployment to complete
 

standalone-node/cluster_installers/sen-uninstall-rke2.sh

@@ -1,7 +1,7 @@
+#!/bin/bash
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-#!/bin/bash
 
 # for basic testing on a coder setup
 if grep -q "Ubuntu" /etc/os-release; then

standalone-node/hook_os/bash/docker.sh

@@ -21,6 +21,7 @@ function check_docker_daemon_for_sanity() {
 	fi
 
 	# Once we know docker is sane, hook up a function that helps us trace invocations.
+	# shellcheck disable=SC2317
 	function docker() {
 		log debug "--> docker $*"
 		command docker "$@"