dev: add targets to benchmark a linter

Author: ldez

Makefile

@@ -60,6 +60,20 @@ fast_check_generated:
 	git checkout -- go.mod go.sum # can differ between go1.16 and go1.17
 	git diff --exit-code # check no changes
 
+# Benchmark
+
+# Benchmark with a local version
+# LINTER=gosec VERSION=v1.59.0 make bench_local
+bench_local:
+	./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
+bench_version:
+	./scripts/bench/bench_version.sh $(LINTER) $(VERSION_OLD) $(VERSION_NEW)
+.PHONY: bench_version
+
 # Non-PHONY targets (real files)
 
 $(BINARY): FORCE

scripts/bench/bench_local.sh

@@ -0,0 +1,31 @@
+#!/bin/bash -e
+
+# Benchmark with a local version
+# Usage: ./scripts/bench/bench_local.sh gosec v1.59.0
+
+# ex: gosec
+LINTER_NAME=$1
+
+# ex: v1.59.0
+GCIL_VERSION=$2
+
+## Download version
+
+curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./temp-${GCIL_VERSION}/ ${GCIL_VERSION}
+
+mv temp-${GCIL_VERSION}/golangci-lint ./golangci-lint-${GCIL_VERSION}
+rm -rf temp-${GCIL_VERSION}
+
+## Build local version
+
+make build
+
+## Run
+
+hyperfine \
+--prepare 'golangci-lint cache clean' "./golangci-lint run --print-issued-lines=false --enable-only ${LINTER_NAME}" \
+--prepare './golangci-lint cache clean' "./golangci-lint-${GCIL_VERSION} run --print-issued-lines=false --enable-only ${LINTER_NAME}"
+
+## Clean
+
+rm ./golangci-lint-${GCIL_VERSION}

scripts/bench/bench_version.sh

@@ -0,0 +1,37 @@
+#!/bin/bash -e
+
+# Benchmark between 2 existing versions
+# Usage: ./scripts/bench/bench_version.sh gosec v1.58.1 v1.58.2
+
+# ex: gosec
+LINTER_NAME=$1
+
+# ex: v1.58.1
+GCIL_VERSION_ONE=$2
+# ex: v1.58.2
+GCIL_VERSION_TWO=$3
+
+## GCIL_VERSION_ONE
+
+curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./temp-${GCIL_VERSION_ONE} ${GCIL_VERSION_ONE}
+
+mv temp-${GCIL_VERSION_ONE}/golangci-lint ./golangci-lint-${GCIL_VERSION_ONE}
+rm -rf temp-${GCIL_VERSION_ONE}
+
+## GCIL_VERSION_TWO
+
+curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./temp-${GCIL_VERSION_TWO} ${GCIL_VERSION_TWO}
+
+mv temp-${GCIL_VERSION_TWO}/golangci-lint ./golangci-lint-${GCIL_VERSION_TWO}
+rm -rf temp-${GCIL_VERSION_TWO}
+
+## Run
+
+hyperfine \
+--prepare 'golangci-lint cache clean' "./golangci-lint-${GCIL_VERSION_ONE} run --issues-exit-code 0 --print-issued-lines=false --enable-only ${LINTER_NAME}" \
+--prepare './golangci-lint cache clean' "./golangci-lint-${GCIL_VERSION_TWO} run --issues-exit-code 0 --print-issued-lines=false --enable-only ${LINTER_NAME}"
+
+## Clean
+
+rm ./golangci-lint-${GCIL_VERSION_ONE}
+rm ./golangci-lint-${GCIL_VERSION_TWO}

scripts/bench/readme.md

@@ -0,0 +1,15 @@
+# Benchmarks
+
+The script use [Hyperfine](https://github.com/sharkdp/hyperfine) to benchmark the command line of golangci-lint.
+
+## Benchmark one linter: with a local version
+
+```bash
+LINTER=gosec VERSION=v1.59.0 make bench_local
+```
+
+## Benchmark one linter: between 2 existing versions
+
+```bash
+LINTER=gosec VERSION_OLD=v1.58.2 VERSION_NEW=v1.59.0 make bench_version
+```