github.com/bazelbuild/bazel-watcher@v0.25.2/internal/e2e/ibazel.go

package e2e

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"strconv"
	"strings"
	"syscall"
	"testing"
	"time"

	"github.com/bazelbuild/rules_go/go/tools/bazel_testing"
)

// Maximum amount of time to wait before failing a test for not matching your expectations.
const (
	defaultDelay = 20 * time.Second
)

type IBazelTester struct {
	t             *testing.T
	ibazelLogFile string

	cmd          *exec.Cmd
	stderrBuffer *Buffer
	stderrOld    string
	stdoutBuffer *Buffer
	stdoutOld    string
	ibazelErrOld string
}

func NewIBazelTester(t *testing.T) *IBazelTester {
	f, err := ioutil.TempFile("", "ibazel_output.*.log")
	if err != nil {
		panic(fmt.Sprintf("Error ioutil.Tempfile: %v", err))
	}

	return &IBazelTester{
		t:             t,
		ibazelLogFile: f.Name(),
	}
}

func (i *IBazelTester) bazelPath() string {
	i.t.Helper()
	path, err := exec.LookPath("bazel")
	if err != nil {
		i.t.Fatalf("Unable to find bazel binary: %v", err)
	}
	return path
}

func (i *IBazelTester) Build(target string) {
	i.t.Helper()
	i.build(target, []string{})
}

func (i *IBazelTester) Test(bazelArgs []string, targets ...string) {
	i.t.Helper()

	args := []string{"--bazel_path=" + i.bazelPath()}
	args = append(args,
		"--log_to_file="+i.ibazelLogFile,
		"--graceful_termination_wait_duration=1s")
	args = append(args, "test")
	args = append(args, "--bazelrc=/dev/null")
	args = append(args, targets...)
	args = append(args, bazelArgs...)
	i.cmd = exec.Command(ibazelPath, args...)
	i.t.Logf("ibazel invoked as: %s", strings.Join(i.cmd.Args, " "))

	i.stdoutBuffer = &Buffer{}
	i.cmd.Stdout = i.stdoutBuffer

	i.stderrBuffer = &Buffer{}
	i.cmd.Stderr = i.stderrBuffer

	if err := i.cmd.Start(); err != nil {
		i.t.Fatalf("Command: %s", i.cmd)
	}
}

func (i *IBazelTester) Coverage(bazelArgs []string, targets ...string) {
	i.t.Helper()

	args := []string{"--bazel_path=" + i.bazelPath()}
	args = append(args,
		"--log_to_file="+i.ibazelLogFile,
		"--graceful_termination_wait_duration=1s")
	args = append(args, "coverage")
	args = append(args, "--bazelrc=/dev/null")
	args = append(args, targets...)
	args = append(args, bazelArgs...)
	i.cmd = exec.Command(ibazelPath, args...)
	i.t.Logf("ibazel invoked as: %s", strings.Join(i.cmd.Args, " "))

	i.stdoutBuffer = &Buffer{}
	i.cmd.Stdout = i.stdoutBuffer

	i.stderrBuffer = &Buffer{}
	i.cmd.Stderr = i.stderrBuffer

	if err := i.cmd.Start(); err != nil {
		i.t.Fatalf("Command: %s", i.cmd)
	}
}

func (i *IBazelTester) Run(bazelArgs []string, target string) {
	i.t.Helper()
	i.run(target, bazelArgs, []string{
		"--log_to_file=" + i.ibazelLogFile,
		"--graceful_termination_wait_duration=1s",
	})
}

func (i *IBazelTester) RunWithProfiler(target string, profiler string) {
	i.t.Helper()
	i.run(target, []string{}, []string{
		"--log_to_file=" + i.ibazelLogFile,
		"--graceful_termination_wait_duration=1s",
		"--profile_dev=" + profiler,
	})
}

func (i *IBazelTester) RunWithBazelFixCommands(target string) {
	i.t.Helper()
	i.run(target, []string{}, []string{
		"--log_to_file=" + i.ibazelLogFile,
		"--graceful_termination_wait_duration=1s",
		"--run_output=true",
		"--run_output_interactive=false",
	})
}

func (i *IBazelTester) RunWithAdditionalArgs(target string, additionalArgs []string) {
	i.t.Helper()
	i.run(target, []string{}, additionalArgs)
}

func (i *IBazelTester) RunUnverifiedWithAdditionalArgs(target string, additionalArgs []string) {
	i.t.Helper()
	prebuild := false
	i.runUnverified(target, []string{}, additionalArgs, prebuild)
}

func (i *IBazelTester) GetOutput() string {
	i.t.Helper()
	return i.stdoutBuffer.String()
}

func (i *IBazelTester) ExpectOutput(want string, delay ...time.Duration) {
	i.t.Helper()

	i.checkExit()

	d := defaultDelay
	if len(delay) == 1 {
		d = delay[0]
	}
	i.Expect(want, i.GetOutput, &i.stdoutOld, d)
}

func (i *IBazelTester) ExpectNoOutput(delay ...time.Duration) {
	i.t.Helper()

	i.checkExit()

	d := defaultDelay
	if len(delay) == 1 {
		d = delay[0]
	}

	// Flush the stdout before waiting for new content.
	i.stdoutOld = i.GetOutput()

	stopAt := time.Now().Add(d)
	for time.Now().Before(stopAt) {
		time.Sleep(5 * time.Millisecond)

		stdout := i.GetOutput()[len(*&i.stdoutOld):]
		if len(stdout) != 0 {
			i.t.Errorf(`Expected no output, but found stdout "%s".`, stdout)
			i.stdoutOld = i.GetOutput()
			return
		}
	}
}

func (i *IBazelTester) ExpectError(want string, delay ...time.Duration) {
	i.t.Helper()

	i.checkExit()

	d := defaultDelay
	if len(delay) == 1 {
		d = delay[0]
	}
	i.Expect(want, i.GetError, &i.stderrOld, d)
}

func (i *IBazelTester) ExpectNoError(delay ...time.Duration) {
	i.t.Helper()

	i.checkExit()

	d := defaultDelay
	if len(delay) == 1 {
		d = delay[0]
	}

	// Flush the stdout before waiting for new content.
	i.stderrOld = i.GetError()

	stopAt := time.Now().Add(d)
	for time.Now().Before(stopAt) {
		time.Sleep(5 * time.Millisecond)

		stderr := i.GetError()[len(*&i.stderrOld):]
		if len(stderr) != 0 {
			i.t.Errorf(`Expected no output err, but found stderr "%s".`, stderr)
			i.stderrOld = i.GetError()
			return
		}
	}
}

func (i *IBazelTester) ExpectIBazelError(want string, delay ...time.Duration) {
	i.t.Helper()

	i.checkExit()

	d := defaultDelay
	if len(delay) == 1 {
		d = delay[0]
	}
	i.Expect(want, i.GetIBazelError, &i.ibazelErrOld, d)
}

func (i *IBazelTester) GetIBazelError() string {
	i.t.Helper()

	i.checkExit()

	iBazelError, err := os.Open(i.ibazelLogFile)
	if err != nil {
		i.t.Errorf("Error os.Open(%q): %v", i.ibazelLogFile, err)
		return ""
	}

	b, err := ioutil.ReadAll(iBazelError)
	if err != nil {
		i.t.Fatalf("Error ioutil.ReadAll(iBazelError): %v", err)
	}

	return string(b)
}

func (i *IBazelTester) ExpectFixCommands(want []string, delay ...time.Duration) {
	i.t.Helper()

	i.checkExit()

	d := defaultDelay
	if len(delay) == 1 {
		d = delay[0]
	}

	logRegexp := regexp.MustCompile("Executing command: `([^`]+)`")

	stopAt := time.Now().Add(d)
	for time.Now().Before(stopAt) {
		time.Sleep(5 * time.Millisecond)

		if len(logRegexp.FindAllStringSubmatch(i.GetIBazelError(), -1)) >= len(want) {
			break
		}
	}

	matches := logRegexp.FindAllStringSubmatch(i.GetIBazelError(), -1)
	if len(matches) != len(want) {
		i.t.Errorf("Expected %v commands to be executed, but found %v.", len(want), len(matches))
		i.t.Errorf("Stderr: [%v]\niBazelStderr: [%v]", i.GetError(), i.GetIBazelError())
	} else {
		var actual []string
		for ind := range matches {
			actual = append(actual, matches[ind][1])
		}
		for ind, expected := range want {
			if actual[ind] != expected {
				i.t.Errorf("Expected the commands to have been executed in order:\nWanted [\n%s\n], got [\n%s\n]",
					strings.Join(want, "\n"), strings.Join(actual, "\n"))
				i.t.Errorf("Stderr: [%v]\niBazelStderr: [%v]", i.GetError(), i.GetIBazelError())
			}
		}
	}
}

func (i *IBazelTester) Expect(want string, stream func() string, history *string, delay time.Duration) {
	i.t.Helper()

	stopAt := time.Now().Add(delay)
	for time.Now().Before(stopAt) {
		time.Sleep(5 * time.Millisecond)

		// Grab the output and strip output that was available last time we passed
		// a test.
		out := stream()[len(*history):]
		if match, err := regexp.MatchString(want, out); match == true && err == nil {
			// Save the current output value for the next iteration.
			*history = stream()
			return
		}
	}

	if match, err := regexp.MatchString(want, stream()); match == false || err != nil {
		i.t.Errorf("Expected iBazel output after %v to be:\nWanted [%v], got [%v]", delay, want, stream())
		i.t.Errorf("Stderr: [%v]\niBazelStderr: [%v]", i.GetError(), i.GetIBazelError())
		//i.t.Log(string(debug.Stack()))

		// In order to prevent cascading errors where the first result failing to
		// match ruins the error output for the rest of the runs, persist the old
		// stdout.
		*history = stream()
	}
}

func (i *IBazelTester) GetError() string {
	i.t.Helper()
	return i.stderrBuffer.String()
}

func (i *IBazelTester) GetSubprocessPid() int64 {
	i.t.Helper()
	f, err := os.Open(filepath.Join(os.TempDir(), "ibazel_e2e_subprocess_launcher.pid"))
	if err != nil {
		panic(err)
	}

	rawPid, err := ioutil.ReadAll(f)
	if err != nil {
		panic(err)
	}

	pid, err := strconv.ParseInt(string(rawPid), 10, 32)
	if err != nil {
		panic(err)
	}
	return pid
}

func (i *IBazelTester) Kill() {
	i.t.Helper()
	if err := i.cmd.Process.Kill(); err != nil {
		panic(err)
	}
}

func (i *IBazelTester) Signal(signum os.Signal) {
	i.t.Helper()
	i.cmd.Process.Signal(signum)
}

func (i *IBazelTester) build(target string, additionalArgs []string) {
	i.t.Helper()
	args := []string{"--bazel_path=" + i.bazelPath()}
	args = append(args, additionalArgs...)
	args = append(args, "build")
	args = append(args, target)
	i.cmd = exec.Command(ibazelPath, args...)

	i.stdoutBuffer = &Buffer{}
	i.cmd.Stdout = i.stdoutBuffer

	i.stderrBuffer = &Buffer{}
	i.cmd.Stderr = i.stderrBuffer

	if err := i.cmd.Start(); err != nil {
		i.t.Fatalf("Command: %s\nError: %v", i.cmd, err)
	}
}

func (i *IBazelTester) checkExit() {
	if i.cmd != nil && i.cmd.ProcessState != nil && i.cmd.ProcessState.Exited() == true {
		i.t.Errorf("ibazel is exited")
	}
}

func (i *IBazelTester) run(target string, bazelArgs []string, additionalArgs []string) {
	prebuild := true
	i.runUnverified(target, bazelArgs, additionalArgs, prebuild)
}

func (i *IBazelTester) runUnverified(target string, bazelArgs []string, additionalArgs []string, prebuild bool) {
	i.t.Helper()

	args := []string{"--bazel_path=" + i.bazelPath()}
	args = append(args, additionalArgs...)
	args = append(args, "run")
	args = append(args, "--bazelrc=/dev/null")
	args = append(args, target)
	args = append(args, bazelArgs...)
	i.cmd = exec.Command(ibazelPath, args...)
	i.t.Logf("ibazel invoked as: %s", strings.Join(i.cmd.Args, " "))

	checkArgs := []string{"build"}
	checkArgs = append(checkArgs, target)
	checkArgs = append(checkArgs, bazelArgs...)
	cmd := bazel_testing.BazelCmd(checkArgs...)

	var buildStdout, buildStderr bytes.Buffer
	cmd.Stdout = &buildStdout
	cmd.Stderr = &buildStderr

	// Before doing anything crazy, let's build the target to make sure it works.
	if prebuild {
		if err := cmd.Run(); err != nil {
			if exitErr, ok := err.(*exec.ExitError); ok {
				status := exitErr.Sys().(syscall.WaitStatus)
				i.t.Fatalf("Unable to build target. Error code: %d\nStdout:\n%s\nStderr:\n%s", status.ExitStatus(), buildStdout.String(), buildStderr.String())
			}
		}
	}

	i.stdoutBuffer = &Buffer{}
	i.cmd.Stdout = i.stdoutBuffer

	i.stderrBuffer = &Buffer{}
	i.cmd.Stderr = i.stderrBuffer

	if err := i.cmd.Start(); err != nil {
		i.t.Fatalf("Command: %s", i.cmd)
	}
}