Shell check test (#153)

Author: ipsita-npg

standalone-node/Makefile

@@ -41,7 +41,7 @@ all:
 configure:
 
 #lint: license yamllint mdlint shellcheck #uncomment this line and remove next line after shellcheck is fixed
-lint: license yamllint mdlint
+lint: license shellcheck yamllint mdlint
 
 build: configure
 	@# Help: Runs build stage

standalone-node/installation_scripts/bootable-usb-prepare.sh

@@ -113,7 +113,7 @@ fi
 # Ask the password from cmd line 
 echo -n "Please Set the Password for $user_name: "
 stty -echo
-read password
+read -r password
 stty echo
 echo 
 
@@ -123,16 +123,15 @@ chmod 600 "$(pwd)/.psswd"
 
 # Validate the custom-cloud-init section
 if ! dpkg -s python3 > /dev/null 2>&1; then
-    apt install -y python3 > /dev/null 2>&1
-    if [ "$?" -ne 0 ]; then
+    if ! apt install -y python3 > /dev/null 2>&1; then
         echo "Pyhon installation failed,please check!!"
     fi
 fi
 CONFIG_FILE="config-file"
 START_MARKER="^services:"
 
 # Extract YAML content from custom cloud-init-section
-# if any error,throw the erros  
+# if any error,throw the errors  
 YAML_CONTENT=$(awk "/$START_MARKER/ {found=1} found" "$CONFIG_FILE")
 
 # Validate using Python
@@ -154,14 +153,15 @@ try:
                     print(f"Invalid runcmd item: {item!r}")
                     sys.exit(1)
     else:
-	    print("")
+        print("")
 except yaml.YAMLError as e:
     print("Custom cloud-init YAML is invalid:\n", e)
     sys.exit(1)
 '
 # Catch the Error
+# shellcheck disable=SC2181
 if [ "$?" -ne 0 ]; then
-    echo "Custome cloud-init file is not valiad,Please check!!"
+    echo "Custom cloud-init file is not valid,Please check!!"
     exit 1
 fi
 
@@ -340,7 +340,7 @@ copy_files() {
         echo "Custom files copied!"
     fi
     # Remove the hidden password file
-    rm -rf $(pwd)/.psswd
+    rm -rf "$(pwd)/.psswd"
 }
 copy_user_apps() {
     echo "Copying user-apps to USB device..."
@@ -350,23 +350,21 @@ copy_user_apps() {
             USER_APPS_PART="p$USER_APPS_PART"
         fi
         check_mnt_mount_exist
-        mount ${USB_DEVICE}${USER_APPS_PART} /mnt
+        mount "${USB_DEVICE}${USER_APPS_PART}" /mnt
         # Use rsync for fater copr
-        if dpkg -s rsync; then 
-            rsync -ah --inplace user-apps /mnt/
-            if [ "$?" -eq 0 ]; then 
+        if dpkg -s rsync; then
+            if rsync -ah --inplace user-apps /mnt/; then 
                 echo "user-apps data copied successfully"
             else
-                echo "user-apps data failes to copy please check!!"
+                echo "user-apps data fails to copy please check!!"
                 umount /mnt
                 exit 1
             fi
-        else 
-            cp -r user-apps /mnt
-            if [ "$?" -eq 0 ]; then
+        else             
+            if cp -r user-apps /mnt; then
                 echo "user-apps data copied successfully"
             else
-                echo "user-apps data failes to copy please check!!"
+                echo "user-apps data fails to copy please check!!"
                 umount /mnt
                 exit 1
             fi

standalone-node/installation_scripts/download_images.sh

@@ -65,7 +65,7 @@ manifests=(
 download_k3s_artifacts () {
 	echo "Downloading k3s artifacts"
 	mkdir -p ${OUT_DIR}/${ARTIFACT_DIR}
-	cd ${OUT_DIR}/${ARTIFACT_DIR}
+	cd ${OUT_DIR}/${ARTIFACT_DIR} || exit
 	curl -OLs https://github.com/k3s-io/k3s/releases/download/v1.32.4%2Bk3s1/sha256sum-amd64.txt
 	curl -sfL https://get.k3s.io --output install.sh
 	curl -OLs https://github.com/k3s-io/k3s/releases/download/v1.32.4%2Bk3s1/k3s
@@ -76,18 +76,19 @@ download_k3s_artifacts () {
 download_airgap_images () {
 	echo "Downloading kubernetes container images"
 	mkdir -p ${OUT_DIR}/${IMG_DIR}
-	cd ${OUT_DIR}/${IMG_DIR} && curl -OLs https://github.com/k3s-io/k3s/releases/download/v1.32.4%2Bk3s1/k3s-airgap-images-amd64.tar.zst && cd ../../
+	cd ${OUT_DIR}/${IMG_DIR} || exit
+	curl -OLs https://github.com/k3s-io/k3s/releases/download/v1.32.4%2Bk3s1/k3s-airgap-images-amd64.tar.zst
+	cd ../../
 }
 
 # Download extension manifests
 download_extension_manifests () {
 	echo "Downloading addons manifests"
 	mkdir -p ${OUT_DIR}/${MANIFEST_DIR}
-	cd ${OUT_DIR}/${MANIFEST_DIR}
+	cd ${OUT_DIR}/${MANIFEST_DIR} || exit
 	for manifest in "${manifests[@]}" ; do
 		name=$(basename "${manifest}")
-		curl -OLs "${manifest}" -o "${OUT_DIR}/${MANIFEST_DIR}/${name}"
-		if [ $? -ne 0 ]; then
+		if ! curl -OLs "${manifest}" -o "${OUT_DIR}/${MANIFEST_DIR}/${name}"; then
 			echo "Failed to download ${name}"
 			exit 1			
 		fi
@@ -105,32 +106,32 @@ download_extension_images () {
 	mkdir -p ${OUT_DIR}/${IMG_DIR}
 	for image in "${images[@]}" ; do
 		## check if image exists already in podman
-		if docker image inspect ${image} > /dev/null 2>&1; then
+		if docker image inspect "${image}" > /dev/null 2>&1; then
 			echo "Image ${image} already exists, skipping download"
 		else
-			docker pull ${image}
+			docker pull "${image}"
 		fi
-		img_name=$(echo ${image##*/} | tr ':' '-')
+		img_name=$(echo "${image##*/}" | tr ':' '-')
 		DEST=${OUT_DIR}/${IMG_DIR}/${TAR_PRX}-${img_name}.${TAR_SFX}
-		docker save -o ${DEST}.tmp ${image}
+		docker save -o "${DEST}.tmp" "${image}"
 		# Create temp dirs for processing
         mkdir -p /tmp/image_repacking/{manifest,content}
 
         # Extract only manifest.json and repositories first
-        tar -xf ${DEST}.tmp -C /tmp/image_repacking/manifest manifest.json repositories 2>/dev/null
+        tar -xf "${DEST}.tmp" -C /tmp/image_repacking/manifest manifest.json repositories 2>/dev/null
 
         # Create initial tar with just the manifest files
-        tar -cf ${DEST} -C /tmp/image_repacking/manifest .
+        tar -cf "${DEST}" -C /tmp/image_repacking/manifest .
 
         # Extract all remaining files (excluding manifest.json and repositories)
-        tar -xf ${DEST}.tmp --exclude="manifest.json" --exclude="repositories" -C /tmp/image_repacking/content
+        tar -xf "${DEST}.tmp" --exclude="manifest.json" --exclude="repositories" -C /tmp/image_repacking/content
 
         # Append all other files to tar
-        tar -rf ${DEST} -C /tmp/image_repacking/content .
+        tar -rf "${DEST}" -C /tmp/image_repacking/content .
 
         # Clean up
         rm -rf /tmp/image_repacking
-        rm -f ${DEST}.tmp
+        rm -f "${DEST}.tmp"
 	done
 }
 
@@ -139,7 +140,7 @@ download_idv_kubevirt_images_and_manifests () {
 	echo "Downloading idv kubevirt artifacts"
 	# download the artifacts
 	mkdir -p ${OUT_DIR}/${ARTIFACT_DIR}
-	cd ${OUT_DIR}/${ARTIFACT_DIR}
+	cd ${OUT_DIR}/${ARTIFACT_DIR} || exit
 	curl -OLs https://github.com/open-edge-platform/edge-desktop-virtualization/releases/download/1.0.0-rc2/intel-idv-kubevirt-1.0.0-rc2.tar.gz
 	# untar
 	tar -xzf intel-idv-kubevirt-1.0.0-rc2.tar.gz -C .
@@ -159,7 +160,7 @@ download_idv_device_plugins_images_and_manifests () {
 	echo "Downloading idv device plugin artifacts"
 	# download the artifacts
 	mkdir -p ${OUT_DIR}/${ARTIFACT_DIR}
-	cd ${OUT_DIR}/${ARTIFACT_DIR}
+	cd ${OUT_DIR}/${ARTIFACT_DIR} || exit
 	curl -OLs https://github.com/open-edge-platform/edge-desktop-virtualization/releases/download/1.0.0-rc2/intel-idv-device-plugin-1.0.0-rc2.tar.gz
 	# untar
 	tar -xzf intel-idv-device-plugin-1.0.0-rc2.tar.gz -C .
@@ -184,7 +185,7 @@ install_pkgs () {
 if [ "${BINARY_INSTALL}" = true ]; then
 	download_k3s_artifacts
 fi
-if [ "${ARIGAP}" = true ]; then
+if [ "${AIRGAP}" = true ]; then
 	download_airgap_images
 fi
 if [ "${IDV_EXTENSIONS}" = true ]; then

standalone-node/installation_scripts/standalone-vm-setup.sh

@@ -25,7 +25,7 @@ deploy_mode=$(grep '^deploy_envmt=' "$CONFIG_FILE" | cut -d '=' -f2)
 deploy_mode=$(echo "$deploy_mode" | tr -d '"')
 
 if [ "$deploy_mode" != "ven" ]; then
-    echo "Please Make sure update the deploy_envmt="ven" in config-file"
+    echo 'Please Make sure update the deploy_envmt="ven" in config-file'
     exit 1
 fi
 
@@ -42,8 +42,7 @@ fi
 if ! dpkg -s qemu-system-x86 >/dev/null 2>&1; then
     echo  "Installing qemu-system-x86.., Please Wait!!"
     apt update
-    apt install -y qemu-system-x86 >/dev/null 2>&1
-    if [ "$?" -ne 0 ]; then
+    if ! apt install -y qemu-system-x86 >/dev/null 2>&1; then
         echo "Qemu Installation Failed,Please check!!"
         exit 1
     fi	
@@ -82,10 +81,11 @@ fi
 ./bootable-usb-prepare.sh /dev/nbd0 usb-bootable-files.tar.gz config-file || { echo "USB device setup failed,please check"; exit 1; }
 
 # Copy the new image if its provided
+# shellcheck disable=SC2236
 if [ ! -z "$new_img" ]; then
     mount /dev/nbd0p5 /mnt
+    # shellcheck disable=SC2115
     rm -rf /mnt/*
-    cp $new_img /mnt
     cp "$new_img" /mnt
     umount /mnt
     sync
@@ -103,6 +103,7 @@ echo "Starting the Installation"
 echo ""
 echo "Please see the installation status on VNC viewer.Enter $host_ip:1 on vnc viewer"
 # Added -cpu host,+vms It will support nested VM configuration as well
+# shellcheck disable=SC2115
 sudo -E qemu-system-x86_64  \
   -m 4G   -enable-kvm  \
   -cpu host,+vmx \
@@ -115,7 +116,7 @@ sudo -E qemu-system-x86_64  \
   -drive file=/dev/nbd0,format=raw,id=usb,if=none \
   -netdev user,id=net0,hostfwd=tcp::2222-:22 \
   -device e1000,netdev=net0
-  
+# shellcheck disable=SC2181
 if [ "$?" -ne 0 ]; then
     echo "Intallation VM launch Failed,Please check!!"
 fi

standalone-node/installation_scripts/write-image-to-usb.sh

@@ -40,15 +40,15 @@ fi
 # Function to wipe filesystem signatures
 wipe_partition() {
     # Check existing filesystem signatures
-    echo "Checking existing filesystem signatures on "$USB_DEVICE"..."
+    echo "Checking existing filesystem signatures on $USB_DEVICE..."
     wipefs --all --no-act "$USB_DEVICE"
 
     # Prompt user for confirmation
-    read -p "Do you want to wipe all filesystem signatures from "$USB_DEVICE"? (yes/no): " user_input
+    read -rp "Do you want to wipe all filesystem signatures from $USB_DEVICE? (yes/no): " user_input
 
     if [[ "$user_input" == "yes" ]]; then
         # Wipe filesystem signatures
-        echo "Wiping filesystem signatures from "$USB_DEVICE"..."
+        echo "Wiping filesystem signatures from $USB_DEVICE..."
         wipefs --all "$USB_DEVICE" || {
             echo "Error: Failed to wipe filesystem signatures from $USB_DEVICE"
             exit 1
@@ -83,7 +83,7 @@ wipe_partition
 
 # Check for blockdev partprobe and ensure they are installed
 for cmd in blockdev partprobe; do
-    if ! command -v $cmd &> /dev/null; then
+    if ! command -v "$cmd" &> /dev/null; then
         echo "Error: $cmd is not installed. Please install it before proceeding."
         exit 1
     fi
@@ -93,7 +93,7 @@ sgdisk -e "$USB_DEVICE" >/dev/null 2>&1
 blockdev --rereadpt "${USB_DEVICE}"
 
 # Create a new partition table
-echo "Creating a new parition table on "${USB_DEVICE}" "
+echo "Creating a new partition table on $USB_DEVICE"
 create_partition() {
     local start=$1
     local end=$2
@@ -128,17 +128,17 @@ copy_to_partition() {
     while [ $attempt -lt $retries ]; do
         if mount "${USB_DEVICE}${part}" "$mount_dir" && rsync --progress "$src" "$mount_dir"; then
             if umount "$mount_dir"; then
-                echo "Successfully copied $src to "$mount_dir" on partition ${USB_DEVICE}${part}."
+                echo "Successfully copied $src to $mount_dir on partition ${USB_DEVICE}${part}."
                 break
             fi
         else
-            echo "Error: Failed to copy $src to "$mount_dir" on attempt $((attempt + 1))/$retries. Retrying..."
+            echo "Error: Failed to copy $src to $mount_dir on attempt $((attempt + 1))/$retries. Retrying..."
             umount "$mount_dir" || true
             sleep 2
         fi
         attempt=$((attempt + 1))
         if [ "$attempt" -eq 2 ]; then
-            echo "Error: Failed to copy $src to "$mount_dir" after $retries attempts!"
+            echo "Error: Failed to copy $src to $mount_dir after $retries attempts!"
             exit 1
         fi
     done

standalone-node/provisioning_scripts/install-os.sh

@@ -72,6 +72,7 @@ check_mnt_mount_exist() {
 detect_usb() {
     for _ in {1..15}; do
         usb_devices=$(lsblk -dn -o NAME,TYPE,SIZE,RM | awk '$2 == "disk" && $4 == 1 && $3 != "0B" {print $1}')
+        # shellcheck disable=SC2086
         for disk_name in $usb_devices; do
             # Bootable USB has 6 partitions,ignore other disks
             if [ "$(lsblk -l "/dev/$disk_name" | grep -c "^$(basename "/dev/$disk_name")[0-9]")" -eq 7 ]; then
@@ -148,6 +149,7 @@ get_block_device_details() {
     echo -e "${GREEN}Found the OS disk  $os_disk${NC}" 
 
     # Clear the disk partitions
+    # shellcheck disable=SC2086
     for disk_name in ${blk_devices}; do
         dd if=/dev/zero of="/dev/$disk_name" bs=100M count=20
 	wipefs --all "/dev/$disk_name"
@@ -424,6 +426,7 @@ boot_order_chage_to_disk() {
 
     efiboot=$(blkid | grep -Ei 'TYPE="vfat"' | grep -Ei 'LABEL="esp|uefi"' |  awk -F: '{print $1}')
 
+    # shellcheck disable=SC2034
     if echo "$efiboot" | grep -q "nvme"; then
         osdisk=$(echo "$rootfs" | grep -oE 'nvme[0-9]+n[0-9]+' | head -n 1)
     elif echo "$efiboot" | grep -q "sd"; then
@@ -434,19 +437,18 @@ boot_order_chage_to_disk() {
     check_mnt_mount_exist
 
     mount "${rootfs}" /mnt
-    mount $efiboot /mnt/boot/efi
+    mount "$efiboot" /mnt/boot/efi
     mount --bind /dev /mnt/dev
     mount --bind /dev/pts /mnt/dev/pts
     mount --bind /proc /mnt/proc
     mount --bind /sys /mnt/sys
     mount --bind /sys/firmware/efi/efivars /mnt/sys/firmware/efi/efivars
 
-    chroot /mnt /bin/bash <<EOT
+    if chroot /mnt /bin/bash <<EOT
     set -e
     bootctl install
 EOT
-
-    if [ "$?" -eq 0 ]; then
+    then
         success "Made Disk as first boot option"
 	#unmount the partitions
         for mount in $(mount | grep '/mnt' | awk '{print $3}' | sort -nr); do
@@ -505,7 +507,7 @@ custom_cloud_init_updates() {
 
     config_file="/mnt/config-file"
 
-    cp $config_file /etc/scripts
+    cp "$config_file" /etc/scripts
     CONFIG_FILE="/etc/scripts/config-file"
 
     umount /mnt

standalone-node/provisioning_scripts/k3s-configure.sh

@@ -5,14 +5,14 @@
 
 # Start the cluster install scripts only once
 if [ ! -f "/var/lib/rancher/k3s_status" ]; then
-    cd /etc/cloud/
+    cd /etc/cloud/ || exit
 
     chmod +x sen-k3s-installer.sh
 
     bash sen-k3s-installer.sh
 else
     echo "k3s is already installed and running. Skipping installation." | sudo tee /var/log/cluster-init.log | sudo tee /dev/tty1
-    cd /etc/cloud/
+    cd /etc/cloud/ || exit
     chmod +x k3s-setup-post-reboot.sh
     bash k3s-setup-post-reboot.sh
 fi

standalone-node/provisioning_scripts/os-partition.sh

@@ -3,6 +3,10 @@
 # SPDX-FileCopyrightText: (C) 2025 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
+# shellcheck disable=SC2086  # Double quote to prevent globbing and word splitting - intentionally not quoted for disk operations
+# shellcheck disable=SC2002  # Useless cat - using cat for readability and consistency
+# shellcheck disable=SC2181  # Check exit code directly - using $? for compatibility with sh
+
 set -x
 
 ##global variables#####