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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
# pylint: disable=g-bad-file-header
# 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.
import os
import tempfile
import unittest
from tools.python.runfiles import runfiles
class RunfilesTest(unittest.TestCase):
# """Unit tests for `runfiles.Runfiles`."""
def testRlocationArgumentValidation(self):
r = runfiles.Create({"RUNFILES_DIR": "whatever"})
self.assertRaises(ValueError, lambda: r.Rlocation(None))
self.assertRaises(ValueError, lambda: r.Rlocation(""))
self.assertRaises(TypeError, lambda: r.Rlocation(1))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("../foo"))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("foo/.."))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("foo/../bar"))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("./foo"))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("foo/."))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("foo/./bar"))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("//foobar"))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("foo//"))
self.assertRaisesRegexp(ValueError, "is not normalized",
lambda: r.Rlocation("foo//bar"))
self.assertRaisesRegexp(ValueError, "is absolute without a drive letter",
lambda: r.Rlocation("\\foo"))
def testCreatesManifestBasedRunfiles(self):
with _MockFile(contents=["a/b c/d"]) as mf:
r = runfiles.Create({
"RUNFILES_MANIFEST_FILE": mf.Path(),
"RUNFILES_DIR": "ignored when RUNFILES_MANIFEST_FILE has a value",
"TEST_SRCDIR": "always ignored",
})
self.assertEqual(r.Rlocation("a/b"), "c/d")
self.assertIsNone(r.Rlocation("foo"))
def testManifestBasedRunfilesEnvVars(self):
with _MockFile(name="MANIFEST") as mf:
r = runfiles.Create({
"RUNFILES_MANIFEST_FILE": mf.Path(),
"TEST_SRCDIR": "always ignored",
})
self.assertDictEqual(
r.EnvVars(), {
"RUNFILES_MANIFEST_FILE": mf.Path(),
"RUNFILES_DIR": mf.Path()[:-len("/MANIFEST")],
"JAVA_RUNFILES": mf.Path()[:-len("/MANIFEST")],
})
with _MockFile(name="foo.runfiles_manifest") as mf:
r = runfiles.Create({
"RUNFILES_MANIFEST_FILE": mf.Path(),
"TEST_SRCDIR": "always ignored",
})
self.assertDictEqual(
r.EnvVars(), {
"RUNFILES_MANIFEST_FILE":
mf.Path(),
"RUNFILES_DIR": (
mf.Path()[:-len("foo.runfiles_manifest")] + "foo.runfiles"),
"JAVA_RUNFILES": (
mf.Path()[:-len("foo.runfiles_manifest")] + "foo.runfiles"),
})
with _MockFile(name="x_manifest") as mf:
r = runfiles.Create({
"RUNFILES_MANIFEST_FILE": mf.Path(),
"TEST_SRCDIR": "always ignored",
})
self.assertDictEqual(
r.EnvVars(), {
"RUNFILES_MANIFEST_FILE": mf.Path(),
"RUNFILES_DIR": "",
"JAVA_RUNFILES": "",
})
def testCreatesDirectoryBasedRunfiles(self):
r = runfiles.Create({
"RUNFILES_DIR": "runfiles/dir",
"TEST_SRCDIR": "always ignored",
})
self.assertEqual(r.Rlocation("a/b"), "runfiles/dir/a/b")
self.assertEqual(r.Rlocation("foo"), "runfiles/dir/foo")
def testDirectoryBasedRunfilesEnvVars(self):
r = runfiles.Create({
"RUNFILES_DIR": "runfiles/dir",
"TEST_SRCDIR": "always ignored",
})
self.assertDictEqual(r.EnvVars(), {
"RUNFILES_DIR": "runfiles/dir",
"JAVA_RUNFILES": "runfiles/dir",
})
def testFailsToCreateManifestBasedBecauseManifestDoesNotExist(self):
def _Run():
runfiles.Create({"RUNFILES_MANIFEST_FILE": "non-existing path"})
self.assertRaisesRegexp(IOError, "non-existing path", _Run)
def testFailsToCreateAnyRunfilesBecauseEnvvarsAreNotDefined(self):
with _MockFile(contents=["a b"]) as mf:
runfiles.Create({
"RUNFILES_MANIFEST_FILE": mf.Path(),
"RUNFILES_DIR": "whatever",
"TEST_SRCDIR": "always ignored",
})
runfiles.Create({
"RUNFILES_DIR": "whatever",
"TEST_SRCDIR": "always ignored",
})
self.assertIsNone(runfiles.Create({"TEST_SRCDIR": "always ignored"}))
self.assertIsNone(runfiles.Create({"FOO": "bar"}))
def testManifestBasedRlocation(self):
with _MockFile(contents=[
"Foo/runfile1", "Foo/runfile2 C:/Actual Path\\runfile2",
"Foo/Bar/runfile3 D:\\the path\\run file 3.txt"
]) as mf:
r = runfiles.CreateManifestBased(mf.Path())
self.assertEqual(r.Rlocation("Foo/runfile1"), "Foo/runfile1")
self.assertEqual(r.Rlocation("Foo/runfile2"), "C:/Actual Path\\runfile2")
self.assertEqual(
r.Rlocation("Foo/Bar/runfile3"), "D:\\the path\\run file 3.txt")
self.assertIsNone(r.Rlocation("unknown"))
if RunfilesTest.IsWindows():
self.assertEqual(r.Rlocation("c:/foo"), "c:/foo")
self.assertEqual(r.Rlocation("c:\\foo"), "c:\\foo")
else:
self.assertEqual(r.Rlocation("/foo"), "/foo")
def testDirectoryBasedRlocation(self):
# The _DirectoryBased strategy simply joins the runfiles directory and the
# runfile's path on a "/". This strategy does not perform any normalization,
# nor does it check that the path exists.
r = runfiles.CreateDirectoryBased("foo/bar baz//qux/")
self.assertEqual(r.Rlocation("arg"), "foo/bar baz//qux/arg")
if RunfilesTest.IsWindows():
self.assertEqual(r.Rlocation("c:/foo"), "c:/foo")
self.assertEqual(r.Rlocation("c:\\foo"), "c:\\foo")
else:
self.assertEqual(r.Rlocation("/foo"), "/foo")
def testPathsFromEnvvars(self):
# Both envvars have a valid value.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "mock1/MANIFEST",
lambda path: path == "mock2")
self.assertEqual(mf, "mock1/MANIFEST")
self.assertEqual(dr, "mock2")
# RUNFILES_MANIFEST_FILE is invalid but RUNFILES_DIR is good and there's a
# runfiles manifest in the runfiles directory.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "mock2/MANIFEST",
lambda path: path == "mock2")
self.assertEqual(mf, "mock2/MANIFEST")
self.assertEqual(dr, "mock2")
# RUNFILES_MANIFEST_FILE is invalid but RUNFILES_DIR is good, but there's no
# runfiles manifest in the runfiles directory.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: False,
lambda path: path == "mock2")
self.assertEqual(mf, "")
self.assertEqual(dr, "mock2")
# RUNFILES_DIR is invalid but RUNFILES_MANIFEST_FILE is good, and it is in
# a valid-looking runfiles directory.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "mock1/MANIFEST",
lambda path: path == "mock1")
self.assertEqual(mf, "mock1/MANIFEST")
self.assertEqual(dr, "mock1")
# RUNFILES_DIR is invalid but RUNFILES_MANIFEST_FILE is good, but it is not
# in any valid-looking runfiles directory.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "mock1/MANIFEST",
lambda path: False)
self.assertEqual(mf, "mock1/MANIFEST")
self.assertEqual(dr, "")
# Both envvars are invalid, but there's a manifest in a runfiles directory
# next to argv0, however there's no other content in the runfiles directory.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "argv0.runfiles/MANIFEST",
lambda path: False)
self.assertEqual(mf, "argv0.runfiles/MANIFEST")
self.assertEqual(dr, "")
# Both envvars are invalid, but there's a manifest next to argv0. There's
# no runfiles tree anywhere.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "argv0.runfiles_manifest",
lambda path: False)
self.assertEqual(mf, "argv0.runfiles_manifest")
self.assertEqual(dr, "")
# Both envvars are invalid, but there's a valid manifest next to argv0, and
# a valid runfiles directory (without a manifest in it).
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "argv0.runfiles_manifest",
lambda path: path == "argv0.runfiles")
self.assertEqual(mf, "argv0.runfiles_manifest")
self.assertEqual(dr, "argv0.runfiles")
# Both envvars are invalid, but there's a valid runfiles directory next to
# argv0, though no manifest in it.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: False,
lambda path: path == "argv0.runfiles")
self.assertEqual(mf, "")
self.assertEqual(dr, "argv0.runfiles")
# Both envvars are invalid, but there's a valid runfiles directory next to
# argv0 with a valid manifest in it.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: path == "argv0.runfiles/MANIFEST",
lambda path: path == "argv0.runfiles")
self.assertEqual(mf, "argv0.runfiles/MANIFEST")
self.assertEqual(dr, "argv0.runfiles")
# Both envvars are invalid and there's no runfiles directory or manifest
# next to the argv0.
mf, dr = runfiles._PathsFrom("argv0", "mock1/MANIFEST", "mock2",
lambda path: False, lambda path: False)
self.assertEqual(mf, "")
self.assertEqual(dr, "")
@staticmethod
def IsWindows():
return os.name == "nt"
class _MockFile(object):
def __init__(self, name=None, contents=None):
self._contents = contents or []
self._name = name or "x"
self._path = None
def __enter__(self):
tmpdir = os.environ.get("TEST_TMPDIR")
self._path = os.path.join(tempfile.mkdtemp(dir=tmpdir), self._name)
with open(self._path, "wt") as f:
f.writelines(l + "\n" for l in self._contents)
return self
def __exit__(self, exc_type, exc_value, traceback):
os.remove(self._path)
os.rmdir(os.path.dirname(self._path))
def Path(self):
return self._path
if __name__ == "__main__":
unittest.main()
|
