Address shellcheck warnings in bootstrap scripts

Several warnings were unaddressed. Some of them were disabled as they can be safely ignored.
Others were refactored as the warnings were legitimate.

Author: s-fairchild

pkg/deploy/assets/gateway-production.json

@@ -3,7 +3,8 @@
 
 # declare -r empty_str=""
 #
-# empty_str - constant; used by functions for optional nameref string arguements
+# empty_str - constant
+#   * used by functions for optional nameref string arguments
 # shellcheck disable=SC2034
 declare -r empty_str=""
 
@@ -21,12 +22,14 @@ declare -r role_rp="rp"
 
 # declare -r role_devproxy="devproxy"
 #
-# role_devproxy - constant; Is used to determine which VMSS is being bootstrapped
+# role_devproxy - constant
+#   * Is used to determine which VMSS is being bootstrapped
 declare -r role_devproxy="devproxy"
 
 # declare -r us_gov_cloud="AzureUSGovernment"
 #
-# us_gov_cloud - constant; Is the name of AZURECLOUDNAME for US government cloud
+# us_gov_cloud - constant
+#   * Is the name of AZURECLOUDNAME for US government cloud
 declare -r us_gov_cloud="AzureUSGovernment"
 
 # declare -i XTRACE_SET=1
@@ -77,7 +80,8 @@ xtrace_toggle() {
 # Wrapper for echo that includes the function name
 # args:
 #   1) msg - string
-#   2) stack_level - int; optional
+#   2) stack_level - int
+#       * optional
 #       * defaults to the function at the bottom of the call stack
 log() {
     local -r msg="${1:-"log message is empty"}"
@@ -100,8 +104,8 @@ abort() {
 # args:
 #   1) filename - string
 #   2) file_contents - string
-#   3) clobber - boolean; optional
-#       * defaults to false
+#   3) clobber - boolean
+#       * Optional; defaults to false
 write_file() {
     local -n filename="$1"
     local -n file_contents="$2"
@@ -163,11 +167,11 @@ verify_role() {
 # get_keyvault_suffix()
 #
 # args:
-#   1) rl - nameref, string;
+#   1) rl - nameref, string
 #       * role to get short role for
-#   2) kv_suffix - nameref, string;
+#   2) kv_suffix - nameref, string
 #       * short role will be assigned to this nameref
-#   3) sec_prefix - nameref, string;
+#   3) sec_prefix - nameref, string
 #       * keyvault certificate prefix will be assigned to this nameref
 get_keyvault_suffix() {
     local -n rl="$1"
@@ -187,7 +191,7 @@ get_keyvault_suffix() {
             sec_prefix="$role_rp"
             ;;
         *)
-            abort "unkown role $rl"
+            abort "unknown role $rl"
             ;;
     esac
 }

pkg/deploy/assets/rp-production.json

@@ -71,7 +71,7 @@ dnf_install_pkgs() {
 #   2) wait_time - nameref, integer
 #       * Time to wait before retrying command
 #   3) retries - integer, optional
-#       * Ammount of times to retry command, defaults to 5
+#       * Amount of times to retry command, defaults to 5
 dnf_update_pkgs() {
     local -n excludes="${1:-empty_str}"
     log "starting"

pkg/deploy/generator/scripts/util-common.sh

@@ -26,7 +26,7 @@ enable_services() {
 # configure_service_aro_gateway
 #
 # args:
-#   1) image - nameref, string;
+#   1) image - nameref, string
 #       * container image
 #   2) role - nameref, string
 #       * VMSS role
@@ -42,6 +42,7 @@ configure_service_aro_gateway() {
     log "starting"
     log "Configuring aro-gateway service"
 
+    # shellcheck disable=SC2034
     local -r aro_gateway_conf_filename='/etc/sysconfig/aro-gateway'
     local -r add_conf_file="PODMAN_NETWORK='podman'
 IPADDRESS='$ipaddress'
@@ -55,6 +56,7 @@ ARO_LOG_LEVEL='$GATEWAYLOGLEVEL'"
     local -r aro_gateway_service_filename='/etc/systemd/system/aro-gateway.service'
 
     # shellcheck disable=SC2034
+    # shellcheck disable=SC2016
     # below variable is in single quotes
     # as it is to be expanded at systemd start time (by systemd, not this script)
     local -r aro_gateway_service_file='[Unit]
@@ -391,7 +393,10 @@ configure_service_aro_mimo_actuator() {
     log "starting"
     log "Configuring aro-mimo-actuator service"
 
+    # shellcheck disable=SC2034
     local -r aro_mimo_actuator_conf_filename='/etc/sysconfig/aro-mimo-actuator'
+
+    # shellcheck disable=SC2034
     local -r add_conf_file="PODMAN_NETWORK='podman'
 IPADDRESS='$ipaddress'
 ARO_LOG_LEVEL='$MIMOACTUATORLOGLEVEL'"
@@ -1088,22 +1093,41 @@ configure_vmss_aro_services() {
     verify_role "$1"
 
     if [ "$r" == "$role_gateway" ]; then
-        configure_service_aro_gateway "${images["rp"]}" "$1" "${configs["gateway_config"]}" "${configs["static_ip_address"]}["gateway"]"
+        configure_service_aro_gateway "${images["rp"]}" "$1" "${configs["gateway_config"]}" "${configs["static_ip_address"]}[gateway]"
         configure_certs_gateway
     elif [ "$r" == "$role_rp" ]; then
-        configure_service_aro_rp "${images["rp"]}" "$1" "${configs["rp_config"]}" "${configs["static_ip_address"]}["rp"]"
-        configure_service_aro_mimo_actuator "${images["rp"]}" "${configs["rp_config"]}" "${configs["static_ip_address"]}["mimo_actuator"]"
-        configure_service_aro_monitor "${images["rp"]}" "${configs["static_ip_address"]}["monitor"]"
-        configure_service_aro_portal "${images["rp"]}" "${configs["static_ip_address"]}["portal"]"
-        configure_service_aro_mise "${images["mise"]}" "${configs["static_ip_address"]}["mise"]"
-        configure_service_aro_otel_collector "${images["otel"]}" "${configs["static_ip_address"]}" "${configs["static_ip_address"]}["otel_collector"]"
+        configure_service_aro_rp "${images["rp"]}" \
+            "$1" \
+            "${configs[rp_config]}" \
+            "${configs[static_ip_address]}[rp]"
+
+        configure_service_aro_mimo_actuator "${images[rp]}" \
+            "${configs[rp_config]}" \
+            "${configs[static_ip_address]}[mimo_actuator]"
+
+        configure_service_aro_monitor "${images[rp]}" "${configs[static_ip_address]}[monitor]"
+
+        configure_service_aro_portal "${images[rp]}" "${configs[static_ip_address]}[portal]"
+
+        configure_service_aro_mise "${images[mise]}" "${configs[static_ip_address]}[mise]"
+
+        configure_service_aro_otel_collector "${images[otel]}" \
+            "${configs[static_ip_address]}" \
+            "${configs["static_ip_address"]}[otel_collector]"
+
         configure_certs_rp
     fi
 
-    configure_service_fluentbit "${configs["fluentbit"]}" "${images["fluentbit"]}"
+    configure_service_fluentbit "${configs[fluentbit]}" "${images[fluentbit]}"
+
     configure_timers_mdm_mdsd "$1"
-    configure_service_mdm "$1" "${images["mdm"]}" "${configs["static_ip_address"]}["mdm"]"
-    configure_service_mdsd "$1" "${configs["mdsd"]}"
+
+    configure_service_mdm "$1" \
+        "${images[mdm]}" \
+        "${configs["static_ip_address"]}[mdm]"
+
+    configure_service_mdsd "$1" "${configs[mdsd]}"
+
     run_azsecd_config_scan
 }