blob: 5d9f459411512edcd6edeebf5094fa4173db274d [file] [log] [blame]
andrew@webrtc.org2442de12012-01-23 17:45:411# Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
2#
3# Use of this source code is governed by a BSD-style license
4# that can be found in the LICENSE file in the root of the source
5# tree. An additional intellectual property rights grant can be found
6# in the file PATENTS. All contributing project authors may
7# be found in the AUTHORS file in the root of the source tree.
niklase@google.comda159d62011-05-30 11:51:348
kjellander7439f972016-12-06 06:47:469import json
kjellander@webrtc.orgaefe61a2014-12-08 13:00:3010import os
kjellander@webrtc.org85759802013-10-22 16:47:4011import re
kjellander@webrtc.org3bd41562014-09-01 11:06:3712import sys
Mirko Bonadei4dc4e252017-09-19 11:49:1613from collections import defaultdict
Oleh Prypin2f33a562017-10-04 18:17:5414from contextlib import contextmanager
kjellander@webrtc.org85759802013-10-22 16:47:4015
16
oprypin2aa463f2017-03-23 10:17:0217# Files and directories that are *skipped* by cpplint in the presubmit script.
18CPPLINT_BLACKLIST = [
Mirko Bonadei92ea95e2017-09-15 04:47:3119 'api/video_codecs/video_decoder.h',
20 'common_types.cc',
21 'common_types.h',
22 'examples/objc',
Steve Antone78bcb92017-10-31 16:53:0823 'media/base/streamparams.h',
24 'media/base/videocommon.h',
25 'media/engine/fakewebrtcdeviceinfo.h',
26 'media/sctp/sctptransport.cc',
Mirko Bonadei92ea95e2017-09-15 04:47:3127 'modules/audio_coding',
Mirko Bonadei92ea95e2017-09-15 04:47:3128 'modules/audio_device',
29 'modules/audio_processing',
30 'modules/desktop_capture',
31 'modules/include/module_common_types.h',
32 'modules/media_file',
33 'modules/utility',
34 'modules/video_capture',
35 'p2p',
Mirko Bonadei92ea95e2017-09-15 04:47:3136 'rtc_base',
37 'sdk/android/src/jni',
38 'sdk/objc',
39 'system_wrappers',
40 'test',
Henrik Kjellander90fd7d82017-05-09 06:30:1041 'tools_webrtc',
Mirko Bonadei92ea95e2017-09-15 04:47:3142 'voice_engine',
kjellander@webrtc.org0fcaf992015-11-26 14:24:5243]
44
jbauchc4e3ead2016-02-19 08:25:5545# These filters will always be removed, even if the caller specifies a filter
46# set, as they are problematic or broken in some way.
47#
48# Justifications for each filter:
49# - build/c++11 : Rvalue ref checks are unreliable (false positives),
50# include file and feature blacklists are
51# google3-specific.
kjellandere5a87a52016-04-27 09:32:1252# - whitespace/operators: Same as above (doesn't seem sufficient to eliminate
53# all move-related errors).
jbauchc4e3ead2016-02-19 08:25:5554BLACKLIST_LINT_FILTERS = [
55 '-build/c++11',
kjellandere5a87a52016-04-27 09:32:1256 '-whitespace/operators',
jbauchc4e3ead2016-02-19 08:25:5557]
58
kjellanderfd595232015-12-04 10:44:0959# List of directories of "supported" native APIs. That means changes to headers
60# will be done in a compatible way following this scheme:
61# 1. Non-breaking changes are made.
62# 2. The old APIs as marked as deprecated (with comments).
63# 3. Deprecation is announced to discuss-webrtc@googlegroups.com and
64# webrtc-users@google.com (internal list).
65# 4. (later) The deprecated APIs are removed.
kjellander53047c92015-12-03 07:56:1466NATIVE_API_DIRS = (
Karl Wibergef52d8b82017-10-25 11:20:0367 'api', # All subdirectories of api/ are included as well.
Mirko Bonadei92ea95e2017-09-15 04:47:3168 'media',
69 'modules/audio_device/include',
70 'pc',
kjellanderdd705472016-06-09 18:17:2771)
Mirko Bonadei4dc4e252017-09-19 11:49:1672
kjellanderdd705472016-06-09 18:17:2773# These directories should not be used but are maintained only to avoid breaking
74# some legacy downstream code.
75LEGACY_API_DIRS = (
Mirko Bonadei92ea95e2017-09-15 04:47:3176 'common_audio/include',
77 'modules/audio_coding/include',
Mirko Bonadei92ea95e2017-09-15 04:47:3178 'modules/audio_processing/include',
79 'modules/bitrate_controller/include',
80 'modules/congestion_controller/include',
81 'modules/include',
82 'modules/remote_bitrate_estimator/include',
83 'modules/rtp_rtcp/include',
84 'modules/rtp_rtcp/source',
85 'modules/utility/include',
86 'modules/video_coding/codecs/h264/include',
87 'modules/video_coding/codecs/i420/include',
88 'modules/video_coding/codecs/vp8/include',
89 'modules/video_coding/codecs/vp9/include',
90 'modules/video_coding/include',
91 'rtc_base',
92 'system_wrappers/include',
93 'voice_engine/include',
kjellander53047c92015-12-03 07:56:1494)
Mirko Bonadei4dc4e252017-09-19 11:49:1695
Karl Wibergd4f01c12017-11-10 09:55:4596# NOTE: The set of directories in API_DIRS should be the same as those
97# listed in the table in native-api.md.
kjellanderdd705472016-06-09 18:17:2798API_DIRS = NATIVE_API_DIRS[:] + LEGACY_API_DIRS[:]
kjellander53047c92015-12-03 07:56:1499
Mirko Bonadei4dc4e252017-09-19 11:49:16100# TARGET_RE matches a GN target, and extracts the target name and the contents.
101TARGET_RE = re.compile(r'(?P<indent>\s*)\w+\("(?P<target_name>\w+)"\) {'
102 r'(?P<target_contents>.*?)'
103 r'(?P=indent)}',
104 re.MULTILINE | re.DOTALL)
105
106# SOURCES_RE matches a block of sources inside a GN target.
107SOURCES_RE = re.compile(r'sources \+?= \[(?P<sources>.*?)\]',
108 re.MULTILINE | re.DOTALL)
109
110# FILE_PATH_RE matchies a file path.
111FILE_PATH_RE = re.compile(r'"(?P<file_path>(\w|\/)+)(?P<extension>\.\w+)"')
112
kjellander53047c92015-12-03 07:56:14113
Oleh Prypin2f33a562017-10-04 18:17:54114@contextmanager
115def _AddToPath(*paths):
116 original_sys_path = sys.path
117 sys.path.extend(paths)
118 try:
119 yield
120 finally:
121 # Restore sys.path to what it was before.
122 sys.path = original_sys_path
ehmaldonado4fb97462017-01-30 13:27:22123
124
charujain9893e252017-09-14 11:33:22125def VerifyNativeApiHeadersListIsValid(input_api, output_api):
kjellander53047c92015-12-03 07:56:14126 """Ensures the list of native API header directories is up to date."""
127 non_existing_paths = []
128 native_api_full_paths = [
129 input_api.os_path.join(input_api.PresubmitLocalPath(),
kjellanderdd705472016-06-09 18:17:27130 *path.split('/')) for path in API_DIRS]
kjellander53047c92015-12-03 07:56:14131 for path in native_api_full_paths:
132 if not os.path.isdir(path):
133 non_existing_paths.append(path)
134 if non_existing_paths:
135 return [output_api.PresubmitError(
136 'Directories to native API headers have changed which has made the '
137 'list in PRESUBMIT.py outdated.\nPlease update it to the current '
138 'location of our native APIs.',
139 non_existing_paths)]
140 return []
141
kjellanderc88b5d52017-04-05 13:42:43142API_CHANGE_MSG = """
kwibergeb133022016-04-07 14:41:48143You seem to be changing native API header files. Please make sure that you:
oprypin375b9ac2017-02-13 12:13:23144 1. Make compatible changes that don't break existing clients. Usually
145 this is done by keeping the existing method signatures unchanged.
146 2. Mark the old stuff as deprecated (see RTC_DEPRECATED macro).
kwibergeb133022016-04-07 14:41:48147 3. Create a timeline and plan for when the deprecated stuff will be
148 removed. (The amount of time we give users to change their code
149 should be informed by how much work it is for them. If they just
150 need to replace one name with another or something equally
151 simple, 1-2 weeks might be good; if they need to do serious work,
152 up to 3 months may be called for.)
153 4. Update/inform existing downstream code owners to stop using the
154 deprecated stuff. (Send announcements to
155 discuss-webrtc@googlegroups.com and webrtc-users@google.com.)
156 5. Remove the deprecated stuff, once the agreed-upon amount of time
157 has passed.
158Related files:
159"""
kjellander53047c92015-12-03 07:56:14160
charujain9893e252017-09-14 11:33:22161def CheckNativeApiHeaderChanges(input_api, output_api):
kjellander53047c92015-12-03 07:56:14162 """Checks to remind proper changing of native APIs."""
163 files = []
Karl Wiberg6bfac032017-10-27 13:14:20164 source_file_filter = lambda x: input_api.FilterSourceFile(
165 x, white_list=[r'.+\.(gn|gni|h)$'])
166 for f in input_api.AffectedSourceFiles(source_file_filter):
167 for path in API_DIRS:
168 dn = os.path.dirname(f.LocalPath())
169 if path == 'api':
170 # Special case: Subdirectories included.
171 if dn == 'api' or dn.startswith('api/'):
172 files.append(f)
173 else:
174 # Normal case: Subdirectories not included.
175 if dn == path:
176 files.append(f)
kjellander53047c92015-12-03 07:56:14177
178 if files:
kjellanderc88b5d52017-04-05 13:42:43179 return [output_api.PresubmitNotifyResult(API_CHANGE_MSG, files)]
kjellander53047c92015-12-03 07:56:14180 return []
181
kjellander@webrtc.org0fcaf992015-11-26 14:24:52182
charujain9893e252017-09-14 11:33:22183def CheckNoIOStreamInHeaders(input_api, output_api):
kjellander@webrtc.org51198f12012-02-21 17:53:46184 """Checks to make sure no .h files include <iostream>."""
185 files = []
186 pattern = input_api.re.compile(r'^#include\s*<iostream>',
187 input_api.re.MULTILINE)
188 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
189 if not f.LocalPath().endswith('.h'):
190 continue
191 contents = input_api.ReadFile(f)
192 if pattern.search(contents):
193 files.append(f)
194
195 if len(files):
Henrik Kjellander57e5fd22015-05-25 10:55:39196 return [output_api.PresubmitError(
kjellander@webrtc.org51198f12012-02-21 17:53:46197 'Do not #include <iostream> in header files, since it inserts static ' +
198 'initialization into every file including the header. Instead, ' +
199 '#include <ostream>. See http://crbug.com/94794',
Henrik Kjellander57e5fd22015-05-25 10:55:39200 files)]
kjellander@webrtc.org51198f12012-02-21 17:53:46201 return []
202
kjellander@webrtc.orge4158642014-08-06 09:11:18203
charujain9893e252017-09-14 11:33:22204def CheckNoPragmaOnce(input_api, output_api):
kjellander6aeef742017-02-20 09:13:18205 """Make sure that banned functions are not used."""
206 files = []
207 pattern = input_api.re.compile(r'^#pragma\s+once',
208 input_api.re.MULTILINE)
209 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
210 if not f.LocalPath().endswith('.h'):
211 continue
212 contents = input_api.ReadFile(f)
213 if pattern.search(contents):
214 files.append(f)
215
216 if files:
217 return [output_api.PresubmitError(
218 'Do not use #pragma once in header files.\n'
219 'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
220 files)]
221 return []
222
223
charujain9893e252017-09-14 11:33:22224def CheckNoFRIEND_TEST(input_api, output_api): # pylint: disable=invalid-name
kjellander@webrtc.org51198f12012-02-21 17:53:46225 """Make sure that gtest's FRIEND_TEST() macro is not used, the
226 FRIEND_TEST_ALL_PREFIXES() macro from testsupport/gtest_prod_util.h should be
227 used instead since that allows for FLAKY_, FAILS_ and DISABLED_ prefixes."""
228 problems = []
229
230 file_filter = lambda f: f.LocalPath().endswith(('.cc', '.h'))
231 for f in input_api.AffectedFiles(file_filter=file_filter):
232 for line_num, line in f.ChangedContents():
233 if 'FRIEND_TEST(' in line:
234 problems.append(' %s:%d' % (f.LocalPath(), line_num))
235
236 if not problems:
237 return []
238 return [output_api.PresubmitPromptWarning('WebRTC\'s code should not use '
239 'gtest\'s FRIEND_TEST() macro. Include testsupport/gtest_prod_util.h and '
240 'use FRIEND_TEST_ALL_PREFIXES() instead.\n' + '\n'.join(problems))]
241
kjellander@webrtc.orge4158642014-08-06 09:11:18242
charujain9893e252017-09-14 11:33:22243def IsLintBlacklisted(blacklist_paths, file_path):
oprypin2aa463f2017-03-23 10:17:02244 """ Checks if a file is blacklisted for lint check."""
245 for path in blacklist_paths:
246 if file_path == path or os.path.dirname(file_path).startswith(path):
kjellander@webrtc.org0fcaf992015-11-26 14:24:52247 return True
248 return False
249
250
charujain9893e252017-09-14 11:33:22251def CheckApprovedFilesLintClean(input_api, output_api,
mflodman@webrtc.org2a452092012-07-01 05:55:23252 source_file_filter=None):
oprypin2aa463f2017-03-23 10:17:02253 """Checks that all new or non-blacklisted .cc and .h files pass cpplint.py.
charujain9893e252017-09-14 11:33:22254 This check is based on CheckChangeLintsClean in
kjellander@webrtc.org51198f12012-02-21 17:53:46255 depot_tools/presubmit_canned_checks.py but has less filters and only checks
256 added files."""
257 result = []
258
259 # Initialize cpplint.
260 import cpplint
261 # Access to a protected member _XX of a client class
262 # pylint: disable=W0212
263 cpplint._cpplint_state.ResetErrorCounts()
264
jbauchc4e3ead2016-02-19 08:25:55265 lint_filters = cpplint._Filters()
266 lint_filters.extend(BLACKLIST_LINT_FILTERS)
267 cpplint._SetFilters(','.join(lint_filters))
268
oprypin2aa463f2017-03-23 10:17:02269 # Create a platform independent blacklist for cpplint.
270 blacklist_paths = [input_api.os_path.join(*path.split('/'))
271 for path in CPPLINT_BLACKLIST]
kjellander@webrtc.org0fcaf992015-11-26 14:24:52272
kjellander@webrtc.org51198f12012-02-21 17:53:46273 # Use the strictest verbosity level for cpplint.py (level 1) which is the
oprypin2aa463f2017-03-23 10:17:02274 # default when running cpplint.py from command line. To make it possible to
275 # work with not-yet-converted code, we're only applying it to new (or
276 # moved/renamed) files and files not listed in CPPLINT_BLACKLIST.
kjellander@webrtc.org51198f12012-02-21 17:53:46277 verbosity_level = 1
278 files = []
279 for f in input_api.AffectedSourceFiles(source_file_filter):
Henrik Kjellander57e5fd22015-05-25 10:55:39280 # Note that moved/renamed files also count as added.
charujain9893e252017-09-14 11:33:22281 if f.Action() == 'A' or not IsLintBlacklisted(blacklist_paths,
oprypin2aa463f2017-03-23 10:17:02282 f.LocalPath()):
kjellander@webrtc.org51198f12012-02-21 17:53:46283 files.append(f.AbsoluteLocalPath())
mflodman@webrtc.org2a452092012-07-01 05:55:23284
kjellander@webrtc.org51198f12012-02-21 17:53:46285 for file_name in files:
286 cpplint.ProcessFile(file_name, verbosity_level)
287
288 if cpplint._cpplint_state.error_count > 0:
289 if input_api.is_committing:
oprypin8e58d652017-03-21 14:52:41290 res_type = output_api.PresubmitError
kjellander@webrtc.org51198f12012-02-21 17:53:46291 else:
292 res_type = output_api.PresubmitPromptWarning
293 result = [res_type('Changelist failed cpplint.py check.')]
294
295 return result
296
charujain9893e252017-09-14 11:33:22297def CheckNoSourcesAbove(input_api, gn_files, output_api):
ehmaldonado5b1ba082016-09-02 12:51:08298 # Disallow referencing source files with paths above the GN file location.
299 source_pattern = input_api.re.compile(r' +sources \+?= \[(.*?)\]',
300 re.MULTILINE | re.DOTALL)
301 file_pattern = input_api.re.compile(r'"((\.\./.*?)|(//.*?))"')
302 violating_gn_files = set()
303 violating_source_entries = []
304 for gn_file in gn_files:
305 contents = input_api.ReadFile(gn_file)
306 for source_block_match in source_pattern.finditer(contents):
307 # Find all source list entries starting with ../ in the source block
308 # (exclude overrides entries).
309 for file_list_match in file_pattern.finditer(source_block_match.group(1)):
310 source_file = file_list_match.group(1)
311 if 'overrides/' not in source_file:
312 violating_source_entries.append(source_file)
313 violating_gn_files.add(gn_file)
314 if violating_gn_files:
315 return [output_api.PresubmitError(
316 'Referencing source files above the directory of the GN file is not '
Henrik Kjellanderb4af3d62016-11-16 19:11:29317 'allowed. Please introduce new GN targets in the proper location '
318 'instead.\n'
ehmaldonado5b1ba082016-09-02 12:51:08319 'Invalid source entries:\n'
320 '%s\n'
321 'Violating GN files:' % '\n'.join(violating_source_entries),
322 items=violating_gn_files)]
323 return []
324
Mirko Bonadei4dc4e252017-09-19 11:49:16325def CheckNoMixingSources(input_api, gn_files, output_api):
326 """Disallow mixing C, C++ and Obj-C/Obj-C++ in the same target.
327
328 See bugs.webrtc.org/7743 for more context.
329 """
330 def _MoreThanOneSourceUsed(*sources_lists):
331 sources_used = 0
332 for source_list in sources_lists:
333 if len(source_list):
334 sources_used += 1
335 return sources_used > 1
336
337 errors = defaultdict(lambda: [])
kjellander7439f972016-12-06 06:47:46338 for gn_file in gn_files:
Mirko Bonadei4dc4e252017-09-19 11:49:16339 gn_file_content = input_api.ReadFile(gn_file)
340 for target_match in TARGET_RE.finditer(gn_file_content):
341 # list_of_sources is a list of tuples of the form
342 # (c_files, cc_files, objc_files) that keeps track of all the sources
343 # defined in a target. A GN target can have more that on definition of
344 # sources (since it supports if/else statements).
345 # E.g.:
346 # rtc_static_library("foo") {
347 # if (is_win) {
348 # sources = [ "foo.cc" ]
349 # } else {
350 # sources = [ "foo.mm" ]
351 # }
352 # }
353 # This is allowed and the presubmit check should support this case.
354 list_of_sources = []
kjellander7439f972016-12-06 06:47:46355 c_files = []
356 cc_files = []
Mirko Bonadei4dc4e252017-09-19 11:49:16357 objc_files = []
358 target_name = target_match.group('target_name')
359 target_contents = target_match.group('target_contents')
360 for sources_match in SOURCES_RE.finditer(target_contents):
361 if '+=' not in sources_match.group(0):
362 if c_files or cc_files or objc_files:
363 list_of_sources.append((c_files, cc_files, objc_files))
364 c_files = []
365 cc_files = []
366 objc_files = []
367 for file_match in FILE_PATH_RE.finditer(sources_match.group(1)):
368 file_path = file_match.group('file_path')
369 extension = file_match.group('extension')
370 if extension == '.c':
371 c_files.append(file_path + extension)
372 if extension == '.cc':
373 cc_files.append(file_path + extension)
374 if extension in ['.m', '.mm']:
375 objc_files.append(file_path + extension)
376 list_of_sources.append((c_files, cc_files, objc_files))
377 for c_files_list, cc_files_list, objc_files_list in list_of_sources:
378 if _MoreThanOneSourceUsed(c_files_list, cc_files_list, objc_files_list):
379 all_sources = sorted(c_files_list + cc_files_list + objc_files_list)
380 errors[gn_file.LocalPath()].append((target_name, all_sources))
381 if errors:
kjellander7439f972016-12-06 06:47:46382 return [output_api.PresubmitError(
Mirko Bonadei4dc4e252017-09-19 11:49:16383 'GN targets cannot mix .c, .cc and .m (or .mm) source files.\n'
384 'Please create a separate target for each collection of sources.\n'
kjellander7439f972016-12-06 06:47:46385 'Mixed sources: \n'
386 '%s\n'
Mirko Bonadei4dc4e252017-09-19 11:49:16387 'Violating GN files:\n%s\n' % (json.dumps(errors, indent=2),
388 '\n'.join(errors.keys())))]
kjellander7439f972016-12-06 06:47:46389 return []
390
charujain9893e252017-09-14 11:33:22391def CheckNoPackageBoundaryViolations(input_api, gn_files, output_api):
ehmaldonado4fb97462017-01-30 13:27:22392 cwd = input_api.PresubmitLocalPath()
Oleh Prypin2f33a562017-10-04 18:17:54393 with _AddToPath(input_api.os_path.join(
394 cwd, 'tools_webrtc', 'presubmit_checks_lib')):
395 from check_package_boundaries import CheckPackageBoundaries
396 build_files = [os.path.join(cwd, gn_file.LocalPath()) for gn_file in gn_files]
397 errors = CheckPackageBoundaries(cwd, build_files)[:5]
398 if errors:
ehmaldonado4fb97462017-01-30 13:27:22399 return [output_api.PresubmitError(
Oleh Prypin2f33a562017-10-04 18:17:54400 'There are package boundary violations in the following GN files:',
401 long_text='\n\n'.join(str(err) for err in errors))]
ehmaldonado4fb97462017-01-30 13:27:22402 return []
403
charujain9893e252017-09-14 11:33:22404def CheckGnChanges(input_api, output_api):
ehmaldonado5b1ba082016-09-02 12:51:08405 source_file_filter = lambda x: input_api.FilterSourceFile(
Oleh Prypinafe01652017-10-04 13:56:08406 x, white_list=(r'.+\.(gn|gni)$',),
407 black_list=r'.*/presubmit_checks_lib/testdata/.*')
ehmaldonado5b1ba082016-09-02 12:51:08408
409 gn_files = []
410 for f in input_api.AffectedSourceFiles(source_file_filter):
Mirko Bonadei92ea95e2017-09-15 04:47:31411 gn_files.append(f)
ehmaldonado5b1ba082016-09-02 12:51:08412
413 result = []
414 if gn_files:
charujain9893e252017-09-14 11:33:22415 result.extend(CheckNoSourcesAbove(input_api, gn_files, output_api))
Mirko Bonadei4dc4e252017-09-19 11:49:16416 result.extend(CheckNoMixingSources(input_api, gn_files, output_api))
417 result.extend(CheckNoPackageBoundaryViolations(input_api, gn_files,
418 output_api))
ehmaldonado5b1ba082016-09-02 12:51:08419 return result
420
Oleh Prypin920b6532017-10-05 09:28:51421def CheckGnGen(input_api, output_api):
422 """Runs `gn gen --check` with default args to detect mismatches between
423 #includes and dependencies in the BUILD.gn files, as well as general build
424 errors.
425 """
426 with _AddToPath(input_api.os_path.join(
427 input_api.PresubmitLocalPath(), 'tools_webrtc', 'presubmit_checks_lib')):
428 from gn_check import RunGnCheck
429 errors = RunGnCheck(input_api.PresubmitLocalPath())[:5]
430 if errors:
431 return [output_api.PresubmitPromptWarning(
432 'Some #includes do not match the build dependency graph. Please run:\n'
433 ' gn gen --check <out_dir>',
434 long_text='\n\n'.join(errors))]
435 return []
436
charujain9893e252017-09-14 11:33:22437def CheckUnwantedDependencies(input_api, output_api):
kjellander@webrtc.org3bd41562014-09-01 11:06:37438 """Runs checkdeps on #include statements added in this
439 change. Breaking - rules is an error, breaking ! rules is a
440 warning.
441 """
442 # Copied from Chromium's src/PRESUBMIT.py.
443
444 # We need to wait until we have an input_api object and use this
445 # roundabout construct to import checkdeps because this file is
446 # eval-ed and thus doesn't have __file__.
Oleh Prypin2f33a562017-10-04 18:17:54447 checkdeps_path = input_api.os_path.join(input_api.PresubmitLocalPath(),
448 'buildtools', 'checkdeps')
449 if not os.path.exists(checkdeps_path):
450 return [output_api.PresubmitError(
451 'Cannot find checkdeps at %s\nHave you run "gclient sync" to '
452 'download all the DEPS entries?' % checkdeps_path)]
453 with _AddToPath(checkdeps_path):
kjellander@webrtc.org3bd41562014-09-01 11:06:37454 import checkdeps
455 from cpp_checker import CppChecker
456 from rules import Rule
kjellander@webrtc.org3bd41562014-09-01 11:06:37457
458 added_includes = []
459 for f in input_api.AffectedFiles():
460 if not CppChecker.IsCppFile(f.LocalPath()):
461 continue
462
Henrik Kjellander57e5fd22015-05-25 10:55:39463 changed_lines = [line for _, line in f.ChangedContents()]
kjellander@webrtc.org3bd41562014-09-01 11:06:37464 added_includes.append([f.LocalPath(), changed_lines])
465
466 deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())
467
468 error_descriptions = []
469 warning_descriptions = []
470 for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
471 added_includes):
472 description_with_path = '%s\n %s' % (path, rule_description)
473 if rule_type == Rule.DISALLOW:
474 error_descriptions.append(description_with_path)
475 else:
476 warning_descriptions.append(description_with_path)
477
478 results = []
479 if error_descriptions:
480 results.append(output_api.PresubmitError(
kjellandera7066a32017-03-23 10:47:05481 'You added one or more #includes that violate checkdeps rules.\n'
482 'Check that the DEPS files in these locations contain valid rules.\n'
483 'See https://cs.chromium.org/chromium/src/buildtools/checkdeps/ for '
484 'more details about checkdeps.',
kjellander@webrtc.org3bd41562014-09-01 11:06:37485 error_descriptions))
486 if warning_descriptions:
487 results.append(output_api.PresubmitPromptOrNotify(
488 'You added one or more #includes of files that are temporarily\n'
489 'allowed but being removed. Can you avoid introducing the\n'
kjellandera7066a32017-03-23 10:47:05490 '#include? See relevant DEPS file(s) for details and contacts.\n'
491 'See https://cs.chromium.org/chromium/src/buildtools/checkdeps/ for '
492 'more details about checkdeps.',
kjellander@webrtc.org3bd41562014-09-01 11:06:37493 warning_descriptions))
494 return results
495
charujain9893e252017-09-14 11:33:22496def CheckCommitMessageBugEntry(input_api, output_api):
497 """Check that bug entries are well-formed in commit message."""
498 bogus_bug_msg = (
Mirko Bonadei61880182017-10-12 13:12:35499 'Bogus Bug entry: %s. Please specify the issue tracker prefix and the '
charujain9893e252017-09-14 11:33:22500 'issue number, separated by a colon, e.g. webrtc:123 or chromium:12345.')
501 results = []
Mirko Bonadei61880182017-10-12 13:12:35502 for bug in input_api.change.BugsFromDescription():
charujain9893e252017-09-14 11:33:22503 bug = bug.strip()
504 if bug.lower() == 'none':
505 continue
charujain81a58c72017-09-25 11:25:45506 if 'b/' not in bug and ':' not in bug:
charujain9893e252017-09-14 11:33:22507 try:
508 if int(bug) > 100000:
509 # Rough indicator for current chromium bugs.
510 prefix_guess = 'chromium'
511 else:
512 prefix_guess = 'webrtc'
Mirko Bonadei61880182017-10-12 13:12:35513 results.append('Bug entry requires issue tracker prefix, e.g. %s:%s' %
charujain9893e252017-09-14 11:33:22514 (prefix_guess, bug))
515 except ValueError:
516 results.append(bogus_bug_msg % bug)
charujain81a58c72017-09-25 11:25:45517 elif not (re.match(r'\w+:\d+', bug) or re.match(r'b/\d+', bug)):
charujain9893e252017-09-14 11:33:22518 results.append(bogus_bug_msg % bug)
519 return [output_api.PresubmitError(r) for r in results]
520
521def CheckChangeHasBugField(input_api, output_api):
Mirko Bonadei61880182017-10-12 13:12:35522 """Requires that the changelist is associated with a bug.
kjellanderd1e26a92016-09-19 15:11:16523
524 This check is stricter than the one in depot_tools/presubmit_canned_checks.py
Mirko Bonadei61880182017-10-12 13:12:35525 since it fails the presubmit if the bug field is missing or doesn't contain
kjellanderd1e26a92016-09-19 15:11:16526 a bug reference.
Mirko Bonadei61880182017-10-12 13:12:35527
528 This supports both 'BUG=' and 'Bug:' since we are in the process of migrating
529 to Gerrit and it encourages the usage of 'Bug:'.
kjellanderd1e26a92016-09-19 15:11:16530 """
Mirko Bonadei61880182017-10-12 13:12:35531 if input_api.change.BugsFromDescription():
kjellanderd1e26a92016-09-19 15:11:16532 return []
533 else:
534 return [output_api.PresubmitError(
Mirko Bonadei61880182017-10-12 13:12:35535 'The "Bug: [bug number]" footer is mandatory. Please create a bug and '
kjellanderd1e26a92016-09-19 15:11:16536 'reference it using either of:\n'
Mirko Bonadei61880182017-10-12 13:12:35537 ' * https://bugs.webrtc.org - reference it using Bug: webrtc:XXXX\n'
538 ' * https://crbug.com - reference it using Bug: chromium:XXXXXX')]
kjellander@webrtc.orge4158642014-08-06 09:11:18539
charujain9893e252017-09-14 11:33:22540def CheckJSONParseErrors(input_api, output_api):
kjellander569cf942016-02-11 13:02:59541 """Check that JSON files do not contain syntax errors."""
542
543 def FilterFile(affected_file):
544 return input_api.os_path.splitext(affected_file.LocalPath())[1] == '.json'
545
546 def GetJSONParseError(input_api, filename):
547 try:
548 contents = input_api.ReadFile(filename)
549 input_api.json.loads(contents)
550 except ValueError as e:
551 return e
552 return None
553
554 results = []
555 for affected_file in input_api.AffectedFiles(
556 file_filter=FilterFile, include_deletes=False):
557 parse_error = GetJSONParseError(input_api,
558 affected_file.AbsoluteLocalPath())
559 if parse_error:
560 results.append(output_api.PresubmitError('%s could not be parsed: %s' %
561 (affected_file.LocalPath(), parse_error)))
562 return results
563
564
charujain9893e252017-09-14 11:33:22565def RunPythonTests(input_api, output_api):
kjellanderc88b5d52017-04-05 13:42:43566 def Join(*args):
Henrik Kjellander8d3ad822015-05-26 17:52:05567 return input_api.os_path.join(input_api.PresubmitLocalPath(), *args)
568
569 test_directories = [
Edward Lemur6d01f6d2017-09-14 15:02:01570 input_api.PresubmitLocalPath(),
Mirko Bonadei92ea95e2017-09-15 04:47:31571 Join('rtc_tools', 'py_event_log_analyzer'),
572 Join('rtc_tools'),
573 Join('audio', 'test', 'unittests'),
ehmaldonado4fb97462017-01-30 13:27:22574 ] + [
Henrik Kjellander90fd7d82017-05-09 06:30:10575 root for root, _, files in os.walk(Join('tools_webrtc'))
ehmaldonado4fb97462017-01-30 13:27:22576 if any(f.endswith('_test.py') for f in files)
Henrik Kjellander8d3ad822015-05-26 17:52:05577 ]
578
579 tests = []
580 for directory in test_directories:
581 tests.extend(
582 input_api.canned_checks.GetUnitTestsInDirectory(
583 input_api,
584 output_api,
585 directory,
586 whitelist=[r'.+_test\.py$']))
587 return input_api.RunTests(tests, parallel=True)
588
589
charujain9893e252017-09-14 11:33:22590def CheckUsageOfGoogleProtobufNamespace(input_api, output_api):
mbonadei38415b22017-04-07 12:38:01591 """Checks that the namespace google::protobuf has not been used."""
592 files = []
593 pattern = input_api.re.compile(r'google::protobuf')
Mirko Bonadei92ea95e2017-09-15 04:47:31594 proto_utils_path = os.path.join('rtc_base', 'protobuf_utils.h')
mbonadei38415b22017-04-07 12:38:01595 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
596 if f.LocalPath() in [proto_utils_path, 'PRESUBMIT.py']:
597 continue
598 contents = input_api.ReadFile(f)
599 if pattern.search(contents):
600 files.append(f)
601
602 if files:
603 return [output_api.PresubmitError(
604 'Please avoid to use namespace `google::protobuf` directly.\n'
605 'Add a using directive in `%s` and include that header instead.'
606 % proto_utils_path, files)]
607 return []
608
609
Mirko Bonadei92ea95e2017-09-15 04:47:31610def _LicenseHeader(input_api):
611 """Returns the license header regexp."""
612 # Accept any year number from 2003 to the current year
613 current_year = int(input_api.time.strftime('%Y'))
614 allowed_years = (str(s) for s in reversed(xrange(2003, current_year + 1)))
615 years_re = '(' + '|'.join(allowed_years) + ')'
616 license_header = (
617 r'.*? Copyright( \(c\))? %(year)s The WebRTC [Pp]roject [Aa]uthors\. '
618 r'All [Rr]ights [Rr]eserved\.\n'
619 r'.*?\n'
620 r'.*? Use of this source code is governed by a BSD-style license\n'
621 r'.*? that can be found in the LICENSE file in the root of the source\n'
622 r'.*? tree\. An additional intellectual property rights grant can be '
623 r'found\n'
624 r'.*? in the file PATENTS\. All contributing project authors may\n'
625 r'.*? be found in the AUTHORS file in the root of the source tree\.\n'
626 ) % {
627 'year': years_re,
628 }
629 return license_header
630
631
charujain9893e252017-09-14 11:33:22632def CommonChecks(input_api, output_api):
andrew@webrtc.org53df1362012-01-26 21:24:23633 """Checks common to both upload and commit."""
niklase@google.comda159d62011-05-30 11:51:34634 results = []
tkchin42f580e2015-11-27 07:18:23635 # Filter out files that are in objc or ios dirs from being cpplint-ed since
636 # they do not follow C++ lint rules.
637 black_list = input_api.DEFAULT_BLACK_LIST + (
638 r".*\bobjc[\\\/].*",
Kári Tristan Helgason3fa35172016-09-09 08:55:05639 r".*objc\.[hcm]+$",
tkchin42f580e2015-11-27 07:18:23640 )
641 source_file_filter = lambda x: input_api.FilterSourceFile(x, None, black_list)
charujain9893e252017-09-14 11:33:22642 results.extend(CheckApprovedFilesLintClean(
tkchin42f580e2015-11-27 07:18:23643 input_api, output_api, source_file_filter))
Mirko Bonadei92ea95e2017-09-15 04:47:31644 results.extend(input_api.canned_checks.CheckLicense(
645 input_api, output_api, _LicenseHeader(input_api)))
phoglund@webrtc.org5d3713932013-03-07 09:59:43646 results.extend(input_api.canned_checks.RunPylint(input_api, output_api,
kjellander@webrtc.org177567c2016-12-22 09:40:28647 black_list=(r'^base[\\\/].*\.py$',
Henrik Kjellander14771ac2015-06-02 11:10:04648 r'^build[\\\/].*\.py$',
649 r'^buildtools[\\\/].*\.py$',
kjellander38c65c82017-04-13 05:43:38650 r'^infra[\\\/].*\.py$',
Henrik Kjellander0779e8f2016-12-22 11:01:17651 r'^ios[\\\/].*\.py$',
Henrik Kjellander14771ac2015-06-02 11:10:04652 r'^out.*[\\\/].*\.py$',
653 r'^testing[\\\/].*\.py$',
654 r'^third_party[\\\/].*\.py$',
kjellander@webrtc.org177567c2016-12-22 09:40:28655 r'^tools[\\\/].*\.py$',
kjellanderafd54942016-12-17 20:21:39656 # TODO(phoglund): should arguably be checked.
Henrik Kjellander90fd7d82017-05-09 06:30:10657 r'^tools_webrtc[\\\/]mb[\\\/].*\.py$',
658 r'^tools_webrtc[\\\/]valgrind[\\\/].*\.py$',
Henrik Kjellander14771ac2015-06-02 11:10:04659 r'^xcodebuild.*[\\\/].*\.py$',),
Henrik Kjellander57e5fd22015-05-25 10:55:39660 pylintrc='pylintrc'))
kjellander569cf942016-02-11 13:02:59661
nisse3d21e232016-09-02 10:07:06662 # TODO(nisse): talk/ is no more, so make below checks simpler?
Henrik Kjellander57e5fd22015-05-25 10:55:39663 # WebRTC can't use the presubmit_canned_checks.PanProjectChecks function since
664 # we need to have different license checks in talk/ and webrtc/ directories.
665 # Instead, hand-picked checks are included below.
Henrik Kjellander63224672015-09-08 06:03:56666
tkchin3cd9a302016-06-08 19:40:28667 # .m and .mm files are ObjC files. For simplicity we will consider .h files in
668 # ObjC subdirectories ObjC headers.
669 objc_filter_list = (r'.+\.m$', r'.+\.mm$', r'.+objc\/.+\.h$')
Henrik Kjellanderb4af3d62016-11-16 19:11:29670 # Skip long-lines check for DEPS and GN files.
671 build_file_filter_list = (r'.+\.gn$', r'.+\.gni$', 'DEPS')
tkchin3cd9a302016-06-08 19:40:28672 eighty_char_sources = lambda x: input_api.FilterSourceFile(x,
673 black_list=build_file_filter_list + objc_filter_list)
674 hundred_char_sources = lambda x: input_api.FilterSourceFile(x,
675 white_list=objc_filter_list)
andrew@webrtc.org2442de12012-01-23 17:45:41676 results.extend(input_api.canned_checks.CheckLongLines(
tkchin3cd9a302016-06-08 19:40:28677 input_api, output_api, maxlen=80, source_file_filter=eighty_char_sources))
678 results.extend(input_api.canned_checks.CheckLongLines(
679 input_api, output_api, maxlen=100,
680 source_file_filter=hundred_char_sources))
681
andrew@webrtc.org2442de12012-01-23 17:45:41682 results.extend(input_api.canned_checks.CheckChangeHasNoTabs(
683 input_api, output_api))
andrew@webrtc.org53df1362012-01-26 21:24:23684 results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace(
685 input_api, output_api))
kjellandere5dc62a2016-12-14 08:16:21686 results.extend(input_api.canned_checks.CheckAuthorizedAuthor(
687 input_api, output_api))
andrew@webrtc.org53df1362012-01-26 21:24:23688 results.extend(input_api.canned_checks.CheckChangeTodoHasOwner(
689 input_api, output_api))
charujain9893e252017-09-14 11:33:22690 results.extend(CheckNativeApiHeaderChanges(input_api, output_api))
691 results.extend(CheckNoIOStreamInHeaders(input_api, output_api))
692 results.extend(CheckNoPragmaOnce(input_api, output_api))
693 results.extend(CheckNoFRIEND_TEST(input_api, output_api))
694 results.extend(CheckGnChanges(input_api, output_api))
695 results.extend(CheckUnwantedDependencies(input_api, output_api))
696 results.extend(CheckJSONParseErrors(input_api, output_api))
697 results.extend(RunPythonTests(input_api, output_api))
698 results.extend(CheckUsageOfGoogleProtobufNamespace(input_api, output_api))
Mirko Bonadei866d3372017-09-15 10:35:26699 results.extend(CheckOrphanHeaders(input_api, output_api))
Mirko Bonadeia730c1c2017-09-18 09:33:13700 results.extend(CheckNewlineAtTheEndOfProtoFiles(input_api, output_api))
andrew@webrtc.org53df1362012-01-26 21:24:23701 return results
andrew@webrtc.org2442de12012-01-23 17:45:41702
kjellander@webrtc.orge4158642014-08-06 09:11:18703
andrew@webrtc.org53df1362012-01-26 21:24:23704def CheckChangeOnUpload(input_api, output_api):
705 results = []
charujain9893e252017-09-14 11:33:22706 results.extend(CommonChecks(input_api, output_api))
Oleh Prypin920b6532017-10-05 09:28:51707 results.extend(CheckGnGen(input_api, output_api))
Henrik Kjellander57e5fd22015-05-25 10:55:39708 results.extend(
709 input_api.canned_checks.CheckGNFormatted(input_api, output_api))
niklase@google.comda159d62011-05-30 11:51:34710 return results
711
kjellander@webrtc.orge4158642014-08-06 09:11:18712
andrew@webrtc.org2442de12012-01-23 17:45:41713def CheckChangeOnCommit(input_api, output_api):
niklase@google.com1198db92011-06-09 07:07:24714 results = []
charujain9893e252017-09-14 11:33:22715 results.extend(CommonChecks(input_api, output_api))
716 results.extend(VerifyNativeApiHeadersListIsValid(input_api, output_api))
niklase@google.com1198db92011-06-09 07:07:24717 results.extend(input_api.canned_checks.CheckOwners(input_api, output_api))
andrew@webrtc.org53df1362012-01-26 21:24:23718 results.extend(input_api.canned_checks.CheckChangeWasUploaded(
719 input_api, output_api))
720 results.extend(input_api.canned_checks.CheckChangeHasDescription(
721 input_api, output_api))
charujain9893e252017-09-14 11:33:22722 results.extend(CheckChangeHasBugField(input_api, output_api))
723 results.extend(CheckCommitMessageBugEntry(input_api, output_api))
kjellander@webrtc.org12cb88c2014-02-13 11:53:43724 results.extend(input_api.canned_checks.CheckTreeIsOpen(
725 input_api, output_api,
726 json_url='http://webrtc-status.appspot.com/current?format=json'))
niklase@google.com1198db92011-06-09 07:07:24727 return results
mbonadei74973ed2017-05-09 14:58:05728
729
charujain9893e252017-09-14 11:33:22730def CheckOrphanHeaders(input_api, output_api):
mbonadei74973ed2017-05-09 14:58:05731 # We need to wait until we have an input_api object and use this
732 # roundabout construct to import prebubmit_checks_lib because this file is
733 # eval-ed and thus doesn't have __file__.
734 error_msg = """Header file {} is not listed in any GN target.
735 Please create a target or add it to an existing one in {}"""
736 results = []
Oleh Prypin2f33a562017-10-04 18:17:54737 with _AddToPath(input_api.os_path.join(
738 input_api.PresubmitLocalPath(), 'tools_webrtc', 'presubmit_checks_lib')):
mbonadei74973ed2017-05-09 14:58:05739 from check_orphan_headers import GetBuildGnPathFromFilePath
740 from check_orphan_headers import IsHeaderInBuildGn
mbonadei74973ed2017-05-09 14:58:05741
742 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
mbonadeia644ad32017-05-10 12:21:55743 if f.LocalPath().endswith('.h') and f.Action() == 'A':
mbonadei74973ed2017-05-09 14:58:05744 file_path = os.path.abspath(f.LocalPath())
745 root_dir = os.getcwd()
746 gn_file_path = GetBuildGnPathFromFilePath(file_path, os.path.exists,
747 root_dir)
748 in_build_gn = IsHeaderInBuildGn(file_path, gn_file_path)
749 if not in_build_gn:
750 results.append(output_api.PresubmitError(error_msg.format(
751 file_path, gn_file_path)))
752 return results
Mirko Bonadei960fd5b2017-06-29 12:59:36753
754
Mirko Bonadeia730c1c2017-09-18 09:33:13755def CheckNewlineAtTheEndOfProtoFiles(input_api, output_api):
Mirko Bonadei960fd5b2017-06-29 12:59:36756 """Checks that all .proto files are terminated with a newline."""
757 error_msg = 'File {} must end with exactly one newline.'
758 results = []
759 source_file_filter = lambda x: input_api.FilterSourceFile(
760 x, white_list=(r'.+\.proto$',))
761 for f in input_api.AffectedSourceFiles(source_file_filter):
762 file_path = f.LocalPath()
763 with open(file_path) as f:
764 lines = f.readlines()
Mirko Bonadeia730c1c2017-09-18 09:33:13765 if len(lines) > 0 and not lines[-1].endswith('\n'):
Mirko Bonadei960fd5b2017-06-29 12:59:36766 results.append(output_api.PresubmitError(error_msg.format(file_path)))
767 return results