blob: 8d3ef1910b494f86812ccc55ce2883dbf91850ec [file] [log] [blame]
[email protected]2299dcf2012-11-15 19:56:241#!/usr/bin/env python
2# Copyright (c) 2012 The Chromium Authors. All rights reserved.
3# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
Daniel Cheng4dcdb6b2017-04-13 08:30:176import os.path
[email protected]99171a92014-06-03 08:44:477import subprocess
[email protected]2299dcf2012-11-15 19:56:248import unittest
9
10import PRESUBMIT
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:3911from PRESUBMIT_test_mocks import MockFile, MockAffectedFile
gayane3dff8c22014-12-04 17:09:5112from PRESUBMIT_test_mocks import MockInputApi, MockOutputApi
[email protected]2299dcf2012-11-15 19:56:2413
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:3914
[email protected]99171a92014-06-03 08:44:4715_TEST_DATA_DIR = 'base/test/data/presubmit'
16
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:3917
[email protected]b00342e7f2013-03-26 16:21:5418class VersionControlConflictsTest(unittest.TestCase):
[email protected]70ca77752012-11-20 03:45:0319 def testTypicalConflict(self):
20 lines = ['<<<<<<< HEAD',
21 ' base::ScopedTempDir temp_dir_;',
22 '=======',
23 ' ScopedTempDir temp_dir_;',
24 '>>>>>>> master']
25 errors = PRESUBMIT._CheckForVersionControlConflictsInFile(
26 MockInputApi(), MockFile('some/path/foo_platform.cc', lines))
27 self.assertEqual(3, len(errors))
28 self.assertTrue('1' in errors[0])
29 self.assertTrue('3' in errors[1])
30 self.assertTrue('5' in errors[2])
31
dbeam95c35a2f2015-06-02 01:40:2332 def testIgnoresReadmes(self):
33 lines = ['A First Level Header',
34 '====================',
35 '',
36 'A Second Level Header',
37 '---------------------']
38 errors = PRESUBMIT._CheckForVersionControlConflictsInFile(
39 MockInputApi(), MockFile('some/polymer/README.md', lines))
40 self.assertEqual(0, len(errors))
41
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:3942
mcasasb7440c282015-02-04 14:52:1943class UmaHistogramChangeMatchedOrNotTest(unittest.TestCase):
44 def testTypicalCorrectlyMatchedChange(self):
45 diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
Vaclav Brozekbdac817c2018-03-24 06:30:4746 diff_java = [
47 'RecordHistogram.recordBooleanHistogram("Bla.Foo.Dummy", true)']
mcasasb7440c282015-02-04 14:52:1948 diff_xml = ['<histogram name="Bla.Foo.Dummy"> </histogram>']
49 mock_input_api = MockInputApi()
50 mock_input_api.files = [
51 MockFile('some/path/foo.cc', diff_cc),
Vaclav Brozekbdac817c2018-03-24 06:30:4752 MockFile('some/path/foo.java', diff_java),
mcasasb7440c282015-02-04 14:52:1953 MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
54 ]
55 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
56 MockOutputApi())
57 self.assertEqual(0, len(warnings))
58
59 def testTypicalNotMatchedChange(self):
60 diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
Vaclav Brozekbdac817c2018-03-24 06:30:4761 diff_java = [
62 'RecordHistogram.recordBooleanHistogram("Bla.Foo.Dummy", true)']
mcasasb7440c282015-02-04 14:52:1963 mock_input_api = MockInputApi()
Vaclav Brozekbdac817c2018-03-24 06:30:4764 mock_input_api.files = [
65 MockFile('some/path/foo.cc', diff_cc),
66 MockFile('some/path/foo.java', diff_java),
67 ]
mcasasb7440c282015-02-04 14:52:1968 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
69 MockOutputApi())
70 self.assertEqual(1, len(warnings))
71 self.assertEqual('warning', warnings[0].type)
Vaclav Brozekbdac817c2018-03-24 06:30:4772 self.assertTrue('foo.cc' in warnings[0].items[0])
73 self.assertTrue('foo.java' in warnings[0].items[1])
mcasasb7440c282015-02-04 14:52:1974
75 def testTypicalNotMatchedChangeViaSuffixes(self):
76 diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
Vaclav Brozekbdac817c2018-03-24 06:30:4777 diff_java = [
78 'RecordHistogram.recordBooleanHistogram("Bla.Foo.Dummy", true)']
mcasasb7440c282015-02-04 14:52:1979 diff_xml = ['<histogram_suffixes name="SuperHistogram">',
80 ' <suffix name="Dummy"/>',
81 ' <affected-histogram name="Snafu.Dummy"/>',
82 '</histogram>']
83 mock_input_api = MockInputApi()
84 mock_input_api.files = [
85 MockFile('some/path/foo.cc', diff_cc),
Vaclav Brozekbdac817c2018-03-24 06:30:4786 MockFile('some/path/foo.java', diff_java),
mcasasb7440c282015-02-04 14:52:1987 MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
88 ]
89 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
90 MockOutputApi())
91 self.assertEqual(1, len(warnings))
92 self.assertEqual('warning', warnings[0].type)
Vaclav Brozekbdac817c2018-03-24 06:30:4793 self.assertTrue('foo.cc' in warnings[0].items[0])
94 self.assertTrue('foo.java' in warnings[0].items[1])
mcasasb7440c282015-02-04 14:52:1995
96 def testTypicalCorrectlyMatchedChangeViaSuffixes(self):
97 diff_cc = ['UMA_HISTOGRAM_BOOL("Bla.Foo.Dummy", true)']
Vaclav Brozekbdac817c2018-03-24 06:30:4798 diff_java = [
99 'RecordHistogram.recordBooleanHistogram("Bla.Foo.Dummy", true)']
mcasasb7440c282015-02-04 14:52:19100 diff_xml = ['<histogram_suffixes name="SuperHistogram">',
101 ' <suffix name="Dummy"/>',
102 ' <affected-histogram name="Bla.Foo"/>',
103 '</histogram>']
104 mock_input_api = MockInputApi()
105 mock_input_api.files = [
106 MockFile('some/path/foo.cc', diff_cc),
Vaclav Brozekbdac817c2018-03-24 06:30:47107 MockFile('some/path/foo.java', diff_java),
mcasasb7440c282015-02-04 14:52:19108 MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
109 ]
110 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
111 MockOutputApi())
112 self.assertEqual(0, len(warnings))
113
114 def testTypicalCorrectlyMatchedChangeViaSuffixesWithSeparator(self):
115 diff_cc = ['UMA_HISTOGRAM_BOOL("Snafu_Dummy", true)']
Vaclav Brozekbdac817c2018-03-24 06:30:47116 diff_java = ['RecordHistogram.recordBooleanHistogram("Snafu_Dummy", true)']
mcasasb7440c282015-02-04 14:52:19117 diff_xml = ['<histogram_suffixes name="SuperHistogram" separator="_">',
118 ' <suffix name="Dummy"/>',
119 ' <affected-histogram name="Snafu"/>',
120 '</histogram>']
121 mock_input_api = MockInputApi()
122 mock_input_api.files = [
123 MockFile('some/path/foo.cc', diff_cc),
Vaclav Brozekbdac817c2018-03-24 06:30:47124 MockFile('some/path/foo.java', diff_java),
mcasasb7440c282015-02-04 14:52:19125 MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
126 ]
127 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
128 MockOutputApi())
129 self.assertEqual(0, len(warnings))
[email protected]70ca77752012-11-20 03:45:03130
Makoto Shimazu3ad422cd2019-05-08 02:35:14131 def testCorrectlyMatchedChangeViaSuffixesWithLineWrapping(self):
132 diff_cc = [
133 'UMA_HISTOGRAM_BOOL("LongHistogramNameNeedsLineWrapping.Dummy", true)']
134 diff_java = ['RecordHistogram.recordBooleanHistogram(' +
135 '"LongHistogramNameNeedsLineWrapping.Dummy", true)']
136 diff_xml = ['<histogram_suffixes',
137 ' name="LongHistogramNameNeedsLineWrapping"',
138 ' separator=".">',
139 ' <suffix name="Dummy"/>',
140 ' <affected-histogram',
141 ' name="LongHistogramNameNeedsLineWrapping"/>',
142 '</histogram>']
143 mock_input_api = MockInputApi()
144 mock_input_api.files = [
145 MockFile('some/path/foo.cc', diff_cc),
146 MockFile('some/path/foo.java', diff_java),
147 MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
148 ]
149 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
150 MockOutputApi())
151 self.assertEqual(0, len(warnings))
152
Vaclav Brozek8a8e2e202018-03-23 22:01:06153 def testNameMatch(self):
154 # Check that the detected histogram name is "Dummy" and not, e.g.,
155 # "Dummy\", true); // The \"correct"
156 diff_cc = ['UMA_HISTOGRAM_BOOL("Dummy", true); // The "correct" histogram']
Vaclav Brozekbdac817c2018-03-24 06:30:47157 diff_java = [
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39158 'RecordHistogram.recordBooleanHistogram("Dummy", true);' +
159 ' // The "correct" histogram']
Vaclav Brozek8a8e2e202018-03-23 22:01:06160 diff_xml = ['<histogram name="Dummy"> </histogram>']
161 mock_input_api = MockInputApi()
162 mock_input_api.files = [
163 MockFile('some/path/foo.cc', diff_cc),
Vaclav Brozekbdac817c2018-03-24 06:30:47164 MockFile('some/path/foo.java', diff_java),
Vaclav Brozek8a8e2e202018-03-23 22:01:06165 MockFile('tools/metrics/histograms/histograms.xml', diff_xml),
166 ]
167 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
168 MockOutputApi())
169 self.assertEqual(0, len(warnings))
170
171 def testSimilarMacroNames(self):
Vaclav Brozekbdac817c2018-03-24 06:30:47172 diff_cc = ['PUMA_HISTOGRAM_COOL("Mountain Lion", 42)']
173 diff_java = [
174 'FakeRecordHistogram.recordFakeHistogram("Mountain Lion", 42)']
Vaclav Brozek8a8e2e202018-03-23 22:01:06175 mock_input_api = MockInputApi()
176 mock_input_api.files = [
177 MockFile('some/path/foo.cc', diff_cc),
Vaclav Brozekbdac817c2018-03-24 06:30:47178 MockFile('some/path/foo.java', diff_java),
Vaclav Brozek8a8e2e202018-03-23 22:01:06179 ]
180 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
181 MockOutputApi())
182 self.assertEqual(0, len(warnings))
183
Vaclav Brozek0e730cbd2018-03-24 06:18:17184 def testMultiLine(self):
185 diff_cc = ['UMA_HISTOGRAM_BOOLEAN(', ' "Multi.Line", true)']
186 diff_cc2 = ['UMA_HISTOGRAM_BOOLEAN(', ' "Multi.Line"', ' , true)']
Vaclav Brozekbdac817c2018-03-24 06:30:47187 diff_java = [
188 'RecordHistogram.recordBooleanHistogram(',
189 ' "Multi.Line", true);',
190 ]
Vaclav Brozek0e730cbd2018-03-24 06:18:17191 mock_input_api = MockInputApi()
192 mock_input_api.files = [
193 MockFile('some/path/foo.cc', diff_cc),
194 MockFile('some/path/foo2.cc', diff_cc2),
Vaclav Brozekbdac817c2018-03-24 06:30:47195 MockFile('some/path/foo.java', diff_java),
Vaclav Brozek0e730cbd2018-03-24 06:18:17196 ]
197 warnings = PRESUBMIT._CheckUmaHistogramChanges(mock_input_api,
198 MockOutputApi())
199 self.assertEqual(1, len(warnings))
200 self.assertEqual('warning', warnings[0].type)
201 self.assertTrue('foo.cc' in warnings[0].items[0])
202 self.assertTrue('foo2.cc' in warnings[0].items[1])
203
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39204
[email protected]b8079ae4a2012-12-05 19:56:49205class BadExtensionsTest(unittest.TestCase):
206 def testBadRejFile(self):
207 mock_input_api = MockInputApi()
208 mock_input_api.files = [
209 MockFile('some/path/foo.cc', ''),
210 MockFile('some/path/foo.cc.rej', ''),
211 MockFile('some/path2/bar.h.rej', ''),
212 ]
213
214 results = PRESUBMIT._CheckPatchFiles(mock_input_api, MockOutputApi())
215 self.assertEqual(1, len(results))
216 self.assertEqual(2, len(results[0].items))
217 self.assertTrue('foo.cc.rej' in results[0].items[0])
218 self.assertTrue('bar.h.rej' in results[0].items[1])
219
220 def testBadOrigFile(self):
221 mock_input_api = MockInputApi()
222 mock_input_api.files = [
223 MockFile('other/path/qux.h.orig', ''),
224 MockFile('other/path/qux.h', ''),
225 MockFile('other/path/qux.cc', ''),
226 ]
227
228 results = PRESUBMIT._CheckPatchFiles(mock_input_api, MockOutputApi())
229 self.assertEqual(1, len(results))
230 self.assertEqual(1, len(results[0].items))
231 self.assertTrue('qux.h.orig' in results[0].items[0])
232
233 def testGoodFiles(self):
234 mock_input_api = MockInputApi()
235 mock_input_api.files = [
236 MockFile('other/path/qux.h', ''),
237 MockFile('other/path/qux.cc', ''),
238 ]
239 results = PRESUBMIT._CheckPatchFiles(mock_input_api, MockOutputApi())
240 self.assertEqual(0, len(results))
241
242
glidere61efad2015-02-18 17:39:43243class CheckSingletonInHeadersTest(unittest.TestCase):
244 def testSingletonInArbitraryHeader(self):
245 diff_singleton_h = ['base::subtle::AtomicWord '
olli.raula36aa8be2015-09-10 11:14:22246 'base::Singleton<Type, Traits, DifferentiatingType>::']
247 diff_foo_h = ['// base::Singleton<Foo> in comment.',
248 'friend class base::Singleton<Foo>']
oysteinec430ad42015-10-22 20:55:24249 diff_foo2_h = [' //Foo* bar = base::Singleton<Foo>::get();']
olli.raula36aa8be2015-09-10 11:14:22250 diff_bad_h = ['Foo* foo = base::Singleton<Foo>::get();']
glidere61efad2015-02-18 17:39:43251 mock_input_api = MockInputApi()
252 mock_input_api.files = [MockAffectedFile('base/memory/singleton.h',
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39253 diff_singleton_h),
glidere61efad2015-02-18 17:39:43254 MockAffectedFile('foo.h', diff_foo_h),
oysteinec430ad42015-10-22 20:55:24255 MockAffectedFile('foo2.h', diff_foo2_h),
glidere61efad2015-02-18 17:39:43256 MockAffectedFile('bad.h', diff_bad_h)]
257 warnings = PRESUBMIT._CheckSingletonInHeaders(mock_input_api,
258 MockOutputApi())
259 self.assertEqual(1, len(warnings))
Sylvain Defresnea8b73d252018-02-28 15:45:54260 self.assertEqual(1, len(warnings[0].items))
glidere61efad2015-02-18 17:39:43261 self.assertEqual('error', warnings[0].type)
olli.raula36aa8be2015-09-10 11:14:22262 self.assertTrue('Found base::Singleton<T>' in warnings[0].message)
glidere61efad2015-02-18 17:39:43263
264 def testSingletonInCC(self):
olli.raula36aa8be2015-09-10 11:14:22265 diff_cc = ['Foo* foo = base::Singleton<Foo>::get();']
glidere61efad2015-02-18 17:39:43266 mock_input_api = MockInputApi()
267 mock_input_api.files = [MockAffectedFile('some/path/foo.cc', diff_cc)]
268 warnings = PRESUBMIT._CheckSingletonInHeaders(mock_input_api,
269 MockOutputApi())
270 self.assertEqual(0, len(warnings))
271
272
[email protected]b00342e7f2013-03-26 16:21:54273class InvalidOSMacroNamesTest(unittest.TestCase):
274 def testInvalidOSMacroNames(self):
275 lines = ['#if defined(OS_WINDOWS)',
276 ' #elif defined(OS_WINDOW)',
277 ' # if defined(OS_MACOSX) || defined(OS_CHROME)',
278 '# else // defined(OS_MAC)',
279 '#endif // defined(OS_MACOS)']
280 errors = PRESUBMIT._CheckForInvalidOSMacrosInFile(
281 MockInputApi(), MockFile('some/path/foo_platform.cc', lines))
282 self.assertEqual(len(lines), len(errors))
283 self.assertTrue(':1 OS_WINDOWS' in errors[0])
284 self.assertTrue('(did you mean OS_WIN?)' in errors[0])
285
286 def testValidOSMacroNames(self):
287 lines = ['#if defined(%s)' % m for m in PRESUBMIT._VALID_OS_MACROS]
288 errors = PRESUBMIT._CheckForInvalidOSMacrosInFile(
289 MockInputApi(), MockFile('some/path/foo_platform.cc', lines))
290 self.assertEqual(0, len(errors))
291
292
lliabraa35bab3932014-10-01 12:16:44293class InvalidIfDefinedMacroNamesTest(unittest.TestCase):
294 def testInvalidIfDefinedMacroNames(self):
295 lines = ['#if defined(TARGET_IPHONE_SIMULATOR)',
296 '#if !defined(TARGET_IPHONE_SIMULATOR)',
297 '#elif defined(TARGET_IPHONE_SIMULATOR)',
298 '#ifdef TARGET_IPHONE_SIMULATOR',
299 ' # ifdef TARGET_IPHONE_SIMULATOR',
300 '# if defined(VALID) || defined(TARGET_IPHONE_SIMULATOR)',
301 '# else // defined(TARGET_IPHONE_SIMULATOR)',
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39302 '#endif // defined(TARGET_IPHONE_SIMULATOR)']
lliabraa35bab3932014-10-01 12:16:44303 errors = PRESUBMIT._CheckForInvalidIfDefinedMacrosInFile(
304 MockInputApi(), MockFile('some/path/source.mm', lines))
305 self.assertEqual(len(lines), len(errors))
306
307 def testValidIfDefinedMacroNames(self):
308 lines = ['#if defined(FOO)',
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39309 '#ifdef BAR']
lliabraa35bab3932014-10-01 12:16:44310 errors = PRESUBMIT._CheckForInvalidIfDefinedMacrosInFile(
311 MockInputApi(), MockFile('some/path/source.cc', lines))
312 self.assertEqual(0, len(errors))
313
314
Samuel Huang0db2ea22019-12-09 16:42:47315class CheckAddedDepsHaveTestApprovalsTest(unittest.TestCase):
Daniel Cheng4dcdb6b2017-04-13 08:30:17316
317 def calculate(self, old_include_rules, old_specific_include_rules,
318 new_include_rules, new_specific_include_rules):
319 return PRESUBMIT._CalculateAddedDeps(
320 os.path, 'include_rules = %r\nspecific_include_rules = %r' % (
321 old_include_rules, old_specific_include_rules),
322 'include_rules = %r\nspecific_include_rules = %r' % (
323 new_include_rules, new_specific_include_rules))
324
325 def testCalculateAddedDeps(self):
326 old_include_rules = [
327 '+base',
328 '-chrome',
329 '+content',
330 '-grit',
331 '-grit/",',
332 '+jni/fooblat.h',
333 '!sandbox',
[email protected]f32e2d1e2013-07-26 21:39:08334 ]
Daniel Cheng4dcdb6b2017-04-13 08:30:17335 old_specific_include_rules = {
336 'compositor\.*': {
337 '+cc',
338 },
339 }
340
341 new_include_rules = [
342 '-ash',
343 '+base',
344 '+chrome',
345 '+components',
346 '+content',
347 '+grit',
348 '+grit/generated_resources.h",',
349 '+grit/",',
350 '+jni/fooblat.h',
351 '+policy',
manzagop85e629e2017-05-09 22:11:48352 '+' + os.path.join('third_party', 'WebKit'),
Daniel Cheng4dcdb6b2017-04-13 08:30:17353 ]
354 new_specific_include_rules = {
355 'compositor\.*': {
356 '+cc',
357 },
358 'widget\.*': {
359 '+gpu',
360 },
361 }
362
[email protected]f32e2d1e2013-07-26 21:39:08363 expected = set([
manzagop85e629e2017-05-09 22:11:48364 os.path.join('chrome', 'DEPS'),
365 os.path.join('gpu', 'DEPS'),
366 os.path.join('components', 'DEPS'),
367 os.path.join('policy', 'DEPS'),
368 os.path.join('third_party', 'WebKit', 'DEPS'),
[email protected]f32e2d1e2013-07-26 21:39:08369 ])
Daniel Cheng4dcdb6b2017-04-13 08:30:17370 self.assertEqual(
371 expected,
372 self.calculate(old_include_rules, old_specific_include_rules,
373 new_include_rules, new_specific_include_rules))
374
375 def testCalculateAddedDepsIgnoresPermutations(self):
376 old_include_rules = [
377 '+base',
378 '+chrome',
379 ]
380 new_include_rules = [
381 '+chrome',
382 '+base',
383 ]
384 self.assertEqual(set(),
385 self.calculate(old_include_rules, {}, new_include_rules,
386 {}))
[email protected]f32e2d1e2013-07-26 21:39:08387
388
[email protected]99171a92014-06-03 08:44:47389class JSONParsingTest(unittest.TestCase):
390 def testSuccess(self):
391 input_api = MockInputApi()
392 filename = 'valid_json.json'
393 contents = ['// This is a comment.',
394 '{',
395 ' "key1": ["value1", "value2"],',
396 ' "key2": 3 // This is an inline comment.',
397 '}'
398 ]
399 input_api.files = [MockFile(filename, contents)]
400 self.assertEqual(None,
401 PRESUBMIT._GetJSONParseError(input_api, filename))
402
403 def testFailure(self):
404 input_api = MockInputApi()
405 test_data = [
406 ('invalid_json_1.json',
407 ['{ x }'],
[email protected]a3343272014-06-17 11:41:53408 'Expecting property name:'),
[email protected]99171a92014-06-03 08:44:47409 ('invalid_json_2.json',
410 ['// Hello world!',
411 '{ "hello": "world }'],
[email protected]a3343272014-06-17 11:41:53412 'Unterminated string starting at:'),
[email protected]99171a92014-06-03 08:44:47413 ('invalid_json_3.json',
414 ['{ "a": "b", "c": "d", }'],
[email protected]a3343272014-06-17 11:41:53415 'Expecting property name:'),
[email protected]99171a92014-06-03 08:44:47416 ('invalid_json_4.json',
417 ['{ "a": "b" "c": "d" }'],
[email protected]a3343272014-06-17 11:41:53418 'Expecting , delimiter:'),
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39419 ]
[email protected]99171a92014-06-03 08:44:47420
421 input_api.files = [MockFile(filename, contents)
422 for (filename, contents, _) in test_data]
423
424 for (filename, _, expected_error) in test_data:
425 actual_error = PRESUBMIT._GetJSONParseError(input_api, filename)
[email protected]a3343272014-06-17 11:41:53426 self.assertTrue(expected_error in str(actual_error),
427 "'%s' not found in '%s'" % (expected_error, actual_error))
[email protected]99171a92014-06-03 08:44:47428
429 def testNoEatComments(self):
430 input_api = MockInputApi()
431 file_with_comments = 'file_with_comments.json'
432 contents_with_comments = ['// This is a comment.',
433 '{',
434 ' "key1": ["value1", "value2"],',
435 ' "key2": 3 // This is an inline comment.',
436 '}'
437 ]
438 file_without_comments = 'file_without_comments.json'
439 contents_without_comments = ['{',
440 ' "key1": ["value1", "value2"],',
441 ' "key2": 3',
442 '}'
443 ]
444 input_api.files = [MockFile(file_with_comments, contents_with_comments),
445 MockFile(file_without_comments,
446 contents_without_comments)]
447
448 self.assertEqual('No JSON object could be decoded',
449 str(PRESUBMIT._GetJSONParseError(input_api,
450 file_with_comments,
451 eat_comments=False)))
452 self.assertEqual(None,
453 PRESUBMIT._GetJSONParseError(input_api,
454 file_without_comments,
455 eat_comments=False))
456
457
458class IDLParsingTest(unittest.TestCase):
459 def testSuccess(self):
460 input_api = MockInputApi()
461 filename = 'valid_idl_basics.idl'
462 contents = ['// Tests a valid IDL file.',
463 'namespace idl_basics {',
464 ' enum EnumType {',
465 ' name1,',
466 ' name2',
467 ' };',
468 '',
469 ' dictionary MyType1 {',
470 ' DOMString a;',
471 ' };',
472 '',
473 ' callback Callback1 = void();',
474 ' callback Callback2 = void(long x);',
475 ' callback Callback3 = void(MyType1 arg);',
476 ' callback Callback4 = void(EnumType type);',
477 '',
478 ' interface Functions {',
479 ' static void function1();',
480 ' static void function2(long x);',
481 ' static void function3(MyType1 arg);',
482 ' static void function4(Callback1 cb);',
483 ' static void function5(Callback2 cb);',
484 ' static void function6(Callback3 cb);',
485 ' static void function7(Callback4 cb);',
486 ' };',
487 '',
488 ' interface Events {',
489 ' static void onFoo1();',
490 ' static void onFoo2(long x);',
491 ' static void onFoo2(MyType1 arg);',
492 ' static void onFoo3(EnumType type);',
493 ' };',
494 '};'
495 ]
496 input_api.files = [MockFile(filename, contents)]
497 self.assertEqual(None,
498 PRESUBMIT._GetIDLParseError(input_api, filename))
499
500 def testFailure(self):
501 input_api = MockInputApi()
502 test_data = [
503 ('invalid_idl_1.idl',
504 ['//',
505 'namespace test {',
506 ' dictionary {',
507 ' DOMString s;',
508 ' };',
509 '};'],
510 'Unexpected "{" after keyword "dictionary".\n'),
511 # TODO(yoz): Disabled because it causes the IDL parser to hang.
512 # See crbug.com/363830.
513 # ('invalid_idl_2.idl',
514 # (['namespace test {',
515 # ' dictionary MissingSemicolon {',
516 # ' DOMString a',
517 # ' DOMString b;',
518 # ' };',
519 # '};'],
520 # 'Unexpected symbol DOMString after symbol a.'),
521 ('invalid_idl_3.idl',
522 ['//',
523 'namespace test {',
524 ' enum MissingComma {',
525 ' name1',
526 ' name2',
527 ' };',
528 '};'],
529 'Unexpected symbol name2 after symbol name1.'),
530 ('invalid_idl_4.idl',
531 ['//',
532 'namespace test {',
533 ' enum TrailingComma {',
534 ' name1,',
535 ' name2,',
536 ' };',
537 '};'],
538 'Trailing comma in block.'),
539 ('invalid_idl_5.idl',
540 ['//',
541 'namespace test {',
542 ' callback Callback1 = void(;',
543 '};'],
544 'Unexpected ";" after "(".'),
545 ('invalid_idl_6.idl',
546 ['//',
547 'namespace test {',
548 ' callback Callback1 = void(long );',
549 '};'],
550 'Unexpected ")" after symbol long.'),
551 ('invalid_idl_7.idl',
552 ['//',
553 'namespace test {',
554 ' interace Events {',
555 ' static void onFoo1();',
556 ' };',
557 '};'],
558 'Unexpected symbol Events after symbol interace.'),
559 ('invalid_idl_8.idl',
560 ['//',
561 'namespace test {',
562 ' interface NotEvent {',
563 ' static void onFoo1();',
564 ' };',
565 '};'],
566 'Did not process Interface Interface(NotEvent)'),
567 ('invalid_idl_9.idl',
568 ['//',
569 'namespace test {',
570 ' interface {',
571 ' static void function1();',
572 ' };',
573 '};'],
574 'Interface missing name.'),
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39575 ]
[email protected]99171a92014-06-03 08:44:47576
577 input_api.files = [MockFile(filename, contents)
578 for (filename, contents, _) in test_data]
579
580 for (filename, _, expected_error) in test_data:
581 actual_error = PRESUBMIT._GetIDLParseError(input_api, filename)
582 self.assertTrue(expected_error in str(actual_error),
583 "'%s' not found in '%s'" % (expected_error, actual_error))
584
585
[email protected]0bb112362014-07-26 04:38:32586class TryServerMasterTest(unittest.TestCase):
587 def testTryServerMasters(self):
588 bots = {
tandriie5587792016-07-14 00:34:50589 'master.tryserver.chromium.android': [
jbudorick3ae7a772016-05-20 02:36:04590 'android_archive_rel_ng',
591 'android_arm64_dbg_recipe',
592 'android_blink_rel',
jbudorick3ae7a772016-05-20 02:36:04593 'android_clang_dbg_recipe',
594 'android_compile_dbg',
jbudorick3ae7a772016-05-20 02:36:04595 'android_compile_x64_dbg',
596 'android_compile_x86_dbg',
597 'android_coverage',
598 'android_cronet_tester'
599 'android_swarming_rel',
600 'cast_shell_android',
601 'linux_android_dbg_ng',
602 'linux_android_rel_ng',
603 ],
tandriie5587792016-07-14 00:34:50604 'master.tryserver.chromium.mac': [
[email protected]0bb112362014-07-26 04:38:32605 'ios_dbg_simulator',
606 'ios_rel_device',
607 'ios_rel_device_ninja',
608 'mac_asan',
609 'mac_asan_64',
610 'mac_chromium_compile_dbg',
611 'mac_chromium_compile_rel',
612 'mac_chromium_dbg',
613 'mac_chromium_rel',
[email protected]0bb112362014-07-26 04:38:32614 'mac_nacl_sdk',
615 'mac_nacl_sdk_build',
616 'mac_rel_naclmore',
[email protected]0bb112362014-07-26 04:38:32617 'mac_x64_rel',
618 'mac_xcodebuild',
619 ],
tandriie5587792016-07-14 00:34:50620 'master.tryserver.chromium.linux': [
[email protected]0bb112362014-07-26 04:38:32621 'chromium_presubmit',
622 'linux_arm_cross_compile',
623 'linux_arm_tester',
[email protected]0bb112362014-07-26 04:38:32624 'linux_chromeos_asan',
625 'linux_chromeos_browser_asan',
626 'linux_chromeos_valgrind',
[email protected]0bb112362014-07-26 04:38:32627 'linux_chromium_chromeos_dbg',
628 'linux_chromium_chromeos_rel',
[email protected]0bb112362014-07-26 04:38:32629 'linux_chromium_compile_dbg',
630 'linux_chromium_compile_rel',
631 'linux_chromium_dbg',
632 'linux_chromium_gn_dbg',
633 'linux_chromium_gn_rel',
634 'linux_chromium_rel',
[email protected]0bb112362014-07-26 04:38:32635 'linux_chromium_trusty32_dbg',
636 'linux_chromium_trusty32_rel',
637 'linux_chromium_trusty_dbg',
638 'linux_chromium_trusty_rel',
639 'linux_clang_tsan',
640 'linux_ecs_ozone',
641 'linux_layout',
642 'linux_layout_asan',
643 'linux_layout_rel',
644 'linux_layout_rel_32',
645 'linux_nacl_sdk',
646 'linux_nacl_sdk_bionic',
647 'linux_nacl_sdk_bionic_build',
648 'linux_nacl_sdk_build',
649 'linux_redux',
650 'linux_rel_naclmore',
651 'linux_rel_precise32',
652 'linux_valgrind',
653 'tools_build_presubmit',
654 ],
tandriie5587792016-07-14 00:34:50655 'master.tryserver.chromium.win': [
[email protected]0bb112362014-07-26 04:38:32656 'win8_aura',
657 'win8_chromium_dbg',
658 'win8_chromium_rel',
659 'win_chromium_compile_dbg',
660 'win_chromium_compile_rel',
661 'win_chromium_dbg',
662 'win_chromium_rel',
663 'win_chromium_rel',
[email protected]0bb112362014-07-26 04:38:32664 'win_chromium_x64_dbg',
665 'win_chromium_x64_rel',
[email protected]0bb112362014-07-26 04:38:32666 'win_nacl_sdk',
667 'win_nacl_sdk_build',
668 'win_rel_naclmore',
669 ],
670 }
671 for master, bots in bots.iteritems():
672 for bot in bots:
673 self.assertEqual(master, PRESUBMIT.GetTryServerMasterForBot(bot),
674 'bot=%s: expected %s, computed %s' % (
675 bot, master, PRESUBMIT.GetTryServerMasterForBot(bot)))
676
677
davileene0426252015-03-02 21:10:41678class UserMetricsActionTest(unittest.TestCase):
679 def testUserMetricsActionInActions(self):
680 input_api = MockInputApi()
681 file_with_user_action = 'file_with_user_action.cc'
682 contents_with_user_action = [
683 'base::UserMetricsAction("AboutChrome")'
684 ]
685
686 input_api.files = [MockFile(file_with_user_action,
687 contents_with_user_action)]
688
689 self.assertEqual(
690 [], PRESUBMIT._CheckUserActionUpdate(input_api, MockOutputApi()))
691
davileene0426252015-03-02 21:10:41692 def testUserMetricsActionNotAddedToActions(self):
693 input_api = MockInputApi()
694 file_with_user_action = 'file_with_user_action.cc'
695 contents_with_user_action = [
696 'base::UserMetricsAction("NotInActionsXml")'
697 ]
698
699 input_api.files = [MockFile(file_with_user_action,
700 contents_with_user_action)]
701
702 output = PRESUBMIT._CheckUserActionUpdate(input_api, MockOutputApi())
703 self.assertEqual(
704 ('File %s line %d: %s is missing in '
705 'tools/metrics/actions/actions.xml. Please run '
706 'tools/metrics/actions/extract_actions.py to update.'
707 % (file_with_user_action, 1, 'NotInActionsXml')),
708 output[0].message)
709
710
agrievef32bcc72016-04-04 14:57:40711class PydepsNeedsUpdatingTest(unittest.TestCase):
712
713 class MockSubprocess(object):
714 CalledProcessError = subprocess.CalledProcessError
715
716 def setUp(self):
717 mock_all_pydeps = ['A.pydeps', 'B.pydeps']
718 self.old_ALL_PYDEPS_FILES = PRESUBMIT._ALL_PYDEPS_FILES
719 PRESUBMIT._ALL_PYDEPS_FILES = mock_all_pydeps
720 self.mock_input_api = MockInputApi()
721 self.mock_output_api = MockOutputApi()
722 self.mock_input_api.subprocess = PydepsNeedsUpdatingTest.MockSubprocess()
723 self.checker = PRESUBMIT.PydepsChecker(self.mock_input_api, mock_all_pydeps)
724 self.checker._file_cache = {
725 'A.pydeps': '# Generated by:\n# CMD A\nA.py\nC.py\n',
726 'B.pydeps': '# Generated by:\n# CMD B\nB.py\nC.py\n',
727 }
728
729 def tearDown(self):
730 PRESUBMIT._ALL_PYDEPS_FILES = self.old_ALL_PYDEPS_FILES
731
732 def _RunCheck(self):
733 return PRESUBMIT._CheckPydepsNeedsUpdating(self.mock_input_api,
734 self.mock_output_api,
735 checker_for_tests=self.checker)
736
737 def testAddedPydep(self):
pastarmovj89f7ee12016-09-20 14:58:13738 # PRESUBMIT._CheckPydepsNeedsUpdating is only implemented for Android.
739 if self.mock_input_api.platform != 'linux2':
740 return []
741
agrievef32bcc72016-04-04 14:57:40742 self.mock_input_api.files = [
743 MockAffectedFile('new.pydeps', [], action='A'),
744 ]
745
Zhiling Huang45cabf32018-03-10 00:50:03746 self.mock_input_api.CreateMockFileInPath(
747 [x.LocalPath() for x in self.mock_input_api.AffectedFiles(
748 include_deletes=True)])
agrievef32bcc72016-04-04 14:57:40749 results = self._RunCheck()
750 self.assertEqual(1, len(results))
751 self.assertTrue('PYDEPS_FILES' in str(results[0]))
752
Zhiling Huang45cabf32018-03-10 00:50:03753 def testPydepNotInSrc(self):
754 self.mock_input_api.files = [
755 MockAffectedFile('new.pydeps', [], action='A'),
756 ]
757 self.mock_input_api.CreateMockFileInPath([])
758 results = self._RunCheck()
759 self.assertEqual(0, len(results))
760
agrievef32bcc72016-04-04 14:57:40761 def testRemovedPydep(self):
pastarmovj89f7ee12016-09-20 14:58:13762 # PRESUBMIT._CheckPydepsNeedsUpdating is only implemented for Android.
763 if self.mock_input_api.platform != 'linux2':
764 return []
765
agrievef32bcc72016-04-04 14:57:40766 self.mock_input_api.files = [
767 MockAffectedFile(PRESUBMIT._ALL_PYDEPS_FILES[0], [], action='D'),
768 ]
Zhiling Huang45cabf32018-03-10 00:50:03769 self.mock_input_api.CreateMockFileInPath(
770 [x.LocalPath() for x in self.mock_input_api.AffectedFiles(
771 include_deletes=True)])
agrievef32bcc72016-04-04 14:57:40772 results = self._RunCheck()
773 self.assertEqual(1, len(results))
774 self.assertTrue('PYDEPS_FILES' in str(results[0]))
775
776 def testRandomPyIgnored(self):
pastarmovj89f7ee12016-09-20 14:58:13777 # PRESUBMIT._CheckPydepsNeedsUpdating is only implemented for Android.
778 if self.mock_input_api.platform != 'linux2':
779 return []
780
agrievef32bcc72016-04-04 14:57:40781 self.mock_input_api.files = [
782 MockAffectedFile('random.py', []),
783 ]
784
785 results = self._RunCheck()
786 self.assertEqual(0, len(results), 'Unexpected results: %r' % results)
787
788 def testRelevantPyNoChange(self):
pastarmovj89f7ee12016-09-20 14:58:13789 # PRESUBMIT._CheckPydepsNeedsUpdating is only implemented for Android.
790 if self.mock_input_api.platform != 'linux2':
791 return []
792
agrievef32bcc72016-04-04 14:57:40793 self.mock_input_api.files = [
794 MockAffectedFile('A.py', []),
795 ]
796
John Budorickab2fa102017-10-06 16:59:49797 def mock_check_output(cmd, shell=False, env=None):
agrievef32bcc72016-04-04 14:57:40798 self.assertEqual('CMD A --output ""', cmd)
799 return self.checker._file_cache['A.pydeps']
800
801 self.mock_input_api.subprocess.check_output = mock_check_output
802
803 results = self._RunCheck()
804 self.assertEqual(0, len(results), 'Unexpected results: %r' % results)
805
806 def testRelevantPyOneChange(self):
pastarmovj89f7ee12016-09-20 14:58:13807 # PRESUBMIT._CheckPydepsNeedsUpdating is only implemented for Android.
808 if self.mock_input_api.platform != 'linux2':
809 return []
810
agrievef32bcc72016-04-04 14:57:40811 self.mock_input_api.files = [
812 MockAffectedFile('A.py', []),
813 ]
814
John Budorickab2fa102017-10-06 16:59:49815 def mock_check_output(cmd, shell=False, env=None):
agrievef32bcc72016-04-04 14:57:40816 self.assertEqual('CMD A --output ""', cmd)
817 return 'changed data'
818
819 self.mock_input_api.subprocess.check_output = mock_check_output
820
821 results = self._RunCheck()
822 self.assertEqual(1, len(results))
823 self.assertTrue('File is stale' in str(results[0]))
824
825 def testRelevantPyTwoChanges(self):
pastarmovj89f7ee12016-09-20 14:58:13826 # PRESUBMIT._CheckPydepsNeedsUpdating is only implemented for Android.
827 if self.mock_input_api.platform != 'linux2':
828 return []
829
agrievef32bcc72016-04-04 14:57:40830 self.mock_input_api.files = [
831 MockAffectedFile('C.py', []),
832 ]
833
John Budorickab2fa102017-10-06 16:59:49834 def mock_check_output(cmd, shell=False, env=None):
agrievef32bcc72016-04-04 14:57:40835 return 'changed data'
836
837 self.mock_input_api.subprocess.check_output = mock_check_output
838
839 results = self._RunCheck()
840 self.assertEqual(2, len(results))
841 self.assertTrue('File is stale' in str(results[0]))
842 self.assertTrue('File is stale' in str(results[1]))
843
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39844
Daniel Bratell8ba52722018-03-02 16:06:14845class IncludeGuardTest(unittest.TestCase):
846 def testIncludeGuardChecks(self):
847 mock_input_api = MockInputApi()
848 mock_output_api = MockOutputApi()
849 mock_input_api.files = [
850 MockAffectedFile('content/browser/thing/foo.h', [
851 '// Comment',
852 '#ifndef CONTENT_BROWSER_THING_FOO_H_',
853 '#define CONTENT_BROWSER_THING_FOO_H_',
854 'struct McBoatFace;',
855 '#endif // CONTENT_BROWSER_THING_FOO_H_',
856 ]),
857 MockAffectedFile('content/browser/thing/bar.h', [
858 '#ifndef CONTENT_BROWSER_THING_BAR_H_',
859 '#define CONTENT_BROWSER_THING_BAR_H_',
860 'namespace content {',
861 '#endif // CONTENT_BROWSER_THING_BAR_H_',
862 '} // namespace content',
863 ]),
864 MockAffectedFile('content/browser/test1.h', [
865 'namespace content {',
866 '} // namespace content',
867 ]),
868 MockAffectedFile('content\\browser\\win.h', [
869 '#ifndef CONTENT_BROWSER_WIN_H_',
870 '#define CONTENT_BROWSER_WIN_H_',
871 'struct McBoatFace;',
872 '#endif // CONTENT_BROWSER_WIN_H_',
873 ]),
874 MockAffectedFile('content/browser/test2.h', [
875 '// Comment',
876 '#ifndef CONTENT_BROWSER_TEST2_H_',
877 'struct McBoatFace;',
878 '#endif // CONTENT_BROWSER_TEST2_H_',
879 ]),
880 MockAffectedFile('content/browser/internal.h', [
881 '// Comment',
882 '#ifndef CONTENT_BROWSER_INTERNAL_H_',
883 '#define CONTENT_BROWSER_INTERNAL_H_',
884 '// Comment',
885 '#ifndef INTERNAL_CONTENT_BROWSER_INTERNAL_H_',
886 '#define INTERNAL_CONTENT_BROWSER_INTERNAL_H_',
887 'namespace internal {',
888 '} // namespace internal',
889 '#endif // INTERNAL_CONTENT_BROWSER_THING_BAR_H_',
890 'namespace content {',
891 '} // namespace content',
892 '#endif // CONTENT_BROWSER_THING_BAR_H_',
893 ]),
894 MockAffectedFile('content/browser/thing/foo.cc', [
895 '// This is a non-header.',
896 ]),
897 MockAffectedFile('content/browser/disabled.h', [
898 '// no-include-guard-because-multiply-included',
899 'struct McBoatFace;',
900 ]),
901 # New files don't allow misspelled include guards.
902 MockAffectedFile('content/browser/spleling.h', [
903 '#ifndef CONTENT_BROWSER_SPLLEING_H_',
904 '#define CONTENT_BROWSER_SPLLEING_H_',
905 'struct McBoatFace;',
906 '#endif // CONTENT_BROWSER_SPLLEING_H_',
907 ]),
Olivier Robinbba137492018-07-30 11:31:34908 # New files don't allow + in include guards.
909 MockAffectedFile('content/browser/foo+bar.h', [
910 '#ifndef CONTENT_BROWSER_FOO+BAR_H_',
911 '#define CONTENT_BROWSER_FOO+BAR_H_',
912 'struct McBoatFace;',
913 '#endif // CONTENT_BROWSER_FOO+BAR_H_',
914 ]),
Daniel Bratell8ba52722018-03-02 16:06:14915 # Old files allow misspelled include guards (for now).
916 MockAffectedFile('chrome/old.h', [
917 '// New contents',
918 '#ifndef CHROME_ODL_H_',
919 '#define CHROME_ODL_H_',
920 '#endif // CHROME_ODL_H_',
921 ], [
922 '// Old contents',
923 '#ifndef CHROME_ODL_H_',
924 '#define CHROME_ODL_H_',
925 '#endif // CHROME_ODL_H_',
926 ]),
927 # Using a Blink style include guard outside Blink is wrong.
928 MockAffectedFile('content/NotInBlink.h', [
929 '#ifndef NotInBlink_h',
930 '#define NotInBlink_h',
931 'struct McBoatFace;',
932 '#endif // NotInBlink_h',
933 ]),
Daniel Bratell39b5b062018-05-16 18:09:57934 # Using a Blink style include guard in Blink is no longer ok.
935 MockAffectedFile('third_party/blink/InBlink.h', [
Daniel Bratell8ba52722018-03-02 16:06:14936 '#ifndef InBlink_h',
937 '#define InBlink_h',
938 'struct McBoatFace;',
939 '#endif // InBlink_h',
940 ]),
941 # Using a bad include guard in Blink is not ok.
Daniel Bratell39b5b062018-05-16 18:09:57942 MockAffectedFile('third_party/blink/AlsoInBlink.h', [
Daniel Bratell8ba52722018-03-02 16:06:14943 '#ifndef WrongInBlink_h',
944 '#define WrongInBlink_h',
945 'struct McBoatFace;',
946 '#endif // WrongInBlink_h',
947 ]),
Daniel Bratell39b5b062018-05-16 18:09:57948 # Using a bad include guard in Blink is not accepted even if
949 # it's an old file.
950 MockAffectedFile('third_party/blink/StillInBlink.h', [
Daniel Bratell8ba52722018-03-02 16:06:14951 '// New contents',
952 '#ifndef AcceptedInBlink_h',
953 '#define AcceptedInBlink_h',
954 'struct McBoatFace;',
955 '#endif // AcceptedInBlink_h',
956 ], [
957 '// Old contents',
958 '#ifndef AcceptedInBlink_h',
959 '#define AcceptedInBlink_h',
960 'struct McBoatFace;',
961 '#endif // AcceptedInBlink_h',
962 ]),
Daniel Bratell39b5b062018-05-16 18:09:57963 # Using a non-Chromium include guard in third_party
964 # (outside blink) is accepted.
965 MockAffectedFile('third_party/foo/some_file.h', [
966 '#ifndef REQUIRED_RPCNDR_H_',
967 '#define REQUIRED_RPCNDR_H_',
968 'struct SomeFileFoo;',
969 '#endif // REQUIRED_RPCNDR_H_',
970 ]),
Kinuko Yasuda0cdb3da2019-07-31 21:50:32971 # Not having proper include guard in *_message_generator.h
972 # for old IPC messages is allowed.
973 MockAffectedFile('content/common/content_message_generator.h', [
974 '#undef CONTENT_COMMON_FOO_MESSAGES_H_',
975 '#include "content/common/foo_messages.h"',
976 '#ifndef CONTENT_COMMON_FOO_MESSAGES_H_',
977 '#error "Failed to include content/common/foo_messages.h"',
978 '#endif',
979 ]),
Daniel Bratell8ba52722018-03-02 16:06:14980 ]
981 msgs = PRESUBMIT._CheckForIncludeGuards(
982 mock_input_api, mock_output_api)
Olivier Robinbba137492018-07-30 11:31:34983 expected_fail_count = 8
Daniel Bratell8ba52722018-03-02 16:06:14984 self.assertEqual(expected_fail_count, len(msgs),
985 'Expected %d items, found %d: %s'
986 % (expected_fail_count, len(msgs), msgs))
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39987 self.assertEqual(msgs[0].items, ['content/browser/thing/bar.h'])
Daniel Bratell8ba52722018-03-02 16:06:14988 self.assertEqual(msgs[0].message,
989 'Include guard CONTENT_BROWSER_THING_BAR_H_ '
990 'not covering the whole file')
991
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39992 self.assertEqual(msgs[1].items, ['content/browser/test1.h'])
Daniel Bratell8ba52722018-03-02 16:06:14993 self.assertEqual(msgs[1].message,
994 'Missing include guard CONTENT_BROWSER_TEST1_H_')
995
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:39996 self.assertEqual(msgs[2].items, ['content/browser/test2.h:3'])
Daniel Bratell8ba52722018-03-02 16:06:14997 self.assertEqual(msgs[2].message,
998 'Missing "#define CONTENT_BROWSER_TEST2_H_" for '
999 'include guard')
1000
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391001 self.assertEqual(msgs[3].items, ['content/browser/spleling.h:1'])
Daniel Bratell8ba52722018-03-02 16:06:141002 self.assertEqual(msgs[3].message,
1003 'Header using the wrong include guard name '
1004 'CONTENT_BROWSER_SPLLEING_H_')
1005
Olivier Robinbba137492018-07-30 11:31:341006 self.assertEqual(msgs[4].items, ['content/browser/foo+bar.h'])
Daniel Bratell8ba52722018-03-02 16:06:141007 self.assertEqual(msgs[4].message,
Olivier Robinbba137492018-07-30 11:31:341008 'Missing include guard CONTENT_BROWSER_FOO_BAR_H_')
1009
1010 self.assertEqual(msgs[5].items, ['content/NotInBlink.h:1'])
1011 self.assertEqual(msgs[5].message,
Daniel Bratell8ba52722018-03-02 16:06:141012 'Header using the wrong include guard name '
1013 'NotInBlink_h')
1014
Olivier Robinbba137492018-07-30 11:31:341015 self.assertEqual(msgs[6].items, ['third_party/blink/InBlink.h:1'])
1016 self.assertEqual(msgs[6].message,
Daniel Bratell8ba52722018-03-02 16:06:141017 'Header using the wrong include guard name '
Daniel Bratell39b5b062018-05-16 18:09:571018 'InBlink_h')
1019
Olivier Robinbba137492018-07-30 11:31:341020 self.assertEqual(msgs[7].items, ['third_party/blink/AlsoInBlink.h:1'])
1021 self.assertEqual(msgs[7].message,
Daniel Bratell39b5b062018-05-16 18:09:571022 'Header using the wrong include guard name '
Daniel Bratell8ba52722018-03-02 16:06:141023 'WrongInBlink_h')
1024
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391025
yolandyan45001472016-12-21 21:12:421026class AndroidDeprecatedTestAnnotationTest(unittest.TestCase):
1027 def testCheckAndroidTestAnnotationUsage(self):
1028 mock_input_api = MockInputApi()
1029 mock_output_api = MockOutputApi()
1030
1031 mock_input_api.files = [
1032 MockAffectedFile('LalaLand.java', [
1033 'random stuff'
1034 ]),
1035 MockAffectedFile('CorrectUsage.java', [
1036 'import android.support.test.filters.LargeTest;',
1037 'import android.support.test.filters.MediumTest;',
1038 'import android.support.test.filters.SmallTest;',
1039 ]),
1040 MockAffectedFile('UsedDeprecatedLargeTestAnnotation.java', [
1041 'import android.test.suitebuilder.annotation.LargeTest;',
1042 ]),
1043 MockAffectedFile('UsedDeprecatedMediumTestAnnotation.java', [
1044 'import android.test.suitebuilder.annotation.MediumTest;',
1045 ]),
1046 MockAffectedFile('UsedDeprecatedSmallTestAnnotation.java', [
1047 'import android.test.suitebuilder.annotation.SmallTest;',
1048 ]),
1049 MockAffectedFile('UsedDeprecatedSmokeAnnotation.java', [
1050 'import android.test.suitebuilder.annotation.Smoke;',
1051 ])
1052 ]
1053 msgs = PRESUBMIT._CheckAndroidTestAnnotationUsage(
1054 mock_input_api, mock_output_api)
1055 self.assertEqual(1, len(msgs),
1056 'Expected %d items, found %d: %s'
1057 % (1, len(msgs), msgs))
1058 self.assertEqual(4, len(msgs[0].items),
1059 'Expected %d items, found %d: %s'
1060 % (4, len(msgs[0].items), msgs[0].items))
1061 self.assertTrue('UsedDeprecatedLargeTestAnnotation.java:1' in msgs[0].items,
1062 'UsedDeprecatedLargeTestAnnotation not found in errors')
1063 self.assertTrue('UsedDeprecatedMediumTestAnnotation.java:1'
1064 in msgs[0].items,
1065 'UsedDeprecatedMediumTestAnnotation not found in errors')
1066 self.assertTrue('UsedDeprecatedSmallTestAnnotation.java:1' in msgs[0].items,
1067 'UsedDeprecatedSmallTestAnnotation not found in errors')
1068 self.assertTrue('UsedDeprecatedSmokeAnnotation.java:1' in msgs[0].items,
1069 'UsedDeprecatedSmokeAnnotation not found in errors')
1070
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391071
Yoland Yanb92fa522017-08-28 17:37:061072class AndroidDeprecatedJUnitFrameworkTest(unittest.TestCase):
Wei-Yin Chen (陳威尹)032f1ac2018-07-27 21:21:271073 def testCheckAndroidTestJUnitFramework(self):
Yoland Yanb92fa522017-08-28 17:37:061074 mock_input_api = MockInputApi()
1075 mock_output_api = MockOutputApi()
yolandyan45001472016-12-21 21:12:421076
Yoland Yanb92fa522017-08-28 17:37:061077 mock_input_api.files = [
1078 MockAffectedFile('LalaLand.java', [
1079 'random stuff'
1080 ]),
1081 MockAffectedFile('CorrectUsage.java', [
1082 'import org.junit.ABC',
1083 'import org.junit.XYZ;',
1084 ]),
1085 MockAffectedFile('UsedDeprecatedJUnit.java', [
1086 'import junit.framework.*;',
1087 ]),
1088 MockAffectedFile('UsedDeprecatedJUnitAssert.java', [
1089 'import junit.framework.Assert;',
1090 ]),
1091 ]
1092 msgs = PRESUBMIT._CheckAndroidTestJUnitFrameworkImport(
1093 mock_input_api, mock_output_api)
1094 self.assertEqual(1, len(msgs),
1095 'Expected %d items, found %d: %s'
1096 % (1, len(msgs), msgs))
1097 self.assertEqual(2, len(msgs[0].items),
1098 'Expected %d items, found %d: %s'
1099 % (2, len(msgs[0].items), msgs[0].items))
1100 self.assertTrue('UsedDeprecatedJUnit.java:1' in msgs[0].items,
1101 'UsedDeprecatedJUnit.java not found in errors')
1102 self.assertTrue('UsedDeprecatedJUnitAssert.java:1'
1103 in msgs[0].items,
1104 'UsedDeprecatedJUnitAssert not found in errors')
1105
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391106
Wei-Yin Chen (陳威尹)032f1ac2018-07-27 21:21:271107class AndroidJUnitBaseClassTest(unittest.TestCase):
1108 def testCheckAndroidTestJUnitBaseClass(self):
Yoland Yanb92fa522017-08-28 17:37:061109 mock_input_api = MockInputApi()
1110 mock_output_api = MockOutputApi()
1111
1112 mock_input_api.files = [
1113 MockAffectedFile('LalaLand.java', [
1114 'random stuff'
1115 ]),
1116 MockAffectedFile('CorrectTest.java', [
1117 '@RunWith(ABC.class);'
1118 'public class CorrectTest {',
1119 '}',
1120 ]),
1121 MockAffectedFile('HistoricallyIncorrectTest.java', [
1122 'public class Test extends BaseCaseA {',
1123 '}',
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391124 ], old_contents=[
Yoland Yanb92fa522017-08-28 17:37:061125 'public class Test extends BaseCaseB {',
1126 '}',
1127 ]),
1128 MockAffectedFile('CorrectTestWithInterface.java', [
1129 '@RunWith(ABC.class);'
1130 'public class CorrectTest implement Interface {',
1131 '}',
1132 ]),
1133 MockAffectedFile('IncorrectTest.java', [
1134 'public class IncorrectTest extends TestCase {',
1135 '}',
1136 ]),
Vaclav Brozekf01ed502018-03-16 19:38:241137 MockAffectedFile('IncorrectWithInterfaceTest.java', [
Yoland Yanb92fa522017-08-28 17:37:061138 'public class Test implements X extends BaseClass {',
1139 '}',
1140 ]),
Vaclav Brozekf01ed502018-03-16 19:38:241141 MockAffectedFile('IncorrectMultiLineTest.java', [
Yoland Yanb92fa522017-08-28 17:37:061142 'public class Test implements X, Y, Z',
1143 ' extends TestBase {',
1144 '}',
1145 ]),
1146 ]
1147 msgs = PRESUBMIT._CheckAndroidTestJUnitInheritance(
1148 mock_input_api, mock_output_api)
1149 self.assertEqual(1, len(msgs),
1150 'Expected %d items, found %d: %s'
1151 % (1, len(msgs), msgs))
1152 self.assertEqual(3, len(msgs[0].items),
1153 'Expected %d items, found %d: %s'
1154 % (3, len(msgs[0].items), msgs[0].items))
1155 self.assertTrue('IncorrectTest.java:1' in msgs[0].items,
1156 'IncorrectTest not found in errors')
Vaclav Brozekf01ed502018-03-16 19:38:241157 self.assertTrue('IncorrectWithInterfaceTest.java:1'
Yoland Yanb92fa522017-08-28 17:37:061158 in msgs[0].items,
Vaclav Brozekf01ed502018-03-16 19:38:241159 'IncorrectWithInterfaceTest not found in errors')
1160 self.assertTrue('IncorrectMultiLineTest.java:2' in msgs[0].items,
1161 'IncorrectMultiLineTest not found in errors')
yolandyan45001472016-12-21 21:12:421162
Jinsong Fan91ebbbd2019-04-16 14:57:171163class AndroidDebuggableBuildTest(unittest.TestCase):
1164
1165 def testCheckAndroidDebuggableBuild(self):
1166 mock_input_api = MockInputApi()
1167 mock_output_api = MockOutputApi()
1168
1169 mock_input_api.files = [
1170 MockAffectedFile('RandomStuff.java', [
1171 'random stuff'
1172 ]),
1173 MockAffectedFile('CorrectUsage.java', [
1174 'import org.chromium.base.BuildInfo;',
1175 'some random stuff',
1176 'boolean isOsDebuggable = BuildInfo.isDebugAndroid();',
1177 ]),
1178 MockAffectedFile('JustCheckUserdebugBuild.java', [
1179 'import android.os.Build;',
1180 'some random stuff',
1181 'boolean isOsDebuggable = Build.TYPE.equals("userdebug")',
1182 ]),
1183 MockAffectedFile('JustCheckEngineeringBuild.java', [
1184 'import android.os.Build;',
1185 'some random stuff',
1186 'boolean isOsDebuggable = "eng".equals(Build.TYPE)',
1187 ]),
1188 MockAffectedFile('UsedBuildType.java', [
1189 'import android.os.Build;',
1190 'some random stuff',
1191 'boolean isOsDebuggable = Build.TYPE.equals("userdebug")'
1192 '|| "eng".equals(Build.TYPE)',
1193 ]),
1194 MockAffectedFile('UsedExplicitBuildType.java', [
1195 'some random stuff',
1196 'boolean isOsDebuggable = android.os.Build.TYPE.equals("userdebug")'
1197 '|| "eng".equals(android.os.Build.TYPE)',
1198 ]),
1199 ]
1200
1201 msgs = PRESUBMIT._CheckAndroidDebuggableBuild(
1202 mock_input_api, mock_output_api)
1203 self.assertEqual(1, len(msgs),
1204 'Expected %d items, found %d: %s'
1205 % (1, len(msgs), msgs))
1206 self.assertEqual(4, len(msgs[0].items),
1207 'Expected %d items, found %d: %s'
1208 % (4, len(msgs[0].items), msgs[0].items))
1209 self.assertTrue('JustCheckUserdebugBuild.java:3' in msgs[0].items)
1210 self.assertTrue('JustCheckEngineeringBuild.java:3' in msgs[0].items)
1211 self.assertTrue('UsedBuildType.java:3' in msgs[0].items)
1212 self.assertTrue('UsedExplicitBuildType.java:2' in msgs[0].items)
1213
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391214
dgn4401aa52015-04-29 16:26:171215class LogUsageTest(unittest.TestCase):
1216
dgnaa68d5e2015-06-10 10:08:221217 def testCheckAndroidCrLogUsage(self):
1218 mock_input_api = MockInputApi()
1219 mock_output_api = MockOutputApi()
1220
1221 mock_input_api.files = [
1222 MockAffectedFile('RandomStuff.java', [
1223 'random stuff'
1224 ]),
dgn87d9fb62015-06-12 09:15:121225 MockAffectedFile('HasAndroidLog.java', [
1226 'import android.util.Log;',
1227 'some random stuff',
1228 'Log.d("TAG", "foo");',
1229 ]),
1230 MockAffectedFile('HasExplicitUtilLog.java', [
1231 'some random stuff',
1232 'android.util.Log.d("TAG", "foo");',
1233 ]),
1234 MockAffectedFile('IsInBasePackage.java', [
1235 'package org.chromium.base;',
dgn38736db2015-09-18 19:20:511236 'private static final String TAG = "cr_Foo";',
dgn87d9fb62015-06-12 09:15:121237 'Log.d(TAG, "foo");',
1238 ]),
1239 MockAffectedFile('IsInBasePackageButImportsLog.java', [
1240 'package org.chromium.base;',
1241 'import android.util.Log;',
dgn38736db2015-09-18 19:20:511242 'private static final String TAG = "cr_Foo";',
dgn87d9fb62015-06-12 09:15:121243 'Log.d(TAG, "foo");',
1244 ]),
1245 MockAffectedFile('HasBothLog.java', [
1246 'import org.chromium.base.Log;',
1247 'some random stuff',
dgn38736db2015-09-18 19:20:511248 'private static final String TAG = "cr_Foo";',
dgn87d9fb62015-06-12 09:15:121249 'Log.d(TAG, "foo");',
1250 'android.util.Log.d("TAG", "foo");',
1251 ]),
dgnaa68d5e2015-06-10 10:08:221252 MockAffectedFile('HasCorrectTag.java', [
1253 'import org.chromium.base.Log;',
1254 'some random stuff',
dgn38736db2015-09-18 19:20:511255 'private static final String TAG = "cr_Foo";',
1256 'Log.d(TAG, "foo");',
1257 ]),
1258 MockAffectedFile('HasOldTag.java', [
1259 'import org.chromium.base.Log;',
1260 'some random stuff',
dgnaa68d5e2015-06-10 10:08:221261 'private static final String TAG = "cr.Foo";',
1262 'Log.d(TAG, "foo");',
1263 ]),
dgn38736db2015-09-18 19:20:511264 MockAffectedFile('HasDottedTag.java', [
dgnaa68d5e2015-06-10 10:08:221265 'import org.chromium.base.Log;',
1266 'some random stuff',
dgn38736db2015-09-18 19:20:511267 'private static final String TAG = "cr_foo.bar";',
dgnaa68d5e2015-06-10 10:08:221268 'Log.d(TAG, "foo");',
1269 ]),
Torne (Richard Coles)3bd7ad02019-10-22 21:20:461270 MockAffectedFile('HasDottedTagPublic.java', [
1271 'import org.chromium.base.Log;',
1272 'some random stuff',
1273 'public static final String TAG = "cr_foo.bar";',
1274 'Log.d(TAG, "foo");',
1275 ]),
dgnaa68d5e2015-06-10 10:08:221276 MockAffectedFile('HasNoTagDecl.java', [
1277 'import org.chromium.base.Log;',
1278 'some random stuff',
1279 'Log.d(TAG, "foo");',
1280 ]),
1281 MockAffectedFile('HasIncorrectTagDecl.java', [
1282 'import org.chromium.base.Log;',
dgn38736db2015-09-18 19:20:511283 'private static final String TAHG = "cr_Foo";',
dgnaa68d5e2015-06-10 10:08:221284 'some random stuff',
1285 'Log.d(TAG, "foo");',
1286 ]),
1287 MockAffectedFile('HasInlineTag.java', [
1288 'import org.chromium.base.Log;',
1289 'some random stuff',
dgn38736db2015-09-18 19:20:511290 'private static final String TAG = "cr_Foo";',
dgnaa68d5e2015-06-10 10:08:221291 'Log.d("TAG", "foo");',
1292 ]),
dgn38736db2015-09-18 19:20:511293 MockAffectedFile('HasUnprefixedTag.java', [
dgnaa68d5e2015-06-10 10:08:221294 'import org.chromium.base.Log;',
1295 'some random stuff',
1296 'private static final String TAG = "rubbish";',
1297 'Log.d(TAG, "foo");',
1298 ]),
1299 MockAffectedFile('HasTooLongTag.java', [
1300 'import org.chromium.base.Log;',
1301 'some random stuff',
dgn38736db2015-09-18 19:20:511302 'private static final String TAG = "21_charachers_long___";',
dgnaa68d5e2015-06-10 10:08:221303 'Log.d(TAG, "foo");',
1304 ]),
1305 ]
1306
1307 msgs = PRESUBMIT._CheckAndroidCrLogUsage(
1308 mock_input_api, mock_output_api)
1309
dgn38736db2015-09-18 19:20:511310 self.assertEqual(5, len(msgs),
1311 'Expected %d items, found %d: %s' % (5, len(msgs), msgs))
dgnaa68d5e2015-06-10 10:08:221312
1313 # Declaration format
dgn38736db2015-09-18 19:20:511314 nb = len(msgs[0].items)
1315 self.assertEqual(2, nb,
1316 'Expected %d items, found %d: %s' % (2, nb, msgs[0].items))
dgnaa68d5e2015-06-10 10:08:221317 self.assertTrue('HasNoTagDecl.java' in msgs[0].items)
1318 self.assertTrue('HasIncorrectTagDecl.java' in msgs[0].items)
dgnaa68d5e2015-06-10 10:08:221319
1320 # Tag length
dgn38736db2015-09-18 19:20:511321 nb = len(msgs[1].items)
1322 self.assertEqual(1, nb,
1323 'Expected %d items, found %d: %s' % (1, nb, msgs[1].items))
dgnaa68d5e2015-06-10 10:08:221324 self.assertTrue('HasTooLongTag.java' in msgs[1].items)
1325
1326 # Tag must be a variable named TAG
dgn38736db2015-09-18 19:20:511327 nb = len(msgs[2].items)
1328 self.assertEqual(1, nb,
1329 'Expected %d items, found %d: %s' % (1, nb, msgs[2].items))
dgnaa68d5e2015-06-10 10:08:221330 self.assertTrue('HasInlineTag.java:4' in msgs[2].items)
1331
dgn87d9fb62015-06-12 09:15:121332 # Util Log usage
dgn38736db2015-09-18 19:20:511333 nb = len(msgs[3].items)
1334 self.assertEqual(2, nb,
1335 'Expected %d items, found %d: %s' % (2, nb, msgs[3].items))
dgn87d9fb62015-06-12 09:15:121336 self.assertTrue('HasAndroidLog.java:3' in msgs[3].items)
1337 self.assertTrue('IsInBasePackageButImportsLog.java:4' in msgs[3].items)
dgnaa68d5e2015-06-10 10:08:221338
dgn38736db2015-09-18 19:20:511339 # Tag must not contain
1340 nb = len(msgs[4].items)
Torne (Richard Coles)3bd7ad02019-10-22 21:20:461341 self.assertEqual(3, nb,
dgn38736db2015-09-18 19:20:511342 'Expected %d items, found %d: %s' % (2, nb, msgs[4].items))
1343 self.assertTrue('HasDottedTag.java' in msgs[4].items)
Torne (Richard Coles)3bd7ad02019-10-22 21:20:461344 self.assertTrue('HasDottedTagPublic.java' in msgs[4].items)
dgn38736db2015-09-18 19:20:511345 self.assertTrue('HasOldTag.java' in msgs[4].items)
1346
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391347
estadee17314a02017-01-12 16:22:161348class GoogleAnswerUrlFormatTest(unittest.TestCase):
1349
1350 def testCatchAnswerUrlId(self):
1351 input_api = MockInputApi()
1352 input_api.files = [
1353 MockFile('somewhere/file.cc',
1354 ['char* host = '
1355 ' "https://support.google.com/chrome/answer/123456";']),
1356 MockFile('somewhere_else/file.cc',
1357 ['char* host = '
1358 ' "https://support.google.com/chrome/a/answer/123456";']),
1359 ]
1360
1361 warnings = PRESUBMIT._CheckGoogleSupportAnswerUrl(
1362 input_api, MockOutputApi())
1363 self.assertEqual(1, len(warnings))
1364 self.assertEqual(2, len(warnings[0].items))
1365
1366 def testAllowAnswerUrlParam(self):
1367 input_api = MockInputApi()
1368 input_api.files = [
1369 MockFile('somewhere/file.cc',
1370 ['char* host = '
1371 ' "https://support.google.com/chrome/?p=cpn_crash_reports";']),
1372 ]
1373
1374 warnings = PRESUBMIT._CheckGoogleSupportAnswerUrl(
1375 input_api, MockOutputApi())
1376 self.assertEqual(0, len(warnings))
1377
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391378
reillyi38965732015-11-16 18:27:331379class HardcodedGoogleHostsTest(unittest.TestCase):
1380
1381 def testWarnOnAssignedLiterals(self):
1382 input_api = MockInputApi()
1383 input_api.files = [
1384 MockFile('content/file.cc',
1385 ['char* host = "https://www.google.com";']),
1386 MockFile('content/file.cc',
1387 ['char* host = "https://www.googleapis.com";']),
1388 MockFile('content/file.cc',
1389 ['char* host = "https://clients1.google.com";']),
1390 ]
1391
1392 warnings = PRESUBMIT._CheckHardcodedGoogleHostsInLowerLayers(
1393 input_api, MockOutputApi())
1394 self.assertEqual(1, len(warnings))
1395 self.assertEqual(3, len(warnings[0].items))
1396
1397 def testAllowInComment(self):
1398 input_api = MockInputApi()
1399 input_api.files = [
1400 MockFile('content/file.cc',
1401 ['char* host = "https://www.aol.com"; // google.com'])
1402 ]
1403
1404 warnings = PRESUBMIT._CheckHardcodedGoogleHostsInLowerLayers(
1405 input_api, MockOutputApi())
1406 self.assertEqual(0, len(warnings))
1407
dgn4401aa52015-04-29 16:26:171408
James Cook6b6597c2019-11-06 22:05:291409class ChromeOsSyncedPrefRegistrationTest(unittest.TestCase):
1410
1411 def testWarnsOnChromeOsDirectories(self):
1412 input_api = MockInputApi()
1413 input_api.files = [
1414 MockFile('ash/file.cc',
1415 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1416 MockFile('chrome/browser/chromeos/file.cc',
1417 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1418 MockFile('chromeos/file.cc',
1419 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1420 MockFile('components/arc/file.cc',
1421 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1422 MockFile('components/exo/file.cc',
1423 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1424 ]
1425 warnings = PRESUBMIT._CheckChromeOsSyncedPrefRegistration(
1426 input_api, MockOutputApi())
1427 self.assertEqual(1, len(warnings))
1428
1429 def testDoesNotWarnOnSyncOsPref(self):
1430 input_api = MockInputApi()
1431 input_api.files = [
1432 MockFile('chromeos/file.cc',
1433 ['PrefRegistrySyncable::SYNCABLE_OS_PREF']),
1434 ]
1435 warnings = PRESUBMIT._CheckChromeOsSyncedPrefRegistration(
1436 input_api, MockOutputApi())
1437 self.assertEqual(0, len(warnings))
1438
1439 def testDoesNotWarnOnCrossPlatformDirectories(self):
1440 input_api = MockInputApi()
1441 input_api.files = [
1442 MockFile('chrome/browser/ui/file.cc',
1443 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1444 MockFile('components/sync/file.cc',
1445 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1446 MockFile('content/browser/file.cc',
1447 ['PrefRegistrySyncable::SYNCABLE_PREF']),
1448 ]
1449 warnings = PRESUBMIT._CheckChromeOsSyncedPrefRegistration(
1450 input_api, MockOutputApi())
1451 self.assertEqual(0, len(warnings))
1452
1453 def testSeparateWarningForPriorityPrefs(self):
1454 input_api = MockInputApi()
1455 input_api.files = [
1456 MockFile('chromeos/file.cc',
1457 ['PrefRegistrySyncable::SYNCABLE_PREF',
1458 'PrefRegistrySyncable::SYNCABLE_PRIORITY_PREF']),
1459 ]
1460 warnings = PRESUBMIT._CheckChromeOsSyncedPrefRegistration(
1461 input_api, MockOutputApi())
1462 self.assertEqual(2, len(warnings))
1463
1464
jbriance9e12f162016-11-25 07:57:501465class ForwardDeclarationTest(unittest.TestCase):
jbriance2c51e821a2016-12-12 08:24:311466 def testCheckHeadersOnlyOutsideThirdParty(self):
jbriance9e12f162016-11-25 07:57:501467 mock_input_api = MockInputApi()
1468 mock_input_api.files = [
1469 MockAffectedFile('somewhere/file.cc', [
1470 'class DummyClass;'
jbriance2c51e821a2016-12-12 08:24:311471 ]),
1472 MockAffectedFile('third_party/header.h', [
1473 'class DummyClass;'
jbriance9e12f162016-11-25 07:57:501474 ])
1475 ]
1476 warnings = PRESUBMIT._CheckUselessForwardDeclarations(mock_input_api,
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391477 MockOutputApi())
jbriance9e12f162016-11-25 07:57:501478 self.assertEqual(0, len(warnings))
1479
1480 def testNoNestedDeclaration(self):
1481 mock_input_api = MockInputApi()
1482 mock_input_api.files = [
1483 MockAffectedFile('somewhere/header.h', [
jbriance2c51e821a2016-12-12 08:24:311484 'class SomeClass {',
1485 ' protected:',
1486 ' class NotAMatch;',
jbriance9e12f162016-11-25 07:57:501487 '};'
1488 ])
1489 ]
1490 warnings = PRESUBMIT._CheckUselessForwardDeclarations(mock_input_api,
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391491 MockOutputApi())
jbriance9e12f162016-11-25 07:57:501492 self.assertEqual(0, len(warnings))
1493
1494 def testSubStrings(self):
1495 mock_input_api = MockInputApi()
1496 mock_input_api.files = [
1497 MockAffectedFile('somewhere/header.h', [
1498 'class NotUsefulClass;',
1499 'struct SomeStruct;',
1500 'UsefulClass *p1;',
1501 'SomeStructPtr *p2;'
1502 ])
1503 ]
1504 warnings = PRESUBMIT._CheckUselessForwardDeclarations(mock_input_api,
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391505 MockOutputApi())
jbriance9e12f162016-11-25 07:57:501506 self.assertEqual(2, len(warnings))
1507
1508 def testUselessForwardDeclaration(self):
1509 mock_input_api = MockInputApi()
1510 mock_input_api.files = [
1511 MockAffectedFile('somewhere/header.h', [
1512 'class DummyClass;',
1513 'struct DummyStruct;',
1514 'class UsefulClass;',
1515 'std::unique_ptr<UsefulClass> p;'
jbriance2c51e821a2016-12-12 08:24:311516 ])
jbriance9e12f162016-11-25 07:57:501517 ]
1518 warnings = PRESUBMIT._CheckUselessForwardDeclarations(mock_input_api,
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391519 MockOutputApi())
jbriance9e12f162016-11-25 07:57:501520 self.assertEqual(2, len(warnings))
1521
jbriance2c51e821a2016-12-12 08:24:311522 def testBlinkHeaders(self):
1523 mock_input_api = MockInputApi()
1524 mock_input_api.files = [
Kent Tamura32dbbcb2018-11-30 12:28:491525 MockAffectedFile('third_party/blink/header.h', [
jbriance2c51e821a2016-12-12 08:24:311526 'class DummyClass;',
1527 'struct DummyStruct;',
1528 ]),
Kent Tamura32dbbcb2018-11-30 12:28:491529 MockAffectedFile('third_party\\blink\\header.h', [
jbriance2c51e821a2016-12-12 08:24:311530 'class DummyClass;',
1531 'struct DummyStruct;',
1532 ])
1533 ]
1534 warnings = PRESUBMIT._CheckUselessForwardDeclarations(mock_input_api,
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:391535 MockOutputApi())
jbriance2c51e821a2016-12-12 08:24:311536 self.assertEqual(4, len(warnings))
1537
jbriance9e12f162016-11-25 07:57:501538
rlanday6802cf632017-05-30 17:48:361539class RelativeIncludesTest(unittest.TestCase):
1540 def testThirdPartyNotWebKitIgnored(self):
1541 mock_input_api = MockInputApi()
1542 mock_input_api.files = [
1543 MockAffectedFile('third_party/test.cpp', '#include "../header.h"'),
1544 MockAffectedFile('third_party/test/test.cpp', '#include "../header.h"'),
1545 ]
1546
1547 mock_output_api = MockOutputApi()
1548
1549 errors = PRESUBMIT._CheckForRelativeIncludes(
1550 mock_input_api, mock_output_api)
1551 self.assertEqual(0, len(errors))
1552
1553 def testNonCppFileIgnored(self):
1554 mock_input_api = MockInputApi()
1555 mock_input_api.files = [
1556 MockAffectedFile('test.py', '#include "../header.h"'),
1557 ]
1558
1559 mock_output_api = MockOutputApi()
1560
1561 errors = PRESUBMIT._CheckForRelativeIncludes(
1562 mock_input_api, mock_output_api)
1563 self.assertEqual(0, len(errors))
1564
1565 def testInnocuousChangesAllowed(self):
1566 mock_input_api = MockInputApi()
1567 mock_input_api.files = [
1568 MockAffectedFile('test.cpp', '#include "header.h"'),
1569 MockAffectedFile('test2.cpp', '../'),
1570 ]
1571
1572 mock_output_api = MockOutputApi()
1573
1574 errors = PRESUBMIT._CheckForRelativeIncludes(
1575 mock_input_api, mock_output_api)
1576 self.assertEqual(0, len(errors))
1577
1578 def testRelativeIncludeNonWebKitProducesError(self):
1579 mock_input_api = MockInputApi()
1580 mock_input_api.files = [
1581 MockAffectedFile('test.cpp', ['#include "../header.h"']),
1582 ]
1583
1584 mock_output_api = MockOutputApi()
1585
1586 errors = PRESUBMIT._CheckForRelativeIncludes(
1587 mock_input_api, mock_output_api)
1588 self.assertEqual(1, len(errors))
1589
1590 def testRelativeIncludeWebKitProducesError(self):
1591 mock_input_api = MockInputApi()
1592 mock_input_api.files = [
Kent Tamura32dbbcb2018-11-30 12:28:491593 MockAffectedFile('third_party/blink/test.cpp',
rlanday6802cf632017-05-30 17:48:361594 ['#include "../header.h']),
1595 ]
1596
1597 mock_output_api = MockOutputApi()
1598
1599 errors = PRESUBMIT._CheckForRelativeIncludes(
1600 mock_input_api, mock_output_api)
1601 self.assertEqual(1, len(errors))
dbeam1ec68ac2016-12-15 05:22:241602
Daniel Cheng13ca61a882017-08-25 15:11:251603
Daniel Bratell65b033262019-04-23 08:17:061604class CCIncludeTest(unittest.TestCase):
1605 def testThirdPartyNotBlinkIgnored(self):
1606 mock_input_api = MockInputApi()
1607 mock_input_api.files = [
1608 MockAffectedFile('third_party/test.cpp', '#include "file.cc"'),
1609 ]
1610
1611 mock_output_api = MockOutputApi()
1612
1613 errors = PRESUBMIT._CheckForCcIncludes(
1614 mock_input_api, mock_output_api)
1615 self.assertEqual(0, len(errors))
1616
1617 def testPythonFileIgnored(self):
1618 mock_input_api = MockInputApi()
1619 mock_input_api.files = [
1620 MockAffectedFile('test.py', '#include "file.cc"'),
1621 ]
1622
1623 mock_output_api = MockOutputApi()
1624
1625 errors = PRESUBMIT._CheckForCcIncludes(
1626 mock_input_api, mock_output_api)
1627 self.assertEqual(0, len(errors))
1628
1629 def testIncFilesAccepted(self):
1630 mock_input_api = MockInputApi()
1631 mock_input_api.files = [
1632 MockAffectedFile('test.py', '#include "file.inc"'),
1633 ]
1634
1635 mock_output_api = MockOutputApi()
1636
1637 errors = PRESUBMIT._CheckForCcIncludes(
1638 mock_input_api, mock_output_api)
1639 self.assertEqual(0, len(errors))
1640
1641 def testInnocuousChangesAllowed(self):
1642 mock_input_api = MockInputApi()
1643 mock_input_api.files = [
1644 MockAffectedFile('test.cpp', '#include "header.h"'),
1645 MockAffectedFile('test2.cpp', 'Something "file.cc"'),
1646 ]
1647
1648 mock_output_api = MockOutputApi()
1649
1650 errors = PRESUBMIT._CheckForCcIncludes(
1651 mock_input_api, mock_output_api)
1652 self.assertEqual(0, len(errors))
1653
1654 def testCcIncludeNonBlinkProducesError(self):
1655 mock_input_api = MockInputApi()
1656 mock_input_api.files = [
1657 MockAffectedFile('test.cpp', ['#include "file.cc"']),
1658 ]
1659
1660 mock_output_api = MockOutputApi()
1661
1662 errors = PRESUBMIT._CheckForCcIncludes(
1663 mock_input_api, mock_output_api)
1664 self.assertEqual(1, len(errors))
1665
1666 def testCppIncludeBlinkProducesError(self):
1667 mock_input_api = MockInputApi()
1668 mock_input_api.files = [
1669 MockAffectedFile('third_party/blink/test.cpp',
1670 ['#include "foo/file.cpp"']),
1671 ]
1672
1673 mock_output_api = MockOutputApi()
1674
1675 errors = PRESUBMIT._CheckForCcIncludes(
1676 mock_input_api, mock_output_api)
1677 self.assertEqual(1, len(errors))
1678
1679
Wei-Yin Chen (陳威尹)c0624d002018-07-30 18:22:191680class NewHeaderWithoutGnChangeTest(unittest.TestCase):
1681 def testAddHeaderWithoutGn(self):
1682 mock_input_api = MockInputApi()
1683 mock_input_api.files = [
1684 MockAffectedFile('base/stuff.h', ''),
1685 ]
1686 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1687 mock_input_api, MockOutputApi())
1688 self.assertEqual(1, len(warnings))
1689 self.assertTrue('base/stuff.h' in warnings[0].items)
1690
1691 def testModifyHeader(self):
1692 mock_input_api = MockInputApi()
1693 mock_input_api.files = [
1694 MockAffectedFile('base/stuff.h', '', action='M'),
1695 ]
1696 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1697 mock_input_api, MockOutputApi())
1698 self.assertEqual(0, len(warnings))
1699
1700 def testDeleteHeader(self):
1701 mock_input_api = MockInputApi()
1702 mock_input_api.files = [
1703 MockAffectedFile('base/stuff.h', '', action='D'),
1704 ]
1705 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1706 mock_input_api, MockOutputApi())
1707 self.assertEqual(0, len(warnings))
1708
1709 def testAddHeaderWithGn(self):
1710 mock_input_api = MockInputApi()
1711 mock_input_api.files = [
1712 MockAffectedFile('base/stuff.h', ''),
1713 MockAffectedFile('base/BUILD.gn', 'stuff.h'),
1714 ]
1715 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1716 mock_input_api, MockOutputApi())
1717 self.assertEqual(0, len(warnings))
1718
1719 def testAddHeaderWithGni(self):
1720 mock_input_api = MockInputApi()
1721 mock_input_api.files = [
1722 MockAffectedFile('base/stuff.h', ''),
1723 MockAffectedFile('base/files.gni', 'stuff.h'),
1724 ]
1725 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1726 mock_input_api, MockOutputApi())
1727 self.assertEqual(0, len(warnings))
1728
1729 def testAddHeaderWithOther(self):
1730 mock_input_api = MockInputApi()
1731 mock_input_api.files = [
1732 MockAffectedFile('base/stuff.h', ''),
1733 MockAffectedFile('base/stuff.cc', 'stuff.h'),
1734 ]
1735 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1736 mock_input_api, MockOutputApi())
1737 self.assertEqual(1, len(warnings))
1738
1739 def testAddHeaderWithWrongGn(self):
1740 mock_input_api = MockInputApi()
1741 mock_input_api.files = [
1742 MockAffectedFile('base/stuff.h', ''),
1743 MockAffectedFile('base/BUILD.gn', 'stuff_h'),
1744 ]
1745 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1746 mock_input_api, MockOutputApi())
1747 self.assertEqual(1, len(warnings))
1748
1749 def testAddHeadersWithGn(self):
1750 mock_input_api = MockInputApi()
1751 mock_input_api.files = [
1752 MockAffectedFile('base/stuff.h', ''),
1753 MockAffectedFile('base/another.h', ''),
1754 MockAffectedFile('base/BUILD.gn', 'another.h\nstuff.h'),
1755 ]
1756 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1757 mock_input_api, MockOutputApi())
1758 self.assertEqual(0, len(warnings))
1759
1760 def testAddHeadersWithWrongGn(self):
1761 mock_input_api = MockInputApi()
1762 mock_input_api.files = [
1763 MockAffectedFile('base/stuff.h', ''),
1764 MockAffectedFile('base/another.h', ''),
1765 MockAffectedFile('base/BUILD.gn', 'another_h\nstuff.h'),
1766 ]
1767 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1768 mock_input_api, MockOutputApi())
1769 self.assertEqual(1, len(warnings))
1770 self.assertFalse('base/stuff.h' in warnings[0].items)
1771 self.assertTrue('base/another.h' in warnings[0].items)
1772
1773 def testAddHeadersWithWrongGn2(self):
1774 mock_input_api = MockInputApi()
1775 mock_input_api.files = [
1776 MockAffectedFile('base/stuff.h', ''),
1777 MockAffectedFile('base/another.h', ''),
1778 MockAffectedFile('base/BUILD.gn', 'another_h\nstuff_h'),
1779 ]
1780 warnings = PRESUBMIT._CheckNewHeaderWithoutGnChange(
1781 mock_input_api, MockOutputApi())
1782 self.assertEqual(1, len(warnings))
1783 self.assertTrue('base/stuff.h' in warnings[0].items)
1784 self.assertTrue('base/another.h' in warnings[0].items)
1785
1786
Michael Giuffridad3bc8672018-10-25 22:48:021787class CorrectProductNameInMessagesTest(unittest.TestCase):
1788 def testProductNameInDesc(self):
1789 mock_input_api = MockInputApi()
1790 mock_input_api.files = [
1791 MockAffectedFile('chrome/app/google_chrome_strings.grd', [
1792 '<message name="Foo" desc="Welcome to Chrome">',
1793 ' Welcome to Chrome!',
1794 '</message>',
1795 ]),
1796 MockAffectedFile('chrome/app/chromium_strings.grd', [
1797 '<message name="Bar" desc="Welcome to Chrome">',
1798 ' Welcome to Chromium!',
1799 '</message>',
1800 ]),
1801 ]
1802 warnings = PRESUBMIT._CheckCorrectProductNameInMessages(
1803 mock_input_api, MockOutputApi())
1804 self.assertEqual(0, len(warnings))
1805
1806 def testChromeInChromium(self):
1807 mock_input_api = MockInputApi()
1808 mock_input_api.files = [
1809 MockAffectedFile('chrome/app/google_chrome_strings.grd', [
1810 '<message name="Foo" desc="Welcome to Chrome">',
1811 ' Welcome to Chrome!',
1812 '</message>',
1813 ]),
1814 MockAffectedFile('chrome/app/chromium_strings.grd', [
1815 '<message name="Bar" desc="Welcome to Chrome">',
1816 ' Welcome to Chrome!',
1817 '</message>',
1818 ]),
1819 ]
1820 warnings = PRESUBMIT._CheckCorrectProductNameInMessages(
1821 mock_input_api, MockOutputApi())
1822 self.assertEqual(1, len(warnings))
1823 self.assertTrue('chrome/app/chromium_strings.grd' in warnings[0].items[0])
1824
1825 def testChromiumInChrome(self):
1826 mock_input_api = MockInputApi()
1827 mock_input_api.files = [
1828 MockAffectedFile('chrome/app/google_chrome_strings.grd', [
1829 '<message name="Foo" desc="Welcome to Chrome">',
1830 ' Welcome to Chromium!',
1831 '</message>',
1832 ]),
1833 MockAffectedFile('chrome/app/chromium_strings.grd', [
1834 '<message name="Bar" desc="Welcome to Chrome">',
1835 ' Welcome to Chromium!',
1836 '</message>',
1837 ]),
1838 ]
1839 warnings = PRESUBMIT._CheckCorrectProductNameInMessages(
1840 mock_input_api, MockOutputApi())
1841 self.assertEqual(1, len(warnings))
1842 self.assertTrue(
1843 'chrome/app/google_chrome_strings.grd:2' in warnings[0].items[0])
1844
1845 def testMultipleInstances(self):
1846 mock_input_api = MockInputApi()
1847 mock_input_api.files = [
1848 MockAffectedFile('chrome/app/chromium_strings.grd', [
1849 '<message name="Bar" desc="Welcome to Chrome">',
1850 ' Welcome to Chrome!',
1851 '</message>',
1852 '<message name="Baz" desc="A correct message">',
1853 ' Chromium is the software you are using.',
1854 '</message>',
1855 '<message name="Bat" desc="An incorrect message">',
1856 ' Google Chrome is the software you are using.',
1857 '</message>',
1858 ]),
1859 ]
1860 warnings = PRESUBMIT._CheckCorrectProductNameInMessages(
1861 mock_input_api, MockOutputApi())
1862 self.assertEqual(1, len(warnings))
1863 self.assertTrue(
1864 'chrome/app/chromium_strings.grd:2' in warnings[0].items[0])
1865 self.assertTrue(
1866 'chrome/app/chromium_strings.grd:8' in warnings[0].items[1])
1867
1868 def testMultipleWarnings(self):
1869 mock_input_api = MockInputApi()
1870 mock_input_api.files = [
1871 MockAffectedFile('chrome/app/chromium_strings.grd', [
1872 '<message name="Bar" desc="Welcome to Chrome">',
1873 ' Welcome to Chrome!',
1874 '</message>',
1875 '<message name="Baz" desc="A correct message">',
1876 ' Chromium is the software you are using.',
1877 '</message>',
1878 '<message name="Bat" desc="An incorrect message">',
1879 ' Google Chrome is the software you are using.',
1880 '</message>',
1881 ]),
1882 MockAffectedFile('components/components_google_chrome_strings.grd', [
1883 '<message name="Bar" desc="Welcome to Chrome">',
1884 ' Welcome to Chrome!',
1885 '</message>',
1886 '<message name="Baz" desc="A correct message">',
1887 ' Chromium is the software you are using.',
1888 '</message>',
1889 '<message name="Bat" desc="An incorrect message">',
1890 ' Google Chrome is the software you are using.',
1891 '</message>',
1892 ]),
1893 ]
1894 warnings = PRESUBMIT._CheckCorrectProductNameInMessages(
1895 mock_input_api, MockOutputApi())
1896 self.assertEqual(2, len(warnings))
1897 self.assertTrue(
1898 'components/components_google_chrome_strings.grd:5'
1899 in warnings[0].items[0])
1900 self.assertTrue(
1901 'chrome/app/chromium_strings.grd:2' in warnings[1].items[0])
1902 self.assertTrue(
1903 'chrome/app/chromium_strings.grd:8' in warnings[1].items[1])
1904
1905
Ken Rockot9f668262018-12-21 18:56:361906class ServiceManifestOwnerTest(unittest.TestCase):
1907 def testServiceManifestJsonChangeNeedsSecurityOwner(self):
Daniel Cheng13ca61a882017-08-25 15:11:251908 mock_input_api = MockInputApi()
1909 mock_input_api.files = [
1910 MockAffectedFile('services/goat/manifest.json',
1911 [
1912 '{',
1913 ' "name": "teleporter",',
1914 ' "display_name": "Goat Teleporter",'
1915 ' "interface_provider_specs": {',
1916 ' }',
1917 '}',
1918 ])
1919 ]
1920 mock_output_api = MockOutputApi()
1921 errors = PRESUBMIT._CheckIpcOwners(
1922 mock_input_api, mock_output_api)
1923 self.assertEqual(1, len(errors))
1924 self.assertEqual(
1925 'Found OWNERS files that need to be updated for IPC security review ' +
1926 'coverage.\nPlease update the OWNERS files below:', errors[0].message)
1927
1928 # No warning if already covered by an OWNERS rule.
1929
Ken Rockot9f668262018-12-21 18:56:361930 def testNonManifestJsonChangesDoNotRequireSecurityOwner(self):
Daniel Cheng13ca61a882017-08-25 15:11:251931 mock_input_api = MockInputApi()
1932 mock_input_api.files = [
1933 MockAffectedFile('services/goat/species.json',
1934 [
1935 '[',
1936 ' "anglo-nubian",',
1937 ' "angora"',
1938 ']',
1939 ])
1940 ]
1941 mock_output_api = MockOutputApi()
1942 errors = PRESUBMIT._CheckIpcOwners(
1943 mock_input_api, mock_output_api)
1944 self.assertEqual([], errors)
1945
Ken Rockot9f668262018-12-21 18:56:361946 def testServiceManifestChangeNeedsSecurityOwner(self):
1947 mock_input_api = MockInputApi()
1948 mock_input_api.files = [
1949 MockAffectedFile('services/goat/public/cpp/manifest.cc',
1950 [
1951 '#include "services/goat/public/cpp/manifest.h"',
1952 'const service_manager::Manifest& GetManifest() {}',
1953 ])]
1954 mock_output_api = MockOutputApi()
1955 errors = PRESUBMIT._CheckIpcOwners(
1956 mock_input_api, mock_output_api)
1957 self.assertEqual(1, len(errors))
1958 self.assertEqual(
1959 'Found OWNERS files that need to be updated for IPC security review ' +
1960 'coverage.\nPlease update the OWNERS files below:', errors[0].message)
1961
1962 def testNonServiceManifestSourceChangesDoNotRequireSecurityOwner(self):
1963 mock_input_api = MockInputApi()
1964 mock_input_api.files = [
1965 MockAffectedFile('some/non/service/thing/foo_manifest.cc',
1966 [
1967 'const char kNoEnforcement[] = "not a manifest!";',
1968 ])]
1969 mock_output_api = MockOutputApi()
1970 errors = PRESUBMIT._CheckIpcOwners(
1971 mock_input_api, mock_output_api)
1972 self.assertEqual([], errors)
1973
Daniel Cheng13ca61a882017-08-25 15:11:251974
Mario Sanchez Prada2472cab2019-09-18 10:58:311975class BannedTypeCheckTest(unittest.TestCase):
Sylvain Defresnea8b73d252018-02-28 15:45:541976
Peter Kasting94a56c42019-10-25 21:54:041977 def testBannedCppFunctions(self):
1978 input_api = MockInputApi()
1979 input_api.files = [
1980 MockFile('some/cpp/problematic/file.cc',
1981 ['using namespace std;']),
Oksana Zhuravlovac8222d22019-12-19 19:21:161982 MockFile('third_party/blink/problematic/file.cc',
1983 ['GetInterfaceProvider()']),
Peter Kasting94a56c42019-10-25 21:54:041984 MockFile('some/cpp/ok/file.cc',
1985 ['using std::string;']),
Allen Bauer53b43fb12020-03-12 17:21:471986 MockFile('some/cpp/problematic/file2.cc',
1987 ['set_owned_by_client()']),
Peter Kasting94a56c42019-10-25 21:54:041988 ]
1989
Oksana Zhuravlovac8222d22019-12-19 19:21:161990 results = PRESUBMIT._CheckNoBannedFunctions(input_api, MockOutputApi())
1991
1992 # warnings are results[0], errors are results[1]
1993 self.assertEqual(2, len(results))
1994 self.assertTrue('some/cpp/problematic/file.cc' in results[1].message)
1995 self.assertTrue(
1996 'third_party/blink/problematic/file.cc' in results[0].message)
1997 self.assertTrue('some/cpp/ok/file.cc' not in results[1].message)
Allen Bauer53b43fb12020-03-12 17:21:471998 self.assertTrue('some/cpp/problematic/file2.cc' in results[0].message)
Peter Kasting94a56c42019-10-25 21:54:041999
Abhijeet Kandalkar1e7c2502019-10-29 15:05:452000 def testBannedBlinkDowncastHelpers(self):
2001 input_api = MockInputApi()
2002 input_api.files = [
2003 MockFile('some/cpp/problematic/file1.cc',
2004 ['DEFINE_TYPE_CASTS(ToType, FromType, from_argument,'
2005 'PointerPredicate(), ReferencePredicate());']),
2006 MockFile('some/cpp/problematic/file2.cc',
2007 ['bool is_test_ele = IsHTMLTestElement(n);']),
2008 MockFile('some/cpp/problematic/file3.cc',
2009 ['auto* html_test_ele = ToHTMLTestElement(n);']),
2010 MockFile('some/cpp/problematic/file4.cc',
2011 ['auto* html_test_ele_or_null = ToHTMLTestElementOrNull(n);']),
2012 MockFile('some/cpp/ok/file1.cc',
2013 ['bool is_test_ele = IsA<HTMLTestElement>(n);']),
2014 MockFile('some/cpp/ok/file2.cc',
2015 ['auto* html_test_ele = To<HTMLTestElement>(n);']),
2016 MockFile('some/cpp/ok/file3.cc',
2017 ['auto* html_test_ele_or_null = ',
2018 'DynamicTo<HTMLTestElement>(n);']),
2019 ]
2020
2021 # warnings are errors[0], errors are errors[1]
2022 errors = PRESUBMIT._CheckNoBannedFunctions(input_api, MockOutputApi())
2023 self.assertEqual(2, len(errors))
2024 self.assertTrue('some/cpp/problematic/file1.cc' in errors[1].message)
2025 self.assertTrue('some/cpp/problematic/file2.cc' in errors[0].message)
2026 self.assertTrue('some/cpp/problematic/file3.cc' in errors[0].message)
2027 self.assertTrue('some/cpp/problematic/file4.cc' in errors[0].message)
2028 self.assertTrue('some/cpp/ok/file1.cc' not in errors[0].message)
2029 self.assertTrue('some/cpp/ok/file2.cc' not in errors[0].message)
2030 self.assertTrue('some/cpp/ok/file3.cc' not in errors[0].message)
2031
Peter K. Lee6c03ccff2019-07-15 14:40:052032 def testBannedIosObjcFunctions(self):
Sylvain Defresnea8b73d252018-02-28 15:45:542033 input_api = MockInputApi()
2034 input_api.files = [
2035 MockFile('some/ios/file.mm',
2036 ['TEST(SomeClassTest, SomeInteraction) {',
2037 '}']),
2038 MockFile('some/mac/file.mm',
2039 ['TEST(SomeClassTest, SomeInteraction) {',
2040 '}']),
2041 MockFile('another/ios_file.mm',
2042 ['class SomeTest : public testing::Test {};']),
Peter K. Lee6c03ccff2019-07-15 14:40:052043 MockFile('some/ios/file_egtest.mm',
2044 ['- (void)testSomething { EXPECT_OCMOCK_VERIFY(aMock); }']),
2045 MockFile('some/ios/file_unittest.mm',
2046 ['TEST_F(SomeTest, TestThis) { EXPECT_OCMOCK_VERIFY(aMock); }']),
Sylvain Defresnea8b73d252018-02-28 15:45:542047 ]
2048
2049 errors = PRESUBMIT._CheckNoBannedFunctions(input_api, MockOutputApi())
2050 self.assertEqual(1, len(errors))
2051 self.assertTrue('some/ios/file.mm' in errors[0].message)
2052 self.assertTrue('another/ios_file.mm' in errors[0].message)
2053 self.assertTrue('some/mac/file.mm' not in errors[0].message)
Peter K. Lee6c03ccff2019-07-15 14:40:052054 self.assertTrue('some/ios/file_egtest.mm' in errors[0].message)
2055 self.assertTrue('some/ios/file_unittest.mm' not in errors[0].message)
Sylvain Defresnea8b73d252018-02-28 15:45:542056
Carlos Knippschildab192b8c2019-04-08 20:02:382057 def testBannedMojoFunctions(self):
2058 input_api = MockInputApi()
2059 input_api.files = [
2060 MockFile('some/cpp/problematic/file.cc',
2061 ['mojo::DataPipe();']),
Oksana Zhuravlovafd247772019-05-16 16:57:292062 MockFile('some/cpp/problematic/file2.cc',
2063 ['mojo::ConvertTo<>']),
Carlos Knippschildab192b8c2019-04-08 20:02:382064 MockFile('some/cpp/ok/file.cc',
2065 ['CreateDataPipe();']),
Kinuko Yasuda376c2ce12019-04-16 01:20:372066 MockFile('some/cpp/ok/file2.cc',
2067 ['mojo::DataPipeDrainer();']),
Oksana Zhuravlovafd247772019-05-16 16:57:292068 MockFile('third_party/blink/ok/file3.cc',
2069 ['mojo::ConvertTo<>']),
2070 MockFile('content/renderer/ok/file3.cc',
2071 ['mojo::ConvertTo<>']),
Carlos Knippschildab192b8c2019-04-08 20:02:382072 ]
2073
Oksana Zhuravlova1d3b59de2019-05-17 00:08:222074 results = PRESUBMIT._CheckNoBannedFunctions(input_api, MockOutputApi())
2075
2076 # warnings are results[0], errors are results[1]
2077 self.assertEqual(2, len(results))
2078 self.assertTrue('some/cpp/problematic/file.cc' in results[1].message)
2079 self.assertTrue('some/cpp/problematic/file2.cc' in results[0].message)
2080 self.assertTrue('some/cpp/ok/file.cc' not in results[1].message)
2081 self.assertTrue('some/cpp/ok/file2.cc' not in results[1].message)
2082 self.assertTrue('third_party/blink/ok/file3.cc' not in results[0].message)
2083 self.assertTrue('content/renderer/ok/file3.cc' not in results[0].message)
Carlos Knippschildab192b8c2019-04-08 20:02:382084
Mario Sanchez Prada2472cab2019-09-18 10:58:312085 def testDeprecatedMojoTypes(self):
Mario Sanchez Pradacec9cef2019-12-15 11:54:572086 ok_paths = ['components/arc']
2087 warning_paths = ['some/cpp']
Mario Sanchez Pradaaab91382019-12-19 08:57:092088 error_paths = ['third_party/blink', 'content']
Mario Sanchez Prada2472cab2019-09-18 10:58:312089 test_cases = [
2090 {
2091 'type': 'mojo::AssociatedBinding<>;',
2092 'file': 'file1.c'
2093 },
2094 {
2095 'type': 'mojo::AssociatedBindingSet<>;',
2096 'file': 'file2.c'
2097 },
2098 {
2099 'type': 'mojo::AssociatedInterfacePtr<>',
2100 'file': 'file3.cc'
2101 },
2102 {
2103 'type': 'mojo::AssociatedInterfacePtrInfo<>',
2104 'file': 'file4.cc'
2105 },
2106 {
2107 'type': 'mojo::AssociatedInterfaceRequest<>',
2108 'file': 'file5.cc'
2109 },
2110 {
2111 'type': 'mojo::Binding<>',
2112 'file': 'file6.cc'
2113 },
2114 {
2115 'type': 'mojo::BindingSet<>',
2116 'file': 'file7.cc'
2117 },
2118 {
2119 'type': 'mojo::InterfacePtr<>',
2120 'file': 'file8.cc'
2121 },
2122 {
2123 'type': 'mojo::InterfacePtrInfo<>',
2124 'file': 'file9.cc'
2125 },
2126 {
2127 'type': 'mojo::InterfaceRequest<>',
2128 'file': 'file10.cc'
2129 },
2130 {
2131 'type': 'mojo::MakeRequest()',
2132 'file': 'file11.cc'
2133 },
2134 {
2135 'type': 'mojo::MakeRequestAssociatedWithDedicatedPipe()',
2136 'file': 'file12.cc'
2137 },
2138 {
2139 'type': 'mojo::MakeStrongBinding()<>',
2140 'file': 'file13.cc'
2141 },
2142 {
2143 'type': 'mojo::MakeStrongAssociatedBinding()<>',
2144 'file': 'file14.cc'
2145 },
2146 {
2147 'type': 'mojo::StrongAssociatedBindingSet<>',
2148 'file': 'file15.cc'
2149 },
2150 {
2151 'type': 'mojo::StrongBindingSet<>',
2152 'file': 'file16.cc'
2153 },
2154 ]
2155
2156 # Build the list of MockFiles considering paths that should trigger warnings
Mario Sanchez Pradacec9cef2019-12-15 11:54:572157 # as well as paths that should trigger errors.
Mario Sanchez Prada2472cab2019-09-18 10:58:312158 input_api = MockInputApi()
2159 input_api.files = []
2160 for test_case in test_cases:
2161 for path in ok_paths:
2162 input_api.files.append(MockFile(os.path.join(path, test_case['file']),
2163 [test_case['type']]))
2164 for path in warning_paths:
2165 input_api.files.append(MockFile(os.path.join(path, test_case['file']),
2166 [test_case['type']]))
Mario Sanchez Pradacec9cef2019-12-15 11:54:572167 for path in error_paths:
2168 input_api.files.append(MockFile(os.path.join(path, test_case['file']),
2169 [test_case['type']]))
Mario Sanchez Prada2472cab2019-09-18 10:58:312170
2171 results = PRESUBMIT._CheckNoDeprecatedMojoTypes(input_api, MockOutputApi())
2172
Mario Sanchez Pradacec9cef2019-12-15 11:54:572173 # warnings are results[0], errors are results[1]
2174 self.assertEqual(2, len(results))
Mario Sanchez Prada2472cab2019-09-18 10:58:312175
2176 for test_case in test_cases:
Mario Sanchez Pradacec9cef2019-12-15 11:54:572177 # Check that no warnings nor errors have been triggered for these paths.
Mario Sanchez Prada2472cab2019-09-18 10:58:312178 for path in ok_paths:
2179 self.assertFalse(path in results[0].message)
Mario Sanchez Pradacec9cef2019-12-15 11:54:572180 self.assertFalse(path in results[1].message)
Mario Sanchez Prada2472cab2019-09-18 10:58:312181
2182 # Check warnings have been triggered for these paths.
2183 for path in warning_paths:
2184 self.assertTrue(path in results[0].message)
Mario Sanchez Pradacec9cef2019-12-15 11:54:572185 self.assertFalse(path in results[1].message)
2186
2187 # Check errors have been triggered for these paths.
2188 for path in error_paths:
2189 self.assertFalse(path in results[0].message)
2190 self.assertTrue(path in results[1].message)
Mario Sanchez Prada2472cab2019-09-18 10:58:312191
Sylvain Defresnea8b73d252018-02-28 15:45:542192
Wei-Yin Chen (陳威尹)032f1ac2018-07-27 21:21:272193class NoProductionCodeUsingTestOnlyFunctionsTest(unittest.TestCase):
Vaclav Brozekf01ed502018-03-16 19:38:242194 def testTruePositives(self):
2195 mock_input_api = MockInputApi()
2196 mock_input_api.files = [
2197 MockFile('some/path/foo.cc', ['foo_for_testing();']),
2198 MockFile('some/path/foo.mm', ['FooForTesting();']),
2199 MockFile('some/path/foo.cxx', ['FooForTests();']),
2200 MockFile('some/path/foo.cpp', ['foo_for_test();']),
2201 ]
2202
2203 results = PRESUBMIT._CheckNoProductionCodeUsingTestOnlyFunctions(
2204 mock_input_api, MockOutputApi())
2205 self.assertEqual(1, len(results))
2206 self.assertEqual(4, len(results[0].items))
2207 self.assertTrue('foo.cc' in results[0].items[0])
2208 self.assertTrue('foo.mm' in results[0].items[1])
2209 self.assertTrue('foo.cxx' in results[0].items[2])
2210 self.assertTrue('foo.cpp' in results[0].items[3])
2211
2212 def testFalsePositives(self):
2213 mock_input_api = MockInputApi()
2214 mock_input_api.files = [
2215 MockFile('some/path/foo.h', ['foo_for_testing();']),
2216 MockFile('some/path/foo.mm', ['FooForTesting() {']),
2217 MockFile('some/path/foo.cc', ['::FooForTests();']),
2218 MockFile('some/path/foo.cpp', ['// foo_for_test();']),
2219 ]
2220
2221 results = PRESUBMIT._CheckNoProductionCodeUsingTestOnlyFunctions(
2222 mock_input_api, MockOutputApi())
2223 self.assertEqual(0, len(results))
2224
2225
Wei-Yin Chen (陳威尹)032f1ac2018-07-27 21:21:272226class NoProductionJavaCodeUsingTestOnlyFunctionsTest(unittest.TestCase):
Vaclav Brozek7dbc28c2018-03-27 08:35:232227 def testTruePositives(self):
2228 mock_input_api = MockInputApi()
2229 mock_input_api.files = [
2230 MockFile('dir/java/src/foo.java', ['FooForTesting();']),
2231 MockFile('dir/java/src/bar.java', ['FooForTests(x);']),
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:392232 MockFile('dir/java/src/baz.java', ['FooForTest(', 'y', ');']),
Vaclav Brozek7dbc28c2018-03-27 08:35:232233 MockFile('dir/java/src/mult.java', [
2234 'int x = SomethingLongHere()',
2235 ' * SomethingLongHereForTesting();'
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:392236 ])
Vaclav Brozek7dbc28c2018-03-27 08:35:232237 ]
2238
2239 results = PRESUBMIT._CheckNoProductionCodeUsingTestOnlyFunctionsJava(
2240 mock_input_api, MockOutputApi())
2241 self.assertEqual(1, len(results))
2242 self.assertEqual(4, len(results[0].items))
2243 self.assertTrue('foo.java' in results[0].items[0])
2244 self.assertTrue('bar.java' in results[0].items[1])
2245 self.assertTrue('baz.java' in results[0].items[2])
2246 self.assertTrue('mult.java' in results[0].items[3])
2247
2248 def testFalsePositives(self):
2249 mock_input_api = MockInputApi()
2250 mock_input_api.files = [
2251 MockFile('dir/java/src/foo.xml', ['FooForTesting();']),
2252 MockFile('dir/java/src/foo.java', ['FooForTests() {']),
2253 MockFile('dir/java/src/bar.java', ['// FooForTest();']),
2254 MockFile('dir/java/src/bar2.java', ['x = 1; // FooForTest();']),
Wei-Yin Chen (陳威尹)54086c212018-07-27 21:41:392255 MockFile('dir/javatests/src/baz.java', ['FooForTest(', 'y', ');']),
2256 MockFile('dir/junit/src/baz.java', ['FooForTest(', 'y', ');']),
Vaclav Brozek7dbc28c2018-03-27 08:35:232257 MockFile('dir/junit/src/javadoc.java', [
2258 '/** Use FooForTest(); to obtain foo in tests.'
2259 ' */'
2260 ]),
2261 MockFile('dir/junit/src/javadoc2.java', [
2262 '/** ',
2263 ' * Use FooForTest(); to obtain foo in tests.'
2264 ' */'
2265 ]),
2266 ]
2267
2268 results = PRESUBMIT._CheckNoProductionCodeUsingTestOnlyFunctionsJava(
2269 mock_input_api, MockOutputApi())
2270 self.assertEqual(0, len(results))
2271
2272
Mohamed Heikald048240a2019-11-12 16:57:372273class NewImagesWarningTest(unittest.TestCase):
2274 def testTruePositives(self):
2275 mock_input_api = MockInputApi()
2276 mock_input_api.files = [
2277 MockFile('dir/android/res/drawable/foo.png', []),
2278 MockFile('dir/android/res/drawable-v21/bar.svg', []),
2279 MockFile('dir/android/res/mipmap-v21-en/baz.webp', []),
2280 MockFile('dir/android/res_gshoe/drawable-mdpi/foobar.png', []),
2281 ]
2282
2283 results = PRESUBMIT._CheckNewImagesWarning(mock_input_api, MockOutputApi())
2284 self.assertEqual(1, len(results))
2285 self.assertEqual(4, len(results[0].items))
2286 self.assertTrue('foo.png' in results[0].items[0].LocalPath())
2287 self.assertTrue('bar.svg' in results[0].items[1].LocalPath())
2288 self.assertTrue('baz.webp' in results[0].items[2].LocalPath())
2289 self.assertTrue('foobar.png' in results[0].items[3].LocalPath())
2290
2291 def testFalsePositives(self):
2292 mock_input_api = MockInputApi()
2293 mock_input_api.files = [
2294 MockFile('dir/pngs/README.md', []),
2295 MockFile('java/test/res/drawable/foo.png', []),
2296 MockFile('third_party/blink/foo.png', []),
2297 MockFile('dir/third_party/libpng/src/foo.cc', ['foobar']),
2298 MockFile('dir/resources.webp/.gitignore', ['foo.png']),
2299 ]
2300
2301 results = PRESUBMIT._CheckNewImagesWarning(mock_input_api, MockOutputApi())
2302 self.assertEqual(0, len(results))
2303
2304
Wei-Yin Chen (陳威尹)032f1ac2018-07-27 21:21:272305class CheckUniquePtrTest(unittest.TestCase):
Vaclav Brozek851d9602018-04-04 16:13:052306 def testTruePositivesNullptr(self):
2307 mock_input_api = MockInputApi()
2308 mock_input_api.files = [
Vaclav Brozekc2fecf42018-04-06 16:40:162309 MockFile('dir/baz.cc', ['std::unique_ptr<T>()']),
2310 MockFile('dir/baz-p.cc', ['std::unique_ptr<T<P>>()']),
Vaclav Brozek851d9602018-04-04 16:13:052311 ]
2312
2313 results = PRESUBMIT._CheckUniquePtr(mock_input_api, MockOutputApi())
2314 self.assertEqual(1, len(results))
Vaclav Brozekc2fecf42018-04-06 16:40:162315 self.assertTrue('nullptr' in results[0].message)
Vaclav Brozek851d9602018-04-04 16:13:052316 self.assertEqual(2, len(results[0].items))
2317 self.assertTrue('baz.cc' in results[0].items[0])
2318 self.assertTrue('baz-p.cc' in results[0].items[1])
2319
2320 def testTruePositivesConstructor(self):
Vaclav Brozek52e18bf2018-04-03 07:05:242321 mock_input_api = MockInputApi()
2322 mock_input_api.files = [
Vaclav Brozekc2fecf42018-04-06 16:40:162323 MockFile('dir/foo.cc', ['return std::unique_ptr<T>(foo);']),
2324 MockFile('dir/bar.mm', ['bar = std::unique_ptr<T>(foo)']),
2325 MockFile('dir/mult.cc', [
Vaclav Brozek95face62018-04-04 14:15:112326 'return',
2327 ' std::unique_ptr<T>(barVeryVeryLongFooSoThatItWouldNotFitAbove);'
2328 ]),
Vaclav Brozekc2fecf42018-04-06 16:40:162329 MockFile('dir/mult2.cc', [
Vaclav Brozek95face62018-04-04 14:15:112330 'barVeryVeryLongLongBaaaaaarSoThatTheLineLimitIsAlmostReached =',
2331 ' std::unique_ptr<T>(foo);'
2332 ]),
Vaclav Brozekc2fecf42018-04-06 16:40:162333 MockFile('dir/mult3.cc', [
Vaclav Brozek95face62018-04-04 14:15:112334 'bar = std::unique_ptr<T>(',
2335 ' fooVeryVeryVeryLongStillGoingWellThisWillTakeAWhileFinallyThere);'
2336 ]),
Vaclav Brozekb7fadb692018-08-30 06:39:532337 MockFile('dir/multi_arg.cc', [
2338 'auto p = std::unique_ptr<std::pair<T, D>>(new std::pair(T, D));']),
Vaclav Brozek52e18bf2018-04-03 07:05:242339 ]
2340
2341 results = PRESUBMIT._CheckUniquePtr(mock_input_api, MockOutputApi())
Vaclav Brozek851d9602018-04-04 16:13:052342 self.assertEqual(1, len(results))
Vaclav Brozekc2fecf42018-04-06 16:40:162343 self.assertTrue('std::make_unique' in results[0].message)
Vaclav Brozekb7fadb692018-08-30 06:39:532344 self.assertEqual(6, len(results[0].items))
Vaclav Brozek851d9602018-04-04 16:13:052345 self.assertTrue('foo.cc' in results[0].items[0])
2346 self.assertTrue('bar.mm' in results[0].items[1])
2347 self.assertTrue('mult.cc' in results[0].items[2])
2348 self.assertTrue('mult2.cc' in results[0].items[3])
2349 self.assertTrue('mult3.cc' in results[0].items[4])
Vaclav Brozekb7fadb692018-08-30 06:39:532350 self.assertTrue('multi_arg.cc' in results[0].items[5])
Vaclav Brozek52e18bf2018-04-03 07:05:242351
2352 def testFalsePositives(self):
2353 mock_input_api = MockInputApi()
2354 mock_input_api.files = [
Vaclav Brozekc2fecf42018-04-06 16:40:162355 MockFile('dir/foo.cc', ['return std::unique_ptr<T[]>(foo);']),
2356 MockFile('dir/bar.mm', ['bar = std::unique_ptr<T[]>(foo)']),
2357 MockFile('dir/file.cc', ['std::unique_ptr<T> p = Foo();']),
2358 MockFile('dir/baz.cc', [
Vaclav Brozek52e18bf2018-04-03 07:05:242359 'std::unique_ptr<T> result = std::make_unique<T>();'
2360 ]),
Vaclav Brozeka54c528b2018-04-06 19:23:552361 MockFile('dir/baz2.cc', [
2362 'std::unique_ptr<T> result = std::make_unique<T>('
2363 ]),
2364 MockFile('dir/nested.cc', ['set<std::unique_ptr<T>>();']),
2365 MockFile('dir/nested2.cc', ['map<U, std::unique_ptr<T>>();']),
Vaclav Brozekb7fadb692018-08-30 06:39:532366
2367 # Two-argument invocation of std::unique_ptr is exempt because there is
2368 # no equivalent using std::make_unique.
2369 MockFile('dir/multi_arg.cc', [
2370 'auto p = std::unique_ptr<T, D>(new T(), D());']),
Vaclav Brozek52e18bf2018-04-03 07:05:242371 ]
2372
2373 results = PRESUBMIT._CheckUniquePtr(mock_input_api, MockOutputApi())
2374 self.assertEqual(0, len(results))
2375
Danil Chapovalov3518f362018-08-11 16:13:432376class CheckNoDirectIncludesHeadersWhichRedefineStrCat(unittest.TestCase):
2377 def testBlocksDirectIncludes(self):
2378 mock_input_api = MockInputApi()
2379 mock_input_api.files = [
2380 MockFile('dir/foo_win.cc', ['#include "shlwapi.h"']),
2381 MockFile('dir/bar.h', ['#include <propvarutil.h>']),
2382 MockFile('dir/baz.h', ['#include <atlbase.h>']),
2383 MockFile('dir/jumbo.h', ['#include "sphelper.h"']),
2384 ]
2385 results = PRESUBMIT._CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
2386 self.assertEquals(1, len(results))
2387 self.assertEquals(4, len(results[0].items))
2388 self.assertTrue('StrCat' in results[0].message)
2389 self.assertTrue('foo_win.cc' in results[0].items[0])
2390 self.assertTrue('bar.h' in results[0].items[1])
2391 self.assertTrue('baz.h' in results[0].items[2])
2392 self.assertTrue('jumbo.h' in results[0].items[3])
2393
2394 def testAllowsToIncludeWrapper(self):
2395 mock_input_api = MockInputApi()
2396 mock_input_api.files = [
2397 MockFile('dir/baz_win.cc', ['#include "base/win/shlwapi.h"']),
2398 MockFile('dir/baz-win.h', ['#include "base/win/atl.h"']),
2399 ]
2400 results = PRESUBMIT._CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
2401 self.assertEquals(0, len(results))
2402
2403 def testAllowsToCreateWrapper(self):
2404 mock_input_api = MockInputApi()
2405 mock_input_api.files = [
2406 MockFile('base/win/shlwapi.h', [
2407 '#include <shlwapi.h>',
2408 '#include "base/win/windows_defines.inc"']),
2409 ]
2410 results = PRESUBMIT._CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
2411 self.assertEquals(0, len(results))
Vaclav Brozek52e18bf2018-04-03 07:05:242412
Mustafa Emre Acer51f2f742020-03-09 19:41:122413
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142414class TranslationScreenshotsTest(unittest.TestCase):
2415 # An empty grd file.
2416 OLD_GRD_CONTENTS = """<?xml version="1.0" encoding="UTF-8"?>
2417 <grit latest_public_release="1" current_release="1">
2418 <release seq="1">
2419 <messages></messages>
2420 </release>
2421 </grit>
2422 """.splitlines()
2423 # A grd file with a single message.
2424 NEW_GRD_CONTENTS1 = """<?xml version="1.0" encoding="UTF-8"?>
2425 <grit latest_public_release="1" current_release="1">
2426 <release seq="1">
2427 <messages>
2428 <message name="IDS_TEST1">
2429 Test string 1
2430 </message>
2431 </messages>
2432 </release>
2433 </grit>
2434 """.splitlines()
2435 # A grd file with two messages.
2436 NEW_GRD_CONTENTS2 = """<?xml version="1.0" encoding="UTF-8"?>
2437 <grit latest_public_release="1" current_release="1">
2438 <release seq="1">
2439 <messages>
2440 <message name="IDS_TEST1">
2441 Test string 1
2442 </message>
2443 <message name="IDS_TEST2">
2444 Test string 2
2445 </message>
2446 </messages>
2447 </release>
2448 </grit>
2449 """.splitlines()
2450
meacerff8a9b62019-12-10 19:43:582451 OLD_GRDP_CONTENTS = (
2452 '<?xml version="1.0" encoding="utf-8"?>',
2453 '<grit-part>',
2454 '</grit-part>'
2455 )
2456
2457 NEW_GRDP_CONTENTS1 = (
2458 '<?xml version="1.0" encoding="utf-8"?>',
2459 '<grit-part>',
2460 '<message name="IDS_PART_TEST1">',
2461 'Part string 1',
2462 '</message>',
2463 '</grit-part>')
2464
2465 NEW_GRDP_CONTENTS2 = (
2466 '<?xml version="1.0" encoding="utf-8"?>',
2467 '<grit-part>',
2468 '<message name="IDS_PART_TEST1">',
2469 'Part string 1',
2470 '</message>',
2471 '<message name="IDS_PART_TEST2">',
2472 'Part string 2',
2473 '</message>',
2474 '</grit-part>')
2475
Mustafa Emre Acerc8a012d2018-07-31 00:00:392476 DO_NOT_UPLOAD_PNG_MESSAGE = ('Do not include actual screenshots in the '
2477 'changelist. Run '
2478 'tools/translate/upload_screenshots.py to '
2479 'upload them instead:')
2480 GENERATE_SIGNATURES_MESSAGE = ('You are adding or modifying UI strings.\n'
2481 'To ensure the best translations, take '
2482 'screenshots of the relevant UI '
2483 '(https://g.co/chrome/translation) and add '
2484 'these files to your changelist:')
2485 REMOVE_SIGNATURES_MESSAGE = ('You removed strings associated with these '
2486 'files. Remove:')
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142487
2488 def makeInputApi(self, files):
2489 input_api = MockInputApi()
2490 input_api.files = files
meacere7be7532019-10-02 17:41:032491 # Override os_path.exists because the presubmit uses the actual
2492 # os.path.exists.
2493 input_api.CreateMockFileInPath(
2494 [x.LocalPath() for x in input_api.AffectedFiles(include_deletes=True)])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142495 return input_api
2496
meacerff8a9b62019-12-10 19:43:582497 """ CL modified and added messages, but didn't add any screenshots."""
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142498 def testNoScreenshots(self):
meacerff8a9b62019-12-10 19:43:582499 # No new strings (file contents same). Should not warn.
2500 input_api = self.makeInputApi([
2501 MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS1,
2502 self.NEW_GRD_CONTENTS1, action='M'),
2503 MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS1,
2504 self.NEW_GRDP_CONTENTS1, action='M')])
2505 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2506 MockOutputApi())
2507 self.assertEqual(0, len(warnings))
2508
2509 # Add two new strings. Should have two warnings.
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142510 input_api = self.makeInputApi([
2511 MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS2,
meacerff8a9b62019-12-10 19:43:582512 self.NEW_GRD_CONTENTS1, action='M'),
2513 MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS2,
2514 self.NEW_GRDP_CONTENTS1, action='M')])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142515 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2516 MockOutputApi())
2517 self.assertEqual(1, len(warnings))
2518 self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[0].message)
Mustafa Emre Acerea3e57a2018-12-17 23:51:012519 self.assertEqual([
meacerff8a9b62019-12-10 19:43:582520 os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
2521 os.path.join('test_grd', 'IDS_TEST2.png.sha1')],
2522 warnings[0].items)
Mustafa Emre Acer36eaad52019-11-12 23:03:342523
meacerff8a9b62019-12-10 19:43:582524 # Add four new strings. Should have four warnings.
Mustafa Emre Acerad8fb082019-11-19 04:24:212525 input_api = self.makeInputApi([
2526 MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS2,
meacerff8a9b62019-12-10 19:43:582527 self.OLD_GRD_CONTENTS, action='M'),
2528 MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS2,
2529 self.OLD_GRDP_CONTENTS, action='M')])
Mustafa Emre Acerad8fb082019-11-19 04:24:212530 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2531 MockOutputApi())
2532 self.assertEqual(1, len(warnings))
2533 self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[0].message)
meacerff8a9b62019-12-10 19:43:582534 self.assertEqual([
2535 os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2536 os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
2537 os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
2538 os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
2539 ], warnings[0].items)
Mustafa Emre Acerad8fb082019-11-19 04:24:212540
meacerff8a9b62019-12-10 19:43:582541 def testPngAddedSha1NotAdded(self):
2542 # CL added one new message in a grd file and added the png file associated
2543 # with it, but did not add the corresponding sha1 file. This should warn
2544 # twice:
2545 # - Once for the added png file (because we don't want developers to upload
2546 # actual images)
2547 # - Once for the missing .sha1 file
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142548 input_api = self.makeInputApi([
Mustafa Emre Acerea3e57a2018-12-17 23:51:012549 MockAffectedFile(
2550 'test.grd',
2551 self.NEW_GRD_CONTENTS1,
2552 self.OLD_GRD_CONTENTS,
2553 action='M'),
2554 MockAffectedFile(
2555 os.path.join('test_grd', 'IDS_TEST1.png'), 'binary', action='A')
2556 ])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142557 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2558 MockOutputApi())
2559 self.assertEqual(2, len(warnings))
2560 self.assertEqual(self.DO_NOT_UPLOAD_PNG_MESSAGE, warnings[0].message)
Mustafa Emre Acerea3e57a2018-12-17 23:51:012561 self.assertEqual([os.path.join('test_grd', 'IDS_TEST1.png')],
2562 warnings[0].items)
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142563 self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[1].message)
Mustafa Emre Acerea3e57a2018-12-17 23:51:012564 self.assertEqual([os.path.join('test_grd', 'IDS_TEST1.png.sha1')],
2565 warnings[1].items)
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142566
meacerff8a9b62019-12-10 19:43:582567 # CL added two messages (one in grd, one in grdp) and added the png files
2568 # associated with the messages, but did not add the corresponding sha1
2569 # files. This should warn twice:
2570 # - Once for the added png files (because we don't want developers to upload
2571 # actual images)
2572 # - Once for the missing .sha1 files
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142573 input_api = self.makeInputApi([
meacerff8a9b62019-12-10 19:43:582574 # Modified files:
Mustafa Emre Acer36eaad52019-11-12 23:03:342575 MockAffectedFile(
2576 'test.grd',
meacerff8a9b62019-12-10 19:43:582577 self.NEW_GRD_CONTENTS1,
Mustafa Emre Acer36eaad52019-11-12 23:03:342578 self.OLD_GRD_CONTENTS,
meacer2308d0742019-11-12 18:15:422579 action='M'),
Mustafa Emre Acer12e7fee2019-11-18 18:49:552580 MockAffectedFile(
meacerff8a9b62019-12-10 19:43:582581 'part.grdp',
2582 self.NEW_GRDP_CONTENTS1,
2583 self.OLD_GRDP_CONTENTS,
2584 action='M'),
2585 # Added files:
2586 MockAffectedFile(
2587 os.path.join('test_grd', 'IDS_TEST1.png'), 'binary', action='A'),
2588 MockAffectedFile(
2589 os.path.join('part_grdp', 'IDS_PART_TEST1.png'), 'binary',
2590 action='A')
Mustafa Emre Acerad8fb082019-11-19 04:24:212591 ])
2592 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2593 MockOutputApi())
2594 self.assertEqual(2, len(warnings))
2595 self.assertEqual(self.DO_NOT_UPLOAD_PNG_MESSAGE, warnings[0].message)
meacerff8a9b62019-12-10 19:43:582596 self.assertEqual([os.path.join('part_grdp', 'IDS_PART_TEST1.png'),
2597 os.path.join('test_grd', 'IDS_TEST1.png')],
Mustafa Emre Acerad8fb082019-11-19 04:24:212598 warnings[0].items)
2599 self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[1].message)
meacerff8a9b62019-12-10 19:43:582600 self.assertEqual([os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2601 os.path.join('test_grd', 'IDS_TEST1.png.sha1')],
2602 warnings[1].items)
Mustafa Emre Acerad8fb082019-11-19 04:24:212603
2604 def testScreenshotsWithSha1(self):
meacerff8a9b62019-12-10 19:43:582605 # CL added four messages (two each in a grd and grdp) and their
2606 # corresponding .sha1 files. No warnings.
Mustafa Emre Acerad8fb082019-11-19 04:24:212607 input_api = self.makeInputApi([
meacerff8a9b62019-12-10 19:43:582608 # Modified files:
Mustafa Emre Acerad8fb082019-11-19 04:24:212609 MockAffectedFile(
2610 'test.grd',
2611 self.NEW_GRD_CONTENTS2,
2612 self.OLD_GRD_CONTENTS,
Mustafa Emre Acer12e7fee2019-11-18 18:49:552613 action='M'),
meacerff8a9b62019-12-10 19:43:582614 MockAffectedFile(
2615 'part.grdp',
2616 self.NEW_GRDP_CONTENTS2,
2617 self.OLD_GRDP_CONTENTS,
2618 action='M'),
2619 # Added files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012620 MockFile(
2621 os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
2622 'binary',
2623 action='A'),
2624 MockFile(
2625 os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
2626 'binary',
meacerff8a9b62019-12-10 19:43:582627 action='A'),
2628 MockFile(
2629 os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2630 'binary',
2631 action='A'),
2632 MockFile(
2633 os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
2634 'binary',
2635 action='A'),
Mustafa Emre Acerea3e57a2018-12-17 23:51:012636 ])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142637 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2638 MockOutputApi())
2639 self.assertEqual([], warnings)
2640
2641 def testScreenshotsRemovedWithSha1(self):
meacerff8a9b62019-12-10 19:43:582642 # Replace new contents with old contents in grd and grp files, removing
2643 # IDS_TEST1, IDS_TEST2, IDS_PART_TEST1 and IDS_PART_TEST2.
2644 # Should warn to remove the sha1 files associated with these strings.
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142645 input_api = self.makeInputApi([
meacerff8a9b62019-12-10 19:43:582646 # Modified files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012647 MockAffectedFile(
2648 'test.grd',
meacerff8a9b62019-12-10 19:43:582649 self.OLD_GRD_CONTENTS, # new_contents
2650 self.NEW_GRD_CONTENTS2, # old_contents
Mustafa Emre Acerea3e57a2018-12-17 23:51:012651 action='M'),
meacerff8a9b62019-12-10 19:43:582652 MockAffectedFile(
2653 'part.grdp',
2654 self.OLD_GRDP_CONTENTS, # new_contents
2655 self.NEW_GRDP_CONTENTS2, # old_contents
2656 action='M'),
2657 # Unmodified files:
2658 MockFile(os.path.join('test_grd', 'IDS_TEST1.png.sha1'), 'binary', ''),
2659 MockFile(os.path.join('test_grd', 'IDS_TEST2.png.sha1'), 'binary', ''),
2660 MockFile(os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2661 'binary', ''),
2662 MockFile(os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
2663 'binary', '')
Mustafa Emre Acerea3e57a2018-12-17 23:51:012664 ])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142665 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2666 MockOutputApi())
2667 self.assertEqual(1, len(warnings))
2668 self.assertEqual(self.REMOVE_SIGNATURES_MESSAGE, warnings[0].message)
Mustafa Emre Acerea3e57a2018-12-17 23:51:012669 self.assertEqual([
meacerff8a9b62019-12-10 19:43:582670 os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2671 os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
Mustafa Emre Acerea3e57a2018-12-17 23:51:012672 os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
2673 os.path.join('test_grd', 'IDS_TEST2.png.sha1')
2674 ], warnings[0].items)
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142675
meacerff8a9b62019-12-10 19:43:582676 # Same as above, but this time one of the .sha1 files is also removed.
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142677 input_api = self.makeInputApi([
meacerff8a9b62019-12-10 19:43:582678 # Modified files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012679 MockAffectedFile(
2680 'test.grd',
meacerff8a9b62019-12-10 19:43:582681 self.OLD_GRD_CONTENTS, # new_contents
2682 self.NEW_GRD_CONTENTS2, # old_contents
Mustafa Emre Acerea3e57a2018-12-17 23:51:012683 action='M'),
meacerff8a9b62019-12-10 19:43:582684 MockAffectedFile(
2685 'part.grdp',
2686 self.OLD_GRDP_CONTENTS, # new_contents
2687 self.NEW_GRDP_CONTENTS2, # old_contents
2688 action='M'),
2689 # Unmodified files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012690 MockFile(os.path.join('test_grd', 'IDS_TEST1.png.sha1'), 'binary', ''),
meacerff8a9b62019-12-10 19:43:582691 MockFile(os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2692 'binary', ''),
2693 # Deleted files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012694 MockAffectedFile(
2695 os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
2696 '',
2697 'old_contents',
meacerff8a9b62019-12-10 19:43:582698 action='D'),
2699 MockAffectedFile(
2700 os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
2701 '',
2702 'old_contents',
Mustafa Emre Acerea3e57a2018-12-17 23:51:012703 action='D')
2704 ])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142705 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2706 MockOutputApi())
2707 self.assertEqual(1, len(warnings))
2708 self.assertEqual(self.REMOVE_SIGNATURES_MESSAGE, warnings[0].message)
meacerff8a9b62019-12-10 19:43:582709 self.assertEqual([os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2710 os.path.join('test_grd', 'IDS_TEST1.png.sha1')
2711 ], warnings[0].items)
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142712
meacerff8a9b62019-12-10 19:43:582713 # Remove all sha1 files. There should be no warnings.
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142714 input_api = self.makeInputApi([
meacerff8a9b62019-12-10 19:43:582715 # Modified files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012716 MockAffectedFile(
2717 'test.grd',
2718 self.OLD_GRD_CONTENTS,
2719 self.NEW_GRD_CONTENTS2,
2720 action='M'),
meacerff8a9b62019-12-10 19:43:582721 MockAffectedFile(
2722 'part.grdp',
2723 self.OLD_GRDP_CONTENTS,
2724 self.NEW_GRDP_CONTENTS2,
2725 action='M'),
2726 # Deleted files:
Mustafa Emre Acerea3e57a2018-12-17 23:51:012727 MockFile(
2728 os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
2729 'binary',
2730 action='D'),
2731 MockFile(
2732 os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
2733 'binary',
meacerff8a9b62019-12-10 19:43:582734 action='D'),
2735 MockFile(
2736 os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
2737 'binary',
2738 action='D'),
2739 MockFile(
2740 os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
2741 'binary',
Mustafa Emre Acerea3e57a2018-12-17 23:51:012742 action='D')
2743 ])
Mustafa Emre Acer29bf6ac92018-07-30 21:42:142744 warnings = PRESUBMIT._CheckTranslationScreenshots(input_api,
2745 MockOutputApi())
2746 self.assertEqual([], warnings)
2747
2748
Mustafa Emre Acer51f2f742020-03-09 19:41:122749class TranslationExpectationsTest(unittest.TestCase):
2750 ERROR_MESSAGE_FORMAT = (
2751 "Failed to get a list of translatable grd files. "
2752 "This happens when:\n"
2753 " - One of the modified grd or grdp files cannot be parsed or\n"
2754 " - %s is not updated.\n"
2755 "Stack:\n"
2756 )
2757 REPO_ROOT = os.path.join('tools', 'translation', 'testdata')
2758 # This lists all .grd files under REPO_ROOT.
2759 EXPECTATIONS = os.path.join(REPO_ROOT,
2760 "translation_expectations.pyl")
2761 # This lists all .grd files under REPO_ROOT except unlisted.grd.
2762 EXPECTATIONS_WITHOUT_UNLISTED_FILE = os.path.join(
2763 REPO_ROOT, "translation_expectations_without_unlisted_file.pyl")
2764
2765 # Tests that the presubmit doesn't return when no grd or grdp files are
2766 # modified.
2767 def testExpectationsNoModifiedGrd(self):
2768 input_api = MockInputApi()
2769 input_api.files = [
2770 MockAffectedFile('not_used.txt', 'not used', 'not used', action='M')
2771 ]
2772 # Fake list of all grd files in the repo. This list is missing all grd/grdps
2773 # under tools/translation/testdata. This is OK because the presubmit won't
2774 # run in the first place since there are no modified grd/grps in input_api.
2775 grd_files = ['doesnt_exist_doesnt_matter.grd']
2776 warnings = PRESUBMIT._CheckTranslationExpectations(
2777 input_api, MockOutputApi(), self.REPO_ROOT, self.EXPECTATIONS,
2778 grd_files)
2779 self.assertEqual(0, len(warnings))
2780
2781
2782 # Tests that the list of files passed to the presubmit matches the list of
2783 # files in the expectations.
2784 def testExpectationsSuccess(self):
2785 # Mock input file list needs a grd or grdp file in order to run the
2786 # presubmit. The file itself doesn't matter.
2787 input_api = MockInputApi()
2788 input_api.files = [
2789 MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
2790 ]
2791 # List of all grd files in the repo.
2792 grd_files = ['test.grd', 'unlisted.grd', 'not_translated.grd',
2793 'internal.grd']
2794 warnings = PRESUBMIT._CheckTranslationExpectations(
2795 input_api, MockOutputApi(), self.REPO_ROOT, self.EXPECTATIONS,
2796 grd_files)
2797 self.assertEqual(0, len(warnings))
2798
2799 # Tests that the presubmit warns when a file is listed in expectations, but
2800 # does not actually exist.
2801 def testExpectationsMissingFile(self):
2802 # Mock input file list needs a grd or grdp file in order to run the
2803 # presubmit.
2804 input_api = MockInputApi()
2805 input_api.files = [
2806 MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
2807 ]
2808 # unlisted.grd is listed under tools/translation/testdata but is not
2809 # included in translation expectations.
2810 grd_files = ['unlisted.grd', 'not_translated.grd', 'internal.grd']
2811 warnings = PRESUBMIT._CheckTranslationExpectations(
2812 input_api, MockOutputApi(), self.REPO_ROOT, self.EXPECTATIONS,
2813 grd_files)
2814 self.assertEqual(1, len(warnings))
2815 self.assertTrue(warnings[0].message.startswith(
2816 self.ERROR_MESSAGE_FORMAT % self.EXPECTATIONS))
2817 self.assertTrue(
2818 ("test.grd is listed in the translation expectations, "
2819 "but this grd file does not exist")
2820 in warnings[0].message)
2821
2822 # Tests that the presubmit warns when a file is not listed in expectations but
2823 # does actually exist.
2824 def testExpectationsUnlistedFile(self):
2825 # Mock input file list needs a grd or grdp file in order to run the
2826 # presubmit.
2827 input_api = MockInputApi()
2828 input_api.files = [
2829 MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
2830 ]
2831 # unlisted.grd is listed under tools/translation/testdata but is not
2832 # included in translation expectations.
2833 grd_files = ['test.grd', 'unlisted.grd', 'not_translated.grd',
2834 'internal.grd']
2835 warnings = PRESUBMIT._CheckTranslationExpectations(
2836 input_api, MockOutputApi(), self.REPO_ROOT,
2837 self.EXPECTATIONS_WITHOUT_UNLISTED_FILE, grd_files)
2838 self.assertEqual(1, len(warnings))
2839 self.assertTrue(warnings[0].message.startswith(
2840 self.ERROR_MESSAGE_FORMAT % self.EXPECTATIONS_WITHOUT_UNLISTED_FILE))
2841 self.assertTrue(
2842 ("unlisted.grd appears to be translatable "
2843 "(because it contains <file> or <message> elements), "
2844 "but is not listed in the translation expectations.")
2845 in warnings[0].message)
2846
2847 # Tests that the presubmit warns twice:
2848 # - for a non-existing file listed in expectations
2849 # - for an existing file not listed in expectations
2850 def testMultipleWarnings(self):
2851 # Mock input file list needs a grd or grdp file in order to run the
2852 # presubmit.
2853 input_api = MockInputApi()
2854 input_api.files = [
2855 MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
2856 ]
2857 # unlisted.grd is listed under tools/translation/testdata but is not
2858 # included in translation expectations.
2859 # test.grd is not listed under tools/translation/testdata but is included
2860 # in translation expectations.
2861 grd_files = ['unlisted.grd', 'not_translated.grd', 'internal.grd']
2862 warnings = PRESUBMIT._CheckTranslationExpectations(
2863 input_api, MockOutputApi(), self.REPO_ROOT,
2864 self.EXPECTATIONS_WITHOUT_UNLISTED_FILE, grd_files)
2865 self.assertEqual(1, len(warnings))
2866 self.assertTrue(warnings[0].message.startswith(
2867 self.ERROR_MESSAGE_FORMAT % self.EXPECTATIONS_WITHOUT_UNLISTED_FILE))
2868 self.assertTrue(
2869 ("unlisted.grd appears to be translatable "
2870 "(because it contains <file> or <message> elements), "
2871 "but is not listed in the translation expectations.")
2872 in warnings[0].message)
2873 self.assertTrue(
2874 ("test.grd is listed in the translation expectations, "
2875 "but this grd file does not exist")
2876 in warnings[0].message)
2877
2878
Dominic Battre033531052018-09-24 15:45:342879class DISABLETypoInTest(unittest.TestCase):
2880
2881 def testPositive(self):
2882 # Verify the typo "DISABLE_" instead of "DISABLED_" in various contexts
2883 # where the desire is to disable a test.
2884 tests = [
2885 # Disabled on one platform:
2886 '#if defined(OS_WIN)\n'
2887 '#define MAYBE_FoobarTest DISABLE_FoobarTest\n'
2888 '#else\n'
2889 '#define MAYBE_FoobarTest FoobarTest\n'
2890 '#endif\n',
2891 # Disabled on one platform spread cross lines:
2892 '#if defined(OS_WIN)\n'
2893 '#define MAYBE_FoobarTest \\\n'
2894 ' DISABLE_FoobarTest\n'
2895 '#else\n'
2896 '#define MAYBE_FoobarTest FoobarTest\n'
2897 '#endif\n',
2898 # Disabled on all platforms:
2899 ' TEST_F(FoobarTest, DISABLE_Foo)\n{\n}',
2900 # Disabled on all platforms but multiple lines
2901 ' TEST_F(FoobarTest,\n DISABLE_foo){\n}\n',
2902 ]
2903
2904 for test in tests:
2905 mock_input_api = MockInputApi()
2906 mock_input_api.files = [
2907 MockFile('some/path/foo_unittest.cc', test.splitlines()),
2908 ]
2909
2910 results = PRESUBMIT._CheckNoDISABLETypoInTests(mock_input_api,
2911 MockOutputApi())
2912 self.assertEqual(
2913 1,
2914 len(results),
2915 msg=('expected len(results) == 1 but got %d in test: %s' %
2916 (len(results), test)))
2917 self.assertTrue(
2918 'foo_unittest.cc' in results[0].message,
2919 msg=('expected foo_unittest.cc in message but got %s in test %s' %
2920 (results[0].message, test)))
2921
2922 def testIngoreNotTestFiles(self):
2923 mock_input_api = MockInputApi()
2924 mock_input_api.files = [
2925 MockFile('some/path/foo.cc', 'TEST_F(FoobarTest, DISABLE_Foo)'),
2926 ]
2927
2928 results = PRESUBMIT._CheckNoDISABLETypoInTests(mock_input_api,
2929 MockOutputApi())
2930 self.assertEqual(0, len(results))
2931
Katie Df13948e2018-09-25 07:33:442932 def testIngoreDeletedFiles(self):
2933 mock_input_api = MockInputApi()
2934 mock_input_api.files = [
2935 MockFile('some/path/foo.cc', 'TEST_F(FoobarTest, Foo)', action='D'),
2936 ]
2937
2938 results = PRESUBMIT._CheckNoDISABLETypoInTests(mock_input_api,
2939 MockOutputApi())
2940 self.assertEqual(0, len(results))
Dominic Battre033531052018-09-24 15:45:342941
Dirk Pranke3c18a382019-03-15 01:07:512942
2943class BuildtoolsRevisionsAreInSyncTest(unittest.TestCase):
2944 # TODO(crbug.com/941824): We need to make sure the entries in
2945 # //buildtools/DEPS are kept in sync with the entries in //DEPS
2946 # so that users of //buildtools in other projects get the same tooling
2947 # Chromium gets. If we ever fix the referenced bug and add 'includedeps'
2948 # support to gclient, we can eliminate the duplication and delete
2949 # these tests for the corresponding presubmit check.
2950
2951 def _check(self, files):
2952 mock_input_api = MockInputApi()
2953 mock_input_api.files = []
2954 for fname, contents in files.items():
2955 mock_input_api.files.append(MockFile(fname, contents.splitlines()))
2956 return PRESUBMIT._CheckBuildtoolsRevisionsAreInSync(mock_input_api,
2957 MockOutputApi())
2958
2959 def testOneFileChangedButNotTheOther(self):
2960 results = self._check({
2961 "DEPS": "'libunwind_revision': 'onerev'",
2962 })
2963 self.assertNotEqual(results, [])
2964
2965 def testNeitherFileChanged(self):
2966 results = self._check({
2967 "OWNERS": "[email protected]",
2968 })
2969 self.assertEqual(results, [])
2970
2971 def testBothFilesChangedAndMatch(self):
2972 results = self._check({
2973 "DEPS": "'libunwind_revision': 'onerev'",
2974 "buildtools/DEPS": "'libunwind_revision': 'onerev'",
2975 })
2976 self.assertEqual(results, [])
2977
2978 def testBothFilesWereChangedAndDontMatch(self):
2979 results = self._check({
2980 "DEPS": "'libunwind_revision': 'onerev'",
2981 "buildtools/DEPS": "'libunwind_revision': 'anotherrev'",
2982 })
2983 self.assertNotEqual(results, [])
2984
2985
Max Morozb47503b2019-08-08 21:03:272986class CheckFuzzTargetsTest(unittest.TestCase):
2987
2988 def _check(self, files):
2989 mock_input_api = MockInputApi()
2990 mock_input_api.files = []
2991 for fname, contents in files.items():
2992 mock_input_api.files.append(MockFile(fname, contents.splitlines()))
2993 return PRESUBMIT._CheckFuzzTargets(mock_input_api, MockOutputApi())
2994
2995 def testLibFuzzerSourcesIgnored(self):
2996 results = self._check({
2997 "third_party/lib/Fuzzer/FuzzerDriver.cpp": "LLVMFuzzerInitialize",
2998 })
2999 self.assertEqual(results, [])
3000
3001 def testNonCodeFilesIgnored(self):
3002 results = self._check({
3003 "README.md": "LLVMFuzzerInitialize",
3004 })
3005 self.assertEqual(results, [])
3006
3007 def testNoErrorHeaderPresent(self):
3008 results = self._check({
3009 "fuzzer.cc": (
3010 "#include \"testing/libfuzzer/libfuzzer_exports.h\"\n" +
3011 "LLVMFuzzerInitialize"
3012 )
3013 })
3014 self.assertEqual(results, [])
3015
3016 def testErrorMissingHeader(self):
3017 results = self._check({
3018 "fuzzer.cc": "LLVMFuzzerInitialize"
3019 })
3020 self.assertEqual(len(results), 1)
3021 self.assertEqual(results[0].items, ['fuzzer.cc'])
3022
3023
Jochen Eisingerf9fbe7b6c32019-11-18 09:37:263024class SetNoParentTest(unittest.TestCase):
3025 def testSetNoParentMissing(self):
3026 mock_input_api = MockInputApi()
3027 mock_input_api.files = [
3028 MockAffectedFile('goat/OWNERS',
3029 [
3030 'set noparent',
3031 '[email protected]',
3032 'per-file *.json=set noparent',
3033 'per-file *[email protected]',
3034 ])
3035 ]
3036 mock_output_api = MockOutputApi()
3037 errors = PRESUBMIT._CheckSetNoParent(mock_input_api, mock_output_api)
3038 self.assertEqual(1, len(errors))
3039 self.assertTrue('goat/OWNERS:1' in errors[0].long_text)
3040 self.assertTrue('goat/OWNERS:3' in errors[0].long_text)
3041
3042
3043 def testSetNoParentWithCorrectRule(self):
3044 mock_input_api = MockInputApi()
3045 mock_input_api.files = [
3046 MockAffectedFile('goat/OWNERS',
3047 [
3048 'set noparent',
3049 'file://ipc/SECURITY_OWNERS',
3050 'per-file *.json=set noparent',
3051 'per-file *.json=file://ipc/SECURITY_OWNERS',
3052 ])
3053 ]
3054 mock_output_api = MockOutputApi()
3055 errors = PRESUBMIT._CheckSetNoParent(mock_input_api, mock_output_api)
3056 self.assertEqual([], errors)
3057
3058
[email protected]2299dcf2012-11-15 19:56:243059if __name__ == '__main__':
3060 unittest.main()