Lint bash scripts with custom shebangs (home-assistant#3824)

* Lint bash scripts with custom shebangs Many scripts in this repository have this shebang: #!/usr/bin/with-contenv bashio However, this doesn't match the shebang regex in action-shellcheck and therefore those files wouldn't get included in the linting check. * Fix or ignore current shellcheck violations * shellcheck: specify bash shell type for scripts with unrecognized shebangs * Convert shutdown script from CRLF line endings to LF * shellcheck: silence remaining violations for now * Apply suggestions from code review * mariadb: avoid adding extra newlines Co-authored-by: Stefan Agner <[email protected]> * Fix GitHub syntax highlighting for bash scripts --------- Co-authored-by: Stefan Agner <[email protected]>
AlfredJKwack · Dec 12, 2024 · c9a0c15 · c9a0c15
1 parent 21ac292
commit c9a0c15
Show file tree

Hide file tree

Showing 126 changed files with 306 additions and 18 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -50,3 +50,21 @@ jobs:
 
       - name: Run linter
         uses: ludeeus/[email protected]
+        with:
+          # Names of scripts with custom shebangs that the action would not
+          # discover on its own:
+          additional_files: >-
+            check_certificate_renewal
+            cpcd-config-up
+            discovery
+            finish
+            lock-tables-for-backup
+            matter-server-discovery
+            reboot
+            run
+            shutdown
+            universal-silabs-flasher-up
+            unlock-tables-for-backup
+            vlc-discovery
+          ignore_paths: >-
+            google_assistant
diff --git a/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/finish b/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/finish
@@ -1,9 +1,11 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +16,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

diff --git a/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/run b/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/assist_microphone/run
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Start service

diff --git a/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/discovery/run b/assist_microphone/rootfs/etc/s6-overlay/s6-rc.d/discovery/run
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Sends discovery information to Home Assistant.

diff --git a/cec_scan/rootfs/etc/services.d/cec-scan/finish b/cec_scan/rootfs/etc/services.d/cec-scan/finish
@@ -1,4 +1,5 @@
 #!/usr/bin/env bashio
+# vim: ft=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service is done
 # ==============================================================================

diff --git a/cec_scan/rootfs/etc/services.d/cec-scan/run b/cec_scan/rootfs/etc/services.d/cec-scan/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Start CEC scan service
 # ==============================================================================

diff --git a/configurator/rootfs/etc/s6-overlay/s6-rc.d/configurator/finish b/configurator/rootfs/etc/s6-overlay/s6-rc.d/configurator/finish
@@ -1,9 +1,11 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +16,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

diff --git a/configurator/rootfs/etc/s6-overlay/s6-rc.d/configurator/run b/configurator/rootfs/etc/s6-overlay/s6-rc.d/configurator/run
@@ -1,4 +1,6 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Start Configurator service
 # ==============================================================================

diff --git a/deconz/rootfs/etc/cont-init.d/firmware.sh b/deconz/rootfs/etc/cont-init.d/firmware.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Manage deCONZ firmware
 # ==============================================================================

diff --git a/deconz/rootfs/etc/cont-init.d/nginx.sh b/deconz/rootfs/etc/cont-init.d/nginx.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Configure NGINX for use with deCONZ
 # ==============================================================================

diff --git a/deconz/rootfs/etc/cont-init.d/novnc.sh b/deconz/rootfs/etc/cont-init.d/novnc.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Setup noVNC
 # ==============================================================================

diff --git a/deconz/rootfs/etc/services.d/deconz/discovery b/deconz/rootfs/etc/services.d/deconz/discovery
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Send deCONZ discovery information to Home Assistant
 # ==============================================================================

diff --git a/deconz/rootfs/etc/services.d/deconz/finish b/deconz/rootfs/etc/services.d/deconz/finish
@@ -1,4 +1,5 @@
 #!/usr/bin/env bashio
+# vim: ft=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay

diff --git a/deconz/rootfs/etc/services.d/deconz/run b/deconz/rootfs/etc/services.d/deconz/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Start deCONZ service
 # ==============================================================================

diff --git a/deconz/rootfs/etc/services.d/nginx/finish b/deconz/rootfs/etc/services.d/nginx/finish
@@ -1,4 +1,5 @@
 #!/usr/bin/env bashio
+# vim: ft=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay

diff --git a/deconz/rootfs/etc/services.d/nginx/run b/deconz/rootfs/etc/services.d/nginx/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Start NGINX service
 # ==============================================================================

diff --git a/deconz/rootfs/etc/services.d/otau-ikea/run b/deconz/rootfs/etc/services.d/otau-ikea/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Download available firmware update for IKEA
 # ==============================================================================

diff --git a/deconz/rootfs/etc/services.d/otau-ledvance/run b/deconz/rootfs/etc/services.d/otau-ledvance/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Download available firmware update for OSRAM Ledvance
 # ==============================================================================

diff --git a/deconz/rootfs/etc/services.d/websockify/run b/deconz/rootfs/etc/services.d/websockify/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Start ozw-admin
 # ==============================================================================

diff --git a/dhcp_server/data/run.sh b/dhcp_server/data/run.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 set -e
 
 CONFIG="/etc/dhcpd.conf"

diff --git a/dnsmasq/rootfs/etc/cont-init.d/config.sh b/dnsmasq/rootfs/etc/cont-init.d/config.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # DNSMASQ config
 # ==============================================================================

diff --git a/dnsmasq/rootfs/etc/services.d/dnsmasq/finish b/dnsmasq/rootfs/etc/services.d/dnsmasq/finish
@@ -1,4 +1,5 @@
 #!/usr/bin/env bashio
+# vim: ft=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service fails
 # s6-overlay docs: https://github.com/just-containers/s6-overlay

diff --git a/dnsmasq/rootfs/etc/services.d/dnsmasq/run b/dnsmasq/rootfs/etc/services.d/dnsmasq/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 CONFIG="/etc/dnsmasq.conf"
 
 # Run dnsmasq

diff --git a/duckdns/rootfs/etc/s6-overlay/s6-rc.d/duckdns/finish b/duckdns/rootfs/etc/s6-overlay/s6-rc.d/duckdns/finish
@@ -1,9 +1,11 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Home Assistant Community Add-on: chrony
 # Take down the S6 supervision tree when chrony fails
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -15,7 +17,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

diff --git a/duckdns/rootfs/etc/s6-overlay/s6-rc.d/duckdns/run b/duckdns/rootfs/etc/s6-overlay/s6-rc.d/duckdns/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 
 CERT_DIR=/data/letsencrypt
 WORK_DIR=/data/workdir

diff --git a/letsencrypt/rootfs/etc/cont-init.d/file-structure.sh b/letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/with-contenv bashio
+# shellcheck shell=bash
 # ==============================================================================
 # Init folder & structures
 # ==============================================================================

diff --git a/letsencrypt/rootfs/etc/services.d/lets-encrypt/finish b/letsencrypt/rootfs/etc/services.d/lets-encrypt/finish
@@ -1,4 +1,5 @@
 #!/usr/bin/env bashio
+# vim: ft=bash
 # ==============================================================================
 # Take down the S6 supervision tree when service is done 
 # ==============================================================================

diff --git a/letsencrypt/rootfs/etc/services.d/lets-encrypt/run b/letsencrypt/rootfs/etc/services.d/lets-encrypt/run
@@ -1,4 +1,6 @@
 #!/usr/bin/with-contenv bashio
+# vim: ft=bash
+# shellcheck shell=bash
 # ==============================================================================
 # Start sshd service if enabled
 # ==============================================================================
@@ -310,6 +312,7 @@ else
     bashio::log.info "Detecting existing certificate type for ${DOMAIN_ARR[1]}"
     readarray -t CBCERTS < <(certbot certificates --non-interactive --cert-name "${DOMAIN_ARR[1]}" --config-dir "$CERT_DIR" --work-dir "$WORK_DIR") 
     for output in "${CBCERTS[@]}"; do
+        # shellcheck disable=SC2076
         if [[ $output =~ "No certificates found." ]]; then
             bashio::log.info "No certificate found - using 'ecdsa' key type."
             KEY_ARGUMENTS+=("--key-type" "ecdsa")

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-core/finish b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-core/finish
@@ -1,8 +1,10 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Take down the S6 supervision tree when daemon fails
 # ==============================================================================
+# shellcheck disable=SC2155
 readonly exit_code_container=$(</run/s6-linux-init-container-results/exitcode)
 readonly exit_code_service="${1}"
 readonly exit_code_signal="${2}"
@@ -14,7 +16,7 @@ bashio::log.info \
 
 if [[ "${exit_code_service}" -eq 256 ]]; then
   if [[ "${exit_code_container}" -eq 0 ]]; then
-    echo $((128 + $exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
+    echo $((128 + exit_code_signal)) > /run/s6-linux-init-container-results/exitcode
   fi
   [[ "${exit_code_signal}" -eq 15 ]] && exec /run/s6/basedir/bin/halt
 elif [[ "${exit_code_service}" -ne 0 ]]; then

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-core/run b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-core/run
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Start MariaDB service

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-core/finish b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-core/finish
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # MariaDB client (to lock tables for backups) stopped

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-core/run b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-core/run
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Start MariaDB client (to lock tables for backups)

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-post/finish b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-post/finish
@@ -1,17 +1,20 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Unlock tables locked for backups
 # ==============================================================================
 
 declare MARIADB_LOCK_CORE_PID
 MARIADB_LOCK_CORE_PID=$(s6-svstat -o pid "/run/service/mariadb-lock-core")
+# shellcheck disable=SC2086
 if bashio::var.equals ${MARIADB_LOCK_CORE_PID} -1; then
     bashio::log.error "Invalid mariadb-lock-core process id ${MARIADB_LOCK_CORE_PID}"
     bashio::exit.nok
 fi
 
 # File descriptor &4 is used as stdin for mysql, because &0 is closed after the mariadb-lock-core service is started
+# shellcheck disable=SC2086
 echo "UNLOCK TABLES;" > /proc/${MARIADB_LOCK_CORE_PID}/fd/4
 
 bashio::log.info "MariaDB tables unlocked"
diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-post/run b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-lock-post/run
@@ -1,17 +1,20 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Lock tables for backups
 # ==============================================================================
 
 declare MARIADB_LOCK_CORE_PID
 MARIADB_LOCK_CORE_PID=$(s6-svstat -o pid "/run/service/mariadb-lock-core")
+# shellcheck disable=SC2086
 if bashio::var.equals ${MARIADB_LOCK_CORE_PID} -1; then
     bashio::log.error "Invalid mariadb-lock-core process id ${MARIADB_LOCK_CORE_PID}"
     bashio::exit.nok
 fi
 
 # File descriptor &4 is used as stdin for mysql, because &0 is closed after the mariadb-lock-core service is started
+# shellcheck disable=SC2086
 echo "FLUSH TABLES WITH READ LOCK;" > /proc/${MARIADB_LOCK_CORE_PID}/fd/4
 
 bashio::log.info "MariaDB tables locked"
diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-post/finish b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-post/finish
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Post-start finalization of MariaDB service

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-post/run b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-post/run
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Post-start initialization of MariaDB service
@@ -8,7 +9,9 @@ function execute_without_error_messages() {
     local current_log_level="${__BASHIO_LOG_LEVELS[${__BASHIO_LOG_LEVEL}]}"
     bashio::log.level fatal
     local exit_code=0
+    # shellcheck disable=SC2068
     $@ || exit_code=$?
+    # shellcheck disable=SC2086
     bashio::log.level ${current_log_level}
     return ${exit_code}
 }

diff --git a/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-pre/run b/mariadb/rootfs/etc/s6-overlay/s6-rc.d/mariadb-pre/run
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Pre-start initialization of MariaDB service
@@ -11,8 +12,8 @@ if ! bashio::fs.directory_exists "${MARIADB_DATA}"; then
 fi
 
 # Save variables
-printf "${MARIADB_DATA}" > /var/run/s6/container_environment/MARIADB_DATA
-printf "${NEW_INSTALL}" > /var/run/s6/container_environment/NEW_INSTALL
+echo -n "${MARIADB_DATA}" > /var/run/s6/container_environment/MARIADB_DATA
+echo -n "${NEW_INSTALL}" > /var/run/s6/container_environment/NEW_INSTALL
 
 # Redirect log output
 mkdir -p "${MARIADB_DATA}"

diff --git a/mariadb/rootfs/usr/bin/lock-tables-for-backup b/mariadb/rootfs/usr/bin/lock-tables-for-backup
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Lock tables for backup

diff --git a/mariadb/rootfs/usr/bin/unlock-tables-for-backup b/mariadb/rootfs/usr/bin/unlock-tables-for-backup
@@ -1,4 +1,5 @@
 #!/command/with-contenv bashio
+# vim: ft=bash
 # shellcheck shell=bash
 # ==============================================================================
 # Unlock tables for backup

diff --git a/matter_server/rootfs/etc/s6-overlay/s6-rc.d/matter-server/finish b/matter_server/rootfs/etc/s6-overlay/s6-rc.d/matter-server/finish
@@ -1,4 +1,5 @@
 #!/usr/bin/env bashio
+# vim: ft=bash
 # ==============================================================================
 # s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================