-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
dev: add targets to benchmark a linter (#4761)
- Loading branch information
Showing
4 changed files
with
163 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
#!/bin/bash -e | ||
|
||
# Benchmark with a local version | ||
# Usage: ./scripts/bench/bench_local.sh gosec v1.59.0 | ||
|
||
# ex: gosec | ||
LINTER=$1 | ||
|
||
# ex: v1.59.0 | ||
VERSION=$2 | ||
|
||
|
||
if [ -z "$LINTER" ] || [ -z "$VERSION" ]; then | ||
cat <<-EOF | ||
Missing required arguments! | ||
Usage: $0 <linter> <old version> <new version> | ||
Example: $0 gosec v1.58.1 v1.58.2 | ||
EOF | ||
|
||
exit 1 | ||
fi | ||
|
||
EOF | ||
|
||
## Clean | ||
|
||
function cleanBinaries() { | ||
echo "Clean binaries" | ||
rm "./golangci-lint-${VERSION}" | ||
rm ./golangci-lint | ||
} | ||
|
||
trap cleanBinaries EXIT | ||
|
||
## Download version | ||
|
||
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "./temp-${VERSION}" "${VERSION}" | ||
|
||
mv "temp-${VERSION}/golangci-lint" "./golangci-lint-${VERSION}" | ||
rm -rf "temp-${VERSION}" | ||
|
||
## Build local version | ||
|
||
make build | ||
|
||
## Run | ||
|
||
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}" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
#!/bin/bash -e | ||
|
||
# Benchmark between 2 existing versions | ||
# Usage: ./scripts/bench/bench_version.sh gosec v1.58.1 v1.58.2 | ||
|
||
# ex: gosec | ||
LINTER="$1" | ||
|
||
# ex: v1.58.1 | ||
VERSION_OLD="$2" | ||
# ex: v1.58.2 | ||
VERSION_NEW="$3" | ||
|
||
if [ -z "$LINTER" ] || [ -z "$VERSION_OLD" ] || [ -z "$VERSION_NEW" ]; then | ||
cat <<-EOF | ||
Missing required arguments! | ||
Usage: $0 <linter> <old version> <new version> | ||
Example: $0 gosec v1.58.1 v1.58.2 | ||
EOF | ||
|
||
exit 1 | ||
fi | ||
|
||
EOF | ||
|
||
## Clean | ||
|
||
function cleanBinaries() { | ||
echo "Clean binaries" | ||
rm "./golangci-lint-${VERSION_OLD}" | ||
rm "./golangci-lint-${VERSION_NEW}" | ||
} | ||
|
||
trap cleanBinaries EXIT | ||
|
||
## Install | ||
|
||
function install() { | ||
local VERSION=$1 | ||
|
||
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "./temp-${VERSION}" "${VERSION}" | ||
|
||
mv "temp-${VERSION}/golangci-lint" "./golangci-lint-${VERSION}" | ||
rm -rf "temp-${VERSION}" | ||
} | ||
|
||
## VERSION_OLD | ||
|
||
install "${VERSION_OLD}" | ||
|
||
## VERSION_NEW | ||
|
||
install "${VERSION_NEW}" | ||
|
||
## Run | ||
|
||
hyperfine \ | ||
--prepare "./golangci-lint-${VERSION_OLD} cache clean" "./golangci-lint-${VERSION_OLD} run --issues-exit-code 0 --print-issued-lines=false --enable-only ${LINTER}" \ | ||
--prepare "./golangci-lint-${VERSION_NEW} cache clean" "./golangci-lint-${VERSION_NEW} run --issues-exit-code 0 --print-issued-lines=false --enable-only ${LINTER}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
make bench_local LINTER=gosec VERSION=v1.59.0 | ||
``` | ||
|
||
## Benchmark one linter: between 2 existing versions | ||
|
||
```bash | ||
make bench_version LINTER=gosec VERSION_OLD=v1.58.1 VERSION_NEW=v1.59.0 | ||
``` |