sweet: save build logs to .build.logs in result dir

This CL saves stdout and stderr during build to *.build.logs in the
result dir.

Change-Id: Ieb8c310a7cc62bb7210e2b8f5c9c29d561b8d401
Reviewed-on: https://go-review.googlesource.com/c/benchmarks/+/709815
Reviewed-by: Michael Knyszek <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: JunyangShao

sweet/cmd/sweet/benchmark.go

@@ -319,16 +319,26 @@ func (b *benchmark) execute(cfgs []*common.Config, r *runCfg) error {
 		goflags += fmt.Sprintf("-pgo=%s", pgo)
 		cfg.BuildEnv.Env = cfg.BuildEnv.MustSet("GOFLAGS=" + goflags)
 
+		// Create a build log file.
+		buildLogPath := filepath.Join(resultsDir, fmt.Sprintf("%s.build.log", cfg.Name))
+		buildLog, err := os.Create(buildLogPath)
+		if err != nil {
+			return fmt.Errorf("create %s build log file for %s: %v", b.name, cfg.Name, err)
+		}
+
 		// Build the benchmark (application and any other necessary components).
 		bcfg := common.BuildConfig{
 			BinDir:   binDir,
 			SrcDir:   srcDir,
 			BenchDir: benchDir,
 			Short:    r.short,
+			BuildLog: buildLog,
 		}
 		if err := b.harness.Build(cfg, &bcfg); err != nil {
+			buildLog.Close()
 			return fmt.Errorf("build %s for %s: %v", b.name, cfg.Name, err)
 		}
+		buildLog.Close()
 
 		// Generate any args to funnel through to benchmarks.
 		args := []string{}

sweet/common/config.go

@@ -7,6 +7,7 @@ package common
 import (
 	"bytes"
 	"fmt"
+	"io"
 	"path/filepath"
 
 	"github.com/BurntSushi/toml"
@@ -81,12 +82,13 @@ type PGOConfig struct {
 	BuildEnv ConfigEnv `toml:"envbuild"`
 }
 
-func (c *Config) GoTool() *Go {
+func (c *Config) GoTool(buildLog io.Writer) *Go {
 	return &Go{
 		Tool: filepath.Join(c.GoRoot, "bin", "go"),
 		// Update the GOROOT so the wrong one doesn't propagate from
 		// the environment.
-		Env: c.BuildEnv.Env.MustSet("GOROOT=" + c.GoRoot),
+		Env:      c.BuildEnv.Env.MustSet("GOROOT=" + c.GoRoot),
+		BuildLog: buildLog,
 	}
 }
 

sweet/common/gotool.go

@@ -6,6 +6,7 @@ package common
 
 import (
 	"fmt"
+	"io"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -17,6 +18,7 @@ type Go struct {
 	Tool       string
 	Env        *Env
 	PassOutput bool
+	BuildLog   io.Writer
 }
 
 func SystemGoTool() (*Go, error) {
@@ -39,9 +41,12 @@ func (g *Go) Do(dir string, args ...string) error {
 	if g.PassOutput {
 		cmd.Stdout = os.Stdout
 		cmd.Stderr = os.Stderr
+	} else if g.BuildLog != nil {
+		cmd.Stderr = g.BuildLog
+		cmd.Stdout = g.BuildLog
 	}
 	log.TraceCommand(cmd, false)
-	if g.PassOutput {
+	if g.PassOutput || g.BuildLog != nil {
 		return cmd.Run()
 	}
 	// Use cmd.Output to get an ExitError with Stderr populated.

sweet/common/harness.go

@@ -4,7 +4,10 @@
 
 package common
 
-import "os"
+import (
+	"io"
+	"os"
+)
 
 type GetConfig struct {
 	// SrcDir is the path to the directory that the harness should write
@@ -40,6 +43,9 @@ type BuildConfig struct {
 	// for testing. Guaranteed to be the same as GetConfig.Short and
 	// RunConfig.Short.
 	Short bool
+
+	// BuildLog is used to pass the build log to a file.
+	BuildLog io.Writer
 }
 
 type RunConfig struct {

sweet/harnesses/cockroachdb.go

@@ -47,7 +47,7 @@ func (h CockroachDB) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 	// Install bazel via bazelisk which is used by `dev`. Install it in the
 	// BinDir to ensure we get a new copy every run and avoid reuse. This is
 	// done by setting the `GOBIN` env var for the `go install` cmd.
-	goInstall := cfg.GoTool()
+	goInstall := cfg.GoTool(bcfg.BuildLog)
 	goInstall.Env = goInstall.Env.MustSet(fmt.Sprintf("GOBIN=%s", bcfg.BinDir))
 	if err := goInstall.Do(bcfg.BinDir, "install", "github.com/bazelbuild/bazelisk@latest"); err != nil {
 		return fmt.Errorf("error building bazelisk: %v", err)
@@ -115,7 +115,7 @@ func (h CockroachDB) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 	// Note that since the version of CockroachDB is pinned, we can generally rely on
 	// the checking below. However as CockroachDB and Go evolve, the logic below may need
 	// to change.
-	ver, err := cfg.GoTool().Version()
+	ver, err := cfg.GoTool(bcfg.BuildLog).Version()
 	if err != nil {
 		return fmt.Errorf("getting go version for toolchain: %v", err)
 	}
@@ -126,7 +126,7 @@ func (h CockroachDB) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 	if v := strings.TrimPrefix(ver, "go version "); strings.HasPrefix(v, "devel ") || v >= "go1.24" {
 		goBuildArgs = append(goBuildArgs, "-tags=untested_go_version")
 	}
-	if err := cfg.GoTool().BuildPath(filepath.Join(bcfg.SrcDir, "pkg/cmd/cockroach-short"), bcfg.BinDir, goBuildArgs...); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(filepath.Join(bcfg.SrcDir, "pkg/cmd/cockroach-short"), bcfg.BinDir, goBuildArgs...); err != nil {
 		return err
 	}
 
@@ -137,7 +137,7 @@ func (h CockroachDB) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 	}
 
 	// Build the benchmark wrapper.
-	if err := cfg.GoTool().BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "cockroachdb-bench")); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "cockroachdb-bench")); err != nil {
 		return err
 	}
 	return nil

sweet/harnesses/esbuild.go

@@ -71,11 +71,11 @@ func (h *ESBuild) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 		return err
 	}
 	// Build driver.
-	if err := cfg.GoTool().BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "esbuild-bench")); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "esbuild-bench")); err != nil {
 		return err
 	}
 	// Build esbuild.
-	return cfg.GoTool().BuildPath(filepath.Join(bcfg.SrcDir, "cmd", "esbuild"), filepath.Join(bcfg.BinDir, "esbuild"))
+	return cfg.GoTool(bcfg.BuildLog).BuildPath(filepath.Join(bcfg.SrcDir, "cmd", "esbuild"), filepath.Join(bcfg.BinDir, "esbuild"))
 }
 
 func (h *ESBuild) Run(cfg *common.Config, rcfg *common.RunConfig) error {

sweet/harnesses/etcd.go

@@ -58,11 +58,11 @@ func (h Etcd) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 	}
 	// Build etcd's benchmarking tool. Our benchmark is just a wrapper around that.
 	benchmarkPkg := filepath.Join(bcfg.SrcDir, "tools", "benchmark")
-	if err := cfg.GoTool().BuildPath(benchmarkPkg, filepath.Join(bcfg.BinDir, "benchmark")); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(benchmarkPkg, filepath.Join(bcfg.BinDir, "benchmark")); err != nil {
 		return err
 	}
 	// Build the benchmark wrapper.
-	return cfg.GoTool().BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "etcd-bench"))
+	return cfg.GoTool(bcfg.BuildLog).BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "etcd-bench"))
 }
 
 func (h Etcd) Run(cfg *common.Config, rcfg *common.RunConfig) error {

sweet/harnesses/go-build.go

@@ -117,7 +117,7 @@ func (h GoBuild) Build(pcfg *common.Config, bcfg *common.BuildConfig) error {
 		return fmt.Errorf("error copying GOROOT: %v", err)
 	}
 	cfg.GoRoot = goroot
-	if err := cfg.GoTool().Do("", "install", "cmd/go", "cmd/compile", "cmd/link"); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).Do("", "install", "cmd/go", "cmd/compile", "cmd/link"); err != nil {
 		return fmt.Errorf("error building cmd/go, cmd/compile, and cmd/link: %v", err)
 	}
 
@@ -147,14 +147,14 @@ func (h GoBuild) Build(pcfg *common.Config, bcfg *common.BuildConfig) error {
 		// when benchmarking.
 		pkgPath := filepath.Join(bcfg.BinDir, bench.name, bench.pkg)
 		dummyBin := filepath.Join(bcfg.BinDir, "dummy")
-		goTool := cfg.GoTool()
+		goTool := cfg.GoTool(bcfg.BuildLog)
 		goTool.Env = cfg.ExecEnv.MustSet("GOROOT=" + cfg.GoRoot)
 		if err := goTool.BuildPath(pkgPath, dummyBin); err != nil {
 			return fmt.Errorf("error building %s %s: %w", bench.name, bench.pkg, err)
 		}
 	}
 
-	if err := cfg.GoTool().BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "go-build-bench")); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, "go-build-bench")); err != nil {
 		return fmt.Errorf("error building go-build tool: %w", err)
 	}
 	return nil
@@ -174,7 +174,7 @@ func (h GoBuild) Run(pcfg *common.Config, rcfg *common.RunConfig) error {
 		cmd := exec.Command(
 			filepath.Join(rcfg.BinDir, "go-build-bench"),
 			append(rcfg.Args, []string{
-				"-go", cfg.GoTool().Tool,
+				"-go", cfg.GoTool(nil).Tool,
 				"-tmp", rcfg.TmpDir,
 				filepath.Join(rcfg.BinDir, bench.name, bench.pkg),
 			}...)...,
@@ -199,7 +199,7 @@ func goBuildBenchmarks(cfg *common.Config, short bool) ([]*buildBenchmark, error
 	var bi *buildinfo.BuildInfo
 	if cfg != nil {
 		var err error
-		bi, err = buildinfo.ReadFile(cfg.GoTool().Tool)
+		bi, err = buildinfo.ReadFile(cfg.GoTool(nil).Tool)
 		if err != nil {
 			return nil, fmt.Errorf("error reading build info from Go toolchain: %v", err)
 		}

sweet/harnesses/gvisor.go

@@ -38,15 +38,15 @@ func (h GVisor) Get(gcfg *common.GetConfig) error {
 
 func (h GVisor) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
 	// Build benchmarking client which will handle a bunch of coordination.
-	if err := cfg.GoTool().BuildPath(filepath.Join(bcfg.BenchDir), filepath.Join(bcfg.BinDir, "gvisor-bench")); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(filepath.Join(bcfg.BenchDir), filepath.Join(bcfg.BinDir, "gvisor-bench")); err != nil {
 		return err
 	}
 
 	// Build the runsc package in the repository. CGO_ENABLED must be 0.
 	// See https://github.com/google/gvisor#using-go-get.
 	cfg.BuildEnv.Env = cfg.BuildEnv.MustSet("CGO_ENABLED=0")
 	bin := filepath.Join(bcfg.BinDir, "runsc")
-	if err := cfg.GoTool().BuildPath(filepath.Join(bcfg.SrcDir, "runsc"), bin); err != nil {
+	if err := cfg.GoTool(bcfg.BuildLog).BuildPath(filepath.Join(bcfg.SrcDir, "runsc"), bin); err != nil {
 		return err
 	}
 

sweet/harnesses/local.go

@@ -27,7 +27,7 @@ func (h *localBenchHarness) Get(_ *common.GetConfig) error {
 }
 
 func (h *localBenchHarness) Build(cfg *common.Config, bcfg *common.BuildConfig) error {
-	return cfg.GoTool().BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, h.binName))
+	return cfg.GoTool(bcfg.BuildLog).BuildPath(bcfg.BenchDir, filepath.Join(bcfg.BinDir, h.binName))
 }
 
 func (h *localBenchHarness) Run(cfg *common.Config, rcfg *common.RunConfig) error {