Add benchmarks to tests (#24)

Author: cyrilst

.gitignore

@@ -11,3 +11,6 @@ doc/*.xml
 
 # packages
 sshproxy_*.tar.gz
+
+# benchmark results
+benchmarks/results

Makefile

@@ -26,6 +26,8 @@ TEST	= test/fedora-image/sshproxy_test.go
 EXE	= $(addprefix bin/, sshproxy sshproxy-dumpd sshproxy-replay sshproxyctl)
 MANDOC	= doc/sshproxy.yaml.5 doc/sshproxy.8 doc/sshproxy-dumpd.8 doc/sshproxy-replay.8 doc/sshproxyctl.8
 PACKAGE = sshproxy_$(SSHPROXY_VERSION)_$(shell uname -s)_$(shell uname -p)
+COMMIT  = $(shell git describe --dirty)
+DATE    = $(shell date -Iseconds)
 
 all: exe doc
 
@@ -93,7 +95,11 @@ check:
 test:
 	cd test && bash ./run.sh
 
+benchmark:
+	mkdir -p benchmarks/results
+	$(GO) test -failfast -race -count=6 -bench=. -run=^# -benchmem ./... | tee benchmarks/results/$(DATE)-$(COMMIT)
+
 clean:
 	rm -f $(EXE) $(MANDOC) doc/*.xml sshproxy_*.tar.gz
 
-.PHONY: all exe doc install install-doc-man install-binaries package fmt get-deps check test clean
+.PHONY: all exe doc install install-doc-man install-binaries package fmt get-deps check test benchmark clean

benchmarks/README.asciidoc

@@ -0,0 +1,25 @@
+Benchmark Tests
+===============
+
+Launching the benchmark tests
+-----------------------------
+
+From the root directory of this repository, just run +make benchmark+. It will
+create a directory benchmarks/results, and store the results in it.
+
+Consistency
+-----------
+
+Benchmarks are only usable if they are consistently run on the same computer,
+and with no other resource-consuming program running at the same time. Keep
+this in mind in order to have consistent results.
+
+Analyzing the benchmark tests
+-----------------------------
+
+You can use +benchstat+ (https://pkg.go.dev/golang.org/x/perf/cmd/benchstat)
+for analyzing the results. Just pass the result file name as an argument in
+order to see the results. You can even compare different results by passing
+more than one file as arguments.
+
+// vim:tw=78:ft=asciidoc:

pkg/utils/utils_test.go

@@ -25,6 +25,26 @@ func TestCalcSessionID(t *testing.T) {
 	}
 }
 
+var calcSessionIDBenchmarks = []struct {
+	username, hostport string
+}{
+	{"arno", "127.0.0.1:22"},
+	{"arno", "192.168.100.100:1234"},
+	{"cyril", "127.0.0.1:22"},
+	{"cyril", "192.168.100.100:1234"},
+}
+
+func BenchmarkCalcSessionID(b *testing.B) {
+	d := time.Now()
+	for _, tt := range calcSessionIDBenchmarks {
+		b.Run(tt.username+"_"+tt.hostport, func(b *testing.B) {
+			for i := 0; i < b.N; i++ {
+				CalcSessionID(tt.username, d, tt.hostport)
+			}
+		})
+	}
+}
+
 var splithostportTests = []struct {
 	hostport, host, port string
 }{
@@ -67,6 +87,16 @@ func TestInvalidSplitHostPort(t *testing.T) {
 	}
 }
 
+func BenchmarkSplitHostPort(b *testing.B) {
+	for _, tt := range splithostportTests {
+		b.Run(tt.hostport, func(b *testing.B) {
+			for i := 0; i < b.N; i++ {
+				SplitHostPort(tt.hostport)
+			}
+		})
+	}
+}
+
 func mockNetLookupHost(host string) ([]string, error) {
 	if host == "err" {
 		return nil, errors.New("LookupHost error")
@@ -190,3 +220,14 @@ func TestInvalidMatchSource(t *testing.T) {
 		}
 	}
 }
+
+func BenchmarkMatchSource(b *testing.B) {
+	netLookupHost = mockNetLookupHost
+	for _, tt := range matchSourceTests {
+		b.Run(tt.source+"_"+tt.sshdHostport, func(b *testing.B) {
+			for i := 0; i < b.N; i++ {
+				MatchSource(tt.source, tt.sshdHostport)
+			}
+		})
+	}
+}