Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

runfiles: remove deprecated api #3198

Merged
merged 1 commit into from
Jun 14, 2022
Merged

runfiles: remove deprecated api #3198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 1 addition & 98 deletions go/tools/bazel/bazel_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"testing"
)
Expand Down Expand Up @@ -96,7 +95,7 @@ func TestRunfilesPath(t *testing.T) {
}

func TestNewTmpDir(t *testing.T) {
//prefix := "new/temp/dir"
// prefix := "new/temp/dir"
prefix := "demodir"
tmpdir, err := NewTmpDir(prefix)
if err != nil {
Expand Down Expand Up @@ -127,101 +126,6 @@ func TestTestWorkspace(t *testing.T) {
}
}

func TestFindRunfiles(t *testing.T) {
testData := []struct {
name string

pathsToCreate []string
wantRunfiles string
wantOk bool
}{
{
"NoFiles",
[]string{},
"",
false,
},
{
"CurrentDirectory",
[]string{
"data-file",
},
".",
true,
},
{
"BazelBinNoConfigurationInPath",
[]string{
"bazel-bin/some/package/bin.runfiles/project/",
"bazel-bin/some/package/bin.runfiles/project/data-file",
"data-file", // bazel-bin should be preferred.
},
"bazel-bin/some/package/bin.runfiles/project",
true,
},
{
"BazelBinConfigurationInPath",
[]string{
"bazel-bin/some/package/amd64/bin.runfiles/project/",
"bazel-bin/some/package/arm64/bin.runfiles/project/",
"bazel-bin/some/package/arm64/bin.runfiles/project/data-file",
"bazel-bin/some/package/powerpc/bin.runfiles/project/",
"data-file", // bazel-bin should be preferred.
},
"bazel-bin/some/package/arm64/bin.runfiles/project",
true,
},
}
for _, d := range testData {
t.Run(d.name, func(t *testing.T) {
cleanup, err := makeAndEnterTempdir()
if err != nil {
t.Fatal(err)
}
defer cleanup()

if err := createPaths(d.pathsToCreate); err != nil {
t.Fatal(err)
}

runfiles, ok := findRunfiles("project", "some/package", "bin", "data-file")
if filepath.Clean(runfiles) != filepath.Clean(d.wantRunfiles) || ok != d.wantOk {
t.Errorf("Got %s, %v; want %s, %v", runfiles, ok, d.wantRunfiles, d.wantOk)
}
})
}
}

func TestEnterRunfiles(t *testing.T) {
cleanup, err := makeAndEnterTempdir()
if err != nil {
t.Fatal(err)
}
defer cleanup()

pathsToCreate := []string{
"bazel-bin/some/package/bin.runfiles/project/",
"bazel-bin/some/package/bin.runfiles/project/data-file",
}
if err := createPaths(pathsToCreate); err != nil {
t.Fatal(err)
}

if err := EnterRunfiles("project", "some/package", "bin", "data-file"); err != nil {
t.Fatalf("Cannot enter runfiles tree: %v", err)
}
// The cleanup routine returned by makeAndEnterTempdir restores the working directory from
// the beginning of the test, so we don't have to worry about it here.

if _, err := os.Lstat("data-file"); err != nil {
wd, err := os.Getwd()
if err != nil {
t.Errorf("failed to get current working directory: %v", err)
}
t.Errorf("data-file not found in current directory (%s); entered invalid runfiles tree?", wd)
}
}

func TestPythonManifest(t *testing.T) {
cleanup, err := makeAndEnterTempdir()
if err != nil {
Expand Down Expand Up @@ -263,7 +167,6 @@ func TestPythonManifest(t *testing.T) {
if entry.Workspace != "__main__" {
t.Errorf("incorrect workspace for runfile. Expected: %s, actual %s", "__main__", entry.Workspace)
}

}

func TestSpliceDelimitedOSArgs(t *testing.T) {
Expand Down
62 changes: 4 additions & 58 deletions go/tools/bazel/runfiles.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func Runfile(path string) (string, error) {
return path, nil
}
}
}
}

// Search the main workspace.
if runfiles.workspace != "" {
Expand Down Expand Up @@ -262,26 +262,6 @@ func RunfilesPath() (string, error) {
return filepath.Join(runfiles.dir, runfiles.workspace), nil
}

// EnterRunfiles locates the directory under which a built binary can find its data dependencies
// using relative paths, and enters that directory.
//
// "workspace" indicates the name of the current project, "pkg" indicates the relative path to the
// build package that contains the binary target, "binary" indicates the basename of the binary
// searched for, and "cookie" indicates an arbitrary data file that we expect to find within the
// runfiles tree.
//
// DEPRECATED: use RunfilesPath instead.
func EnterRunfiles(workspace string, pkg string, binary string, cookie string) error {
runfiles, ok := findRunfiles(workspace, pkg, binary, cookie)
if !ok {
return fmt.Errorf("cannot find runfiles tree")
}
if err := os.Chdir(runfiles); err != nil {
return fmt.Errorf("cannot enter runfiles tree: %v", err)
}
return nil
}

var runfiles = struct {
once, listOnce sync.Once

Expand All @@ -308,13 +288,13 @@ var runfiles = struct {
}{}

type index struct {
indexWithWorkspace map[indexKey]*RunfileEntry
indexWithWorkspace map[indexKey]*RunfileEntry
indexIgnoringWorksapce map[string]*RunfileEntry
}

func newIndex() index {
return index {
indexWithWorkspace: make(map[indexKey]*RunfileEntry),
return index{
indexWithWorkspace: make(map[indexKey]*RunfileEntry),
indexIgnoringWorksapce: make(map[string]*RunfileEntry),
}
}
Expand Down Expand Up @@ -456,37 +436,3 @@ func initRunfiles() {
sort.Strings(runfiles.workspaces)
}
}

// getCandidates returns the list of all possible "prefix/suffix" paths where there might be an
// optional component in-between the two pieces.
//
// This function exists to cope with issues #1239 because we cannot tell where the built Go
// binaries are located upfront.
//
// DEPRECATED: only used by EnterRunfiles.
func getCandidates(prefix string, suffix string) []string {
candidates := []string{filepath.Join(prefix, suffix)}
if entries, err := ioutil.ReadDir(prefix); err == nil {
for _, entry := range entries {
candidate := filepath.Join(prefix, entry.Name(), suffix)
candidates = append(candidates, candidate)
}
}
return candidates
}

// findRunfiles locates the directory under which a built binary can find its data dependencies
// using relative paths.
//
// DEPRECATED: only used by EnterRunfiles.
func findRunfiles(workspace string, pkg string, binary string, cookie string) (string, bool) {
candidates := getCandidates(filepath.Join("bazel-bin", pkg), filepath.Join(binary+".runfiles", workspace))
candidates = append(candidates, ".")

for _, candidate := range candidates {
if _, err := os.Stat(filepath.Join(candidate, cookie)); err == nil {
return candidate, true
}
}
return "", false
}