Add Bazel 8 compatibility with automatic bzlmod/WORKSPACE detection

Add centralized compatibility function

Remove compat function

Add compatibility to build file

Import statement and capitalization

Remove compat function

Adapt import and using the function

Remove moved compatibility file

Add utils build file

Move utils function to separate package and adapt imports

Author: janwinkler1

.bazelversion

@@ -1 +1 @@
-7.6.1
+8.2.1

MODULE.bazel

@@ -4,6 +4,7 @@ bazel_dep(name = "bazel_skylib", version = "1.8.1")
 bazel_dep(name = "rules_proto", version = "7.1.0")
 bazel_dep(name = "rules_go", version = "0.55.1", repo_name = "io_bazel_rules_go")
 bazel_dep(name = "gazelle", version = "0.44.0", repo_name = "bazel_gazelle")
+bazel_dep(name = "bazel_features", version = "1.21.0")
 
 # Configure Go SDK
 go_sdk = use_extension("@io_bazel_rules_go//go:extensions.bzl", "go_sdk")

MODULE.bazel.lock

@@ -29,6 +29,8 @@ var Version = "Development"
 
 var overrideableStartupFlags []string = []string{
 	"--bazelrc",
+	"--bazelrc=",
+	"--nobazelrc",
 	"--home_rc",
 	"--nohome_rc",
 	"--output_base",
@@ -53,6 +55,9 @@ var overrideableBazelFlags []string = []string{
 	"--define=",
 	"--dynamic_mode=",
 	"--enable_bzlmod=",
+	"--enable_bzlmod",
+	"--enable_workspace",
+	"--enable_workspace=",
 	"--features=",
 	"--flaky_test_attempts=",
 	"--host_jvmopt",
@@ -62,6 +67,7 @@ var overrideableBazelFlags []string = []string{
 	"-k",
 	"--nocache_test_results",
 	"--noenable_bzlmod",
+	"--noenable_workspace",
 	"--nostamp",
 	"--output_groups=",
 	"--override_repository=",
@@ -213,7 +219,7 @@ func applyDefaultBazelArgs(bazelArgs []string) []string {
 			return bazelArgs
 		}
 	}
-	if (isTerminal()) {
+	if isTerminal() {
 		return append(bazelArgs, "--isatty=1")
 	} else {
 		return append(bazelArgs, "--isatty=0")

cmd/ibazel/main.go

@@ -238,8 +238,7 @@ func (b *bazel) newCommand(command string, args ...string) (*bytes.Buffer, *byte
 func (b *bazel) Info() (map[string]string, error) {
 	b.WriteToStderr(false)
 	b.WriteToStdout(false)
-	stdoutBuffer, _ := b.newCommand("info")
-
+	stdoutBuffer, _ := b.newCommand("info", b.args...)
 	// This gofunction only prints if 'bazel info' takes longer than 8 seconds
 	doneCh := make(chan struct{})
 	defer close(doneCh)
@@ -292,6 +291,7 @@ func (b *bazel) processInfo(info string) (map[string]string, error) {
 func (b *bazel) Query(args ...string) (*blaze_query.QueryResult, error) {
 	blazeArgs := append([]string(nil), "--output=proto", "--order_output=no", "--color=no")
 	blazeArgs = append(blazeArgs, args...)
+	blazeArgs = append(blazeArgs, b.args...)
 
 	b.WriteToStderr(true)  // revert 34c48343 (#536: Improve logging infrastructure) TODO: hide behind argument?
 	b.WriteToStdout(false)
@@ -383,10 +383,13 @@ func (b *bazel) Test(args ...string) (*bytes.Buffer, error) {
 func (b *bazel) Run(args ...string) (*exec.Cmd, *bytes.Buffer, error) {
 	b.WriteToStderr(true)
 	b.WriteToStdout(true)
-	stdoutBuffer, stderrBuffer := b.newCommand("run", append(b.args, args...)...)
+	runArgs := append(b.args, args...)
+	stdoutBuffer, stderrBuffer := b.newCommand("run", runArgs...)
 	b.cmd.Stdin = os.Stdin
 
-	_, _ = stdoutBuffer.Write(stderrBuffer.Bytes())
+	if _, err := stdoutBuffer.Write(stderrBuffer.Bytes()); err != nil {
+		return nil, nil, fmt.Errorf("stdout.write(): %w", err)
+	}
 
 	err := b.cmd.Run()
 	if err != nil {

internal/bazel/bazel.go

@@ -18,5 +18,6 @@ go_library(
         "@io_bazel_rules_go//go/tools/bazel:go_default_library",
         "@io_bazel_rules_go//go/tools/bazel_testing:go_default_library",
         "@org_golang_x_tools//txtar",
+        "//internal/utils"
     ],
 )

internal/e2e/BUILD

@@ -14,6 +14,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/bazelbuild/bazel-watcher/internal/utils"
 	"github.com/bazelbuild/rules_go/go/tools/bazel_testing"
 )
 
@@ -22,6 +23,10 @@ const (
 	defaultDelay = 50 * time.Second
 )
 
+var defaultFlags = []string{
+	"--graceful_termination_wait_duration=1s",
+}
+
 type IBazelTester struct {
 	t             *testing.T
 	ibazelLogFile string
@@ -35,7 +40,7 @@ type IBazelTester struct {
 }
 
 func NewIBazelTester(t *testing.T) *IBazelTester {
-	f, err := ioutil.TempFile("", "ibazel_output.*.log")
+	f, err := os.CreateTemp("", "ibazel_output.*.log")
 	if err != nil {
 		panic(fmt.Sprintf("Error ioutil.Tempfile: %v", err))
 	}
@@ -66,13 +71,14 @@ func (i *IBazelTester) Test(bazelArgs []string, targets ...string) {
 	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")
+	bazelArgs = utils.EnsureBazel8Compatibility(bazelArgs)
 	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.t.Logf("ibazel invoked in %s as: %s", i.cmd.Dir,
+		strings.Join(i.cmd.Args, " "))
 
 	i.stdoutBuffer = &Buffer{}
 	i.cmd.Stdout = i.stdoutBuffer
@@ -89,15 +95,17 @@ func (i *IBazelTester) Coverage(bazelArgs []string, targets ...string) {
 	i.t.Helper()
 
 	args := []string{"--bazel_path=" + i.bazelPath()}
+	args = append(args, defaultFlags...)
 	args = append(args,
 		"--log_to_file="+i.ibazelLogFile,
-		"--graceful_termination_wait_duration=1s")
+	)
 	args = append(args, "coverage")
-	args = append(args, "--bazelrc=/dev/null")
+	bazelArgs = utils.EnsureBazel8Compatibility(bazelArgs)
 	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.t.Logf("ibazel invoked in %s as: %s", i.cmd.Dir,
+		strings.Join(i.cmd.Args, " "))
 
 	i.stdoutBuffer = &Buffer{}
 	i.cmd.Stdout = i.stdoutBuffer
@@ -112,24 +120,22 @@ func (i *IBazelTester) Coverage(bazelArgs []string, targets ...string) {
 
 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",
-	})
+	i.run(target, utils.EnsureBazel8Compatibility(bazelArgs), append(defaultFlags,
+		"--log_to_file="+i.ibazelLogFile,
+	))
 }
 
 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,
-	})
+	i.run(target, utils.EnsureBazel8Compatibility([]string{}), append(defaultFlags,
+		"--log_to_file="+i.ibazelLogFile,
+		"--profile_dev="+profiler,
+	))
 }
 
 func (i *IBazelTester) RunWithBazelFixCommands(target string) {
 	i.t.Helper()
-	i.run(target, []string{}, []string{
+	i.run(target, utils.EnsureBazel8Compatibility([]string{}), []string{
 		"--log_to_file=" + i.ibazelLogFile,
 		"--graceful_termination_wait_duration=1s",
 		"--run_output=true",
@@ -139,13 +145,13 @@ func (i *IBazelTester) RunWithBazelFixCommands(target string) {
 
 func (i *IBazelTester) RunWithAdditionalArgs(target string, additionalArgs []string) {
 	i.t.Helper()
-	i.run(target, []string{}, additionalArgs)
+	i.run(target, utils.EnsureBazel8Compatibility([]string{}), additionalArgs)
 }
 
 func (i *IBazelTester) RunUnverifiedWithAdditionalArgs(target string, additionalArgs []string) {
 	i.t.Helper()
 	prebuild := false
-	i.runUnverified(target, []string{}, additionalArgs, prebuild)
+	i.runUnverified(target, utils.EnsureBazel8Compatibility([]string{}), additionalArgs, prebuild)
 }
 
 func (i *IBazelTester) GetOutput() string {
@@ -415,15 +421,17 @@ func (i *IBazelTester) runUnverified(target string, bazelArgs []string, addition
 	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, " "))
+	i.t.Logf("ibazel invoked in %s as: %s in: %s",
+		i.cmd.Dir, strings.Join(i.cmd.Args, " "),
+		os.Getenv("TEST_TMPDIR"))
 
 	checkArgs := []string{"build"}
 	checkArgs = append(checkArgs, target)
-	checkArgs = append(checkArgs, bazelArgs...)
+	checkArgs = append(checkArgs, utils.EnsureBazel8Compatibility(bazelArgs)...)
 	cmd := bazel_testing.BazelCmd(checkArgs...)
 
 	var buildStdout, buildStderr bytes.Buffer
@@ -436,6 +444,8 @@ func (i *IBazelTester) runUnverified(target string, bazelArgs []string, addition
 			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())
+			} else {
+				i.t.Fatalf("Unable to build target. %v", err)
 			}
 		}
 	}

internal/e2e/ibazel.go

@@ -26,6 +26,7 @@ go_library(
     visibility = ["//:__subpackages__"],
     deps = [
         "//internal/bazel",
+        "//internal/utils",
         "//internal/ibazel/command",
         "//internal/ibazel/fswatcher",
         "//internal/ibazel/fswatcher/common",

internal/ibazel/BUILD

@@ -26,6 +26,7 @@ import (
 	"time"
 
 	"github.com/bazelbuild/bazel-watcher/internal/bazel"
+	"github.com/bazelbuild/bazel-watcher/internal/utils"
 	"github.com/bazelbuild/bazel-watcher/internal/ibazel/command"
 	"github.com/bazelbuild/bazel-watcher/internal/ibazel/fswatcher"
 	"github.com/bazelbuild/bazel-watcher/internal/ibazel/fswatcher/common"
@@ -43,9 +44,9 @@ var bazelNew = bazel.New
 var commandDefaultCommand = command.DefaultCommand
 var commandNotifyCommand = command.NotifyCommand
 var exitMessages = map[os.Signal]string{
-	syscall.SIGINT:  "Subprocess killed from getting SIGINT (trigger SIGINT again to stop ibazel)",
-	syscall.SIGTERM: "Subprocess killed from getting SIGTERM",
-	syscall.SIGHUP:  "Subprocess killed from getting SIGHUP",
+        syscall.SIGINT:  "Subprocess killed from getting SIGINT (trigger SIGINT again to stop ibazel)",
+        syscall.SIGTERM: "Subprocess killed from getting SIGTERM",
+        syscall.SIGHUP:  "Subprocess killed from getting SIGHUP",
 }
 
 type State string
@@ -169,7 +170,8 @@ func (i *IBazel) handleSignals() {
 func (i *IBazel) newBazel() bazel.Bazel {
 	b := bazelNew()
 	b.SetStartupArgs(i.startupArgs)
-	b.SetArguments(i.bazelArgs)
+	bazelArgs := utils.EnsureBazel8Compatibility(i.bazelArgs)
+	b.SetArguments(bazelArgs)
 	return b
 }
 

internal/ibazel/ibazel.go

@@ -301,10 +301,10 @@ func TestIBazelBuild(t *testing.T) {
 	i.build("//path/to:target")
 	expected := [][]string{
 		{"SetStartupArgs"},
-		{"SetArguments"},
+		{"SetArguments", "--enable_bzlmod"},
 		{"Info"},
 		{"SetStartupArgs"},
-		{"SetArguments"},
+		{"SetArguments", "--enable_bzlmod"},
 		{"Cancel"},
 		{"WriteToStderr", "true"},
 		{"WriteToStdout", "true"},
@@ -337,16 +337,16 @@ func TestIBazelTest(t *testing.T) {
 	i.test("//path/to:target")
 	expected := [][]string{
 		{"SetStartupArgs"},
-		{"SetArguments"},
+		{"SetArguments", "--enable_bzlmod"},
 		{"Info"},
 		{"SetStartupArgs"},
-		{"SetArguments"},
+		{"SetArguments", "--enable_bzlmod"},
 		{"SetStartupArgs"},
-		{"SetArguments"},
+		{"SetArguments", "--enable_bzlmod"},
 		{"WriteToStderr", "false"},
 		{"WriteToStdout", "false"},
 		{"CQuery", "//path/to:target"},
-		{"SetArguments", "--test_output=streamed"},
+		{"SetArguments", "--test_output=streamed", "--enable_bzlmod"},
 		{"Cancel"},
 		{"WriteToStderr", "true"},
 		{"WriteToStdout", "true"},