chore: make dependency checks nicer

coder · deansheather · Jun 18, 2022 · Jun 7, 2022 · Jun 8, 2022 · Jun 8, 2022
commit 449a1a1e8db7cd7fcfc41ac6f3ddb969294ad78f
diff --git a/scripts/archive.sh b/scripts/archive.sh
@@ -73,22 +73,14 @@ fi
 input_file="$(realpath "$1")"
 
 # Check dependencies
-if [[ "$format" == "zip" ]] && ! command -v zip; then
-	error "The 'zip' binary is required."
+if [[ "$format" == "zip" ]]; then
+	dependencies zip
 fi
-if [[ "$format" == "tar.gz" ]] && ! command -v tar; then
-	error "The 'tar' binary is required."
+if [[ "$format" == "tar.gz" ]]; then
+	dependencies tar
 fi
 if [[ "$sign_darwin" == 1 ]]; then
-	if ! command -v jq; then
-		error "The 'jq' binary is required."
-	fi
-	if ! command -v codesign; then
-		error "The 'codesign' binary is required."
-	fi
-	if ! command -v gon; then
-		error "The 'gon' binary is required."
-	fi
+	dependencies jq codesign gon
 fi
 
 # Determine default output path.

diff --git a/scripts/build_docker.sh b/scripts/build_docker.sh
@@ -57,9 +57,7 @@ if [[ "$arch" == "" ]]; then
 fi
 
 # Check dependencies
-if ! command -v docker; then
-	error "The 'docker' binary is required."
-fi
+dependencies docker
 
 # Remove the "v" prefix.
 version="${version#v}"

diff --git a/scripts/build_docker_multiarch.sh b/scripts/build_docker_multiarch.sh
@@ -49,9 +49,7 @@ if [[ "$#" == 0 ]]; then
 fi
 
 # Check dependencies
-if ! command -v docker; then
-	error "The 'docker' binary is required."
-fi
+dependencies docker
 
 # Remove the "v" prefix.
 version="${version#v}"

diff --git a/scripts/build_go.sh b/scripts/build_go.sh
@@ -80,19 +80,9 @@ if [[ "$version" == "" ]]; then
 fi
 
 # Check dependencies
-if ! command -v go; then
-	error "The 'go' binary is required."
-fi
+dependencies go
 if [[ "$sign_darwin" == 1 ]]; then
-	if ! command -v jq; then
-		error "The 'jq' binary is required."
-	fi
-	if ! command -v codesign; then
-		error "The 'codesign' binary is required."
-	fi
-	if ! command -v gon; then
-		error "The 'gon' binary is required."
-	fi
+	dependencies codesign
 fi
 
 build_args=(

diff --git a/scripts/build_go_matrix.sh b/scripts/build_go_matrix.sh
@@ -142,34 +142,26 @@ for s in $(echo "$specs_str" | tr " " "\n" | awk '!a[$0]++'); do
 done
 
 # Check dependencies
-if ! command -v go; then
-	error "The 'go' binary is required."
-fi
+dependencies go
 if [[ "$sign_darwin" == 1 ]]; then
-	if ! command -v jq; then
-		error "The 'jq' binary is required."
-	fi
-	if ! command -v codesign; then
-		error "The 'codesign' binary is required."
-	fi
-	if ! command -v gon; then
-		error "The 'gon' binary is required."
-	fi
+	dependencies jq codesign gon
 fi
 if [[ "$archive" == 1 ]]; then
-	if [[ "$may_zip" == 1 ]] && ! command -v zip; then
-		error "The 'zip' binary is required."
+	if [[ "$may_zip" == 1 ]]; then
+		dependencies zip
 	fi
-	if [[ "$may_tar" == 1 ]] && ! command -v tar; then
-		error "The 'zip' binary is required."
+	if [[ "$may_tar" == 1 ]]; then
+		dependencies tar
 	fi
 fi
-if [[ "$package_linux" == 1 ]] && ! command -v nfpm; then
-	error "The 'nfpm' binary is required."
+if [[ "$package_linux" == 1 ]]; then
+	dependencies nfpm
 fi
 
+bin_name="coder"
 build_args=()
 if [[ "$slim" == 1 ]]; then
+	bin_name+="-slim"
 	build_args+=(--slim)
 fi
 if [[ "$sign_darwin" == 1 ]]; then
@@ -195,7 +187,7 @@ for spec in "${specs[@]}"; do
 	# Ensure parent dir.
 	mkdir -p "$(dirname "$spec_output")"
 
-	log "--- Building coder for $spec_os $spec_arch ($spec_output_binary)"
+	log "--- Building $bin_name for $spec_os $spec_arch ($spec_output_binary)"
 	execrelative ./build_go.sh \
 		--version "$version" \
 		--os "$spec_os" \

diff --git a/scripts/build_go_slim.sh b/scripts/build_go_slim.sh
@@ -47,9 +47,7 @@ while true; do
 done
 
 # Check dependencies
-if ! command -v go; then
-	error "The 'go' binary is required."
-fi
+dependencies go
 
 # Remove the "v" prefix.
 version="${version#v}"

diff --git a/scripts/lib.sh b/scripts/lib.sh
@@ -15,8 +15,11 @@ set -euo pipefail
 #
 # Taken from https://stackoverflow.com/a/3915420 (CC-BY-SA 4.0)
 realpath() {
+	local dir
+	local base
 	dir="$(dirname "$1")"
 	base="$(basename "$1")"
+
 	if [[ ! -d "$dir" ]]; then
 		error "Could not change directory to '$dir': directory does not exist"
 	fi
@@ -57,12 +60,27 @@ cdroot() {
 # be sourced by other scripts.
 execrelative() {
 	pushd "$SCRIPT_DIR" || error "Could not change directory to '$SCRIPT_DIR'"
-	rc=0
+	local rc=0
 	"$@" || rc=$?
 	popd
 	return $rc
 }
 
+dependencies() {
+	local fail=0
+	for dep in "$@"; do
+		if ! command -v "$dep" >/dev/null; then
+			log "ERROR: The '$dep' dependency is required, but is not available."
+			fail=1
+		fi
+	done
+
+	if [[ "$fail" == 1 ]]; then
+		log
+		error "One or more dependencies are not available, check above log output for more details."
+	fi
+}
+
 # maybedryrun prints the given program and flags, and then, if the first
 # argument is 0, executes it. The reason the first argument should be 0 is that
 # it is expected that you have a dry_run variable in your script that is set to

diff --git a/scripts/package.sh b/scripts/package.sh
@@ -51,9 +51,7 @@ fi
 input_file="$(realpath "$1")"
 
 # Check dependencies
-if ! command -v nfpm; then
-	error "The 'nfpm' binary is required."
-fi
+dependencies nfpm
 
 # Remove the "v" prefix.
 version="${version#v}"

diff --git a/scripts/publish_release.sh b/scripts/publish_release.sh
@@ -51,9 +51,7 @@ while true; do
 done
 
 # Check dependencies
-if ! command -v gh; then
-	error "The 'gh' binary is required."
-fi
+dependencies gh
 
 # Remove the "v" prefix.
 version="${version#v}"

diff --git a/scripts/sign_darwin.sh b/scripts/sign_darwin.sh
@@ -21,19 +21,13 @@ if [[ "${AC_APPLICATION_IDENTITY:-}" == "" ]]; then
 fi
 
 # Check dependencies
-if ! command -v jq; then
-	error "The 'jq' binary is required."
-fi
-if ! command -v codesign; then
-	error "The 'codesign' binary is required."
-fi
-if ! command -v gon; then
-	error "The 'gon' binary is required."
-fi
+dependencies jq codesign gon
+
+output_path="$1"
 
 # Create the gon config.
 config="$(mktemp -d)/gon.json"
-jq -r --null-input --arg path "$(pwd)/$1" '{
+jq -r --null-input --arg path "$output_path" '{
 	"notarize": [
 		{
 			"path": $path,
@@ -43,7 +37,7 @@ jq -r --null-input --arg path "$(pwd)/$1" '{
 }' >"$config"
 
 # Sign the zip file with our certificate.
-codesign -s "$AC_APPLICATION_IDENTITY" -f -v --timestamp --options runtime "$1"
+codesign -s "$AC_APPLICATION_IDENTITY" -f -v --timestamp --options runtime "$output_path"
 
 # Notarize the signed zip file.
 #

diff --git a/scripts/version.sh b/scripts/version.sh
@@ -24,7 +24,7 @@ if [[ "$last_tag" != "$current" ]]; then
 		# make won't exit on $(shell cmd) failures :(
 		if [[ "$(ps -o comm= "$PPID" || true)" == *make* ]]; then
 			log "ERROR: version.sh attemped to generate a dev version string when CODER_NO_DEV_VERSION was set"
-			kill "$PPID"
+			kill "$PPID" || true
 			exit 1
 		fi