gotools

A collection of command-line utilities for working with Go

gotools is a collection of command-line utilities for working with Go.

gobench

gobench automated running Go benchmarks across your current working tree and a base Git branch (usually main). It alternates benchmark runs to minimise system noise, and pipes the output into benchstat for comparison. This allows you to see the impact of your unmerged changes.

Installation

gobench requires benchstat to be installed:

$ go install golang.org/x/perf/cmd/benchstat@latest

Then install gobench:

$ go install alexwlchan.net/projects/gotools/cmd/gobench@latest

Usage and flags

Run gobench and pass arguments you’d pass to go test to choose which benchmark to run. For example:

$ gobench ./control/controlapi -bench=BenchmarkDevices

There are optional flags to control the gobench behaviour:

-base (default main) – set the base Git branch or commit to compare against
-samples (default 6) – the numebr of alternating sample rounds to run
-no-sync (default false) – skip copying dirty/untracked working tree files to the base worktree

Demo: measuring an optimisation

Check out this repo at main.
Create a new feature branch:
```
$ git checkout -b fib-faster
```
In example/fib/fib_test.go, replace FibRecursive(20) with FibIterative(20).
Commit your changes.

Run gobench to measure the performance impact:

$ go run ./cmd/gobench ./example/fib -bench=BenchmarkFib

License

This project is shared under the MIT license.