• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2017 The Bazel Authors. All rights reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#    http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15"""Unit tests for paths.bzl."""
16
17load("//lib:paths.bzl", "paths")
18load("//lib:unittest.bzl", "asserts", "unittest")
19
20def _basename_test(ctx):
21    """Unit tests for paths.basename."""
22    env = unittest.begin(ctx)
23
24    # Verify some degenerate cases.
25    asserts.equals(env, "", paths.basename(""))
26    asserts.equals(env, "", paths.basename("/"))
27    asserts.equals(env, "bar", paths.basename("foo///bar"))
28
29    # Verify some realistic cases.
30    asserts.equals(env, "foo", paths.basename("foo"))
31    asserts.equals(env, "foo", paths.basename("/foo"))
32    asserts.equals(env, "foo", paths.basename("bar/foo"))
33    asserts.equals(env, "foo", paths.basename("/bar/foo"))
34
35    # Verify that we correctly duplicate Python's os.path.basename behavior,
36    # where a trailing slash means the basename is empty.
37    asserts.equals(env, "", paths.basename("foo/"))
38    asserts.equals(env, "", paths.basename("/foo/"))
39
40    return unittest.end(env)
41
42basename_test = unittest.make(_basename_test)
43
44def _dirname_test(ctx):
45    """Unit tests for paths.dirname."""
46    env = unittest.begin(ctx)
47
48    # Verify some degenerate cases.
49    asserts.equals(env, "", paths.dirname(""))
50    asserts.equals(env, "/", paths.dirname("/"))
51    asserts.equals(env, "foo", paths.dirname("foo///bar"))
52
53    # Verify some realistic cases.
54    asserts.equals(env, "", paths.dirname("foo"))
55    asserts.equals(env, "/", paths.dirname("/foo"))
56    asserts.equals(env, "bar", paths.dirname("bar/foo"))
57    asserts.equals(env, "/bar", paths.dirname("/bar/foo"))
58
59    # Verify that we correctly duplicate Python's os.path.dirname behavior,
60    # where a trailing slash means the dirname is the same as the original
61    # path (without the trailing slash).
62    asserts.equals(env, "foo", paths.dirname("foo/"))
63    asserts.equals(env, "/foo", paths.dirname("/foo/"))
64
65    return unittest.end(env)
66
67dirname_test = unittest.make(_dirname_test)
68
69def _is_absolute_test(ctx):
70    """Unit tests for paths.is_absolute."""
71    env = unittest.begin(ctx)
72
73    # Try a degenerate case.
74    asserts.false(env, paths.is_absolute(""))
75
76    # Try some relative paths.
77    asserts.false(env, paths.is_absolute("foo"))
78    asserts.false(env, paths.is_absolute("foo/"))
79    asserts.false(env, paths.is_absolute("foo/bar"))
80
81    # Try some Linux absolute paths.
82    asserts.true(env, paths.is_absolute("/"))
83    asserts.true(env, paths.is_absolute("/foo"))
84    asserts.true(env, paths.is_absolute("/foo/"))
85    asserts.true(env, paths.is_absolute("/foo/bar"))
86
87    # Try some Windows absolute paths.
88    asserts.true(env, paths.is_absolute("D:\\"))
89    asserts.true(env, paths.is_absolute("C:\\"))
90    asserts.true(env, paths.is_absolute("C:\\foo"))
91    asserts.true(env, paths.is_absolute("C:\\foo\\bar"))
92
93    return unittest.end(env)
94
95is_absolute_test = unittest.make(_is_absolute_test)
96
97def _join_test(ctx):
98    """Unit tests for paths.join."""
99    env = unittest.begin(ctx)
100
101    # Try a degenerate case.
102    asserts.equals(env, "", paths.join(""))
103
104    # Try some basic paths.
105    asserts.equals(env, "foo", paths.join("foo"))
106    asserts.equals(env, "foo/bar", paths.join("foo", "bar"))
107    asserts.equals(env, "foo/bar/baz", paths.join("foo", "bar", "baz"))
108
109    # Make sure an initially absolute path stays absolute.
110    asserts.equals(env, "/foo", paths.join("/foo"))
111    asserts.equals(env, "/foo/bar", paths.join("/foo", "bar"))
112
113    # Make sure an absolute path later in the list resets the result.
114    asserts.equals(env, "/baz", paths.join("foo", "bar", "/baz"))
115    asserts.equals(env, "/baz", paths.join("foo", "/bar", "/baz"))
116    asserts.equals(env, "/bar/baz", paths.join("foo", "/bar", "baz"))
117    asserts.equals(env, "/bar", paths.join("/foo", "/bar"))
118
119    # Make sure a leading empty segment doesn't make it absolute.
120    asserts.equals(env, "foo", paths.join("", "foo"))
121
122    # Try some trailing slash scenarios.
123    asserts.equals(env, "foo/", paths.join("foo", ""))
124    asserts.equals(env, "foo/", paths.join("foo/"))
125    asserts.equals(env, "foo/", paths.join("foo/", ""))
126    asserts.equals(env, "foo//", paths.join("foo//", ""))
127    asserts.equals(env, "foo//", paths.join("foo//"))
128    asserts.equals(env, "foo/bar/baz/", paths.join("foo/", "bar/", "baz", ""))
129    asserts.equals(env, "foo/bar/baz/", paths.join("foo/", "bar/", "baz/"))
130    asserts.equals(env, "foo/bar/baz/", paths.join("foo/", "bar/", "baz/", ""))
131
132    # Make sure that adjacent empty segments don't add extra path separators.
133    asserts.equals(env, "foo/", paths.join("foo", "", ""))
134    asserts.equals(env, "foo", paths.join("", "", "foo"))
135    asserts.equals(env, "foo/bar", paths.join("foo", "", "", "bar"))
136
137    return unittest.end(env)
138
139join_test = unittest.make(_join_test)
140
141def _normalize_test(ctx):
142    """Unit tests for paths.normalize."""
143    env = unittest.begin(ctx)
144
145    # Try the most basic case.
146    asserts.equals(env, ".", paths.normalize(""))
147
148    # Try some basic adjacent-slash removal.
149    asserts.equals(env, "foo/bar", paths.normalize("foo//bar"))
150    asserts.equals(env, "foo/bar", paths.normalize("foo////bar"))
151
152    # Try some "." removal.
153    asserts.equals(env, "foo/bar", paths.normalize("foo/./bar"))
154    asserts.equals(env, "foo/bar", paths.normalize("./foo/bar"))
155    asserts.equals(env, "foo/bar", paths.normalize("foo/bar/."))
156    asserts.equals(env, "/", paths.normalize("/."))
157
158    # Try some ".." removal.
159    asserts.equals(env, "bar", paths.normalize("foo/../bar"))
160    asserts.equals(env, "foo", paths.normalize("foo/bar/.."))
161    asserts.equals(env, ".", paths.normalize("foo/.."))
162    asserts.equals(env, ".", paths.normalize("foo/bar/../.."))
163    asserts.equals(env, "..", paths.normalize("foo/../.."))
164    asserts.equals(env, "/", paths.normalize("/foo/../.."))
165    asserts.equals(env, "../../c", paths.normalize("a/b/../../../../c/d/.."))
166
167    # Make sure one or two initial slashes are preserved, but three or more are
168    # collapsed to a single slash.
169    asserts.equals(env, "/foo", paths.normalize("/foo"))
170    asserts.equals(env, "//foo", paths.normalize("//foo"))
171    asserts.equals(env, "/foo", paths.normalize("///foo"))
172
173    # Trailing slashes should be removed unless the entire path is a trailing
174    # slash.
175    asserts.equals(env, "/", paths.normalize("/"))
176    asserts.equals(env, "foo", paths.normalize("foo/"))
177    asserts.equals(env, "foo/bar", paths.normalize("foo/bar/"))
178
179    return unittest.end(env)
180
181normalize_test = unittest.make(_normalize_test)
182
183def _relativize_test(ctx):
184    """Unit tests for paths.relativize."""
185    env = unittest.begin(ctx)
186
187    # Make sure that relative-to-current-directory works in all forms.
188    asserts.equals(env, "foo", paths.relativize("foo", ""))
189    asserts.equals(env, "foo", paths.relativize("foo", "."))
190
191    # Try some regular cases.
192    asserts.equals(env, "bar", paths.relativize("foo/bar", "foo"))
193    asserts.equals(env, "baz", paths.relativize("foo/bar/baz", "foo/bar"))
194    asserts.equals(env, "bar/baz", paths.relativize("foo/bar/baz", "foo"))
195
196    # Try a case where a parent directory is normalized away.
197    asserts.equals(env, "baz", paths.relativize("foo/bar/../baz", "foo"))
198
199    # Relative paths work, as long as they share a common start.
200    asserts.equals(env, "file", paths.relativize("../foo/bar/baz/file", "../foo/bar/baz"))
201    asserts.equals(env, "baz/file", paths.relativize("../foo/bar/baz/file", "../foo/bar"))
202
203    # TODO(allevato): Test failure cases, once that is possible.
204
205    return unittest.end(env)
206
207relativize_test = unittest.make(_relativize_test)
208
209def _replace_extension_test(ctx):
210    """Unit tests for paths.replace_extension."""
211    env = unittest.begin(ctx)
212
213    # Try some degenerate cases.
214    asserts.equals(env, ".foo", paths.replace_extension("", ".foo"))
215    asserts.equals(env, "/.foo", paths.replace_extension("/", ".foo"))
216    asserts.equals(env, "foo.bar", paths.replace_extension("foo", ".bar"))
217
218    # Try a directory with an extension and basename that doesn't have one.
219    asserts.equals(
220        env,
221        "foo.bar/baz.quux",
222        paths.replace_extension("foo.bar/baz", ".quux"),
223    )
224
225    # Now try some things with legit extensions.
226    asserts.equals(env, "a.z", paths.replace_extension("a.b", ".z"))
227    asserts.equals(env, "a.b.z", paths.replace_extension("a.b.c", ".z"))
228    asserts.equals(env, "a/b.z", paths.replace_extension("a/b.c", ".z"))
229    asserts.equals(env, "a.b/c.z", paths.replace_extension("a.b/c.d", ".z"))
230    asserts.equals(env, ".a/b.z", paths.replace_extension(".a/b.c", ".z"))
231    asserts.equals(env, ".a.z", paths.replace_extension(".a.b", ".z"))
232
233    # Verify that we don't insert a period on the extension if none is provided.
234    asserts.equals(env, "foobaz", paths.replace_extension("foo.bar", "baz"))
235
236    return unittest.end(env)
237
238replace_extension_test = unittest.make(_replace_extension_test)
239
240def _split_extension_test(ctx):
241    """Unit tests for paths.split_extension."""
242    env = unittest.begin(ctx)
243
244    # Try some degenerate cases.
245    asserts.equals(env, ("", ""), paths.split_extension(""))
246    asserts.equals(env, ("/", ""), paths.split_extension("/"))
247    asserts.equals(env, ("foo", ""), paths.split_extension("foo"))
248
249    # Try some paths whose basenames start with ".".
250    asserts.equals(env, (".", ""), paths.split_extension("."))
251    asserts.equals(env, (".bashrc", ""), paths.split_extension(".bashrc"))
252    asserts.equals(env, ("foo/.bashrc", ""), paths.split_extension("foo/.bashrc"))
253    asserts.equals(
254        env,
255        (".foo/.bashrc", ""),
256        paths.split_extension(".foo/.bashrc"),
257    )
258
259    # Try some directories with extensions with basenames that don't have one.
260    asserts.equals(env, ("foo.bar/baz", ""), paths.split_extension("foo.bar/baz"))
261    asserts.equals(
262        env,
263        ("foo.bar/.bashrc", ""),
264        paths.split_extension("foo.bar/.bashrc"),
265    )
266
267    # Now try some things that will actually get split.
268    asserts.equals(env, ("a", ".b"), paths.split_extension("a.b"))
269    asserts.equals(env, ("a.b", ".c"), paths.split_extension("a.b.c"))
270    asserts.equals(env, ("a/b", ".c"), paths.split_extension("a/b.c"))
271    asserts.equals(env, ("a.b/c", ".d"), paths.split_extension("a.b/c.d"))
272    asserts.equals(env, (".a/b", ".c"), paths.split_extension(".a/b.c"))
273    asserts.equals(env, (".a", ".b"), paths.split_extension(".a.b"))
274
275    return unittest.end(env)
276
277split_extension_test = unittest.make(_split_extension_test)
278
279def paths_test_suite():
280    """Creates the test targets and test suite for paths.bzl tests."""
281    unittest.suite(
282        "paths_tests",
283        basename_test,
284        dirname_test,
285        is_absolute_test,
286        join_test,
287        normalize_test,
288        relativize_test,
289        replace_extension_test,
290        split_extension_test,
291    )
292