Add shfmt to enforce consistent formatting of bats tests

Signed-off-by: Jan Dubois <[email protected]>
jandubois · Mar 29, 2023 · 1f58f26 · 1f58f26
1 parent 897ce97
commit 1f58f26
Show file tree

Hide file tree

Showing 14 changed files with 108 additions and 108 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -18,5 +18,3 @@ indent_style = tab
 
 [*.{sh,bash,bats}]
 indent_size = 4
-# shfmt option
-keep_padding = true
diff --git a/bats/tests/containers/factory-reset.bats b/bats/tests/containers/factory-reset.bats
@@ -46,7 +46,7 @@ start_application() {
 rdctl_factory_reset() {
     rdctl factory-reset "$@"
 
-    if [[ "$1" == "--remove-kubernetes-cache=true" ]]; then
+    if [[ $1 == "--remove-kubernetes-cache=true" ]]; then
         assert_not_exist "$PATH_CACHE"
     else
         assert_exists "$PATH_CACHE"
@@ -65,7 +65,7 @@ check_installation() {
     local assert=assert
     local refute=refute
 
-    if [ "${1:-}" == "before" ]; then
+    if [ "${1-}" == "before" ]; then
         assert=refute
         refute=assert
     fi
@@ -100,16 +100,17 @@ check_installation() {
     # Check if ./rd/bin was removed from the path
     if is_unix; then
         # TODO add check for config.fish
-        env_profiles=("$HOME/.bashrc"
-                      "$HOME/.zshrc"
-                      "$HOME/.cshrc"
-                      "$HOME/.tcshrc"
-                     )
+        env_profiles=(
+            "$HOME/.bashrc"
+            "$HOME/.zshrc"
+            "$HOME/.cshrc"
+            "$HOME/.tcshrc"
+        )
         for candidate in .bash_profile .bash_login .profile; do
             if [ -e "$HOME/$candidate" ]; then
                 env_profiles+=("$HOME/$candidate")
                 # Only the first candidate that exists will be modified
-                if [ "${1:-}" = "before" ]; then
+                if [ "${1-}" = "before" ]; then
                     break
                 fi
             fi

diff --git a/bats/tests/extensions/containers.bats b/bats/tests/extensions/containers.bats
@@ -41,7 +41,7 @@ namespace_arg() {
 
 @test 'build extension testing images' {
     local extension
-    for extension in vm-image vm-compose ; do
+    for extension in vm-image vm-compose; do
         ctrctl build \
             "$(namespace_arg)" \
             --tag rd/extension/$extension \
@@ -54,7 +54,7 @@ namespace_arg() {
 
     run rdctl api /v1/extensions
     assert_success
-    output="$(jq ".[\"$(id vm-image)\"]" <<< "${output}")"
+    output="$(jq ".[\"$(id vm-image)\"]" <<<"${output}")"
     assert_output true
 }
 
@@ -77,7 +77,7 @@ namespace_arg() {
 
     run rdctl api /v1/extensions
     assert_success
-    output="$(jq ".[\"$(id vm-compose)\"]" <<< "${output}")"
+    output="$(jq ".[\"$(id vm-compose)\"]" <<<"${output}")"
     assert_output true
 }
 

diff --git a/bats/tests/extensions/install.bats b/bats/tests/extensions/install.bats
@@ -22,9 +22,9 @@ assert_file_contents_equal() { # $have $want
     local want_hash="$(md5sum "$want" | cut -d ' ' -f 1)"
     if [ "$have_hash" != "$want_hash" ]; then
         printf "expected : %s (%s)\nactual   : %s (%s)" \
-            "$want" "$want_hash" "$have" "$have_hash" \
-        | batslib_decorate "files are different" \
-        | fail
+            "$want" "$want_hash" "$have" "$have_hash" |
+            batslib_decorate "files are different" |
+            fail
     fi
 }
 

diff --git a/bats/tests/helpers/kubernetes.bash b/bats/tests/helpers/kubernetes.bash
@@ -1,7 +1,7 @@
 wait_for_apiserver() {
     local desired_version="${1:-$RD_KUBERNETES_PREV_VERSION}"
     while true; do
-        until kubectl get --raw /readyz &> /dev/null; do sleep 1; done
+        until kubectl get --raw /readyz &>/dev/null; do sleep 1; done
         sleep 1
         run kubectl get node -o jsonpath="{.items[0].status.nodeInfo.kubeletVersion}"
         if [ "$status" -eq 0 ]; then

diff --git a/bats/tests/helpers/os.bash b/bats/tests/helpers/os.bash
@@ -2,39 +2,40 @@ UNAME=$(uname)
 ARCH=$(uname -m)
 
 case $UNAME in
-    Darwin)
-        # OS matches the directory name of the PATH_RESOURCES directory,
-        # so uses "darwin" and not "macos".
-        OS=darwin
-        ;;
-    Linux)
-        if [[ $(uname -a) =~ microsoft ]]; then
-            OS=windows
-        else
-            OS=linux
-        fi
-        ;;
-    *)
-        echo "Unexpected uname: $UNAME" >&2
-        exit 1
+Darwin)
+    # OS matches the directory name of the PATH_RESOURCES directory,
+    # so uses "darwin" and not "macos".
+    OS=darwin
+    ;;
+Linux)
+    if [[ $(uname -a) =~ microsoft ]]; then
+        OS=windows
+    else
+        OS=linux
+    fi
+    ;;
+*)
+    echo "Unexpected uname: $UNAME" >&2
+    exit 1
+    ;;
 esac
 
 is_linux() {
-    if [ -z "${1:-}" ]; then
+    if [ -z "${1-}" ]; then
         test "$OS" = linux
     else
         test "$OS" = linux -a "$ARCH" = "$1"
     fi
 }
 is_macos() {
-    if [ -z "${1:-}" ]; then
+    if [ -z "${1-}" ]; then
         test "$OS" = darwin
     else
         test "$OS" = darwin -a "$ARCH" = "$1"
     fi
 }
 is_windows() {
-    if [ -z "${1:-}" ]; then
+    if [ -z "${1-}" ]; then
         test "$OS" = windows
     else
         test "$OS" = windows -a "$ARCH" = "$1"

diff --git a/bats/tests/helpers/paths.bash b/bats/tests/helpers/paths.bash
@@ -34,7 +34,7 @@ win32env() {
     # The cmd.exe _sometimes_ returns an empty string when invoked in a subshell
     # wslpath "$(cmd.exe /c "echo %$1%" 2>/dev/null)" | tr -d "\r"
     # Let's see if powershell.exe avoids this issue
-    wslpath "$(powershell.exe -Command "Write-Output \${Env:$1}")"  | tr -d "\r"
+    wslpath "$(powershell.exe -Command "Write-Output \${Env:$1}")" | tr -d "\r"
 }
 
 if is_windows; then

diff --git a/bats/tests/helpers/utils.bash b/bats/tests/helpers/utils.bash
@@ -1,7 +1,7 @@
 is_true() {
     # case-insensitive check; false values: '', '0', 'no', and 'false'
     local value="$(echo "$1" | tr '[:upper:]' '[:lower:]')"
-    if [[ "$value" =~ ^(0|no|false)?$ ]]; then
+    if [[ $value =~ ^(0|no|false)?$ ]]; then
         false
     else
         true
@@ -31,22 +31,22 @@ try() {
     local delay=5
     while [[ $# -gt 0 ]] && [[ $1 == -* ]]; do
         case "$1" in
-            --max)
-                max=$2
-                shift
-                ;;
-            --delay)
-                delay=$2
-                shift
-                ;;
-            --)
-                shift
-                break
-                ;;
-            *)
-                printf "Usage error: unknown flag '%s'" "$1" >&2
-                return 1
-                ;;
+        --max)
+            max=$2
+            shift
+            ;;
+        --delay)
+            delay=$2
+            shift
+            ;;
+        --)
+            shift
+            break
+            ;;
+        *)
+            printf "Usage error: unknown flag '%s'" "$1" >&2
+            return 1
+            ;;
         esac
         shift
     done
@@ -55,6 +55,6 @@ try() {
         run "$@"
         [ "$status" -eq 0 ] && return
         sleep "$delay"
-        count=$(( count + 1 ))
+        count=$((count + 1))
     done
 }
diff --git a/bats/tests/helpers/vm.bash b/bats/tests/helpers/vm.bash
@@ -27,7 +27,7 @@ factory_reset() {
     fi
 
     mkdir -p "$PATH_CONFIG"
-    cat <<EOF > "$PATH_CONFIG_FILE"
+    cat <<EOF >"$PATH_CONFIG_FILE"
 {
   "version": 5,
   "application": {
@@ -63,10 +63,10 @@ start_container_engine() {
     # Detach `rdctl start` because on Windows the process may not exit until
     # Rancher Desktop itself quits.
     rdctl start \
-          --application.updater.enabled=false \
-          --container-engine="$RD_CONTAINER_ENGINE" \
-          --kubernetes-enabled=false \
-          "$@" &
+        --application.updater.enabled=false \
+        --container-engine="$RD_CONTAINER_ENGINE" \
+        --kubernetes-enabled=false \
+        "$@" &
 }
 
 start_kubernetes() {

diff --git a/bats/tests/k8s/helm-install-rancher.bats b/bats/tests/k8s/helm-install-rancher.bats
@@ -3,7 +3,7 @@
 setup() {
     load '../helpers/load'
 
-    # TODO - Consider implementing a function to check for sudo permissions before running tests that require them. 
+    # TODO - Consider implementing a function to check for sudo permissions before running tests that require them.
     # If sudo permissions are not present, these tests should be skipped.
     if is_linux; then
         run sudo sysctl -w net.ipv4.ip_unprivileged_port_start=443
@@ -21,7 +21,7 @@ setup() {
 }
 
 @test 'add helm repo' {
-    helm repo add jetstack https://charts.jetstack.io        
+    helm repo add jetstack https://charts.jetstack.io
     helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
     helm repo update
 }
@@ -44,7 +44,7 @@ get_host() {
         --create-namespace
     helm upgrade \
         --install rancher rancher-latest/rancher \
-        --namespace cattle-system  \
+        --namespace cattle-system \
         --set hostname="$(get_host)" \
         --wait \
         --timeout=10m \

diff --git a/bats/tests/k8s/traefik.bats b/bats/tests/k8s/traefik.bats
@@ -29,13 +29,13 @@ get_host() {
 assert_traefik_pods_are_down() {
     run kubectl get --all-namespaces pods
 
-    if  [[ "$output" != *"connection refused"* ]] && \
-        [[ "$output" != *"No resources found"* ]] && \
-        [[ "$output" != *"ContainerCreating"* ]] && \
-        [[ "$output" != *"Pending"* ]] && \
-        [[ "$output" != *"Completed"* ]] && \
-        [[ "$output" != *"Terminating"* ]] && \
-        [[ "$output" != *"traefik"* ]]; then
+    if [[ $output != *"connection refused"* ]] &&
+        [[ $output != *"No resources found"* ]] &&
+        [[ $output != *"ContainerCreating"* ]] &&
+        [[ $output != *"Pending"* ]] &&
+        [[ $output != *"Completed"* ]] &&
+        [[ $output != *"Terminating"* ]] &&
+        [[ $output != *"traefik"* ]]; then
         return 0
     else
         return 1
@@ -45,12 +45,12 @@ assert_traefik_pods_are_down() {
 assert_traefik_pods_are_up() {
     run kubectl get --all-namespaces pods
 
-    if [[ "$output" != *"connection refused"* ]] && \
-        [[ "$output" != *"No resources found"* ]] && \
-        [[ "$output" != *"ContainerCreating"* ]] && \
-        [[ "$output" != *"Pending"* ]] && \
-        [[ "$output" != *"Terminating"* ]] && \
-        [[ "$output" =~ "traefik" ]]; then
+    if [[ $output != *"connection refused"* ]] &&
+        [[ $output != *"No resources found"* ]] &&
+        [[ $output != *"ContainerCreating"* ]] &&
+        [[ $output != *"Pending"* ]] &&
+        [[ $output != *"Terminating"* ]] &&
+        [[ $output =~ "traefik" ]]; then
         return 0
     else
         return 1
@@ -70,14 +70,14 @@ assert_traefik_pods_are_up() {
 }
 
 @test 'enable traefik' {
-     # Enable traefik
-     rdctl set --kubernetes.options.traefik=TRUE
-     wait_for_apiserver
-     # Check if the traefik pods come up
-     try --max 30 --delay 10 assert_traefik_pods_are_up
-     assert_success
-     run curl "http://$(get_host):80"
-     [ "$status" -ne 0 ]
-     run curl -k "https://$(get_host):443"
-     [ "$status" -ne 0 ]
+    # Enable traefik
+    rdctl set --kubernetes.options.traefik=TRUE
+    wait_for_apiserver
+    # Check if the traefik pods come up
+    try --max 30 --delay 10 assert_traefik_pods_are_up
+    assert_success
+    run curl "http://$(get_host):80"
+    [ "$status" -ne 0 ]
+    run curl -k "https://$(get_host):443"
+    [ "$status" -ne 0 ]
 }
diff --git a/bats/tests/k8s/up-downgrade-k8s.bats b/bats/tests/k8s/up-downgrade-k8s.bats
@@ -77,13 +77,13 @@ verify_images() {
 }
 
 verify_nginx_after_change_k8s() {
-        run curl http://localhost:8686
-        assert_failure
-        assert_output --partial "Failed to connect to localhost port 8686"
+    run curl http://localhost:8686
+    assert_failure
+    assert_output --partial "Failed to connect to localhost port 8686"
 
-        run curl http://localhost:8585
-        assert_success
-        assert_output --partial "Welcome to nginx!"
+    run curl http://localhost:8585
+    assert_success
+    assert_output --partial "Welcome to nginx!"
 }
 
 @test 'verify nginx after upgrade' {

diff --git a/bats/tests/k8s/wordpress.bats b/bats/tests/k8s/wordpress.bats
@@ -24,11 +24,11 @@ setup() {
 
 @test 'deploy wordpress' {
     helm install wordpress bitnami/wordpress \
-          --wait \
-          --timeout 20m \
-          --set service.type=NodePort \
-          --set volumePermissions.enabled=true \
-          --set mariadb.volumePermissions.enabled=true
+        --wait \
+        --timeout 20m \
+        --set service.type=NodePort \
+        --set volumePermissions.enabled=true \
+        --set mariadb.volumePermissions.enabled=true
 }
 
 @test 'verify wordpress was deployed' {