[gazelle] Add java_include_binary directive

java/gazelle/configure.go

@@ -67,6 +67,7 @@ func (jc *Configurer) KnownDirectives() []string {
 		javaconfig.JavaMavenRepositoryName,
 		javaconfig.JavaAnnotationProcessorPlugin,
 		javaconfig.JavaResolveToJavaExports,
+		javaconfig.JavaIncludeBinary,
 	}
 }
 
@@ -79,6 +80,8 @@ func (jc *Configurer) initRootConfig(c *config.Config) javaconfig.Configs {
 	return c.Exts[languageName].(javaconfig.Configs)
 }
 
+const binaryConfigError string = "invalid value for directive %q: %s: possible values are true/false"
+
 func (jc *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
 	cfgs := jc.initRootConfig(c)
 	cfg, exists := cfgs[rel]
@@ -129,8 +132,16 @@ func (jc *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
 				case "false":
 					cfg.SetGenerateProto(false)
 				default:
-					jc.lang.logger.Fatal().Msgf("invalid value for directive %q: %s: possible values are true/false",
-						javaconfig.JavaGenerateProto, d.Value)
+					jc.lang.logger.Fatal().Msgf(binaryConfigError, javaconfig.JavaGenerateProto, d.Value)
+				}
+			case javaconfig.JavaIncludeBinary:
+				switch d.Value {
+				case "true":
+					cfg.SetIncludeBinary(true)
+				case "false":
+					cfg.SetIncludeBinary(false)
+				default:
+					jc.lang.logger.Fatal().Msgf(binaryConfigError, javaconfig.JavaIncludeBinary, d.Value)
 				}
 			case javaconfig.JavaAnnotationProcessorPlugin:
 				// Format: # gazelle:java_annotation_processor_plugin com.example.AnnotationName com.example.AnnotationProcessorImpl
@@ -165,8 +176,7 @@ func (jc *Configurer) Configure(c *config.Config, rel string, f *rule.File) {
 				case "false":
 					cfg.SetResolveToJavaExports(false)
 				default:
-					jc.lang.logger.Fatal().Msgf("invalid value for directive %q: %s: possible values are true/false",
-						javaconfig.JavaResolveToJavaExports, d.Value)
+					jc.lang.logger.Fatal().Msgf(binaryConfigError, javaconfig.JavaResolveToJavaExports, d.Value)
 				}
 			}
 

java/gazelle/generate.go

@@ -203,22 +203,8 @@ func (l javaLang) GenerateRules(args language.GenerateArgs) language.GenerateRes
 		l.generateJavaLibrary(args.File, args.Rel, filepath.Base(args.Rel), productionJavaFiles.SortedSlice(), allPackageNames, nonLocalProductionJavaImports, nonLocalJavaExports, annotationProcessorClasses, false, javaLibraryKind, &res, cfg, args.Config.RepoName)
 	}
 
-	var testHelperJavaClasses *sorted_set.SortedSet[types.ClassName]
-	for _, m := range allMains.SortedSlice() {
-		// Lazily populate because java_binaries are pretty rare
-		if testHelperJavaClasses == nil {
-			testHelperJavaClasses = sorted_set.NewSortedSetFn[types.ClassName]([]types.ClassName{}, types.ClassNameLess)
-			for _, testHelperJavaFile := range testHelperJavaFiles.SortedSlice() {
-				testHelperJavaClasses.Add(*testHelperJavaFile.ClassName())
-			}
-		}
-		isTestOnly := false
-		libName := filepath.Base(args.Rel)
-		if testHelperJavaClasses.Contains(m) {
-			isTestOnly = true
-			libName = testHelperLibname(libName)
-		}
-		l.generateJavaBinary(args.File, m, libName, isTestOnly, &res)
+	if cfg.IncludeBinary() {
+		l.processJavaBinary(args.File, args.Rel, allMains, testHelperJavaFiles, &res)
 	}
 
 	// We add special packages to point to testonly libraries which - this accumulates them,
@@ -514,6 +500,26 @@ func (l javaLang) generateJavaLibrary(file *rule.File, pathToPackageRelativeToBa
 	}
 }
 
+func (l javaLang) processJavaBinary(file *rule.File, rel string, allMains *sorted_set.SortedSet[types.ClassName], testHelperJavaFiles *sorted_set.SortedSet[javaFile], res *language.GenerateResult) {
+	var testHelperJavaClasses *sorted_set.SortedSet[types.ClassName]
+	for _, m := range allMains.SortedSlice() {
+		// Lazily populate because java_binaries are pretty rare
+		if testHelperJavaClasses == nil {
+			testHelperJavaClasses = sorted_set.NewSortedSetFn[types.ClassName]([]types.ClassName{}, types.ClassNameLess)
+			for _, testHelperJavaFile := range testHelperJavaFiles.SortedSlice() {
+				testHelperJavaClasses.Add(*testHelperJavaFile.ClassName())
+			}
+		}
+		isTestOnly := false
+		libName := filepath.Base(rel)
+		if testHelperJavaClasses.Contains(m) {
+			isTestOnly = true
+			libName = testHelperLibname(libName)
+		}
+		l.generateJavaBinary(file, m, libName, isTestOnly, res)
+	}
+}
+
 func (l javaLang) generateJavaBinary(file *rule.File, m types.ClassName, libName string, testonly bool, res *language.GenerateResult) {
 	const ruleKind = "java_binary"
 	name := m.BareOuterClassName()

java/gazelle/javaconfig/config.go

@@ -60,6 +60,10 @@ const (
 	// Can be either "true" or "false". Defaults to "true".
 	// Inherited by children packages, can only be set at the root of the repository.
 	JavaResolveToJavaExports = "java_resolve_to_java_exports"
+
+	//JavaIncludeBinary tells the code generator to include creating the `java_binary` rules
+	// Can be either "true" or "false". Defaults to "true"
+	JavaIncludeBinary = "java_include_binary"
 )
 
 // Configs is an extension of map[string]*Config. It provides finding methods
@@ -82,6 +86,7 @@ func (c *Config) NewChild() *Config {
 		extensionEnabled:       c.extensionEnabled,
 		isModuleRoot:           false,
 		generateProto:          true,
+		includeBinary:          c.includeBinary,
 		resolveToJavaExports:   c.resolveToJavaExports,
 		mavenInstallFile:       c.mavenInstallFile,
 		moduleGranularity:      c.moduleGranularity,
@@ -113,6 +118,7 @@ type Config struct {
 	extensionEnabled                                   bool
 	isModuleRoot                                       bool
 	generateProto                                      bool
+	includeBinary                                      bool
 	resolveToJavaExports                               *types.LateInit[bool]
 	mavenInstallFile                                   string
 	moduleGranularity                                  string
@@ -137,6 +143,7 @@ func New(repoRoot string) *Config {
 		extensionEnabled:       true,
 		isModuleRoot:           false,
 		generateProto:          true,
+		includeBinary:          true,
 		resolveToJavaExports:   types.NewLateInit[bool](true),
 		mavenInstallFile:       "maven_install.json",
 		moduleGranularity:      "package",
@@ -173,6 +180,14 @@ func (c *Config) SetGenerateProto(generate bool) {
 	c.generateProto = generate
 }
 
+func (c *Config) IncludeBinary() bool {
+	return c.includeBinary
+}
+
+func (c *Config) SetIncludeBinary(include bool) {
+	c.includeBinary = include
+}
+
 func (c *Config) MavenRepositoryName() string {
 	return c.mavenRepositoryName
 }

java/gazelle/testdata/bin_disable_bin/maven_install.json

@@ -0,0 +1 @@
+{"version": "2"}

java/gazelle/testdata/bin_disable_bin/src/main/java/com/example/hello/BUILD.in

@@ -0,0 +1 @@
+# gazelle:java_include_binary false

java/gazelle/testdata/bin_disable_bin/src/main/java/com/example/hello/BUILD.out

@@ -0,0 +1,9 @@
+load("@rules_java//java:defs.bzl", "java_library")
+
+# gazelle:java_include_binary false
+
+java_library(
+    name = "hello",
+    srcs = ["Hello.java"],
+    visibility = ["//:__subpackages__"],
+)

java/gazelle/testdata/bin_disable_bin/src/main/java/com/example/hello/Hello.java

@@ -0,0 +1,7 @@
+package gazelle.testdata.bin_disable_bin.src.main.java.com.example.hello;
+
+public class Hello {
+    public static void main(String[] args) {
+        System.out.println("Hello, World!");
+    }
+}

java/gazelle/testdata/bin_in_test_disable_bin/BUILD.in

@@ -0,0 +1,2 @@
+# gazelle:resolve java org.junit @maven//:junit_junit
+# gazelle:java_include_binary false

java/gazelle/testdata/bin_in_test_disable_bin/BUILD.out

@@ -0,0 +1,2 @@
+# gazelle:resolve java org.junit @maven//:junit_junit
+# gazelle:java_include_binary false

java/gazelle/testdata/bin_in_test_disable_bin/maven_install.json

@@ -0,0 +1 @@
+{"version": "2"}

java/gazelle/testdata/bin_in_test_disable_bin/src/test/java/com/example/test/BUILD.out

@@ -0,0 +1,10 @@
+load("@contrib_rules_jvm//java:defs.bzl", "java_test_suite")
+
+java_test_suite(
+    name = "test",
+    srcs = [
+        "SomeOtherTest.java",
+        "SomeTestBinary.java",
+    ],
+    deps = ["@maven//:junit_junit"],
+)

java/gazelle/testdata/bin_in_test_disable_bin/src/test/java/com/example/test/SomeOtherTest.java

@@ -0,0 +1,8 @@
+package gazelle.testdata.bin_in_test_disable_bin.src.test.java.com.example.test;
+
+import org.junit.Test;
+
+public class SomeOtherTest {
+  @Test
+  public void testPasses() {}
+}

java/gazelle/testdata/bin_in_test_disable_bin/src/test/java/com/example/test/SomeTestBinary.java

@@ -0,0 +1,7 @@
+package gazelle.testdata.bin_in_test_disable_bin.src.test.java.com.example.test;
+
+public class SomeTestBinary {
+  public static void main(String[] args) {
+    System.out.println("Test passed!");
+  }
+}