forked from bazelbuild/rules_go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
bazel.go
105 lines (90 loc) · 3.22 KB
/
bazel.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// Copyright 2017 Google Inc.
//
// 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 bazel provides utilities for interacting with the surrounding Bazel environment.
package bazel
import (
"fmt"
"io/ioutil"
"os"
"path/filepath"
)
const TEST_SRCDIR = "TEST_SRCDIR"
const TEST_TMPDIR = "TEST_TMPDIR"
const TEST_WORKSPACE = "TEST_WORKSPACE"
var defaultTestWorkspace = ""
// Runfile returns an absolute path to the specified file in the runfiles directory of the running target.
// It searches the current working directory, RunfilesPath() directory, and RunfilesPath()/TestWorkspace().
// Returns an error if unable to locate RunfilesPath() or if the file does not exist.
func Runfile(path string) (string, error) {
if _, err := os.Stat(path); err == nil {
// absolute path or found in current working directory
return path, nil
}
runfiles, err := RunfilesPath()
if err != nil {
return "", err
}
filename := filepath.Join(runfiles, path)
if _, err := os.Stat(filename); err == nil {
// found at RunfilesPath()/path
return filename, nil
}
workspace, err := TestWorkspace()
if err != nil {
return "", err
}
filename = filepath.Join(runfiles, workspace, path)
if _, err := os.Stat(filename); err == nil {
// found at RunfilesPath()/TestWorkspace()/path
return filename, nil
}
return "", fmt.Errorf("unable to find file %q", path)
}
// RunfilesPath return the path to the run files tree for this test.
// It returns an error if TEST_SRCDIR does not exist.
func RunfilesPath() (string, error) {
if src, ok := os.LookupEnv(TEST_SRCDIR); ok {
return src, nil
}
return "", fmt.Errorf("environment variable %q is not defined, are you running with bazel test", TEST_SRCDIR)
}
// NewTmpDir creates a new temporary directory in TestTmpDir().
func NewTmpDir(prefix string) (string, error) {
return ioutil.TempDir(TestTmpDir(), prefix)
}
// TestTmpDir returns the path the Bazel test temp directory.
// If TEST_TMPDIR is not defined, it returns the OS default temp dir.
func TestTmpDir() string {
if tmp, ok := os.LookupEnv(TEST_TMPDIR); ok {
return tmp
}
return os.TempDir()
}
// TestWorkspace returns the name of the Bazel workspace for this test.
// If TEST_WORKSPACE is not defined, it returns an error.
func TestWorkspace() (string, error) {
if ws, ok := os.LookupEnv(TEST_WORKSPACE); ok {
return ws, nil
}
if defaultTestWorkspace != "" {
return defaultTestWorkspace, nil
}
return "", fmt.Errorf("Unable to find environment variable TEST_WORKSPACE")
}
// SetDefaultTestWorkspace allows you to set a fake value for the
// environment variable TEST_WORKSPACE if it is not defined. This is useful
// when running tests on the command line and not through Bazel.
func SetDefaultTestWorkspace(w string) {
defaultTestWorkspace = w
}