Allow overriding getopt from the environment

koobs · ghuntley · commit 6f2054915bb0 · 2022-12-07T17:30:35.000Z
coder currently wants GNU getopt for reasons:

  # BSD getopt (which is installed by default on Macs) is not supported.

Although getopt is notoriously non-portable and behaviour differs across
implementations and operating systems, in leui of a discussion
to remove this specific implementation requirement...

Add a GETOPT environment variable in lib.sh and build_go.sh to allow
specifying getopt location, leaving the current value 'getopt' as the
default.
diff --git a/scripts/build_go.sh b/scripts/build_go.sh
@@ -27,6 +27,9 @@ set -euo pipefail
 # shellcheck source=scripts/lib.sh
 source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
 
+# Allow specifying/overriding GETOPT via environment
+GETOPT?=getopt
+
 version=""
 os="${GOOS:-linux}"
 arch="${GOARCH:-amd64}"
@@ -35,7 +38,7 @@ sign_darwin="${CODER_SIGN_DARWIN:-0}"
 output_path=""
 agpl="${CODER_BUILD_AGPL:-0}"
 
-args="$(getopt -o "" -l version:,os:,arch:,output:,slim,agpl,sign-darwin -- "$@")"
+args="$($(GETOPT) -o "" -l version:,os:,arch:,output:,slim,agpl,sign-darwin -- "$@")"
 eval set -- "$args"
 while true; do
 	case "$1" in
diff --git a/scripts/lib.sh b/scripts/lib.sh
@@ -33,6 +33,9 @@ realpath() {
 SCRIPT_DIR="$(realpath "$(dirname "${BASH_SOURCE[0]}")")"
 PROJECT_ROOT="$(cd "$SCRIPT_DIR" && realpath "$(git rev-parse --show-toplevel)")"
 
+# Allow specifying/overriding GETOPT via environment
+GETOPT?=getopt
+
 # pushd is a silent alternative to the real pushd shell command.
 pushd() {
 	command pushd "$@" >/dev/null || error "Could not pushd to '$*'"
@@ -149,7 +152,7 @@ if [[ "${CODER_LIBSH_NO_CHECK_DEPENDENCIES:-}" != *t* ]]; then
 	fi
 
 	# BSD getopt (which is installed by default on Macs) is not supported.
-	if [[ "$(getopt --version)" == *--* ]]; then
+	if [[ "$($(GETOPT) --version)" == *--* ]]; then
 		libsh_bad_dependencies=1
 		log "ERROR: You need GNU getopt to run the scripts in the Coder repo."
 		if isdarwin; then
