Merge pull request #781 from mandre/shellcheck

CI: Add a bash linter to pre-submits

.github/workflows/test.yml

@@ -100,6 +100,16 @@ jobs:
         # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
         version: v1.55.2
 
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
+        with:
+          severity: error
+
   test-coverage:
     name: test-coverage
     runs-on: ubuntu-latest

hack/deploy-setup.sh

@@ -22,7 +22,7 @@ load_manifest() {
     fi
     files="service_account.yaml role.yaml role_binding.yaml clusterrole.yaml clusterrolebinding.yaml configmap.yaml sriovoperatorconfig.yaml operator.yaml"
     for m in ${files}; do
-      if [ "$(echo ${EXCLUSIONS[@]} | grep -o ${m} | wc -w | xargs)" == "0" ] ; then
+      if [ "$(echo "${EXCLUSIONS[@]}" | grep -o ${m} | wc -w | xargs)" == "0" ] ; then
         envsubst< ${m} | ${OPERATOR_EXEC} apply ${namespace:-} --validate=false -f -
       fi
     done

hack/env.sh

@@ -1,3 +1,5 @@
+#!/bin/bash
+
 if [ -z $SKIP_VAR_SET ]; then
         export SRIOV_CNI_IMAGE=${SRIOV_CNI_IMAGE:-ghcr.io/k8snetworkplumbingwg/sriov-cni}
         export SRIOV_INFINIBAND_CNI_IMAGE=${SRIOV_INFINIBAND_CNI_IMAGE:-ghcr.io/k8snetworkplumbingwg/ib-sriov-cni}

hack/run-e2e-test-kind.sh

@@ -6,7 +6,7 @@ export SRIOV_NETWORK_OPERATOR_IMAGE="${SRIOV_NETWORK_OPERATOR_IMAGE:-sriov-netwo
 export SRIOV_NETWORK_CONFIG_DAEMON_IMAGE="${SRIOV_NETWORK_CONFIG_DAEMON_IMAGE:-origin-sriov-network-config-daemon:e2e-test}"
 export KUBECONFIG="${KUBECONFIG:-${HOME}/.kube/config}"
 INTERFACES_SWITCHER="${INTERFACES_SWITCHER:-"test-suite"}"
-SUPPORTED_INTERFACE_SWTICHER_MODES=("test-suite", "system-service")
+SUPPORTED_INTERFACE_SWITCHER_MODES=("test-suite", "system-service")
 RETRY_MAX=10
 INTERVAL=10
 TIMEOUT=300
@@ -16,9 +16,9 @@ while test $# -gt 0; do
     case "$1" in
     --device-netns-switcher)
         INTERFACES_SWITCHER="$2"
-        if [[ ! "${SUPPORTED_INTERFACE_SWTICHER_MODES[@]}" =~ "${INTERFACES_SWITCHER}" ]]; then
+        if [[ ! "${SUPPORTED_INTERFACE_SWITCHER_MODES[*]}" =~ "${INTERFACES_SWITCHER}" ]]; then
             echo "Error: unsupported interface switching mode: ${INTERFACES_SWITCHER}!"
-            echo "Supported modes are: ${SUPPORTED_INTERFACE_SWTICHER_MODES[@]}"
+            echo "Supported modes are: ${SUPPORTED_INTERFACE_SWITCHER_MODES[*]}"
             exit 1
         fi
         shift

hack/vf-netns-switcher.sh

@@ -95,7 +95,7 @@ It must be of the form <netns>:<pf1>,<pf2>. This flag can be repeated to specify
 done
 
 return_interfaces_to_default_namespace(){
-    for netns in ${netnses[@]};do
+    for netns in "${netnses[@]}";do
         for pf in ${pfs[$netns]};do
             return_interface_to_default_namespace "${netns}" "${pf}"
         done
@@ -277,19 +277,20 @@ switch_interface_vf_representors(){
         return 0
     fi
 
-    for interface in $(ls /sys/class/net);do
-        phys_switch_id=$(cat /sys/class/net/$interface/phys_switch_id)
+    for interface in /sys/class/net/*;do
+        phys_switch_id=$(cat $interface/phys_switch_id)
         if [[ "$phys_switch_id" != "${pf_switch_ids[$pf_name]}" ]]; then
             continue
         fi
-        phys_port_name=$(cat /sys/class/net/$interface/phys_port_name)
+        phys_port_name=$(cat $interface/phys_port_name)
         phys_port_name_pf_index=${phys_port_name%vf*}
         phys_port_name_pf_index=${phys_port_name_pf_index#pf}
         if [[ "$phys_port_name_pf_index" != "${pf_port_names[$pf_name]:1}"  ]]; then
             continue
         fi
-        echo "Switching VF representor $interface of PF $pf_name to netns $worker_netns"
-        switch_vf $interface $worker_netns
+        interface_name=${interface##*/}
+        echo "Switching VF representor $interface_name of PF $pf_name to netns $worker_netns"
+        switch_vf $interface_name $worker_netns
     done
 }
 
@@ -348,7 +349,7 @@ variables_check(){
 check_empty_var(){
     local var_name="$1"
 
-    if [[ -z "${!var_name[@]}" ]];then
+    if [[ -z "${!var_name[*]}" ]];then
         echo "Error: $var_name is empty..."
         return 1
     fi
@@ -360,7 +361,7 @@ main(){
     trap return_interfaces_to_default_namespace INT EXIT TERM
 
     while true;do
-        for netns in ${netnses[@]};do
+        for netns in "${netnses[@]}";do
             switch_pfs "$netns" "${pfs[$netns]}"
             sleep 2
             switch_netns_vfs "$netns"
@@ -388,7 +389,7 @@ if [[ "$status" != "0" ]];then
     exit $status
 fi
 
-for netns in ${netnses[@]};do
+for netns in "${netnses[@]}";do
     netns_create "$netns"
     let status=$status+$?
     if [[ "$status" != "0" ]];then
@@ -397,13 +398,13 @@ for netns in ${netnses[@]};do
     fi
 done
 
-for netns in ${netnses[@]};do
+for netns in "${netnses[@]}";do
     get_pcis_from_pfs "$netns" "${pfs[$netns]}"
     get_pf_switch_dev_info "$netns" "${pfs[$netns]}"
 done
 
 if [[ "${#pcis[@]}" == "0" ]];then
-    echo "Error: could not get pci addresses of interfaces ${pfs[@]}!!"
+    echo "Error: could not get pci addresses of interfaces ${pfs[*]}!!"
     exit 1
 fi
 

test/scripts/enable-kargs_test.sh

@@ -40,13 +40,14 @@ setUp() {
     cp $(which cat)                     ${FAKE_HOST}/usr/bin/
     cp $(which test)                    ${FAKE_HOST}/usr/bin/
     cp $(which sh)                      ${FAKE_HOST}/usr/bin/
+    cp $(which grep)                    ${FAKE_HOST}/usr/bin/
     cp "$SCRIPTPATH/rpm-ostree_mock"    ${FAKE_HOST}/usr/bin/rpm-ostree
 }
 
 # Mock chroot calls to the temporary test folder
 export real_chroot=$(which chroot)
 chroot() {
-    $real_chroot $FAKE_HOST ${@:2}
+    $real_chroot $FAKE_HOST "${@:2}"
 }
 export -f chroot
 

test/scripts/rpm-ostree_mock

@@ -5,7 +5,7 @@
 # Write invocation with arguments to a file to allow making assertion.
 echo "$*" >> /rpm-ostree_calls
 
-if [ "$*" != *"--append"* ]
+if ! echo "$*" | grep -q "\--append"
 then
     # Caller is trying to read kernel arguments.
     cat /proc/cmdline