walk/walk_test.go

/* Copyright 2018 The Bazel Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package walk

import (
	"bytes"
	"flag"
	"fmt"
	"os"
	"path"
	"path/filepath"
	"reflect"
	"testing"

	"github.com/bazelbuild/bazel-gazelle/config"
	"github.com/bazelbuild/bazel-gazelle/rule"
	"github.com/bazelbuild/bazel-gazelle/testtools"
	"github.com/google/go-cmp/cmp"
)

func TestConfigureCallbackOrder(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{{Path: "a/b/"}})
	defer cleanup()

	check := func(t *testing.T, configureRels, callbackRels []string) {
		configureWant := []string{"", "a", "a/b"}
		if diff := cmp.Diff(configureWant, configureRels); diff != "" {
			t.Errorf("configure order (-want +got):\n%s", diff)
		}
		callbackWant := []string{"a/b", "a", ""}
		if diff := cmp.Diff(callbackWant, callbackRels); diff != "" {
			t.Errorf("callback order (-want +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		var configureRels, callbackRels []string
		c, cexts := testConfig(t, dir)
		cexts = append(cexts, &testConfigurer{func(_ *config.Config, rel string, _ *rule.File) {
			configureRels = append(configureRels, rel)
		}})
		Walk(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(_ string, rel string, _ *config.Config, _ bool, _ *rule.File, _, _, _ []string) {
			callbackRels = append(callbackRels, rel)
		})
		check(t, configureRels, callbackRels)
	})

	t.Run("Walk2", func(t *testing.T) {
		var configureRels, callbackRels []string
		c, cexts := testConfig(t, dir)
		cexts = append(cexts, &testConfigurer{func(_ *config.Config, rel string, _ *rule.File) {
			configureRels = append(configureRels, rel)
		}})
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			callbackRels = append(callbackRels, args.Rel)
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, configureRels, callbackRels)
	})
}

func TestUpdateDirs(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{Path: "update/sub/"},
		{Path: "update/sub/sub/"},
		{
			Path:    "update/ignore/BUILD.bazel",
			Content: "# gazelle:ignore",
		},
		{Path: "update/ignore/sub/"},
		{
			Path:    "update/error/BUILD.bazel",
			Content: "(",
		},
		{Path: "update/error/sub/"},
	})
	defer cleanup()

	type visitSpec struct {
		Rel    string
		Update bool
	}
	for _, tc := range []struct {
		desc    string
		rels    []string
		mode    Mode
		want    []visitSpec
		wantErr bool
	}{
		{
			desc: "visit_all_update_subdirs",
			rels: []string{"update"},
			mode: VisitAllUpdateSubdirsMode,
			want: []visitSpec{
				{"update/error/sub", true},
				{"update/error", false},
				{"update/ignore/sub", true},
				{"update/ignore", false},
				{"update/sub/sub", true},
				{"update/sub", true},
				{"update", true},
				{"", false},
			},
			wantErr: true,
		}, {
			desc: "visit_all_update_dirs",
			rels: []string{"update", "update/ignore/sub"},
			mode: VisitAllUpdateDirsMode,
			want: []visitSpec{
				{"update/error/sub", false},
				{"update/error", false},
				{"update/ignore/sub", true},
				{"update/ignore", false},
				{"update/sub/sub", false},
				{"update/sub", false},
				{"update", true},
				{"", false},
			},
			wantErr: true,
		}, {
			desc: "update_dirs",
			rels: []string{"update", "update/ignore/sub"},
			mode: UpdateDirsMode,
			want: []visitSpec{
				{"update/ignore/sub", true},
				{"update/ignore", false},
				{"update", true},
				{"", false},
			},
		}, {
			desc: "update_subdirs",
			rels: []string{"update/ignore", "update/sub"},
			mode: UpdateSubdirsMode,
			want: []visitSpec{
				{"update/ignore/sub", true},
				{"update/ignore", false},
				{"update/sub/sub", true},
				{"update/sub", true},
				{"update", false},
				{"", false},
			},
		},
	} {
		t.Run(tc.desc, func(t *testing.T) {
			c, cexts := testConfig(t, dir)
			dirs := make([]string, len(tc.rels))
			for i, rel := range tc.rels {
				dirs[i] = filepath.Join(dir, filepath.FromSlash(rel))
			}

			t.Run("Walk", func(t *testing.T) {
				var visits []visitSpec
				Walk(c, cexts, dirs, tc.mode, func(_ string, rel string, _ *config.Config, update bool, _ *rule.File, _, _, _ []string) {
					visits = append(visits, visitSpec{rel, update})
				})
				if diff := cmp.Diff(tc.want, visits); diff != "" {
					t.Errorf("Walk visits (-want +got):\n%s", diff)
				}
			})

			t.Run("Walk2", func(t *testing.T) {
				var visits []visitSpec
				err := Walk2(c, cexts, dirs, tc.mode, func(args Walk2FuncArgs) Walk2FuncResult {
					visits = append(visits, visitSpec{args.Rel, args.Update})
					return Walk2FuncResult{}
				})
				if tc.wantErr && err == nil {
					t.Fatal("unexpected success")
				}
				if !tc.wantErr {
					if !tc.wantErr && err != nil {
						t.Fatal(err)
					}
					if diff := cmp.Diff(tc.want, visits); diff != "" {
						t.Errorf("Walk visits (-want +got):\n%s", diff)
					}
				}
			})
		})
	}
}

func TestGenMode(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{Path: "mode-create/"},
		{Path: "mode-create/a.go"},
		{Path: "mode-create/sub/"},
		{Path: "mode-create/sub/b.go"},
		{Path: "mode-create/sub/sub2/"},
		{Path: "mode-create/sub/sub2/sub3/c.go"},
		{Path: "mode-update/"},
		{
			Path:    "mode-update/BUILD.bazel",
			Content: "# gazelle:generation_mode update_only",
		},
		{Path: "mode-update/a.go"},
		{Path: "mode-update/sub/"},
		{Path: "mode-update/sub/b.go"},
		{Path: "mode-update/sub/sub2/"},
		{Path: "mode-update/sub/sub2/sub3/c.go"},
		{Path: "mode-update/sub/sub3/"},
		{Path: "mode-update/sub/sub3/BUILD.bazel"},
		{Path: "mode-update/sub/sub3/d.go"},
		{Path: "mode-update/sub/sub3/sub4/"},
		{Path: "mode-update/sub/sub3/sub4/e.go"},
	})
	defer cleanup()

	type visitSpec struct {
		rel            string
		subdirs, files []string
	}

	check := func(t *testing.T, visits []visitSpec) {
		t.Helper()
		if len(visits) != 7 {
			t.Errorf("Expected 7 visits, got %v", len(visits))
		}

		if !reflect.DeepEqual(visits[len(visits)-1].subdirs, []string{"mode-create", "mode-update"}) {
			t.Errorf("Last visit should be root dir with 2 subdirs")
		}

		if len(visits[0].subdirs) != 0 || len(visits[0].files) != 1 || visits[0].files[0] != "c.go" {
			t.Errorf("Leaf visit should be only files: %v", visits[0])
		}
		modeUpdateFiles1 := []string{"BUILD.bazel", "d.go", "sub4/e.go"}
		if !reflect.DeepEqual(visits[4].files, modeUpdateFiles1) {
			t.Errorf("update mode should contain files in subdirs. Want %v, got: %v", modeUpdateFiles1, visits[5].files)
		}

		modeUpdateFiles2 := []string{"BUILD.bazel", "a.go", "sub/b.go", "sub/sub2/sub3/c.go"}
		if !reflect.DeepEqual(visits[5].files, modeUpdateFiles2) {
			t.Errorf("update mode should contain files in subdirs. Want %v, got: %v", modeUpdateFiles2, visits[5].files)
		}

		// Verify every file+directory is only passed to a single WalkFunc invocation.
		filesSeen := make(map[string]string)
		for _, v := range visits {
			for _, f := range v.files {
				fullPath := filepath.Join(v.rel, f)
				if p, exists := filesSeen[fullPath]; exists {
					t.Errorf("File %q already seen in %q, now also in %q", fullPath, p, v.rel)
				}
				filesSeen[fullPath] = v.rel
			}
			for _, f := range v.subdirs {
				fullPath := filepath.Join(v.rel, f)
				if p, exists := filesSeen[fullPath]; exists {
					t.Errorf("Dir %q already seen in %q, now also in %q", fullPath, p, v.rel)
				}
				filesSeen[fullPath] = v.rel
			}
		}
	}

	t.Run("Walk generation_mode create vs update", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var visits []visitSpec
		Walk(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(_ string, rel string, _ *config.Config, update bool, _ *rule.File, subdirs, regularFiles, _ []string) {
			visits = append(visits, visitSpec{
				rel:     rel,
				subdirs: subdirs,
				files:   regularFiles,
			})
		})
		check(t, visits)
	})

	t.Run("Walk2 generation_mode create vs update", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var visits []visitSpec
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			visits = append(visits, visitSpec{
				rel:     args.Rel,
				subdirs: args.Subdirs,
				files:   args.RegularFiles,
			})
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, visits)
	})
}

func TestCustomBuildName(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path:    "BUILD.bazel",
			Content: "# gazelle:build_file_name BUILD.test",
		}, {
			Path: "BUILD",
		}, {
			Path: "sub/BUILD.test",
		}, {
			Path: "sub/BUILD.bazel",
		},
	})
	defer cleanup()

	check := func(t *testing.T, rels []string) {
		t.Helper()
		want := []string{
			"sub/BUILD.test",
			"BUILD.bazel",
		}
		if diff := cmp.Diff(want, rels); diff != "" {
			t.Errorf("Walk relative paths (-want +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var rels []string
		Walk(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(_ string, _ string, _ *config.Config, _ bool, f *rule.File, _, _, _ []string) {
			rel, err := filepath.Rel(c.RepoRoot, f.Path)
			if err != nil {
				t.Error(err)
			} else {
				rels = append(rels, filepath.ToSlash(rel))
			}
		})
		check(t, rels)
	})

	t.Run("Walk2", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var rels []string
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			rel, err := filepath.Rel(c.RepoRoot, args.File.Path)
			if err != nil {
				t.Error(err)
			} else {
				rels = append(rels, filepath.ToSlash(rel))
			}
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, rels)
	})
}

func TestExcludeFiles(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path: "BUILD.bazel",
			Content: `
# gazelle:exclude **/*.pb.go
# gazelle:exclude *.gen.go
# gazelle:exclude a.go
# gazelle:exclude c/**/b
# gazelle:exclude gen
# gazelle:exclude ign
# gazelle:exclude sub/b.go

gen(
    name = "x",
    out = "gen",
)`,
		},
		{
			Path: ".bazelignore",
			Content: `
dir
dir2/a/b
dir3/

# Globs are not allowed in .bazelignore so this will not be ignored
foo/*

# Random comment followed by a line
a.file

# Paths can have a ./ prefix
./b.file
././blah/../ugly/c.file
`,
		},
		{Path: ".dot"},       // not ignored
		{Path: "_blank"},     // not ignored
		{Path: "a/a.proto"},  // not ignored
		{Path: "a/b.gen.go"}, // not ignored
		{Path: "dir2/a/c"},   // not ignored
		{Path: "foo/a/c"},    // not ignored

		{Path: "a.gen.go"},        // ignored by '*.gen.go'
		{Path: "a.go"},            // ignored by 'a.go'
		{Path: "a.pb.go"},         // ignored by '**/*.pb.go'
		{Path: "a/a.pb.go"},       // ignored by '**/*.pb.go'
		{Path: "a/b/a.pb.go"},     // ignored by '**/*.pb.go'
		{Path: "c/x/b/foo"},       // ignored by 'c/**/b'
		{Path: "c/x/y/b/bar"},     // ignored by 'c/**/b'
		{Path: "c/x/y/b/foo/bar"}, // ignored by 'c/**/b'
		{Path: "ign/bad"},         // ignored by 'ign'
		{Path: "sub/b.go"},        // ignored by 'sub/b.go'
		{Path: "dir/contents"},    // ignored by .bazelignore 'dir'
		{Path: "dir2/a/b"},        // ignored by .bazelignore 'dir2/a/b'
		{Path: "dir3/g/h"},        // ignored by .bazelignore 'dir3/'
		{Path: "a.file"},          // ignored by .bazelignore 'a.file'
		{Path: "b.file"},          // ignored by .bazelignore './b.file'
		{Path: "ugly/c.file"},     // ignored by .bazelignore '././blah/../ugly/c.file'
	})
	defer cleanup()

	check := func(t *testing.T, files []string) {
		t.Helper()
		want := []string{"a/a.proto", "a/b.gen.go", "dir2/a/c", "foo/a/c", ".bazelignore", ".dot", "BUILD.bazel", "_blank"}
		if diff := cmp.Diff(want, files); diff != "" {
			t.Errorf("Walk files (-want +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var files []string
		Walk(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(_ string, rel string, _ *config.Config, _ bool, _ *rule.File, _, regularFiles, genFiles []string) {
			for _, f := range regularFiles {
				files = append(files, path.Join(rel, f))
			}
			for _, f := range genFiles {
				files = append(files, path.Join(rel, f))
			}
		})
		check(t, files)
	})

	t.Run("Walk2", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var files []string
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			for _, f := range args.RegularFiles {
				files = append(files, path.Join(args.Rel, f))
			}
			for _, f := range args.GenFiles {
				files = append(files, path.Join(args.Rel, f))
			}
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, files)
	})
}

func TestExcludeSelf(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path: "BUILD.bazel",
		}, {
			Path:    "sub/BUILD.bazel",
			Content: "# gazelle:exclude .",
		}, {
			Path: "sub/below/BUILD.bazel",
		},
	})
	defer cleanup()

	check := func(t *testing.T, rels []string) {
		t.Helper()
		want := []string{""}
		if diff := cmp.Diff(want, rels); diff != "" {
			t.Errorf("Walk relative paths (-want +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var rels []string
		Walk(c, cexts, []string{dir}, VisitAllUpdateDirsMode, func(_ string, rel string, _ *config.Config, _ bool, f *rule.File, _, _, _ []string) {
			rels = append(rels, rel)
		})
		check(t, rels)
	})

	t.Run("Walk2", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var rels []string
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateDirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			rels = append(rels, args.Rel)
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, rels)
	})
}

func TestGeneratedFiles(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path: "BUILD.bazel",
			Content: `
unknown_rule(
    name = "blah1",
    out = "gen1",
)

unknown_rule(
    name = "blah2",
    outs = [
        "gen2",
        "gen-and-static",
    ],
)
`,
		},
		{Path: "gen-and-static"},
		{Path: "static"},
	})
	defer cleanup()

	check := func(t *testing.T, regularFiles, genFiles []string) {
		t.Helper()
		regWant := []string{"BUILD.bazel", "gen-and-static", "static"}
		if diff := cmp.Diff(regWant, regularFiles); diff != "" {
			t.Errorf("Walk regularFiles (-want +got):\n%s", diff)
		}
		genWant := []string{"gen1", "gen2", "gen-and-static"}
		if diff := cmp.Diff(genWant, genFiles); diff != "" {
			t.Errorf("Walk genFiles (-want +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var regularFiles, genFiles []string
		Walk(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(_ string, rel string, _ *config.Config, _ bool, _ *rule.File, _, reg, gen []string) {
			for _, f := range reg {
				regularFiles = append(regularFiles, path.Join(rel, f))
			}
			for _, f := range gen {
				genFiles = append(genFiles, path.Join(rel, f))
			}
		})
		check(t, regularFiles, genFiles)
	})

	t.Run("Walk2", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var regularFiles, genFiles []string
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			for _, f := range args.RegularFiles {
				regularFiles = append(regularFiles, path.Join(args.Rel, f))
			}
			for _, f := range args.GenFiles {
				genFiles = append(genFiles, path.Join(args.Rel, f))
			}
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, regularFiles, genFiles)
	})
}

func TestFollow(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path: "BUILD.bazel",
			Content: `
# gazelle:follow a
# gazelle:exclude _*
`,
		},
		{Path: "_a/"},
		{Path: "_b/"},
		{Path: "_c"},
		{
			Path:    "a",
			Symlink: "_a",
		},
		{
			Path:    "b",
			Symlink: "_b",
		},
		{
			Path:    "c",
			Symlink: "_c",
		},
	})
	defer cleanup()

	check := func(t *testing.T, regularFiles, subdirs []string) {
		t.Helper()
		wantRegularFiles := []string{"BUILD.bazel", "b", "c"}
		if diff := cmp.Diff(wantRegularFiles, regularFiles); diff != "" {
			t.Errorf("regular files (-want, +got):\n%s", diff)
		}
		wantSubdirs := []string{"a"}
		if diff := cmp.Diff(wantSubdirs, subdirs); diff != "" {
			t.Errorf("subdirs (-want, +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var gotRegularFiles, gotSubdirs []string
		Walk(c, cexts, []string{dir}, UpdateDirsMode, func(_, _ string, _ *config.Config, _ bool, _ *rule.File, subdirs, regularFiles, _ []string) {
			gotRegularFiles = regularFiles
			gotSubdirs = subdirs
		})
		check(t, gotRegularFiles, gotSubdirs)
	})

	t.Run("Walk2", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var gotRegularFiles, gotSubdirs []string
		err := Walk2(c, cexts, []string{dir}, UpdateDirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			gotRegularFiles = args.RegularFiles
			gotSubdirs = args.Subdirs
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, gotRegularFiles, gotSubdirs)
	})
}

func TestSubdirsContained(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path: "BUILD.bazel",
			Content: `
# gazelle:exclude exclude
# gazelle:generation_mode update_only
`,
		},
		{
			Path: "with_build_file/BUILD.bazel",
		},
		{
			Path: "with_build_file/sub/file.txt",
		},
		{
			Path: "without_build_file/file.txt",
		},
		{
			Path: "without_build_file/sub/file.txt",
		},
		{
			Path: "exclude/file.txt",
		},
		{
			Path: "exclude/sub/file.txt",
		},
	})
	defer cleanup()

	wantRegularFiles := []string{"BUILD.bazel", "without_build_file/file.txt", "without_build_file/sub/file.txt"}
	wantSubdirs := []string{"with_build_file", "without_build_file", "without_build_file/sub"}
	check := func(t *testing.T, regularFiles, subdirs []string) {
		if diff := cmp.Diff(wantRegularFiles, regularFiles); diff != "" {
			t.Errorf("regular files (-want, +got):\n%s", diff)
		}
		if diff := cmp.Diff(wantSubdirs, subdirs); diff != "" {
			t.Errorf("subdirs (-want, +got):\n%s", diff)
		}
	}

	t.Run("Walk", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var rootRegularFiles, rootSubdirs []string
		Walk(c, cexts, []string{dir}, VisitAllUpdateSubdirsMode, func(_, rel string, _ *config.Config, _ bool, _ *rule.File, subdirs, regularFiles, _ []string) {
			if rel == "" {
				rootRegularFiles = regularFiles
				rootSubdirs = subdirs
			}
		})
		check(t, rootRegularFiles, rootSubdirs)
	})

	t.Run("Walk2", func(t *testing.T) {
		c, cexts := testConfig(t, dir)
		var rootRegularFiles, rootSubdirs []string
		err := Walk2(c, cexts, []string{dir}, VisitAllUpdateDirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
			if args.Rel == "" {
				rootRegularFiles = args.RegularFiles
				rootSubdirs = args.Subdirs
			}
			return Walk2FuncResult{}
		})
		if err != nil {
			t.Fatal(err)
		}
		check(t, rootRegularFiles, rootSubdirs)
	})
}

func TestRelsToVisit(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{Path: "update/sub/"},
		{Path: "extra/a/sub/"},
		{Path: "extra/b/sub/"},
		{Path: "extra/does/not/"},
	})
	defer cleanup()

	// Update the update/ directory only without recursing.
	// Return extra/a/ through RelsToVisit.
	var configuredRels, visitedRels, updatedRels []string
	c, cexts := testConfig(t, dir)
	cexts = append(cexts, &testConfigurer{
		configure: func(_ *config.Config, rel string, _ *rule.File) {
			configuredRels = append(configuredRels, rel)
		},
	})
	updateDir := filepath.Join(dir, "update")
	err := Walk2(c, cexts, []string{updateDir}, UpdateDirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
		visitedRels = append(visitedRels, args.Rel)
		if args.Update {
			updatedRels = append(updatedRels, args.Rel)
		}
		res := Walk2FuncResult{}
		switch args.Rel {
		case "update":
			res.RelsToVisit = []string{"update", "extra/a"}
		case "extra/a":
			res.RelsToVisit = []string{"update", "extra/b/sub"}
		case "extra/b/sub":
			res.RelsToVisit = []string{"update", "extra/b"}
		case "extra/b":
			res.RelsToVisit = []string{"extra/does/not/exist"}
		}
		return res
	})
	if err != nil {
		t.Fatal(err)
	}

	// Verify directories mentioned in RelsToVisit were configured, as well as
	// their parents.
	wantConfiguredRels := []string{"", "update", "extra", "extra/a", "extra/b", "extra/b/sub", "extra/does", "extra/does/not"}
	if diff := cmp.Diff(wantConfiguredRels, configuredRels); diff != "" {
		t.Errorf("configured rels (-want,+got):\n%s", diff)
	}
	// Verify directories mentioned in RelsToVisit were visited, as well as their
	// parents.
	wantVisitedRels := []string{"update", "", "extra", "extra/a", "extra/b", "extra/b/sub", "extra/does", "extra/does/not"}
	if diff := cmp.Diff(wantVisitedRels, visitedRels); diff != "" {
		t.Errorf("visited rels (-want,+got)\n%s", diff)
	}
	// Verify directories mentioned in RelsToVisit were not updated.
	wantUpdatedRels := []string{"update"}
	if diff := cmp.Diff(wantUpdatedRels, updatedRels); diff != "" {
		t.Errorf("updated rels (-want,+got)\n%s", diff)
	}
}

func TestGetDirInfo(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path: "BUILD.bazel",
			Content: `
# gazelle:exclude exclude
genrule(
    name = "gen",
		outs = ["gen.txt"],
)
`,
		},
		{
			Path: "exclude",
		},
		{
			Path: "file",
		},
		{
			Path: "subdir/",
		},
	})
	defer cleanup()

	wantRegularFiles := []string{"BUILD.bazel", "file"}
	wantSubdirs := []string{"subdir"}
	wantGenFiles := []string{"gen.txt"}

	c, cexts := testConfig(t, dir)
	err := Walk2(c, cexts, []string{dir}, VisitAllUpdateDirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
		di, err := GetDirInfo("")
		if err != nil {
			t.Fatal(err)
		}
		if diff := cmp.Diff(wantRegularFiles, di.RegularFiles); diff != "" {
			t.Errorf("regular files (-want, +got):\n%s", diff)
		}
		if diff := cmp.Diff(wantSubdirs, di.Subdirs); diff != "" {
			t.Errorf("subdirectories (-want, +got):\n%s", diff)
		}
		if diff := cmp.Diff(wantGenFiles, di.GenFiles); diff != "" {
			t.Errorf("gen files (-want, +got):\n%s", diff)
		}
		return Walk2FuncResult{}
	})
	if err != nil {
		t.Fatal(err)
	}
}

func TestGetDirInfoSubdir(t *testing.T) {
	dir, cleanup := testtools.CreateFiles(t, []testtools.FileSpec{
		{
			Path:    "BUILD.bazel",
			Content: `# gazelle:exclude x`,
		},
		{
			Path: "a/b/c.txt",
		},
		{
			Path: "x/y/z.txt",
		},
	})
	defer cleanup()

	c, cexts := testConfig(t, dir)
	err := Walk2(c, cexts, []string{dir}, UpdateDirsMode, func(args Walk2FuncArgs) Walk2FuncResult {
		bInfo, err := GetDirInfo("a/b")
		if err != nil {
			t.Fatal(err)
		}
		if diff := cmp.Diff([]string{"c.txt"}, bInfo.RegularFiles); diff != "" {
			t.Errorf("a/b: regular files (-want, +got):\n%s", diff)
		}

		if _, err := GetDirInfo("x/y"); err == nil {
			t.Errorf("x/y: unexpected success")
		}
		return Walk2FuncResult{}
	})
	if err != nil {
		t.Fatal(err)
	}
}

func testConfig(t *testing.T, dir string) (*config.Config, []config.Configurer) {
	args := []string{"-repo_root", dir}
	cexts := []config.Configurer{&config.CommonConfigurer{}, &Configurer{}}
	c := testtools.NewTestConfig(t, cexts, nil, args)
	return c, cexts
}

var _ config.Configurer = (*testConfigurer)(nil)

type testConfigurer struct {
	configure func(c *config.Config, rel string, f *rule.File)
}

func (*testConfigurer) RegisterFlags(_ *flag.FlagSet, _ string, _ *config.Config) {}

func (*testConfigurer) CheckFlags(_ *flag.FlagSet, _ *config.Config) error { return nil }

func (*testConfigurer) KnownDirectives() []string { return nil }

func (tc *testConfigurer) Configure(c *config.Config, rel string, f *rule.File) {
	tc.configure(c, rel, f)
}

// BenchmarkWalk measures how long it takes Walk to traverse a synthetic repo.
//
// There are 10 top-level directories. Each has 10 subdirectories. Each of
// those has 10 subdirectories (so 1001 directories in total).
//
// Each directory has 10 files and a BUILD file with a filegroup that includes
// those files (the content isn't really important, we just want to exercise
// the parser a little bit.)
//
// This is somewhat unrealistic: the whole tree is likely to be in the kernel's
// memory in the kernel's file cache, so this doesn't measure I/O to disk.
// Still, this is frequently true for real projects where Gazelle is invoked.
func BenchmarkWalk(b *testing.B) {
	// Create a fake repo to walk.
	subdirCount := 10
	fileCount := 10
	levelCount := 3

	buildFileBuilder := &bytes.Buffer{}
	fmt.Fprintf(buildFileBuilder, "filegroup(\n    srcs = [\n")
	for i := range fileCount {
		fmt.Fprintf(buildFileBuilder, "        \"f%d\",\n", i)
	}
	fmt.Fprintf(buildFileBuilder, "    ],\n)\n")
	buildFileContent := buildFileBuilder.Bytes()

	rootDir := b.TempDir()
	var createDir func(string, int)
	createDir = func(dir string, level int) {
		buildFilePath := filepath.Join(dir, "BUILD")
		if err := os.WriteFile(buildFilePath, buildFileContent, 0666); err != nil {
			b.Fatal(err)
		}

		for i := range fileCount {
			filePath := filepath.Join(dir, fmt.Sprintf("f%d", i))
			if err := os.WriteFile(filePath, nil, 0666); err != nil {
				b.Fatal(err)
			}
		}

		if level < levelCount {
			for i := range subdirCount {
				subdir := filepath.Join(dir, fmt.Sprintf("d%d", i))
				if err := os.Mkdir(subdir, 0777); err != nil {
					b.Fatal(err)
				}
				createDir(subdir, level+1)
			}
		}
	}
	createDir(rootDir, 0)

	cexts := []config.Configurer{&Configurer{}}
	c := config.New()
	c.RepoRoot = rootDir
	c.RepoRoot = rootDir
	c.IndexLibraries = true
	fs := flag.NewFlagSet("gazelle", flag.ContinueOnError)
	for _, cext := range cexts {
		cext.RegisterFlags(fs, "update", c)
	}
	args := []string{rootDir}
	if err := fs.Parse(args); err != nil {
		b.Fatal(err)
	}
	for _, cext := range cexts {
		cext.CheckFlags(fs, c)
	}

	// Benchmark calling Walk with a trivial callback function.
	wf := func(dir, rel string, c *config.Config, update bool, f *rule.File, subdirs, regularFiles, genFiles []string) {
	}

	b.ResetTimer()
	for range b.N {
		Walk(c, nil, fs.Args(), VisitAllUpdateSubdirsMode, wf)
	}
}