Ensure consistent use of best-practice set -o in all scripts (#1864)

maru-ava · web-flow · commit 6c8a7d490355 · 2023-08-17T11:34:46.000-04:00
diff --git a/.github/workflows/build-deb-pkg.sh b/.github/workflows/build-deb-pkg.sh
@@ -1,3 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
 DEBIAN_BASE_DIR=$PKG_ROOT/debian
 AVALANCHE_BUILD_BIN_DIR=$DEBIAN_BASE_DIR/usr/local/bin
 TEMPLATE=.github/workflows/debian/template 
diff --git a/.github/workflows/build-tgz-pkg.sh b/.github/workflows/build-tgz-pkg.sh
@@ -1,3 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
 AVALANCHE_ROOT=$PKG_ROOT/avalanchego-$TAG
 
 mkdir -p $AVALANCHE_ROOT
diff --git a/.github/workflows/build_and_test.sh b/.github/workflows/build_and_test.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # Avalanche root directory
 AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd ../.. && pwd )
diff --git a/.github/workflows/cleanup-net-outage-sim.sh b/.github/workflows/cleanup-net-outage-sim.sh
@@ -1,4 +1,6 @@
-set -o pipefail
+#!/usr/bin/env bash
+
+set -euo pipefail
 
 ###
 # cleanup removes the docker instance and the network
diff --git a/.github/workflows/publish_image.sh b/.github/workflows/publish_image.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # If this is not a trusted build (Docker Credentials are not set)
 if [[ -z "$DOCKER_USERNAME"  ]]; then
diff --git a/.github/workflows/run-net-outage-sim.sh b/.github/workflows/run-net-outage-sim.sh
@@ -1,5 +1,6 @@
-set -o pipefail
-set -e
+#!/usr/bin/env bash
+
+set -euo pipefail
 
 SUCCESS=1
 
diff --git a/.github/workflows/run_e2e_tests.sh b/.github/workflows/run_e2e_tests.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # Testing specific variables
 avalanche_testing_repo="avaplatform/avalanche-testing"
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 print_usage() {
   printf "Usage: build [OPTIONS]
diff --git a/scripts/build_avalanche.sh b/scripts/build_avalanche.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 print_usage() {
   printf "Usage: build_avalanche [OPTIONS]
diff --git a/scripts/build_coreth.sh b/scripts/build_coreth.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 race=''
 coreth_path=''
diff --git a/scripts/build_fuzz.sh b/scripts/build_fuzz.sh
@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+set -euo pipefail
+
 # Mostly taken from https://github.com/golang/go/issues/46312#issuecomment-1153345129
 
 # Directory above this script
diff --git a/scripts/build_image.sh b/scripts/build_image.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # Avalanchego root folder
 AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
diff --git a/scripts/build_local_dep_image.sh b/scripts/build_local_dep_image.sh
@@ -1,8 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 echo "Building docker image based off of most recent local commits of avalanchego and coreth"
 
diff --git a/scripts/build_local_image.sh b/scripts/build_local_image.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # Directory above this script
 AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
diff --git a/scripts/build_test.sh b/scripts/build_test.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # Directory above this script
 AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
diff --git a/scripts/build_testnetctl.sh b/scripts/build_testnetctl.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 # Avalanchego root folder
 AVALANCHE_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )
diff --git a/scripts/install_anr.sh b/scripts/install_anr.sh
@@ -1,7 +1,6 @@
 #!/usr/bin/env bash
-set -e
-set -o nounset
-set -o pipefail
+
+set -euo pipefail
 
 # Avalanche root directory
 AVALANCHE_PATH=$(
diff --git a/scripts/lint.sh b/scripts/lint.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -o errexit
-set -o pipefail
-set -e
+set -euo pipefail
 
 if ! [[ "$0" =~ scripts/lint.sh ]]; then
   echo "must be run from repository root"
diff --git a/scripts/mock.gen.sh b/scripts/mock.gen.sh
@@ -1,6 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-set -e
+set -euo pipefail
 
 if ! [[ "$0" =~ scripts/mock.gen.sh ]]; then
   echo "must be run from repository root"
diff --git a/scripts/protobuf_codegen.sh b/scripts/protobuf_codegen.sh
@@ -1,4 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
+set -euo pipefail
 
 if ! [[ "$0" =~ scripts/protobuf_codegen.sh ]]; then
   echo "must be run from repository root"
@@ -39,7 +41,7 @@ if [[ $(protoc-gen-go-grpc --version | cut -f2 -d' ') != "${PROTOC_GEN_GO_GRPC_V
 fi
 
 TARGET=$PWD/proto
-if [ -n "$1" ]; then 
+if [ -n "${1:-}" ]; then
   TARGET="$1"
 fi
 
diff --git a/scripts/tests.e2e.persistent.sh b/scripts/tests.e2e.persistent.sh
@@ -1,8 +1,6 @@
 #!/usr/bin/env bash
 
-set -e
-set -o nounset
-set -o pipefail
+set -euo pipefail
 
 ################################################################
 # This script deploys a persistent local network and configures
diff --git a/scripts/tests.e2e.sh b/scripts/tests.e2e.sh
@@ -1,7 +1,6 @@
 #!/usr/bin/env bash
-set -e
-set -o nounset
-set -o pipefail
+
+set -euo pipefail
 
 # e.g.,
 # ./scripts/build.sh
diff --git a/scripts/tests.upgrade.sh b/scripts/tests.upgrade.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
-set -e
+
+set -euo pipefail
 
 # e.g.,
 # ./scripts/build.sh
@@ -9,14 +10,14 @@ if ! [[ "$0" =~ scripts/tests.upgrade.sh ]]; then
   exit 255
 fi
 
-VERSION=$1
+VERSION="${1:-}"
 if [[ -z "${VERSION}" ]]; then
   echo "Missing version argument!"
   echo "Usage: ${0} [VERSION] [NEW-BINARY]" >>/dev/stderr
   exit 255
 fi
 
-NEW_BINARY=$2
+NEW_BINARY="${2:-}"
 if [[ -z "${NEW_BINARY}" ]]; then
   echo "Missing new binary path argument!"
   echo "Usage: ${0} [VERSION] [NEW-BINARY]" >>/dev/stderr
@@ -95,7 +96,7 @@ echo "running upgrade tests against the local cluster with ${NEW_BINARY}"
 pkill -P ${PID} || true
 kill -2 ${PID}
 
-if [[ ${EXIT_CODE} -gt 0 ]]; then
+if [[ "${EXIT_CODE:-}" -gt 0 ]]; then
   echo "FAILURE with exit code ${EXIT_CODE}"
   exit ${EXIT_CODE}
 else
