First version

.github/workflows/benchmark.yml

@@ -0,0 +1,15 @@
+name: Benchmark
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.15.x
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Test
+      run: |
+        go version
+        go run scripts/benchmark/benchmark.go $GITHUB_SHA scripts/benchmark/BENCHMARK.template.md BENCHMARK.md

scripts/benchmark/BENCHMARK.template.md

@@ -0,0 +1,14 @@
+# Benchmark
+
+Date: {{ .Date }}
+
+Commit: {{ .CommitHash }}
+
+GOOS: {{ .GOOS }}
+
+## Binary size
+
+
+|   |{{range .Headers}} {{ . }} |{{end}}
+| ------------- |{{range .Headers}} ------------- |{{end}}{{range .BinarySizeRows}} 
+| {{range .}} {{.}} |{{end}}{{end}}

scripts/benchmark/benchmark.go

@@ -0,0 +1,185 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/exec"
+	"runtime"
+	"strings"
+	"text/template"
+	"time"
+)
+
+type report struct {
+	Date           string
+	GOOS           string
+	CommitHash     string
+	Headers        []string
+	BinarySizeRows [][]string
+}
+
+type project struct {
+	name          string
+	path          string
+	targetPackage string
+}
+
+var projects = []*project{
+	{"staticcheck", "go-tools", "./cmd/staticcheck"},
+	{"keyify", "go-tools", "./cmd/keyify"},
+	{"micro", "micro", "./cmd/micro"},
+}
+
+var binarySizeCommands = [][]string{
+	{"go", "build"},
+	{"go", "build", "-ldflags", "-s -w"},
+	{"garble", seedParam, "build"},
+	{"garble", seedParam, "-tiny", "build"},
+	{"garble", seedParam, "-literals", "build"},
+	{"garble", seedParam, "-tiny", "-literals", "build"},
+}
+
+const (
+	dateFormat = "2006-01-02"
+	seedParam  = "-seed=ESIzRFVmd4g"
+)
+
+func exitAndSkipWorkFlow() {
+	const skipWorkflowCode = 78
+	os.Exit(skipWorkflowCode)
+}
+
+func alreadyProcessed(commitHash, outputFile string) bool {
+	file, err := os.Open(outputFile)
+	if err != nil {
+		return false
+	}
+	defer file.Close()
+
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		if strings.Contains(scanner.Text(), commitHash) {
+			return true
+		}
+	}
+	return false
+}
+
+func fileSize(path string) (int64, error) {
+	fi, err := os.Stat(path)
+	if err != nil {
+		return 0, err
+	}
+	return fi.Size(), nil
+}
+
+func formatSize(firstSize int64) string {
+	return fmt.Sprintf("%d", firstSize)
+}
+
+func diffSize(firstSize, secondSize int64) string {
+	if firstSize == secondSize {
+		return formatSize(firstSize)
+	}
+
+	diff := float64(secondSize-firstSize) / float64(firstSize) * 100
+	return fmt.Sprintf("%s (%.2f%%)", formatSize(secondSize), diff)
+}
+
+func processProject(p *project) ([]string, error) {
+	row := []string{p.name}
+
+	var tempFiles []string
+	defer func() {
+		for _, file := range tempFiles {
+			os.Remove(file)
+		}
+	}()
+
+	var firstSize int64
+	for i, command := range binarySizeCommands {
+		tempOutputFile, err := ioutil.TempFile("", p.name)
+		if err != nil {
+			return nil, err
+		}
+		tempOutputFile.Close()
+		tempFiles = append(tempFiles, tempOutputFile.Name())
+
+		buildCommand := append(command, "-o", tempOutputFile.Name(), p.targetPackage)
+		if runtime.GOOS == "windows" {
+			buildCommand[0] += ".exe"
+		}
+
+		cmd := exec.Command(buildCommand[0], buildCommand[1:]...)
+		cmd.Dir = p.path
+
+		if output, err := cmd.CombinedOutput(); err != nil {
+			return nil, fmt.Errorf("build error: %v\n\n%s", err, string(output))
+		}
+
+		size, err := fileSize(tempOutputFile.Name())
+		if err != nil {
+			return nil, err
+		}
+
+		if i == 0 {
+			firstSize = size
+			row = append(row, formatSize(size))
+			continue
+		}
+
+		row = append(row, diffSize(firstSize, size))
+	}
+
+	return row, nil
+}
+
+func main() {
+	if len(os.Args) != 4 {
+		panic("invalid usage: go run benchmark.go <commit> <input> <output>")
+	}
+
+	commitHash, inputPath, outputPath := os.Args[1], os.Args[2], os.Args[3]
+
+	if alreadyProcessed(commitHash, outputPath) {
+		exitAndSkipWorkFlow()
+	}
+
+	r := &report{
+		Date:       time.Now().Format(dateFormat),
+		GOOS:       runtime.GOOS,
+		CommitHash: commitHash,
+	}
+
+	for _, command := range binarySizeCommands {
+		header := strings.Join(command, " ")
+		header = strings.ReplaceAll(header, seedParam, "")
+		header = strings.ReplaceAll(header, "  ", " ")
+		r.Headers = append(r.Headers, header)
+	}
+
+	for _, p := range projects {
+		row, err := processProject(p)
+		if err != nil {
+			panic(err)
+		}
+		r.BinarySizeRows = append(r.BinarySizeRows, row)
+	}
+
+	tmpl, err := template.ParseFiles(inputPath)
+	if err != nil {
+		panic(err)
+	}
+
+	outputFile, err := os.Create(outputPath)
+	if err != nil {
+		panic(err)
+	}
+	defer outputFile.Close()
+
+	if err := tmpl.Execute(outputFile, r); err != nil {
+		panic(err)
+	}
+}