review: check parameters

Author: ldez

Makefile

@@ -65,12 +65,14 @@ fast_check_generated:
 # Benchmark with a local version
 # LINTER=gosec VERSION=v1.59.0 make bench_local
 bench_local: hyperfine
+	@:$(call check_defined, LINTER VERSION, 'missing parameter(s)')
 	@./scripts/bench/bench_local.sh $(LINTER) $(VERSION)
 .PHONY: bench_local
 
 # Benchmark between 2 existing versions
-# LINTER=gosec VERSION_OLD=v1.58.2 VERSION_NEW=v1.59.0 make bench_version
+# make bench_version LINTER=gosec VERSION_OLD=v1.58.2 VERSION_NEW=v1.59.0
 bench_version: hyperfine
+	@:$(call check_defined, LINTER VERSION_OLD VERSION_NEW, 'missing parameter(s)')
 	@./scripts/bench/bench_version.sh $(LINTER) $(VERSION_OLD) $(VERSION_NEW)
 .PHONY: bench_version
 
@@ -120,3 +122,19 @@ website_dump_info:
 update_contributors_list:
 	cd .github/contributors && npm run all
 
+# Functions
+
+# Check that given variables are set and all have non-empty values,
+# die with an error otherwise.
+#
+# Params:
+#   1. Variable name(s) to test.
+#   2. (optional) Error message to print.
+#
+# https://stackoverflow.com/a/10858332/8228109
+check_defined = \
+    $(strip $(foreach 1,$1, \
+        $(call __check_defined,$1,$(strip $(value 2)))))
+__check_defined = \
+    $(if $(value $1),, \
+      $(error Undefined $1$(if $2, ($2))))

scripts/bench/bench_local.sh

@@ -36,6 +36,3 @@ hyperfine \
 --prepare './golangci-lint cache clean' "./golangci-lint run --issues-exit-code 0 --print-issued-lines=false --enable-only ${LINTER}" \
 --prepare "./golangci-lint-${VERSION} cache clean" "./golangci-lint-${VERSION} run --issues-exit-code 0 --print-issued-lines=false --enable-only ${LINTER}"
 
-## Clean
-
-rm "./golangci-lint-${VERSION}"

scripts/bench/readme.md

@@ -5,11 +5,11 @@ The script use [Hyperfine](https://github.com/sharkdp/hyperfine) to benchmark th
 ## Benchmark one linter: with a local version
 
 ```bash
-LINTER=gosec VERSION=v1.59.0 make bench_local
+make bench_local LINTER=gosec VERSION=v1.59.0
 ```
 
 ## Benchmark one linter: between 2 existing versions
 
 ```bash
-LINTER=gosec VERSION_OLD=v1.58.1 VERSION_NEW=v1.59.0 make bench_version
+make bench_version LINTER=gosec VERSION_OLD=v1.58.1 VERSION_NEW=v1.59.0 
 ```