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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
import contextlib
import os
import sys
import textwrap
import traceback
import unittest
import mozpack.path as mozpath
from mozunit import MockedOpen, main
from mozbuild.configure import ConfigureError
from mozbuild.configure.lint import LintSandbox
test_data_path = mozpath.abspath(mozpath.dirname(__file__))
test_data_path = mozpath.join(test_data_path, "data")
class TestLint(unittest.TestCase):
def lint_test(self, options=[], env={}):
sandbox = LintSandbox(env, ["configure"] + options)
sandbox.run(mozpath.join(test_data_path, "moz.configure"))
def moz_configure(self, source):
return MockedOpen(
{os.path.join(test_data_path, "moz.configure"): textwrap.dedent(source)}
)
@contextlib.contextmanager
def assertRaisesFromLine(self, exc_type, line):
with self.assertRaises(exc_type) as e:
yield e
_, _, tb = sys.exc_info()
self.assertEqual(
traceback.extract_tb(tb)[-1][:2],
(mozpath.join(test_data_path, "moz.configure"), line),
)
def test_configure_testcase(self):
# Lint python/mozbuild/mozbuild/test/configure/data/moz.configure
self.lint_test()
def test_depends_failures(self):
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
def foo(value):
return value
@depends('--help', foo)
@imports('os')
def bar(help, foo):
return foo
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 7) as e:
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
def foo(value):
return value
@depends('--help', foo)
def bar(help, foo):
return foo
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "The dependency on `--help` is unused")
with self.assertRaisesFromLine(ConfigureError, 3) as e:
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
@imports('os')
def foo(value):
return value
@depends('--help', foo)
@imports('os')
def bar(help, foo):
return foo
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
"Missing '--help' dependency because `bar` depends on '--help' and `foo`",
)
with self.assertRaisesFromLine(ConfigureError, 7) as e:
with self.moz_configure(
"""
@template
def tmpl():
qux = 42
option('--foo', help='foo')
@depends('--foo')
def foo(value):
qux
return value
@depends('--help', foo)
@imports('os')
def bar(help, foo):
return foo
tmpl()
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
"Missing '--help' dependency because `bar` depends on '--help' and `foo`",
)
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
def foo(value):
return value
include(foo)
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 3) as e:
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
@imports('os')
def foo(value):
return value
include(foo)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "Missing '--help' dependency")
with self.assertRaisesFromLine(ConfigureError, 3) as e:
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
@imports('os')
def foo(value):
return value
@depends(foo)
def bar(value):
return value
include(bar)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "Missing '--help' dependency")
with self.assertRaisesFromLine(ConfigureError, 3) as e:
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
@imports('os')
def foo(value):
return value
option('--bar', help='bar', when=foo)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "Missing '--help' dependency")
# This would have failed with "Missing '--help' dependency"
# in the past, because of the reference to the builtin False.
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
def foo(value):
return False or value
option('--bar', help='bar', when=foo)
"""
):
self.lint_test()
# However, when something that is normally a builtin is overridden,
# we should still want the dependency on --help.
with self.assertRaisesFromLine(ConfigureError, 7) as e:
with self.moz_configure(
"""
@template
def tmpl():
sorted = 42
option('--foo', help='foo')
@depends('--foo')
def foo(value):
return sorted
option('--bar', help='bar', when=foo)
tmpl()
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "Missing '--help' dependency")
# There is a default restricted `os` module when there is no explicit
# @imports, and it's fine to use it without a dependency on --help.
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
def foo(value):
os
return value
include(foo)
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 3) as e:
with self.moz_configure(
"""
option('--foo', help='foo')
@depends('--foo')
def foo(value):
return
include(foo)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "The dependency on `--foo` is unused")
with self.assertRaisesFromLine(ConfigureError, 5) as e:
with self.moz_configure(
"""
@depends(when=True)
def bar():
return
@depends(bar)
def foo(value):
return
include(foo)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "The dependency on `bar` is unused")
with self.assertRaisesFromLine(ConfigureError, 2) as e:
with self.moz_configure(
"""
@depends(depends(when=True)(lambda: None))
def foo(value):
return
include(foo)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "The dependency on `<lambda>` is unused")
with self.assertRaisesFromLine(ConfigureError, 9) as e:
with self.moz_configure(
"""
@template
def tmpl():
@depends(when=True)
def bar():
return
return bar
qux = tmpl()
@depends(qux)
def foo(value):
return
include(foo)
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "The dependency on `qux` is unused")
def test_default_enable(self):
# --enable-* with default=True is not allowed.
with self.moz_configure(
"""
option('--enable-foo', default=False, help='foo')
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 2) as e:
with self.moz_configure(
"""
option('--enable-foo', default=True, help='foo')
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
"--disable-foo should be used instead of " "--enable-foo with default=True",
)
def test_default_disable(self):
# --disable-* with default=False is not allowed.
with self.moz_configure(
"""
option('--disable-foo', default=True, help='foo')
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 2) as e:
with self.moz_configure(
"""
option('--disable-foo', default=False, help='foo')
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
"--enable-foo should be used instead of "
"--disable-foo with default=False",
)
def test_default_with(self):
# --with-* with default=True is not allowed.
with self.moz_configure(
"""
option('--with-foo', default=False, help='foo')
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 2) as e:
with self.moz_configure(
"""
option('--with-foo', default=True, help='foo')
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
"--without-foo should be used instead of " "--with-foo with default=True",
)
def test_default_without(self):
# --without-* with default=False is not allowed.
with self.moz_configure(
"""
option('--without-foo', default=True, help='foo')
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 2) as e:
with self.moz_configure(
"""
option('--without-foo', default=False, help='foo')
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
"--with-foo should be used instead of " "--without-foo with default=False",
)
def test_default_func(self):
# Help text for an option with variable default should contain
# {enable|disable} rule.
with self.moz_configure(
"""
option(env='FOO', help='foo')
option('--enable-bar', default=depends('FOO')(lambda x: bool(x)),
help='{Enable|Disable} bar')
"""
):
self.lint_test()
with self.assertRaisesFromLine(ConfigureError, 3) as e:
with self.moz_configure(
"""
option(env='FOO', help='foo')
option('--enable-bar', default=depends('FOO')(lambda x: bool(x)),\
help='Enable bar')
"""
):
self.lint_test()
self.assertEqual(
str(e.exception),
'`help` should contain "{Enable|Disable}" because of '
"non-constant default",
)
def test_large_offset(self):
with self.assertRaisesFromLine(ConfigureError, 375):
with self.moz_configure(
"""
option(env='FOO', help='foo')
"""
+ "\n" * 371
+ """
option('--enable-bar', default=depends('FOO')(lambda x: bool(x)),\
help='Enable bar')
"""
):
self.lint_test()
def test_undefined_global(self):
with self.assertRaisesFromLine(NameError, 6) as e:
with self.moz_configure(
"""
option(env='FOO', help='foo')
@depends('FOO')
def foo(value):
if value:
return unknown
return value
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "global name 'unknown' is not defined")
# Ideally, this would raise on line 4, where `unknown` is used, but
# python disassembly doesn't give use the information.
with self.assertRaisesFromLine(NameError, 2) as e:
with self.moz_configure(
"""
@template
def tmpl():
@depends(unknown)
def foo(value):
if value:
return True
return foo
tmpl()
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "global name 'unknown' is not defined")
def test_unnecessary_imports(self):
with self.assertRaisesFromLine(NameError, 3) as e:
with self.moz_configure(
"""
option(env='FOO', help='foo')
@depends('FOO')
@imports(_from='__builtin__', _import='list')
def foo(value):
if value:
return list()
return value
"""
):
self.lint_test()
self.assertEqual(str(e.exception), "builtin 'list' doesn't need to be imported")
if __name__ == "__main__":
main()
|
