Add gazelle support for v2

gazelle/buf/buf.go

@@ -33,12 +33,10 @@ const (
 
 const lang = "buf"
 
-var (
-	stringToBreakingMode = map[string]BreakingMode{
-		"module":  BreakingModeModule,
-		"package": BreakingModePackage,
-	}
-)
+var stringToBreakingMode = map[string]BreakingMode{
+	"module":  BreakingModeModule,
+	"package": BreakingModePackage,
+}
 
 // BreakingMode is the generation strategy for buf_breaking_test
 //
@@ -80,25 +78,33 @@ type Config struct {
 	ModuleRoot bool
 	// BufConfigFile is for the nearest buf.yaml
 	BufConfigFile label.Label
-	// GeneratePushRule controls if buf_push should be generated.
+	// Path to the nearest module root.
 	//
-	// Always false for now.
-	GeneratePushRule bool
+	// Only applies to v2.
+	ModuleConfig *ModuleConfig
 }
 
 // BufModule is the parsed buf.yaml. It currently only supports version, name, and build
 // top-level attributes.
 type BufModule struct {
-	Version string      `json:"version,omitempty" yaml:"version,omitempty"`
-	Name    string      `json:"name,omitempty" yaml:"name,omitempty"`
-	Build   BuildConfig `json:"build,omitempty" yaml:"build,omitempty"`
+	Version string `json:"version,omitempty" yaml:"version,omitempty"`
+	// V1
+	Name  string      `json:"name,omitempty" yaml:"name,omitempty"`
+	Build BuildConfig `json:"build,omitempty" yaml:"build,omitempty"`
+	// V2
+	Modules []ModuleConfig `json:"modules,omitempty" yaml:"modules,omitempty"`
 }
 
 // BuildConfig is the build section of the buf.yaml
 type BuildConfig struct {
 	Excludes []string `json:"excludes,omitempty" yaml:"excludes,omitempty"`
 }
 
+type ModuleConfig struct {
+	Path     string   `json:"path,omitempty" yaml:"path,omitempty"`
+	Excludes []string `json:"excludes,omitempty" yaml:"excludes,omitempty"`
+}
+
 // GetConfigForGazelleConfig extracts a Config from gazelle config.
 // It will return `nil` if one is not found.
 //

gazelle/buf/buf_lock.go

@@ -24,5 +24,6 @@ type bufLock struct {
 		Owner      string `yaml:"owner,omitempty" json:"owner,omitempty"`
 		Repository string `yaml:"repository,omitempty" json:"repository,omitempty"`
 		Commit     string `yaml:"commit,omitempty" json:"commit,omitempty"`
+		Name       string `json:"name,omitempty" yaml:"name,omitempty"`
 	} `yaml:"deps,omitempty" json:"deps,omitempty"`
 }

gazelle/buf/buf_test.go

@@ -32,47 +32,51 @@ import (
 func TestLint(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "lint")
+	testRunGazelle(t, "v2/lint")
 }
 
 func TestBreaking(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "breaking_module")
 	testRunGazelle(t, "breaking_package")
 	testRunGazelle(t, "breaking_package_to_module")
+	testRunGazelle(t, "v2/breaking_module")
+	testRunGazelle(t, "v2/breaking_package")
+	testRunGazelle(t, "v2/breaking_package_to_module")
 }
 
 func TestExcludes(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "excludes_module")
 	testRunGazelle(t, "excludes_package")
+	testRunGazelle(t, "v2/excludes_module")
+	testRunGazelle(t, "v2/excludes_package")
 }
 
 func TestWorkspaces(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "workspace")
+	testRunGazelle(t, "v2/workspace")
 }
 
 func TestCrossResolve(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "cross_resolve")
-}
-
-func TestPush(t *testing.T) {
-	// Skipping this test until we release the `buf_push` rule
-	t.SkipNow()
-	t.Parallel()
-	testRunGazelle(t, "push")
+	testRunGazelle(t, "v2/cross_resolve")
 }
 
 func TestMerge(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "merge")
+	testRunGazelle(t, "v2/merge")
 }
 
 func TestImportResolve(t *testing.T) {
 	t.Parallel()
 	testRunGazelle(t, "imports", "update-repos", "--from_file=buf.work.yaml", "-to_macro=buf_deps.bzl%buf_deps", "-prune")
 	testRunGazelle(t, "imports_toolchain_name", "update-repos", "--from_file=buf.work.yaml", "-to_macro=buf_deps.bzl%buf_deps", "-prune")
+	testRunGazelle(t, "v2/imports", "update-repos", "--from_file=buf.yaml", "-to_macro=buf_deps.bzl%buf_deps", "-prune")
+	testRunGazelle(t, "v2/imports_toolchain_name", "update-repos", "--from_file=buf.yaml", "-to_macro=buf_deps.bzl%buf_deps", "-prune")
 }
 
 func testRunGazelle(t *testing.T, name string, gazelleArgs ...string) {

gazelle/buf/config.go

@@ -85,7 +85,16 @@ func loadConfig(gazelleConfig *config.Config, packageRelativePath string, file *
 	if err != nil {
 		log.Print("error trying to load default config", err)
 	}
-	if bufModule != nil {
+	if config.Module != nil && config.Module.Version == "v2" {
+		for _, module := range config.Module.Modules {
+			if module.Path == packageRelativePath {
+				config.ModuleRoot = true
+				config.BufConfigFile = label.New("", "", "buf.yaml") // v2 will always have a buf.yaml at the roor.
+				config.ModuleConfig = &module
+				break
+			}
+		}
+	} else if bufModule != nil {
 		config.Module = bufModule
 		config.ModuleRoot = true
 		config.BufConfigFile = label.New("", packageRelativePath, bufConfigFile)
@@ -172,11 +181,20 @@ func isWithinExcludes(config *Config, path string) bool {
 	if config.Module == nil {
 		return false
 	}
+	// v1
 	for _, exclude := range config.Module.Build.Excludes {
 		if strings.Contains(path, exclude) {
 			return true
 		}
 	}
+	// v2, all paths are relative to the root to `buf.yaml`, so no need to filter out the module.
+	for _, module := range config.Module.Modules {
+		for _, exclude := range module.Excludes {
+			if strings.HasPrefix(path, exclude) {
+				return true
+			}
+		}
+	}
 	return false
 }
 

gazelle/buf/generate.go

@@ -51,12 +51,6 @@ func (*bufLang) GenerateRules(args language.GenerateArgs) language.GenerateResul
 		result.Imports = append(result.Imports, struct{}{})
 	}
 	if config.ModuleRoot {
-		protoImportPaths := getProtoImportPaths(config, args.Dir)
-		if config.GeneratePushRule && config.Module.Name != "" {
-			pushRule := generatePushRule()
-			result.Gen = append(result.Gen, pushRule)
-			result.Imports = append(result.Imports, protoImportPaths)
-		}
 		if config.BreakingImageTarget != "" && config.BreakingMode == BreakingModeModule {
 			breakingRule := generateBreakingRule(config, "buf")
 			result.Gen = append(result.Gen, breakingRule)
@@ -73,10 +67,6 @@ func (*bufLang) GenerateRules(args language.GenerateArgs) language.GenerateResul
 			result.Empty = append(result.Empty, generateEmptyRule(rule))
 			continue
 		}
-		if rule.Kind() == pushRuleKind {
-			result.Empty = append(result.Empty, generateEmptyRule(rule))
-			continue
-		}
 		// proto_library targets are mapped one to one for lint and breaking rules in package mode
 		if rule.Kind() == lintRuleKind || rule.Kind() == breakingRuleKind {
 			if shouldRemoveSingleTargetBufRule(
@@ -96,6 +86,9 @@ func generateLintRule(config *Config, target string) *rule.Rule {
 	if config.Module != nil {
 		r.SetAttr("config", config.BufConfigFile.String())
 	}
+	if config.ModuleConfig != nil {
+		r.SetAttr("module", config.ModuleConfig.Path)
+	}
 	return r
 }
 
@@ -113,13 +106,9 @@ func generateBreakingRule(config *Config, target string) *rule.Rule {
 	if config.Module != nil {
 		r.SetAttr("config", config.BufConfigFile.String())
 	}
-	return r
-}
-
-func generatePushRule() *rule.Rule {
-	r := rule.NewRule(pushRuleKind, "buf_push")
-	r.SetAttr("config", "buf.yaml")
-	r.SetAttr("lock", "buf.lock")
+	if config.ModuleConfig != nil {
+		r.SetAttr("module", config.ModuleConfig.Path)
+	}
 	return r
 }
 

gazelle/buf/kinds.go

@@ -20,7 +20,6 @@ const (
 	lintRuleKind             = "buf_lint_test"
 	breakingRuleKind         = "buf_breaking_test"
 	dependenciesRepoRuleKind = "buf_dependencies"
-	pushRuleKind             = "buf_push"
 )
 
 var bufKinds = map[string]rule.KindInfo{
@@ -56,20 +55,6 @@ var bufKinds = map[string]rule.KindInfo{
 			"modules": true,
 		},
 	},
-	pushRuleKind: {
-		MatchAttrs: []string{"targets"},
-		NonEmptyAttrs: map[string]bool{
-			"targets": true,
-		},
-		MergeableAttrs: map[string]bool{
-			"targets": true,
-			"config":  true,
-			"lock":    true,
-		},
-		ResolveAttrs: map[string]bool{
-			"targets": true,
-		},
-	},
 }
 
 var bufLoads = []rule.LoadInfo{
@@ -79,7 +64,6 @@ var bufLoads = []rule.LoadInfo{
 			lintRuleKind,
 			breakingRuleKind,
 			dependenciesRepoRuleKind,
-			pushRuleKind,
 		},
 	},
 }

gazelle/buf/resolve.go

@@ -42,8 +42,6 @@ func (l *bufLang) Resolve(
 		if config.BreakingMode != BreakingModeModule {
 			return
 		}
-		fallthrough
-	case pushRuleKind:
 		resolveProtoTargetsForRule(
 			gazelleConfig,
 			ruleIndex,
@@ -55,7 +53,7 @@ func (l *bufLang) Resolve(
 	}
 }
 
-// resolveProtoTargetsForRule resolves targets of buf_breaking_test in Module mode and buf_push
+// resolveProtoTargetsForRule resolves targets of buf_breaking_test in Module mode
 func resolveProtoTargetsForRule(
 	gazelleConfig *config.Config,
 	ruleIndex *resolve.RuleIndex,
@@ -64,7 +62,7 @@ func resolveProtoTargetsForRule(
 	importsRaw interface{},
 	fromLabel label.Label,
 ) {
-	// importsRaw will be `[]string` for module mode and buf_push
+	// importsRaw will be `[]string` for module mode
 	imports, ok := importsRaw.([]string)
 	if !ok {
 		return

gazelle/buf/testdata/v2/breaking_module/BUILD.in

@@ -0,0 +1 @@
+# gazelle:buf_breaking_against //:against_file

gazelle/buf/testdata/v2/breaking_module/BUILD.out

@@ -0,0 +1,10 @@
+load("@rules_buf//buf:defs.bzl", "buf_breaking_test")
+
+# gazelle:buf_breaking_against //:against_file
+
+buf_breaking_test(
+    name = "buf_breaking",
+    against = "//:against_file",
+    config = "//:buf.yaml",
+    targets = ["//foo/v1:foo_proto"],
+)

gazelle/buf/testdata/v2/breaking_module/buf.yaml

@@ -0,0 +1,14 @@
+version: v2
+lint:
+  use:
+    - DEFAULT
+  except:
+    - FIELD_NOT_REQUIRED
+    - PACKAGE_NO_IMPORT_CYCLE
+  disallow_comment_ignores: true
+breaking:
+  use:
+    - FILE
+  except:
+    - EXTENSION_NO_DELETE
+    - FIELD_SAME_DEFAULT

gazelle/buf/testdata/v2/breaking_module/foo/v1/BUILD.in

@@ -0,0 +1,9 @@
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@rules_buf//buf:defs.bzl", "buf_lint_test")
+
+proto_library(
+    name = "foo_proto",
+    srcs = ["foo.proto"],
+    visibility = ["//visibility:public"],
+)
+

gazelle/buf/testdata/v2/breaking_module/foo/v1/BUILD.out

@@ -0,0 +1,14 @@
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@rules_buf//buf:defs.bzl", "buf_lint_test")
+
+proto_library(
+    name = "foo_proto",
+    srcs = ["foo.proto"],
+    visibility = ["//visibility:public"],
+)
+
+buf_lint_test(
+    name = "foo_proto_lint",
+    config = "//:buf.yaml",
+    targets = [":foo_proto"],
+)

gazelle/buf/testdata/v2/breaking_package/BUILD.in

@@ -0,0 +1,2 @@
+# gazelle:buf_breaking_against //:against_file
+# gazelle:buf_breaking_mode package

gazelle/buf/testdata/v2/breaking_package/BUILD.out

@@ -0,0 +1,2 @@
+# gazelle:buf_breaking_against //:against_file
+# gazelle:buf_breaking_mode package

gazelle/buf/testdata/v2/breaking_package/buf.yaml

@@ -0,0 +1,14 @@
+version: v2
+lint:
+  use:
+    - DEFAULT
+  except:
+    - FIELD_NOT_REQUIRED
+    - PACKAGE_NO_IMPORT_CYCLE
+  disallow_comment_ignores: true
+breaking:
+  use:
+    - FILE
+  except:
+    - EXTENSION_NO_DELETE
+    - FIELD_SAME_DEFAULT

gazelle/buf/testdata/v2/breaking_package/foo/v1/BUILD.in

@@ -0,0 +1,9 @@
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@rules_buf//buf:defs.bzl", "buf_lint_test")
+
+proto_library(
+    name = "foo_proto",
+    srcs = ["foo.proto"],
+    visibility = ["//visibility:public"],
+)
+