Add auto formatting for shell scripts (#461)

Author: mtotowamkwe

docker/app/run-gunicorn.sh

@@ -5,7 +5,7 @@ declare -a api_spec_paths
 case "${CONNEXION_SPEC}" in
   file:*)
     specs="${CONNEXION_SPEC:5}"
-    IFS="," read -r -a api_spec_paths <<< "${specs}"
+    IFS="," read -r -a api_spec_paths <<<"${specs}"
     ;;
   dir:*)
     specs="${CONNEXION_SPEC:4}"

docker/ci/Dockerfile

@@ -26,6 +26,14 @@ RUN wget -q https://github.com/instrumenta/kubeval/releases/download/${KUBEVAL_V
   && rm kubeval-linux-amd64.tar.gz \
   && kubeval --version
 
+ARG SHFMT_VERSION=3.1.1
+RUN wget -q https://github.com/mvdan/sh/releases/download/v${SHFMT_VERSION}/shfmt_v${SHFMT_VERSION}_linux_amd64 \
+  && mv shfmt_v${SHFMT_VERSION}_linux_amd64 shfmt \
+  && cp shfmt /usr/local/bin \
+  && rm shfmt \
+  && chmod +x /usr/local/bin/shfmt \
+  && shfmt -version
+
 COPY docker/ci/requirements.txt ./
 RUN pip install --no-cache-dir -r requirements.txt
 
@@ -60,3 +68,5 @@ RUN helm lint --strict ./helm/opwen_cloudserver \
  && helm template ./helm/opwen_cloudserver > helm.yaml \
  && kubeval --ignore-missing-schemas helm.yaml \
  && rm helm.yaml
+
+RUN shfmt -d -i 2 -ci .

docker/integtest/0-wait-for-services.sh

@@ -31,10 +31,10 @@ wait_for_appinsights() {
   for i in $(seq 1 "${max_retries}"); do
     if [[ \
       "$(az storage container exists \
-      --name "${APPINSIGHTS_INSTRUMENTATIONKEY}" \
-      --connection-string "$(az_connection_string)" \
-      --output tsv)" = "True" \
-   ]]; then
+        --name "${APPINSIGHTS_INSTRUMENTATIONKEY}" \
+        --connection-string "$(az_connection_string)" \
+        --output tsv)" = "True" ]] \
+        ; then
       log "Appinsights is running"
       return
     fi

docker/integtest/1-register-client.sh

@@ -40,13 +40,19 @@ if REGISTRATION_CREDENTIALS="baduser:badpassword" authenticated_request \
   "http://nginx:8888/api/email/register/" \
   -H "Content-Type: application/json" \
   -d '{"domain":"hacker.lokole.ca"}' \
-; then echo "Was able to register a client with bad basic auth credentials" >&2; exit 4; fi
+  ; then
+  echo "Was able to register a client with bad basic auth credentials" >&2
+  exit 4
+fi
 
 if REGISTRATION_CREDENTIALS="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" authenticated_request \
   "http://nginx:8888/api/email/register/" \
   -H "Content-Type: application/json" \
   -d '{"domain":"hacker.lokole.ca"}' \
-; then echo "Was able to register a client with bad bearer credentials" >&2; exit 4; fi
+  ; then
+  echo "Was able to register a client with bad bearer credentials" >&2
+  exit 4
+fi
 
 # also register another client to simulate multi-client emails
 authenticated_request \
@@ -68,7 +74,10 @@ if authenticated_request \
   "http://nginx:8888/api/email/register/" \
   -H "Content-Type: application/json" \
   -d '{"domain":"developer3.lokole.ca"}' \
-; then echo "Was able to register a duplicate client" >&2; exit 5; fi
+  ; then
+  echo "Was able to register a duplicate client" >&2
+  exit 5
+fi
 
 authenticated_request \
   "http://nginx:8888/api/email/register/developer3.lokole.ca" \

docker/integtest/2-client-uploads-emails.sh

@@ -11,8 +11,8 @@ mkdir -p "${out_dir}"
 emails_to_send="${in_dir}/client-emails.tar.gz"
 tar -czf "${emails_to_send}" -C "${in_dir}" emails.jsonl zzusers.jsonl
 
-client_id="$(jq -r '.client_id' < "${out_dir}/register1.json")"
-resource_container="$(jq -r '.resource_container' < "${out_dir}/register1.json")"
+client_id="$(jq -r '.client_id' <"${out_dir}/register1.json")"
+resource_container="$(jq -r '.resource_container' <"${out_dir}/register1.json")"
 resource_id="$(uuidgen).tar.gz"
 
 # workflow 1: send emails written on the client to the world

docker/integtest/3-receive-email-for-client.sh

@@ -13,7 +13,7 @@ email_to_receive="${in_dir}/inbound-email.mime"
 if [[ -n "$1" ]]; then
   client_id="$1"
 else
-  client_id="$(jq -r '.client_id' < "${out_dir}/register1.json")"
+  client_id="$(jq -r '.client_id' <"${out_dir}/register1.json")"
 fi
 
 # workflow 2a: receive an email directed at one of the clients

docker/integtest/4-client-downloads-emails.sh

@@ -13,33 +13,33 @@ num_emails_expected_for_client[2]=1
 
 for i in 1 2; do
 
-client_id="$(jq -r '.client_id' < "${out_dir}/register${i}.json")"
-resource_container="$(jq -r '.resource_container' < "${out_dir}/register${i}.json")"
+  client_id="$(jq -r '.client_id' <"${out_dir}/register${i}.json")"
+  resource_container="$(jq -r '.resource_container' <"${out_dir}/register${i}.json")"
 
-# workflow 2b: deliver emails written by the world to a lokole client
-# first the client makes a request to ask the server to package up all the
-# emails sent from the world to the client during the last period; the server
-# will package up the emails and store them on the shared blob storage
-curl -fs \
-  -H "Accept: application/json" \
-  "http://nginx:8888/api/email/download/${client_id}" \
-| tee "${out_dir}/download${i}.json"
+  # workflow 2b: deliver emails written by the world to a lokole client
+  # first the client makes a request to ask the server to package up all the
+  # emails sent from the world to the client during the last period; the server
+  # will package up the emails and store them on the shared blob storage
+  curl -fs \
+    -H "Accept: application/json" \
+    "http://nginx:8888/api/email/download/${client_id}" |
+    tee "${out_dir}/download${i}.json"
 
-resource_id="$(jq -r '.resource_id' < "${out_dir}/download${i}.json")"
+  resource_id="$(jq -r '.resource_id' <"${out_dir}/download${i}.json")"
 
-# now we simulate the client downloading the package from the shared blob storage
-az_storage download "${resource_container}" "${resource_id}" "${out_dir}/downloaded${i}.tar.gz"
+  # now we simulate the client downloading the package from the shared blob storage
+  az_storage download "${resource_container}" "${resource_id}" "${out_dir}/downloaded${i}.tar.gz"
 
-tar xzf "${out_dir}/downloaded${i}.tar.gz" -C "${out_dir}"
+  tar xzf "${out_dir}/downloaded${i}.tar.gz" -C "${out_dir}"
 
-num_emails_actual="$(wc -l "${out_dir}/emails.jsonl" | cut -d' ' -f1)"
-num_emails_expected="${num_emails_expected_for_client[${i}]}"
+  num_emails_actual="$(wc -l "${out_dir}/emails.jsonl" | cut -d' ' -f1)"
+  num_emails_expected="${num_emails_expected_for_client[${i}]}"
 
-if [[ "${num_emails_actual}" -ne "${num_emails_expected}" ]]; then
-  echo "Got ${num_emails_actual} emails but expected ${num_emails_expected}" >&2
-  exit 1
-fi
+  if [[ "${num_emails_actual}" -ne "${num_emails_expected}" ]]; then
+    echo "Got ${num_emails_actual} emails but expected ${num_emails_expected}" >&2
+    exit 1
+  fi
 
-rm "${out_dir}/emails.jsonl"
+  rm "${out_dir}/emails.jsonl"
 
 done

docker/integtest/6-receive-service-email.sh

@@ -10,7 +10,6 @@ mkdir -p "${out_dir}"
 
 email_to_receive="${in_dir}/service-email.mime"
 
-
 #receive an email directed at the service endpoint
 http --check-status -f POST \
   "http://nginx:8888/api/email/sendgrid/service" \

docker/integtest/utils.sh

@@ -2,15 +2,16 @@
 set -eo pipefail
 
 get_container() {
-  docker ps --format  '{{.Names}}' | grep "$1"
+  docker ps --format '{{.Names}}' | grep "$1"
 }
 
 log() {
   echo "$@" >&2
 }
 
 authenticated_request() {
-  local endpoint="$1"; shift
+  local endpoint="$1"
+  shift
 
   if [[ "${REGISTRATION_CREDENTIALS}" =~ ^[^:]+:.*$ ]]; then
     curl -fs "${endpoint}" -u "${REGISTRATION_CREDENTIALS}" "$@"
@@ -38,7 +39,7 @@ az_storage() {
     --name "${blob}" \
     --container-name "${container}" \
     --connection-string "$(az_connection_string)" \
-  > /dev/null
+    >/dev/null
 }
 
 wait_seconds() {

docker/nginx/run-nginx.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-mo < /app/nginx.conf.mustache > /app/nginx.conf
-mo < /app/server.conf.mustache > /etc/nginx/sites-enabled/server.conf
+mo </app/nginx.conf.mustache >/app/nginx.conf
+mo </app/server.conf.mustache >/etc/nginx/sites-enabled/server.conf
 
 exec nginx -c "/app/nginx.conf" -p "${PWD}" -g "daemon off;"