Skip to content

Commit

Permalink
Apply map_kind to args as well as rule kinds
Browse files Browse the repository at this point in the history
bazel-contrib#1310 added support for
adding args from Gazelle, so you can express things like:

```
maybe(
    java_test,
    ...
)
```

But `map_kind` doesn't currently get applied to these args.

This PR adds that application.
  • Loading branch information
illicitonion committed Jan 22, 2024
1 parent 55b3ce6 commit 72c8613
Show file tree
Hide file tree
Showing 5 changed files with 175 additions and 6 deletions.
1 change: 1 addition & 0 deletions cmd/gazelle/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ go_library(
"//resolve",
"//rule",
"//walk",
"@com_github_bazelbuild_buildtools//build",
"@com_github_pmezard_go_difflib//difflib",
],
)
Expand Down
32 changes: 26 additions & 6 deletions cmd/gazelle/fix-update.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import (
"github.com/bazelbuild/bazel-gazelle/resolve"
"github.com/bazelbuild/bazel-gazelle/rule"
"github.com/bazelbuild/bazel-gazelle/walk"
"github.com/bazelbuild/buildtools/build"
)

// updateConfig holds configuration information needed to run the fix and
Expand Down Expand Up @@ -380,17 +381,36 @@ func runFixUpdate(wd string, cmd command, args []string) (err error) {
if f != nil {
allRules = append(allRules, f.Rules...)
}
for _, r := range allRules {
repl, err := lookupMapKindReplacement(c.KindMap, r.Kind())

maybeRecordReplacement := func(ruleKind string) (*string, error) {
repl, err := lookupMapKindReplacement(c.KindMap, ruleKind)
if err != nil {
errorsFromWalk = append(errorsFromWalk, fmt.Errorf("looking up mapped kind: %w", err))
continue
return nil, err
}
if repl != nil {
mappedKindInfo[repl.KindName] = kinds[r.Kind()]
mappedKindInfo[repl.KindName] = kinds[ruleKind]
mappedKinds = append(mappedKinds, *repl)
mrslv.MappedKind(rel, *repl)
r.SetKind(repl.KindName)
return &repl.KindName, nil
}
return nil, nil
}

for _, r := range allRules {
if replacementName, err := maybeRecordReplacement(r.Kind()); err != nil {
errorsFromWalk = append(errorsFromWalk, fmt.Errorf("looking up mapped kind: %w", err))
} else if replacementName != nil {
r.SetKind(*replacementName)
}

for i, arg := range r.Args() {
if ident, ok := arg.(*build.Ident); ok {
if replacementName, err := maybeRecordReplacement(ident.Name); err != nil {
errorsFromWalk = append(errorsFromWalk, fmt.Errorf("looking up mapped kind: %w", err))
} else if replacementName != nil {
r.UpdateArg(i, &build.Ident{Name: *replacementName})
}
}
}
}
for _, r := range empty {
Expand Down
136 changes: 136 additions & 0 deletions cmd/gazelle/fix_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -407,3 +407,139 @@ go_library(

testtools.CheckFiles(t, dir, fixture)
}

func TestFix_MapKind_Argument_SameName(t *testing.T) {
before := []testtools.FileSpec{
{
Path: "BUILD.bazel",
Content: `
load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
# gazelle:map_kind go_binary go_binary //my:custom.bzl
maybe(
go_binary,
name = "nofix",
library = ":go_default_library",
visibility = ["//visibility:public"],
)
go_library(
name = "go_default_library",
srcs = ["some.go"],
importpath = "example.com/repo",
visibility = ["//visibility:public"],
)`,
},
{
Path: "some.go",
Content: `package some`,
},
}

after := []testtools.FileSpec{
{
Path: "BUILD.bazel",
Content: `
load("//my:custom.bzl", "go_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
# gazelle:map_kind go_binary go_binary //my:custom.bzl
maybe(
go_binary,
name = "nofix",
library = ":go_default_library",
visibility = ["//visibility:public"],
)
go_library(
name = "go_default_library",
srcs = ["some.go"],
importpath = "example.com/repo",
visibility = ["//visibility:public"],
)`,
},
}

dir, cleanup := testtools.CreateFiles(t, before)
defer cleanup()

if err := run(dir, []string{
"-repo_root", dir,
"-go_prefix", "example.com/repo",
dir,
}); err != nil {
t.Fatalf("run failed: %v", err)
}

testtools.CheckFiles(t, dir, after)
}

func TestFix_MapKind_Argument_DifferentName(t *testing.T) {
before := []testtools.FileSpec{
{
Path: "BUILD.bazel",
Content: `
load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
# gazelle:map_kind go_binary custom_go_binary //my:custom.bzl
maybe(
go_binary,
name = "nofix",
library = ":go_default_library",
visibility = ["//visibility:public"],
)
go_library(
name = "go_default_library",
srcs = ["some.go"],
importpath = "example.com/repo",
visibility = ["//visibility:public"],
)`,
},
{
Path: "some.go",
Content: `package some`,
},
}

after := []testtools.FileSpec{
{
Path: "BUILD.bazel",
Content: `
load("//my:custom.bzl", "custom_go_binary")
load("@io_bazel_rules_go//go:def.bzl", "go_library")
# gazelle:map_kind go_binary custom_go_binary //my:custom.bzl
maybe(
custom_go_binary,
name = "nofix",
library = ":go_default_library",
visibility = ["//visibility:public"],
)
go_library(
name = "go_default_library",
srcs = ["some.go"],
importpath = "example.com/repo",
visibility = ["//visibility:public"],
)`,
},
}

dir, cleanup := testtools.CreateFiles(t, before)
defer cleanup()

if err := run(dir, []string{
"-repo_root", dir,
"-go_prefix", "example.com/repo",
dir,
}); err != nil {
t.Fatalf("run failed: %v", err)
}

testtools.CheckFiles(t, dir, after)
}
9 changes: 9 additions & 0 deletions rule/rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -1016,6 +1016,15 @@ func (r *Rule) AddArg(value bzl.Expr) {
r.updated = true
}

// UpdateArg replaces an existing arg with a new value.
func (r *Rule) UpdateArg(index int, value bzl.Expr) {
if len(r.args) < index {
panic(fmt.Sprintf("Can't update argument at index %d, only have %d args", index, len(r.args)))
}
r.args[index] = value
r.updated = true
}

// SortedAttrs returns the keys of attributes whose values will be sorted
func (r *Rule) SortedAttrs() []string {
return r.sortedAttrs
Expand Down
3 changes: 3 additions & 0 deletions rule/rule_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ y_library(name = "bar")
loadMaybe.Insert(f, 0)
baz := NewRule("maybe", "baz")
baz.AddArg(&bzl.LiteralExpr{Token: "z"})
baz.AddArg(&bzl.LiteralExpr{Token: "z"})
baz.UpdateArg(0, &bzl.LiteralExpr{Token: "z0"})
baz.SetAttr("srcs", GlobValue{
Patterns: []string{"**"},
Excludes: []string{"*.pem"},
Expand All @@ -85,6 +87,7 @@ y_library(
)
maybe(
z0,
z,
name = "baz",
srcs = glob(
Expand Down

0 comments on commit 72c8613

Please sign in to comment.