Shellcheck - fix errors and add to CI (#26)

Fix shellcheck errors in the existing code Add shellcheck workflow to GitHub CI Add the shellcheck workflow to the dependencies of the release workflow
redhat-cop · Nov 30, 2023 · fb014b6 · fb014b6
1 parent 38f69b0
commit fb014b6
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 8 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,10 +11,13 @@ jobs:
     uses: swapdisk/lvm_snapshots/.github/workflows/ansible-lint.yml@main
   pylint:
     uses: swapdisk/lvm_snapshots/.github/workflows/pylint.yml@main
+  shellcheck:
+      uses: swapdisk/lvm_snapshots/.github/workflows/shellcheck.yml@main
   prechecks:
     needs:
       - ansible-lint
       - pylint
+      - shellcheck
     runs-on: ubuntu-latest
     steps:
       - run: >-

diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
@@ -0,0 +1,18 @@
+name: ShellCheck
+on:
+- push
+- pull_request
+- workflow_call
+
+jobs:
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master
diff --git a/roles/bigboot/files/bigboot.sh b/roles/bigboot/files/bigboot.sh
@@ -129,16 +129,16 @@ parse_flags() {
         do
         case $i in
             -d=*|--device=*)
-            DEVICE_NAME=(${i#*=})
+            DEVICE_NAME="(${i#*=})"
             ;;
             -s=*|--size=*)
-            INCREMENT_BOOT_PARTITION_SIZE=(${i#*=})
+            INCREMENT_BOOT_PARTITION_SIZE="(${i#*=})"
             ;;
             -b=*|--boot=*)
-            BOOT_PARTITION_NUMBER=(${i#*=})
+            BOOT_PARTITION_NUMBER="(${i#*=})"
             ;;
             -p=*|--prefix=*)
-            PARTITION_PREFIX=(${i#*=})
+            PARTITION_PREFIX="(${i#*=})"
             ;;
             -h)
             print_help

diff --git a/roles/bigboot/files/module-setup.sh b/roles/bigboot/files/module-setup.sh
@@ -8,6 +8,7 @@ check(){
 
 install() {
     inst_multiple -o /usr/bin/mount /usr/bin/umount /usr/sbin/parted /usr/bin/mktemp /usr/bin/wc /usr/bin/date /usr/bin/sed /usr/bin/awk /usr/bin/basename /usr/sbin/resize2fs /usr/sbin/tune2fs /usr/sbin/partprobe /usr/bin/numfmt /usr/sbin/lvm /usr/bin/lsblk /usr/sbin/e2fsck /usr/sbin/fdisk /usr/bin/findmnt /usr/bin/tail /usr/ /usr/sbin/xfs_growfs /usr/sbin/xfs_db
+    # shellcheck disable=SC2154
     inst_hook pre-mount 99 "$moddir/increase-boot-partition.sh"
     inst_binary "$moddir/sfdisk.static" "/usr/sbin/sfdisk"
     inst_simple "$moddir/bigboot.sh" "/usr/bin/bigboot.sh"

diff --git a/roles/shrink_lv/files/module-setup.sh b/roles/shrink_lv/files/module-setup.sh
@@ -8,6 +8,7 @@ check(){
 
 install() {
     inst_multiple -o /usr/bin/numfmt /usr/bin/findmnt /usr/bin/lsblk /usr/sbin/lvm /usr/bin/awk /usr/bin/sed /usr/bin/mktemp /usr/bin/date /usr/bin/head /usr/sbin/blockdev /usr/sbin/tune2fs /usr/sbin/resize2fs /usr/bin/cut /usr/sbin/fsadm /usr/sbin/fsck.ext4
+    # shellcheck disable=SC2154
     inst_hook pre-mount 99 "$moddir/shrink-start.sh"
     inst_simple "$moddir/shrink.sh" "/usr/bin/shrink.sh"
 }
diff --git a/roles/shrink_lv/files/shrink.sh b/roles/shrink_lv/files/shrink.sh
@@ -16,8 +16,9 @@ function get_device_name() {
 }
 
 function ensure_size_in_bytes() {
-    local expected_size=$(/usr/bin/numfmt  --from iec "$1")
-    let expected_size=(${expected_size} + $VOLUME_SIZE_ALIGNMENT)/$VOLUME_SIZE_ALIGNMENT*$VOLUME_SIZE_ALIGNMENT
+    local expected_size
+    expected_size=$(/usr/bin/numfmt  --from iec "$1")
+    (( expected_size=(expected_size+VOLUME_SIZE_ALIGNMENT)/VOLUME_SIZE_ALIGNMENT*VOLUME_SIZE_ALIGNMENT ))
     echo $expected_size
 }
 
@@ -163,7 +164,7 @@ function parse_flags() {
         do
         case $i in
             -d=*|--device=*)
-            entries+=(${i#*=})
+            entries+="(${i#*=})"
             ;;
             -h)
             display_help
@@ -185,7 +186,7 @@ function parse_flags() {
 
 function parse_entry() {
     IFS=':'
-    read -a strarr <<< "$1"
+    read -ra strarr <<< "$1"
 
     if [[ ${#strarr[@]} != 2 ]]; then
         echo "Invalid device entry $1"