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
|
import unittest
from StringIO import StringIO
from cuddlefish.manifest import scan_module
class Extra:
def failUnlessKeysAre(self, d, keys):
self.failUnlessEqual(sorted(d.keys()), sorted(keys))
class Require(unittest.TestCase, Extra):
def scan(self, text):
lines = StringIO(text).readlines()
requires, problems, locations = scan_module("fake.js", lines)
self.failUnlessEqual(problems, False)
return requires
def scan_locations(self, text):
lines = StringIO(text).readlines()
requires, problems, locations = scan_module("fake.js", lines)
self.failUnlessEqual(problems, False)
return requires, locations
def test_modules(self):
mod = """var foo = require('one');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one"])
mod = """var foo = require(\"one\");"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one"])
mod = """var foo=require( 'one' ) ; """
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one"])
mod = """var foo = require('o'+'ne'); // tricky, denied"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, [])
mod = """require('one').immediately.do().stuff();"""
requires, locations = self.scan_locations(mod)
self.failUnlessKeysAre(requires, ["one"])
self.failUnlessEqual(locations, {"one": 1})
# these forms are commented out, and thus ignored
mod = """// var foo = require('one');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, [])
mod = """/* var foo = require('one');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, [])
mod = """ * var foo = require('one');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, [])
mod = """ ' var foo = require('one');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one"])
mod = """ \" var foo = require('one');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one"])
# multiple requires
mod = """const foo = require('one');
const foo = require('two');"""
requires, locations = self.scan_locations(mod)
self.failUnlessKeysAre(requires, ["one", "two"])
self.failUnlessEqual(locations["one"], 1)
self.failUnlessEqual(locations["two"], 2)
mod = """const foo = require('repeated');
const bar = require('repeated');
const baz = require('repeated');"""
requires, locations = self.scan_locations(mod)
self.failUnlessKeysAre(requires, ["repeated"])
self.failUnlessEqual(locations["repeated"], 1) # first occurrence
mod = """const foo = require('one'); const foo = require('two');"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one", "two"])
# define calls
mod = """define('one', ['two', 'numbers/three'], function(t, th) {});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["two", "numbers/three"])
mod = """define(
['odd',
"numbers/four"], function() {});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["odd", "numbers/four"])
mod = """define(function(require, exports, module) {
var a = require("some/module/a"),
b = require('b/v1');
exports.a = a;
//This is a fakeout: require('bad');
/* And another var bad = require('bad2'); */
require('foo').goFoo();
});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["some/module/a", "b/v1", "foo"])
mod = """define (
"foo",
["bar"], function (bar) {
var me = require("me");
}
)"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["bar", "me"])
mod = """define(['se' + 'ven', 'eight', nine], function () {});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["eight"])
# async require calls
mod = """require(['one'], function(one) {var o = require("one");});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one"])
mod = """require([ 'one' ], function(one) {var t = require("two");});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["one", "two"])
mod = """require ( ['two', 'numbers/three'], function(t, th) {});"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["two", "numbers/three"])
mod = """require (
["bar", "fa" + 'ke' ], function (bar) {
var me = require("me");
// require("bad").doBad();
}
)"""
requires = self.scan(mod)
self.failUnlessKeysAre(requires, ["bar", "me"])
def scan2(text, fn="fake.js"):
stderr = StringIO()
lines = StringIO(text).readlines()
requires, problems, locations = scan_module(fn, lines, stderr)
stderr.seek(0)
return requires, problems, stderr.readlines()
class Chrome(unittest.TestCase, Extra):
def test_ignore_loader(self):
# we specifically ignore the two loader files
mod = """let {Cc,Ci} = require('chrome');"""
requires, problems, err = scan2(mod, "blah/cuddlefish.js")
self.failUnlessKeysAre(requires, ["chrome"])
self.failUnlessEqual(problems, False)
self.failUnlessEqual(err, [])
mod = """let {Cc,Ci} = require('chrome');"""
requires, problems, err = scan2(mod, "securable-module.js")
self.failUnlessKeysAre(requires, ["chrome"])
self.failUnlessEqual(problems, False)
self.failUnlessEqual(err, [])
def test_chrome(self):
mod = """let {Cc,Ci} = require('chrome');"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, ["chrome"])
self.failUnlessEqual(problems, False)
self.failUnlessEqual(err, [])
mod = """var foo = require('foo');
let {Cc,Ci} = require('chrome');"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, ["foo", "chrome"])
self.failUnlessEqual(problems, False)
self.failUnlessEqual(err, [])
mod = """let c = require('chrome');"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, ["chrome"])
self.failUnlessEqual(problems, False)
self.failUnlessEqual(err, [])
mod = """var foo = require('foo');
let c = require('chrome');"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, ["foo", "chrome"])
self.failUnlessEqual(problems, False)
self.failUnlessEqual(err, [])
def test_chrome_components(self):
# Bug 663541: tolerate "Components" if you're marked with
# require("chrome"), to avoid requiring module authors to rewrite a
# lot of code. Once bug 636145 is fixed, such code will break. To fix
# it, add {Components}=require("chrome"), but that won't work until
# after 636145 is fixed.
mod = """require("chrome");
var ios = Components.classes['@mozilla.org/network/io-service;1'];"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, ["chrome"])
self.failUnlessEqual((problems, err), (False, []))
def test_not_chrome(self):
# from bug 596595
mod = r'soughtLines: new RegExp("^\\s*(\\[[0-9 .]*\\])?\\s*\\(\\((EE|WW)\\)|.* [Cc]hipsets?: \\)|\\s*Backtrace")'
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, [])
self.failUnlessEqual((problems,err), (False, []))
def test_not_chrome2(self):
# from bug 655788
mod = r"var foo = 'some stuff Cr';"
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, [])
self.failUnlessEqual((problems,err), (False, []))
class BadChrome(unittest.TestCase, Extra):
def test_bad_alias(self):
# using Components.* gets you an error, with a message that teaches
# you the correct approach.
mod = """let Cc = Components.classes;
let Cu = Components.utils;
"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, [])
self.failUnlessEqual(problems, True)
self.failUnlessEqual(err[1], "The following lines from file fake.js:\n")
self.failUnlessEqual(err[2], " 1: let Cc = Components.classes;\n")
self.failUnlessEqual(err[3], " 2: let Cu = Components.utils;\n")
self.failUnlessEqual(err[4], "use 'Components' to access chrome authority. To do so, you need to add a\n")
self.failUnlessEqual(err[5], "line somewhat like the following:\n")
self.failUnlessEqual(err[7], ' const {Cc,Cu} = require("chrome");\n')
self.failUnlessEqual(err[9], "Then you can use 'Components' as well as any shortcuts to its properties\n")
def test_bad_misc(self):
# If it looks like you're using something that doesn't have an alias,
# the warning also suggests a better way.
mod = """if (Components.isSuccessCode(foo))
"""
requires, problems, err = scan2(mod)
self.failUnlessKeysAre(requires, [])
self.failUnlessEqual(problems, True)
self.failUnlessEqual(err[1], "The following lines from file fake.js:\n")
self.failUnlessEqual(err[2], " 1: if (Components.isSuccessCode(foo))\n")
self.failUnlessEqual(err[3], "use 'Components' to access chrome authority. To do so, you need to add a\n")
self.failUnlessEqual(err[4], "line somewhat like the following:\n")
self.failUnlessEqual(err[6], ' const {components} = require("chrome");\n')
self.failUnlessEqual(err[8], "Then you can use 'Components' as well as any shortcuts to its properties\n")
if __name__ == '__main__':
unittest.main()
|
