chore: update scripts to pass shellcheck

See https://github.com/koalaman/shellcheck

Remove unusued files:
* push.sh
* Dockerfile.e2e
* frontend/test-e2e.sh

Author: spadgett

build-backend.sh

@@ -5,8 +5,6 @@ set -e
 # Builds the server-side golang resources for tectonic-console. For a
 # complete build, you must also run build-frontend
 
-PROJECT_DIR=$(basename ${PWD})
-
 # Use deps from vendor dir.
 export GOFLAGS="-mod=vendor"
 

builder-run.sh

@@ -14,22 +14,22 @@ set -e
 BUILDER_IMAGE="quay.io/coreos/tectonic-console-builder:v19"
 
 # forward whitelisted env variables to docker
-ENV_STR=""
-VOLUME_MOUNT=""
+ENV_STR=()
+VOLUME_MOUNT=()
 for VAR in ${DOCKER_ENV//,/ }; do
     if [ "$VAR" = 'KUBECONFIG' ]
     then
-      VOLUME_MOUNT="-v $KUBECONFIG:/kube/config"
-      ENV_STR="$ENV_STR -e KUBECONFIG=/kube/config"
+      VOLUME_MOUNT=("-v" "$KUBECONFIG:/kube/config")
+      ENV_STR+=("-e" "KUBECONFIG=/kube/config")
     else
-      ENV_STR="$ENV_STR -e $VAR=${!VAR}"
+      ENV_STR+=("-e" "$VAR=${!VAR}")
     fi
 done
 
-docker run $ENV_STR --rm --net=host \
+docker run "${ENV_STR[@]}" --rm --net=host \
        --user="${BUILDER_RUN_USER}" \
-       $VOLUME_MOUNT \
+       "${VOLUME_MOUNT[@]}" \
        -v "$(pwd)":/go/src/github.com/openshift/console \
        --shm-size=512m \
        -w /go/src/github.com/openshift/console \
-       $BUILDER_IMAGE "$@"
+       "$BUILDER_IMAGE" "$@"

chromium-version.sh

@@ -1,3 +1,6 @@
+# shellcheck shell=bash
+# Source this script: "source ./chromium-version.sh"
+
 # Chrome Version 76.0.3809.0 (Developer Build) (64-bit)
 export FORCE_CHROME_BRANCH_BASE="665006"
 export FORCE_CHROME_BRANCH_SHA256SUM="a1ae2e0950828f991119825f62c24464ab3765aa219d150a94fb782a4c66a744"

contrib/environment.sh

@@ -1,27 +1,39 @@
-# This file is an example of how you might set up your environment to
-# run the tectonic console during development. To use it for running
-# bridge, do
+# shellcheck shell=bash
+#
+# NOTE: This script is for native Kubernetes. If connecting to an OpenShift
+# cluster instead, use contrib/oc-environment.sh.
+#
+# This file is an example of how you might set up your environment to run the
+# OpenShift console during development when connecting to a native Kubernetes
+# cluster. To use it for running bridge, do
 #
 # . contrib/environment.sh
 # ./bin/bridge
 #
+# You'll need a working kubectl, and you'll need jq installed and in your path
+# for this script to work correctly.
+#
+# This will use the first secret it finds in the default namespace. All secrets
+# must be valid or removed from the namespace.
+#
+# The environment variables beginning with "BRIDGE_" act just like bridge
+# command line arguments - in fact. to get more information about any of them,
+# you can run ./bin/bridge --help
 
-# You'll need a working kubectl, and you'll need jq installed and in
-# your path for this script to work correctly.
-
-# This will use the first secret it finds in the default namespace.
-# All secrets must be valid or removed from the namespace.
+BRIDGE_USER_AUTH="disabled"
+export BRIDGE_USER_AUTH
 
-# The environment variables beginning with "BRIDGE_" act just like
-# bridge command line arguments - in fact. to get more information
-# about any of them, you can run ./bin/bridge --help
+BRIDGE_K8S_MODE="off-cluster"
+export BRIDGE_K8S_MODE
 
-export BRIDGE_USER_AUTH="disabled"
-export BRIDGE_K8S_MODE="off-cluster"
 BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT=$(kubectl config view -o json | jq '{myctx: .["current-context"], ctxs: .contexts[], clusters: .clusters[]}' | jq 'select(.myctx == .ctxs.name)' | jq 'select(.ctxs.context.cluster ==  .clusters.name)' | jq '.clusters.cluster.server' -r)
 export BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT
-export BRIDGE_K8S_MODE_OFF_CLUSTER_SKIP_VERIFY_TLS=true
-export BRIDGE_K8S_AUTH="bearer-token"
+
+BRIDGE_K8S_MODE_OFF_CLUSTER_SKIP_VERIFY_TLS=true
+export BRIDGE_K8S_MODE_OFF_CLUSTER_SKIP_VERIFY_TLS
+
+BRIDGE_K8S_AUTH="bearer-token"
+export BRIDGE_K8S_AUTH
 
 secretname=$(kubectl get serviceaccount default --namespace=kube-system -o jsonpath='{.secrets[0].name}')
 BRIDGE_K8S_AUTH_BEARER_TOKEN=$(kubectl get secret "$secretname" --namespace=kube-system -o template --template='{{.data.token}}' | base64 --decode)

contrib/oc-environment.sh

@@ -1,26 +1,43 @@
-# This file is an example of how you might set up your environment to
-# run the tectonic console against OpenShift during development. To use it for running
-# bridge, do
+# shellcheck shell=bash
+#
+# This file is an example of how you might set up your environment to run the
+# console against an OpenShift cluster during development. To use it for
+# running bridge, do
 #
 # . contrib/oc-environment.sh
 # ./bin/bridge
 #
+# You'll need oc, and you'll need to be logged into a cluster.
+#
+# The environment variables beginning with "BRIDGE_" act just like bridge
+# command line arguments - in fact. to get more information about any of them,
+# you can run ./bin/bridge --help
+
+BRIDGE_USER_AUTH="disabled"
+export BRIDGE_USER_AUTH
+
+BRIDGE_K8S_MODE="off-cluster"
+export BRIDGE_K8S_MODE
+
+BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT=$(oc whoami --show-server)
+export BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT
+
+BRIDGE_K8S_MODE_OFF_CLUSTER_SKIP_VERIFY_TLS=true
+export BRIDGE_K8S_MODE_OFF_CLUSTER_SKIP_VERIFY_TLS
+
+BRIDGE_K8S_MODE_OFF_CLUSTER_THANOS=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.thanosURL}')
+export BRIDGE_K8S_MODE_OFF_CLUSTER_THANOS
+
+BRIDGE_K8S_MODE_OFF_CLUSTER_PROMETHEUS=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.prometheusURL}')
+export BRIDGE_K8S_MODE_OFF_CLUSTER_PROMETHEUS
+
+BRIDGE_K8S_MODE_OFF_CLUSTER_ALERTMANAGER=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.alertmanagerURL}')
+export BRIDGE_K8S_MODE_OFF_CLUSTER_ALERTMANAGER
+
+BRIDGE_K8S_AUTH="bearer-token"
+export BRIDGE_K8S_AUTH
 
-# You'll need a working oc logged in, and you'll need jq installed and in your
-# path for this script to work correctly.
-
-# The environment variables beginning with "BRIDGE_" act just like
-# bridge command line arguments - in fact. to get more information
-# about any of them, you can run ./bin/bridge --help
-
-export BRIDGE_USER_AUTH="disabled"
-export BRIDGE_K8S_MODE="off-cluster"
-export BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT=$(oc whoami --show-server)
-export BRIDGE_K8S_MODE_OFF_CLUSTER_SKIP_VERIFY_TLS=true
-export BRIDGE_K8S_MODE_OFF_CLUSTER_THANOS=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.thanosURL}')
-export BRIDGE_K8S_MODE_OFF_CLUSTER_PROMETHEUS=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.prometheusURL}')
-export BRIDGE_K8S_MODE_OFF_CLUSTER_ALERTMANAGER=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.alertmanagerURL}')
-export BRIDGE_K8S_AUTH="bearer-token"
-export BRIDGE_K8S_AUTH_BEARER_TOKEN=$(oc whoami --show-token)
+BRIDGE_K8S_AUTH_BEARER_TOKEN=$(oc whoami --show-token)
+export BRIDGE_K8S_AUTH_BEARER_TOKEN
 
 echo "Using $BRIDGE_K8S_MODE_OFF_CLUSTER_ENDPOINT"

e2e.Dockerfile

@@ -7,14 +7,14 @@ set -exuo pipefail
     --ca-file=examples/ca.crt \
     --k8s-auth=openshift \
     --k8s-mode=off-cluster \
-    --k8s-mode-off-cluster-endpoint=$(oc whoami --show-server) \
+    --k8s-mode-off-cluster-endpoint="$(oc whoami --show-server)" \
     --k8s-mode-off-cluster-skip-verify-tls=true \
     --listen=http://127.0.0.1:9000 \
     --public-dir=./frontend/public/dist \
     --user-auth=openshift \
     --user-auth-oidc-client-id=console-oauth-client \
     --user-auth-oidc-client-secret-file=examples/console-client-secret \
     --user-auth-oidc-ca-file=examples/ca.crt \
-    --k8s-mode-off-cluster-prometheus=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.prometheusURL}')  \
-    --k8s-mode-off-cluster-alertmanager=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.alertmanagerURL}') \
-    --k8s-mode-off-cluster-thanos=$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.prometheusURL}')
+    --k8s-mode-off-cluster-prometheus="$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.prometheusURL}')"  \
+    --k8s-mode-off-cluster-alertmanager="$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.alertmanagerURL}')" \
+    --k8s-mode-off-cluster-thanos="$(oc -n openshift-monitoring get configmap sharing-config -o jsonpath='{.data.prometheusURL}')"

examples/run-bridge.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+shellcheck --external-sources -- *.sh contrib/*.sh examples/*.sh

frontend/test-e2e.sh

@@ -21,12 +21,12 @@ export GOFLAGS="-mod=vendor"
 COVER=${COVER:-"-cover"}
 
 TESTABLE="pkg/auth pkg/proxy pkg/server pkg/helm/actions pkg/helm/handlers"
-FORMATTABLE="cmd pkg"
+FORMATTABLE=(cmd pkg)
 
 # user has not provided PKG override
 if [ -z "${PKG}" ]; then
 	TEST=${TESTABLE}
-	FMT=${FORMATTABLE}
+	FMT=("${FORMATTABLE[@]}")
 
 # user has provided PKG override
 else
@@ -35,28 +35,28 @@ else
 	TEST=${TEST//./}
 
 	# only run gofmt on packages provided by user
-	FMT="${TEST}"
+	FMT=("${TEST[@]}")
 fi
 
 # split TEST into an array and prepend repo path to each local package
-split=(${TEST// / })
-TEST=${split[@]/#/github.com/openshift/console/}
+read -ra split <<<"$TEST"
+TEST=("${split[@]/#/github.com/openshift/console/}")
 
 echo "Running tests..."
-go test ${COVER} $@ ${TEST}
+go test "${COVER}" "$@" "${TEST[@]}"
 
 echo "Checking gofmt..."
-fmtRes=$(gofmt -l ${FMT})
+fmtRes=$(gofmt -l "${FMT[@]}")
 if [ -n "${fmtRes}" ]; then
 	echo -e "gofmt checking failed:\n${fmtRes}"
 	exit 255
 fi
 
 echo "Checking govet..."
-vetRes=$(go vet ${TEST})
+vetRes=$(go vet "${TEST[@]}")
 if [ -n "${vetRes}" ]; then
-        echo -e "govet checking failed:\n${vetRes}"
-        exit 255
+	echo -e "govet checking failed:\n${vetRes}"
+	exit 255
 fi
 
 echo "Success"

push.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 CONSOLE_URL=$(oc get console.config.openshift.io cluster --template '{{.status.consoleURL}}')
 if [ -z "${CONSOLE_URL}" ]
@@ -22,8 +22,7 @@ VALID_CIPHER_SAMPLE=(
 
 for CIPHER in "${VALID_CIPHER_SAMPLE[@]}"
 do
-  RESULT=$(openssl s_client -connect "${SERVER}" -cipher "${CIPHER}" -CAfile /tmp/default-ingress-cert-file.txt 2>&1)
-  if [[ $? -eq 0 ]]
+  if openssl s_client -connect "${SERVER}" -cipher "${CIPHER}" -CAfile /tmp/default-ingress-cert-file.txt 2>&1
   then
     echo "valid cipher was correctly accepted (${CIPHER})"
   else    
@@ -47,12 +46,11 @@ INVALID_CIPHER_SAMPLE=(
 
 for CIPHER in "${INVALID_CIPHER_SAMPLE[@]}"
 do
-  RESULT=$(openssl s_client -connect "${SERVER}" -cipher "${CIPHER}" -CAfile /tmp/default-ingress-cert-file.txt 2>&1)
-  if [[ $? -eq 0 ]]
+  if openssl s_client -connect "${SERVER}" -cipher "${CIPHER}" -CAfile /tmp/default-ingress-cert-file.txt 2>&1
   then
     echo "invalid cipher suite used to connect to console (${CIPHER})"  
     exit 1  
   else    
     echo "invalid cipher was correctly denied (${CIPHER})"
   fi
-done
+done