andrew@webrtc.org | 2442de1 | 2012-01-23 17:45:41 +0000 | [diff] [blame] | 1 | # 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.com | da159d6 | 2011-05-30 11:51:34 +0000 | [diff] [blame] | 8 | |
kjellander | 7439f97 | 2016-12-05 22:47:46 -0800 | [diff] [blame] | 9 | import json |
kjellander@webrtc.org | aefe61a | 2014-12-08 13:00:30 +0000 | [diff] [blame] | 10 | import os |
kjellander@webrtc.org | 8575980 | 2013-10-22 16:47:40 +0000 | [diff] [blame] | 11 | import re |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 12 | import sys |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 13 | from collections import defaultdict |
Oleh Prypin | 2f33a56 | 2017-10-04 20:17:54 +0200 | [diff] [blame] | 14 | from contextlib import contextmanager |
kjellander@webrtc.org | 8575980 | 2013-10-22 16:47:40 +0000 | [diff] [blame] | 15 | |
| 16 | |
oprypin | 2aa463f | 2017-03-23 03:17:02 -0700 | [diff] [blame] | 17 | # Files and directories that are *skipped* by cpplint in the presubmit script. |
| 18 | CPPLINT_BLACKLIST = [ |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 19 | 'api/video_codecs/video_decoder.h', |
| 20 | 'common_types.cc', |
| 21 | 'common_types.h', |
| 22 | 'examples/objc', |
Steve Anton | e78bcb9 | 2017-10-31 09:53:08 -0700 | [diff] [blame] | 23 | 'media/base/streamparams.h', |
| 24 | 'media/base/videocommon.h', |
| 25 | 'media/engine/fakewebrtcdeviceinfo.h', |
| 26 | 'media/sctp/sctptransport.cc', |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 27 | 'modules/audio_coding', |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 28 | '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', |
Steve Anton | 6c38cc7 | 2017-11-29 10:25:58 -0800 | [diff] [blame] | 35 | 'p2p/base/session.cc', |
| 36 | 'p2p/base/session.h', |
| 37 | 'p2p/base/pseudotcp.cc', |
| 38 | 'p2p/base/pseudotcp.h', |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 39 | 'rtc_base', |
| 40 | 'sdk/android/src/jni', |
| 41 | 'sdk/objc', |
| 42 | 'system_wrappers', |
| 43 | 'test', |
Henrik Kjellander | 90fd7d8 | 2017-05-09 08:30:10 +0200 | [diff] [blame] | 44 | 'tools_webrtc', |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 45 | 'voice_engine', |
kjellander@webrtc.org | 0fcaf99 | 2015-11-26 15:24:52 +0100 | [diff] [blame] | 46 | ] |
| 47 | |
jbauch | c4e3ead | 2016-02-19 00:25:55 -0800 | [diff] [blame] | 48 | # These filters will always be removed, even if the caller specifies a filter |
| 49 | # set, as they are problematic or broken in some way. |
| 50 | # |
| 51 | # Justifications for each filter: |
| 52 | # - build/c++11 : Rvalue ref checks are unreliable (false positives), |
| 53 | # include file and feature blacklists are |
| 54 | # google3-specific. |
kjellander | e5a87a5 | 2016-04-27 02:32:12 -0700 | [diff] [blame] | 55 | # - whitespace/operators: Same as above (doesn't seem sufficient to eliminate |
| 56 | # all move-related errors). |
jbauch | c4e3ead | 2016-02-19 00:25:55 -0800 | [diff] [blame] | 57 | BLACKLIST_LINT_FILTERS = [ |
| 58 | '-build/c++11', |
kjellander | e5a87a5 | 2016-04-27 02:32:12 -0700 | [diff] [blame] | 59 | '-whitespace/operators', |
jbauch | c4e3ead | 2016-02-19 00:25:55 -0800 | [diff] [blame] | 60 | ] |
| 61 | |
kjellander | fd59523 | 2015-12-04 02:44:09 -0800 | [diff] [blame] | 62 | # List of directories of "supported" native APIs. That means changes to headers |
| 63 | # will be done in a compatible way following this scheme: |
| 64 | # 1. Non-breaking changes are made. |
| 65 | # 2. The old APIs as marked as deprecated (with comments). |
| 66 | # 3. Deprecation is announced to discuss-webrtc@googlegroups.com and |
| 67 | # webrtc-users@google.com (internal list). |
| 68 | # 4. (later) The deprecated APIs are removed. |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 69 | NATIVE_API_DIRS = ( |
Karl Wiberg | ef52d8b8 | 2017-10-25 13:20:03 +0200 | [diff] [blame] | 70 | 'api', # All subdirectories of api/ are included as well. |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 71 | 'media', |
| 72 | 'modules/audio_device/include', |
| 73 | 'pc', |
kjellander | dd70547 | 2016-06-09 11:17:27 -0700 | [diff] [blame] | 74 | ) |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 75 | |
kjellander | dd70547 | 2016-06-09 11:17:27 -0700 | [diff] [blame] | 76 | # These directories should not be used but are maintained only to avoid breaking |
| 77 | # some legacy downstream code. |
| 78 | LEGACY_API_DIRS = ( |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 79 | 'common_audio/include', |
| 80 | 'modules/audio_coding/include', |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 81 | 'modules/audio_processing/include', |
| 82 | 'modules/bitrate_controller/include', |
| 83 | 'modules/congestion_controller/include', |
| 84 | 'modules/include', |
| 85 | 'modules/remote_bitrate_estimator/include', |
| 86 | 'modules/rtp_rtcp/include', |
| 87 | 'modules/rtp_rtcp/source', |
| 88 | 'modules/utility/include', |
| 89 | 'modules/video_coding/codecs/h264/include', |
| 90 | 'modules/video_coding/codecs/i420/include', |
| 91 | 'modules/video_coding/codecs/vp8/include', |
| 92 | 'modules/video_coding/codecs/vp9/include', |
| 93 | 'modules/video_coding/include', |
| 94 | 'rtc_base', |
| 95 | 'system_wrappers/include', |
| 96 | 'voice_engine/include', |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 97 | ) |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 98 | |
Karl Wiberg | d4f01c1 | 2017-11-10 10:55:45 +0100 | [diff] [blame] | 99 | # NOTE: The set of directories in API_DIRS should be the same as those |
| 100 | # listed in the table in native-api.md. |
kjellander | dd70547 | 2016-06-09 11:17:27 -0700 | [diff] [blame] | 101 | API_DIRS = NATIVE_API_DIRS[:] + LEGACY_API_DIRS[:] |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 102 | |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 103 | # TARGET_RE matches a GN target, and extracts the target name and the contents. |
| 104 | TARGET_RE = re.compile(r'(?P<indent>\s*)\w+\("(?P<target_name>\w+)"\) {' |
| 105 | r'(?P<target_contents>.*?)' |
| 106 | r'(?P=indent)}', |
| 107 | re.MULTILINE | re.DOTALL) |
| 108 | |
| 109 | # SOURCES_RE matches a block of sources inside a GN target. |
| 110 | SOURCES_RE = re.compile(r'sources \+?= \[(?P<sources>.*?)\]', |
| 111 | re.MULTILINE | re.DOTALL) |
| 112 | |
| 113 | # FILE_PATH_RE matchies a file path. |
| 114 | FILE_PATH_RE = re.compile(r'"(?P<file_path>(\w|\/)+)(?P<extension>\.\w+)"') |
| 115 | |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 116 | |
Oleh Prypin | 2f33a56 | 2017-10-04 20:17:54 +0200 | [diff] [blame] | 117 | @contextmanager |
| 118 | def _AddToPath(*paths): |
| 119 | original_sys_path = sys.path |
| 120 | sys.path.extend(paths) |
| 121 | try: |
| 122 | yield |
| 123 | finally: |
| 124 | # Restore sys.path to what it was before. |
| 125 | sys.path = original_sys_path |
ehmaldonado | 4fb9746 | 2017-01-30 05:27:22 -0800 | [diff] [blame] | 126 | |
| 127 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 128 | def VerifyNativeApiHeadersListIsValid(input_api, output_api): |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 129 | """Ensures the list of native API header directories is up to date.""" |
| 130 | non_existing_paths = [] |
| 131 | native_api_full_paths = [ |
| 132 | input_api.os_path.join(input_api.PresubmitLocalPath(), |
kjellander | dd70547 | 2016-06-09 11:17:27 -0700 | [diff] [blame] | 133 | *path.split('/')) for path in API_DIRS] |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 134 | for path in native_api_full_paths: |
| 135 | if not os.path.isdir(path): |
| 136 | non_existing_paths.append(path) |
| 137 | if non_existing_paths: |
| 138 | return [output_api.PresubmitError( |
| 139 | 'Directories to native API headers have changed which has made the ' |
| 140 | 'list in PRESUBMIT.py outdated.\nPlease update it to the current ' |
| 141 | 'location of our native APIs.', |
| 142 | non_existing_paths)] |
| 143 | return [] |
| 144 | |
kjellander | c88b5d5 | 2017-04-05 06:42:43 -0700 | [diff] [blame] | 145 | API_CHANGE_MSG = """ |
kwiberg | eb13302 | 2016-04-07 07:41:48 -0700 | [diff] [blame] | 146 | You seem to be changing native API header files. Please make sure that you: |
oprypin | 375b9ac | 2017-02-13 04:13:23 -0800 | [diff] [blame] | 147 | 1. Make compatible changes that don't break existing clients. Usually |
| 148 | this is done by keeping the existing method signatures unchanged. |
| 149 | 2. Mark the old stuff as deprecated (see RTC_DEPRECATED macro). |
kwiberg | eb13302 | 2016-04-07 07:41:48 -0700 | [diff] [blame] | 150 | 3. Create a timeline and plan for when the deprecated stuff will be |
| 151 | removed. (The amount of time we give users to change their code |
| 152 | should be informed by how much work it is for them. If they just |
| 153 | need to replace one name with another or something equally |
| 154 | simple, 1-2 weeks might be good; if they need to do serious work, |
| 155 | up to 3 months may be called for.) |
| 156 | 4. Update/inform existing downstream code owners to stop using the |
| 157 | deprecated stuff. (Send announcements to |
| 158 | discuss-webrtc@googlegroups.com and webrtc-users@google.com.) |
| 159 | 5. Remove the deprecated stuff, once the agreed-upon amount of time |
| 160 | has passed. |
| 161 | Related files: |
| 162 | """ |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 163 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 164 | def CheckNativeApiHeaderChanges(input_api, output_api): |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 165 | """Checks to remind proper changing of native APIs.""" |
| 166 | files = [] |
Karl Wiberg | 6bfac03 | 2017-10-27 15:14:20 +0200 | [diff] [blame] | 167 | source_file_filter = lambda x: input_api.FilterSourceFile( |
| 168 | x, white_list=[r'.+\.(gn|gni|h)$']) |
| 169 | for f in input_api.AffectedSourceFiles(source_file_filter): |
| 170 | for path in API_DIRS: |
| 171 | dn = os.path.dirname(f.LocalPath()) |
| 172 | if path == 'api': |
| 173 | # Special case: Subdirectories included. |
| 174 | if dn == 'api' or dn.startswith('api/'): |
| 175 | files.append(f) |
| 176 | else: |
| 177 | # Normal case: Subdirectories not included. |
| 178 | if dn == path: |
| 179 | files.append(f) |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 180 | |
| 181 | if files: |
kjellander | c88b5d5 | 2017-04-05 06:42:43 -0700 | [diff] [blame] | 182 | return [output_api.PresubmitNotifyResult(API_CHANGE_MSG, files)] |
kjellander | 53047c9 | 2015-12-02 23:56:14 -0800 | [diff] [blame] | 183 | return [] |
| 184 | |
kjellander@webrtc.org | 0fcaf99 | 2015-11-26 15:24:52 +0100 | [diff] [blame] | 185 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 186 | def CheckNoIOStreamInHeaders(input_api, output_api): |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 187 | """Checks to make sure no .h files include <iostream>.""" |
| 188 | files = [] |
| 189 | pattern = input_api.re.compile(r'^#include\s*<iostream>', |
| 190 | input_api.re.MULTILINE) |
| 191 | for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile): |
| 192 | if not f.LocalPath().endswith('.h'): |
| 193 | continue |
| 194 | contents = input_api.ReadFile(f) |
| 195 | if pattern.search(contents): |
| 196 | files.append(f) |
| 197 | |
| 198 | if len(files): |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 199 | return [output_api.PresubmitError( |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 200 | 'Do not #include <iostream> in header files, since it inserts static ' + |
| 201 | 'initialization into every file including the header. Instead, ' + |
| 202 | '#include <ostream>. See http://crbug.com/94794', |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 203 | files)] |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 204 | return [] |
| 205 | |
kjellander@webrtc.org | e415864 | 2014-08-06 09:11:18 +0000 | [diff] [blame] | 206 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 207 | def CheckNoPragmaOnce(input_api, output_api): |
kjellander | 6aeef74 | 2017-02-20 01:13:18 -0800 | [diff] [blame] | 208 | """Make sure that banned functions are not used.""" |
| 209 | files = [] |
| 210 | pattern = input_api.re.compile(r'^#pragma\s+once', |
| 211 | input_api.re.MULTILINE) |
| 212 | for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile): |
| 213 | if not f.LocalPath().endswith('.h'): |
| 214 | continue |
| 215 | contents = input_api.ReadFile(f) |
| 216 | if pattern.search(contents): |
| 217 | files.append(f) |
| 218 | |
| 219 | if files: |
| 220 | return [output_api.PresubmitError( |
| 221 | 'Do not use #pragma once in header files.\n' |
| 222 | 'See http://www.chromium.org/developers/coding-style#TOC-File-headers', |
| 223 | files)] |
| 224 | return [] |
| 225 | |
| 226 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 227 | def CheckNoFRIEND_TEST(input_api, output_api): # pylint: disable=invalid-name |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 228 | """Make sure that gtest's FRIEND_TEST() macro is not used, the |
| 229 | FRIEND_TEST_ALL_PREFIXES() macro from testsupport/gtest_prod_util.h should be |
| 230 | used instead since that allows for FLAKY_, FAILS_ and DISABLED_ prefixes.""" |
| 231 | problems = [] |
| 232 | |
| 233 | file_filter = lambda f: f.LocalPath().endswith(('.cc', '.h')) |
| 234 | for f in input_api.AffectedFiles(file_filter=file_filter): |
| 235 | for line_num, line in f.ChangedContents(): |
| 236 | if 'FRIEND_TEST(' in line: |
| 237 | problems.append(' %s:%d' % (f.LocalPath(), line_num)) |
| 238 | |
| 239 | if not problems: |
| 240 | return [] |
| 241 | return [output_api.PresubmitPromptWarning('WebRTC\'s code should not use ' |
| 242 | 'gtest\'s FRIEND_TEST() macro. Include testsupport/gtest_prod_util.h and ' |
| 243 | 'use FRIEND_TEST_ALL_PREFIXES() instead.\n' + '\n'.join(problems))] |
| 244 | |
kjellander@webrtc.org | e415864 | 2014-08-06 09:11:18 +0000 | [diff] [blame] | 245 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 246 | def IsLintBlacklisted(blacklist_paths, file_path): |
oprypin | 2aa463f | 2017-03-23 03:17:02 -0700 | [diff] [blame] | 247 | """ Checks if a file is blacklisted for lint check.""" |
| 248 | for path in blacklist_paths: |
| 249 | if file_path == path or os.path.dirname(file_path).startswith(path): |
kjellander@webrtc.org | 0fcaf99 | 2015-11-26 15:24:52 +0100 | [diff] [blame] | 250 | return True |
| 251 | return False |
| 252 | |
| 253 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 254 | def CheckApprovedFilesLintClean(input_api, output_api, |
mflodman@webrtc.org | 2a45209 | 2012-07-01 05:55:23 +0000 | [diff] [blame] | 255 | source_file_filter=None): |
oprypin | 2aa463f | 2017-03-23 03:17:02 -0700 | [diff] [blame] | 256 | """Checks that all new or non-blacklisted .cc and .h files pass cpplint.py. |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 257 | This check is based on CheckChangeLintsClean in |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 258 | depot_tools/presubmit_canned_checks.py but has less filters and only checks |
| 259 | added files.""" |
| 260 | result = [] |
| 261 | |
| 262 | # Initialize cpplint. |
| 263 | import cpplint |
| 264 | # Access to a protected member _XX of a client class |
| 265 | # pylint: disable=W0212 |
| 266 | cpplint._cpplint_state.ResetErrorCounts() |
| 267 | |
jbauch | c4e3ead | 2016-02-19 00:25:55 -0800 | [diff] [blame] | 268 | lint_filters = cpplint._Filters() |
| 269 | lint_filters.extend(BLACKLIST_LINT_FILTERS) |
| 270 | cpplint._SetFilters(','.join(lint_filters)) |
| 271 | |
oprypin | 2aa463f | 2017-03-23 03:17:02 -0700 | [diff] [blame] | 272 | # Create a platform independent blacklist for cpplint. |
| 273 | blacklist_paths = [input_api.os_path.join(*path.split('/')) |
| 274 | for path in CPPLINT_BLACKLIST] |
kjellander@webrtc.org | 0fcaf99 | 2015-11-26 15:24:52 +0100 | [diff] [blame] | 275 | |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 276 | # Use the strictest verbosity level for cpplint.py (level 1) which is the |
oprypin | 2aa463f | 2017-03-23 03:17:02 -0700 | [diff] [blame] | 277 | # default when running cpplint.py from command line. To make it possible to |
| 278 | # work with not-yet-converted code, we're only applying it to new (or |
| 279 | # moved/renamed) files and files not listed in CPPLINT_BLACKLIST. |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 280 | verbosity_level = 1 |
| 281 | files = [] |
| 282 | for f in input_api.AffectedSourceFiles(source_file_filter): |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 283 | # Note that moved/renamed files also count as added. |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 284 | if f.Action() == 'A' or not IsLintBlacklisted(blacklist_paths, |
oprypin | 2aa463f | 2017-03-23 03:17:02 -0700 | [diff] [blame] | 285 | f.LocalPath()): |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 286 | files.append(f.AbsoluteLocalPath()) |
mflodman@webrtc.org | 2a45209 | 2012-07-01 05:55:23 +0000 | [diff] [blame] | 287 | |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 288 | for file_name in files: |
| 289 | cpplint.ProcessFile(file_name, verbosity_level) |
| 290 | |
| 291 | if cpplint._cpplint_state.error_count > 0: |
| 292 | if input_api.is_committing: |
oprypin | 8e58d65 | 2017-03-21 07:52:41 -0700 | [diff] [blame] | 293 | res_type = output_api.PresubmitError |
kjellander@webrtc.org | 51198f1 | 2012-02-21 17:53:46 +0000 | [diff] [blame] | 294 | else: |
| 295 | res_type = output_api.PresubmitPromptWarning |
| 296 | result = [res_type('Changelist failed cpplint.py check.')] |
| 297 | |
| 298 | return result |
| 299 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 300 | def CheckNoSourcesAbove(input_api, gn_files, output_api): |
ehmaldonado | 5b1ba08 | 2016-09-02 05:51:08 -0700 | [diff] [blame] | 301 | # Disallow referencing source files with paths above the GN file location. |
| 302 | source_pattern = input_api.re.compile(r' +sources \+?= \[(.*?)\]', |
| 303 | re.MULTILINE | re.DOTALL) |
| 304 | file_pattern = input_api.re.compile(r'"((\.\./.*?)|(//.*?))"') |
| 305 | violating_gn_files = set() |
| 306 | violating_source_entries = [] |
| 307 | for gn_file in gn_files: |
| 308 | contents = input_api.ReadFile(gn_file) |
| 309 | for source_block_match in source_pattern.finditer(contents): |
| 310 | # Find all source list entries starting with ../ in the source block |
| 311 | # (exclude overrides entries). |
| 312 | for file_list_match in file_pattern.finditer(source_block_match.group(1)): |
| 313 | source_file = file_list_match.group(1) |
| 314 | if 'overrides/' not in source_file: |
| 315 | violating_source_entries.append(source_file) |
| 316 | violating_gn_files.add(gn_file) |
| 317 | if violating_gn_files: |
| 318 | return [output_api.PresubmitError( |
| 319 | 'Referencing source files above the directory of the GN file is not ' |
Henrik Kjellander | b4af3d6 | 2016-11-16 20:11:29 +0100 | [diff] [blame] | 320 | 'allowed. Please introduce new GN targets in the proper location ' |
| 321 | 'instead.\n' |
ehmaldonado | 5b1ba08 | 2016-09-02 05:51:08 -0700 | [diff] [blame] | 322 | 'Invalid source entries:\n' |
| 323 | '%s\n' |
| 324 | 'Violating GN files:' % '\n'.join(violating_source_entries), |
| 325 | items=violating_gn_files)] |
| 326 | return [] |
| 327 | |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 328 | def CheckNoMixingSources(input_api, gn_files, output_api): |
| 329 | """Disallow mixing C, C++ and Obj-C/Obj-C++ in the same target. |
| 330 | |
| 331 | See bugs.webrtc.org/7743 for more context. |
| 332 | """ |
| 333 | def _MoreThanOneSourceUsed(*sources_lists): |
| 334 | sources_used = 0 |
| 335 | for source_list in sources_lists: |
| 336 | if len(source_list): |
| 337 | sources_used += 1 |
| 338 | return sources_used > 1 |
| 339 | |
| 340 | errors = defaultdict(lambda: []) |
kjellander | 7439f97 | 2016-12-05 22:47:46 -0800 | [diff] [blame] | 341 | for gn_file in gn_files: |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 342 | gn_file_content = input_api.ReadFile(gn_file) |
| 343 | for target_match in TARGET_RE.finditer(gn_file_content): |
| 344 | # list_of_sources is a list of tuples of the form |
| 345 | # (c_files, cc_files, objc_files) that keeps track of all the sources |
| 346 | # defined in a target. A GN target can have more that on definition of |
| 347 | # sources (since it supports if/else statements). |
| 348 | # E.g.: |
| 349 | # rtc_static_library("foo") { |
| 350 | # if (is_win) { |
| 351 | # sources = [ "foo.cc" ] |
| 352 | # } else { |
| 353 | # sources = [ "foo.mm" ] |
| 354 | # } |
| 355 | # } |
| 356 | # This is allowed and the presubmit check should support this case. |
| 357 | list_of_sources = [] |
kjellander | 7439f97 | 2016-12-05 22:47:46 -0800 | [diff] [blame] | 358 | c_files = [] |
| 359 | cc_files = [] |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 360 | objc_files = [] |
| 361 | target_name = target_match.group('target_name') |
| 362 | target_contents = target_match.group('target_contents') |
| 363 | for sources_match in SOURCES_RE.finditer(target_contents): |
| 364 | if '+=' not in sources_match.group(0): |
| 365 | if c_files or cc_files or objc_files: |
| 366 | list_of_sources.append((c_files, cc_files, objc_files)) |
| 367 | c_files = [] |
| 368 | cc_files = [] |
| 369 | objc_files = [] |
| 370 | for file_match in FILE_PATH_RE.finditer(sources_match.group(1)): |
| 371 | file_path = file_match.group('file_path') |
| 372 | extension = file_match.group('extension') |
| 373 | if extension == '.c': |
| 374 | c_files.append(file_path + extension) |
| 375 | if extension == '.cc': |
| 376 | cc_files.append(file_path + extension) |
| 377 | if extension in ['.m', '.mm']: |
| 378 | objc_files.append(file_path + extension) |
| 379 | list_of_sources.append((c_files, cc_files, objc_files)) |
| 380 | for c_files_list, cc_files_list, objc_files_list in list_of_sources: |
| 381 | if _MoreThanOneSourceUsed(c_files_list, cc_files_list, objc_files_list): |
| 382 | all_sources = sorted(c_files_list + cc_files_list + objc_files_list) |
| 383 | errors[gn_file.LocalPath()].append((target_name, all_sources)) |
| 384 | if errors: |
kjellander | 7439f97 | 2016-12-05 22:47:46 -0800 | [diff] [blame] | 385 | return [output_api.PresubmitError( |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 386 | 'GN targets cannot mix .c, .cc and .m (or .mm) source files.\n' |
| 387 | 'Please create a separate target for each collection of sources.\n' |
kjellander | 7439f97 | 2016-12-05 22:47:46 -0800 | [diff] [blame] | 388 | 'Mixed sources: \n' |
| 389 | '%s\n' |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 390 | 'Violating GN files:\n%s\n' % (json.dumps(errors, indent=2), |
| 391 | '\n'.join(errors.keys())))] |
kjellander | 7439f97 | 2016-12-05 22:47:46 -0800 | [diff] [blame] | 392 | return [] |
| 393 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 394 | def CheckNoPackageBoundaryViolations(input_api, gn_files, output_api): |
ehmaldonado | 4fb9746 | 2017-01-30 05:27:22 -0800 | [diff] [blame] | 395 | cwd = input_api.PresubmitLocalPath() |
Oleh Prypin | 2f33a56 | 2017-10-04 20:17:54 +0200 | [diff] [blame] | 396 | with _AddToPath(input_api.os_path.join( |
| 397 | cwd, 'tools_webrtc', 'presubmit_checks_lib')): |
| 398 | from check_package_boundaries import CheckPackageBoundaries |
| 399 | build_files = [os.path.join(cwd, gn_file.LocalPath()) for gn_file in gn_files] |
| 400 | errors = CheckPackageBoundaries(cwd, build_files)[:5] |
| 401 | if errors: |
ehmaldonado | 4fb9746 | 2017-01-30 05:27:22 -0800 | [diff] [blame] | 402 | return [output_api.PresubmitError( |
Oleh Prypin | 2f33a56 | 2017-10-04 20:17:54 +0200 | [diff] [blame] | 403 | 'There are package boundary violations in the following GN files:', |
| 404 | long_text='\n\n'.join(str(err) for err in errors))] |
ehmaldonado | 4fb9746 | 2017-01-30 05:27:22 -0800 | [diff] [blame] | 405 | return [] |
| 406 | |
Mirko Bonadei | 5c1ad59 | 2017-12-12 11:52:27 +0100 | [diff] [blame] | 407 | def CheckPublicDepsIsNotUsed(gn_files, output_api): |
| 408 | result = [] |
| 409 | error_msg = ('public_deps is not allowed in WebRTC BUILD.gn files because ' |
| 410 | 'it doesn\'t map well to downstream build systems.\n' |
| 411 | 'Used in: %s (line %d).') |
| 412 | for affected_file in gn_files: |
| 413 | for (line_number, affected_line) in affected_file.ChangedContents(): |
| 414 | if 'public_deps' in affected_line: |
| 415 | result.append( |
| 416 | output_api.PresubmitError(error_msg % (affected_file.LocalPath(), |
| 417 | line_number))) |
| 418 | return result |
| 419 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 420 | def CheckGnChanges(input_api, output_api): |
ehmaldonado | 5b1ba08 | 2016-09-02 05:51:08 -0700 | [diff] [blame] | 421 | source_file_filter = lambda x: input_api.FilterSourceFile( |
Oleh Prypin | afe0165 | 2017-10-04 15:56:08 +0200 | [diff] [blame] | 422 | x, white_list=(r'.+\.(gn|gni)$',), |
Mirko Bonadei | 5c1ad59 | 2017-12-12 11:52:27 +0100 | [diff] [blame] | 423 | black_list=(r'.*/presubmit_checks_lib/testdata/.*',)) |
ehmaldonado | 5b1ba08 | 2016-09-02 05:51:08 -0700 | [diff] [blame] | 424 | |
| 425 | gn_files = [] |
| 426 | for f in input_api.AffectedSourceFiles(source_file_filter): |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 427 | gn_files.append(f) |
ehmaldonado | 5b1ba08 | 2016-09-02 05:51:08 -0700 | [diff] [blame] | 428 | |
| 429 | result = [] |
| 430 | if gn_files: |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 431 | result.extend(CheckNoSourcesAbove(input_api, gn_files, output_api)) |
Mirko Bonadei | 4dc4e25 | 2017-09-19 13:49:16 +0200 | [diff] [blame] | 432 | result.extend(CheckNoMixingSources(input_api, gn_files, output_api)) |
| 433 | result.extend(CheckNoPackageBoundaryViolations(input_api, gn_files, |
| 434 | output_api)) |
Mirko Bonadei | 5c1ad59 | 2017-12-12 11:52:27 +0100 | [diff] [blame] | 435 | result.extend(CheckPublicDepsIsNotUsed(gn_files, output_api)) |
ehmaldonado | 5b1ba08 | 2016-09-02 05:51:08 -0700 | [diff] [blame] | 436 | return result |
| 437 | |
Oleh Prypin | 920b653 | 2017-10-05 11:28:51 +0200 | [diff] [blame] | 438 | def CheckGnGen(input_api, output_api): |
| 439 | """Runs `gn gen --check` with default args to detect mismatches between |
| 440 | #includes and dependencies in the BUILD.gn files, as well as general build |
| 441 | errors. |
| 442 | """ |
| 443 | with _AddToPath(input_api.os_path.join( |
| 444 | input_api.PresubmitLocalPath(), 'tools_webrtc', 'presubmit_checks_lib')): |
| 445 | from gn_check import RunGnCheck |
| 446 | errors = RunGnCheck(input_api.PresubmitLocalPath())[:5] |
| 447 | if errors: |
| 448 | return [output_api.PresubmitPromptWarning( |
| 449 | 'Some #includes do not match the build dependency graph. Please run:\n' |
| 450 | ' gn gen --check <out_dir>', |
| 451 | long_text='\n\n'.join(errors))] |
| 452 | return [] |
| 453 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 454 | def CheckUnwantedDependencies(input_api, output_api): |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 455 | """Runs checkdeps on #include statements added in this |
| 456 | change. Breaking - rules is an error, breaking ! rules is a |
| 457 | warning. |
| 458 | """ |
| 459 | # Copied from Chromium's src/PRESUBMIT.py. |
| 460 | |
| 461 | # We need to wait until we have an input_api object and use this |
| 462 | # roundabout construct to import checkdeps because this file is |
| 463 | # eval-ed and thus doesn't have __file__. |
Oleh Prypin | 2f33a56 | 2017-10-04 20:17:54 +0200 | [diff] [blame] | 464 | checkdeps_path = input_api.os_path.join(input_api.PresubmitLocalPath(), |
| 465 | 'buildtools', 'checkdeps') |
| 466 | if not os.path.exists(checkdeps_path): |
| 467 | return [output_api.PresubmitError( |
| 468 | 'Cannot find checkdeps at %s\nHave you run "gclient sync" to ' |
| 469 | 'download all the DEPS entries?' % checkdeps_path)] |
| 470 | with _AddToPath(checkdeps_path): |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 471 | import checkdeps |
| 472 | from cpp_checker import CppChecker |
| 473 | from rules import Rule |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 474 | |
| 475 | added_includes = [] |
| 476 | for f in input_api.AffectedFiles(): |
| 477 | if not CppChecker.IsCppFile(f.LocalPath()): |
| 478 | continue |
| 479 | |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 480 | changed_lines = [line for _, line in f.ChangedContents()] |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 481 | added_includes.append([f.LocalPath(), changed_lines]) |
| 482 | |
| 483 | deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath()) |
| 484 | |
| 485 | error_descriptions = [] |
| 486 | warning_descriptions = [] |
| 487 | for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes( |
| 488 | added_includes): |
| 489 | description_with_path = '%s\n %s' % (path, rule_description) |
| 490 | if rule_type == Rule.DISALLOW: |
| 491 | error_descriptions.append(description_with_path) |
| 492 | else: |
| 493 | warning_descriptions.append(description_with_path) |
| 494 | |
| 495 | results = [] |
| 496 | if error_descriptions: |
| 497 | results.append(output_api.PresubmitError( |
kjellander | a7066a3 | 2017-03-23 03:47:05 -0700 | [diff] [blame] | 498 | 'You added one or more #includes that violate checkdeps rules.\n' |
| 499 | 'Check that the DEPS files in these locations contain valid rules.\n' |
| 500 | 'See https://cs.chromium.org/chromium/src/buildtools/checkdeps/ for ' |
| 501 | 'more details about checkdeps.', |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 502 | error_descriptions)) |
| 503 | if warning_descriptions: |
| 504 | results.append(output_api.PresubmitPromptOrNotify( |
| 505 | 'You added one or more #includes of files that are temporarily\n' |
| 506 | 'allowed but being removed. Can you avoid introducing the\n' |
kjellander | a7066a3 | 2017-03-23 03:47:05 -0700 | [diff] [blame] | 507 | '#include? See relevant DEPS file(s) for details and contacts.\n' |
| 508 | 'See https://cs.chromium.org/chromium/src/buildtools/checkdeps/ for ' |
| 509 | 'more details about checkdeps.', |
kjellander@webrtc.org | 3bd4156 | 2014-09-01 11:06:37 +0000 | [diff] [blame] | 510 | warning_descriptions)) |
| 511 | return results |
| 512 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 513 | def CheckCommitMessageBugEntry(input_api, output_api): |
| 514 | """Check that bug entries are well-formed in commit message.""" |
| 515 | bogus_bug_msg = ( |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 516 | 'Bogus Bug entry: %s. Please specify the issue tracker prefix and the ' |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 517 | 'issue number, separated by a colon, e.g. webrtc:123 or chromium:12345.') |
| 518 | results = [] |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 519 | for bug in input_api.change.BugsFromDescription(): |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 520 | bug = bug.strip() |
| 521 | if bug.lower() == 'none': |
| 522 | continue |
charujain | 81a58c7 | 2017-09-25 13:25:45 +0200 | [diff] [blame] | 523 | if 'b/' not in bug and ':' not in bug: |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 524 | try: |
| 525 | if int(bug) > 100000: |
| 526 | # Rough indicator for current chromium bugs. |
| 527 | prefix_guess = 'chromium' |
| 528 | else: |
| 529 | prefix_guess = 'webrtc' |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 530 | results.append('Bug entry requires issue tracker prefix, e.g. %s:%s' % |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 531 | (prefix_guess, bug)) |
| 532 | except ValueError: |
| 533 | results.append(bogus_bug_msg % bug) |
charujain | 81a58c7 | 2017-09-25 13:25:45 +0200 | [diff] [blame] | 534 | elif not (re.match(r'\w+:\d+', bug) or re.match(r'b/\d+', bug)): |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 535 | results.append(bogus_bug_msg % bug) |
| 536 | return [output_api.PresubmitError(r) for r in results] |
| 537 | |
| 538 | def CheckChangeHasBugField(input_api, output_api): |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 539 | """Requires that the changelist is associated with a bug. |
kjellander | d1e26a9 | 2016-09-19 08:11:16 -0700 | [diff] [blame] | 540 | |
| 541 | This check is stricter than the one in depot_tools/presubmit_canned_checks.py |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 542 | since it fails the presubmit if the bug field is missing or doesn't contain |
kjellander | d1e26a9 | 2016-09-19 08:11:16 -0700 | [diff] [blame] | 543 | a bug reference. |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 544 | |
| 545 | This supports both 'BUG=' and 'Bug:' since we are in the process of migrating |
| 546 | to Gerrit and it encourages the usage of 'Bug:'. |
kjellander | d1e26a9 | 2016-09-19 08:11:16 -0700 | [diff] [blame] | 547 | """ |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 548 | if input_api.change.BugsFromDescription(): |
kjellander | d1e26a9 | 2016-09-19 08:11:16 -0700 | [diff] [blame] | 549 | return [] |
| 550 | else: |
| 551 | return [output_api.PresubmitError( |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 552 | 'The "Bug: [bug number]" footer is mandatory. Please create a bug and ' |
kjellander | d1e26a9 | 2016-09-19 08:11:16 -0700 | [diff] [blame] | 553 | 'reference it using either of:\n' |
Mirko Bonadei | 6188018 | 2017-10-12 15:12:35 +0200 | [diff] [blame] | 554 | ' * https://bugs.webrtc.org - reference it using Bug: webrtc:XXXX\n' |
| 555 | ' * https://crbug.com - reference it using Bug: chromium:XXXXXX')] |
kjellander@webrtc.org | e415864 | 2014-08-06 09:11:18 +0000 | [diff] [blame] | 556 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 557 | def CheckJSONParseErrors(input_api, output_api): |
kjellander | 569cf94 | 2016-02-11 05:02:59 -0800 | [diff] [blame] | 558 | """Check that JSON files do not contain syntax errors.""" |
| 559 | |
| 560 | def FilterFile(affected_file): |
| 561 | return input_api.os_path.splitext(affected_file.LocalPath())[1] == '.json' |
| 562 | |
| 563 | def GetJSONParseError(input_api, filename): |
| 564 | try: |
| 565 | contents = input_api.ReadFile(filename) |
| 566 | input_api.json.loads(contents) |
| 567 | except ValueError as e: |
| 568 | return e |
| 569 | return None |
| 570 | |
| 571 | results = [] |
| 572 | for affected_file in input_api.AffectedFiles( |
| 573 | file_filter=FilterFile, include_deletes=False): |
| 574 | parse_error = GetJSONParseError(input_api, |
| 575 | affected_file.AbsoluteLocalPath()) |
| 576 | if parse_error: |
| 577 | results.append(output_api.PresubmitError('%s could not be parsed: %s' % |
| 578 | (affected_file.LocalPath(), parse_error))) |
| 579 | return results |
| 580 | |
| 581 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 582 | def RunPythonTests(input_api, output_api): |
kjellander | c88b5d5 | 2017-04-05 06:42:43 -0700 | [diff] [blame] | 583 | def Join(*args): |
Henrik Kjellander | 8d3ad82 | 2015-05-26 19:52:05 +0200 | [diff] [blame] | 584 | return input_api.os_path.join(input_api.PresubmitLocalPath(), *args) |
| 585 | |
| 586 | test_directories = [ |
Edward Lemur | 6d01f6d | 2017-09-14 17:02:01 +0200 | [diff] [blame] | 587 | input_api.PresubmitLocalPath(), |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 588 | Join('rtc_tools', 'py_event_log_analyzer'), |
| 589 | Join('rtc_tools'), |
| 590 | Join('audio', 'test', 'unittests'), |
ehmaldonado | 4fb9746 | 2017-01-30 05:27:22 -0800 | [diff] [blame] | 591 | ] + [ |
Henrik Kjellander | 90fd7d8 | 2017-05-09 08:30:10 +0200 | [diff] [blame] | 592 | root for root, _, files in os.walk(Join('tools_webrtc')) |
ehmaldonado | 4fb9746 | 2017-01-30 05:27:22 -0800 | [diff] [blame] | 593 | if any(f.endswith('_test.py') for f in files) |
Henrik Kjellander | 8d3ad82 | 2015-05-26 19:52:05 +0200 | [diff] [blame] | 594 | ] |
| 595 | |
| 596 | tests = [] |
| 597 | for directory in test_directories: |
| 598 | tests.extend( |
| 599 | input_api.canned_checks.GetUnitTestsInDirectory( |
| 600 | input_api, |
| 601 | output_api, |
| 602 | directory, |
| 603 | whitelist=[r'.+_test\.py$'])) |
| 604 | return input_api.RunTests(tests, parallel=True) |
| 605 | |
| 606 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 607 | def CheckUsageOfGoogleProtobufNamespace(input_api, output_api): |
mbonadei | 38415b2 | 2017-04-07 05:38:01 -0700 | [diff] [blame] | 608 | """Checks that the namespace google::protobuf has not been used.""" |
| 609 | files = [] |
| 610 | pattern = input_api.re.compile(r'google::protobuf') |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 611 | proto_utils_path = os.path.join('rtc_base', 'protobuf_utils.h') |
mbonadei | 38415b2 | 2017-04-07 05:38:01 -0700 | [diff] [blame] | 612 | for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile): |
| 613 | if f.LocalPath() in [proto_utils_path, 'PRESUBMIT.py']: |
| 614 | continue |
| 615 | contents = input_api.ReadFile(f) |
| 616 | if pattern.search(contents): |
| 617 | files.append(f) |
| 618 | |
| 619 | if files: |
| 620 | return [output_api.PresubmitError( |
| 621 | 'Please avoid to use namespace `google::protobuf` directly.\n' |
| 622 | 'Add a using directive in `%s` and include that header instead.' |
| 623 | % proto_utils_path, files)] |
| 624 | return [] |
| 625 | |
| 626 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 627 | def _LicenseHeader(input_api): |
| 628 | """Returns the license header regexp.""" |
| 629 | # Accept any year number from 2003 to the current year |
| 630 | current_year = int(input_api.time.strftime('%Y')) |
| 631 | allowed_years = (str(s) for s in reversed(xrange(2003, current_year + 1))) |
| 632 | years_re = '(' + '|'.join(allowed_years) + ')' |
| 633 | license_header = ( |
| 634 | r'.*? Copyright( \(c\))? %(year)s The WebRTC [Pp]roject [Aa]uthors\. ' |
| 635 | r'All [Rr]ights [Rr]eserved\.\n' |
| 636 | r'.*?\n' |
| 637 | r'.*? Use of this source code is governed by a BSD-style license\n' |
| 638 | r'.*? that can be found in the LICENSE file in the root of the source\n' |
| 639 | r'.*? tree\. An additional intellectual property rights grant can be ' |
| 640 | r'found\n' |
| 641 | r'.*? in the file PATENTS\. All contributing project authors may\n' |
| 642 | r'.*? be found in the AUTHORS file in the root of the source tree\.\n' |
| 643 | ) % { |
| 644 | 'year': years_re, |
| 645 | } |
| 646 | return license_header |
| 647 | |
| 648 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 649 | def CommonChecks(input_api, output_api): |
andrew@webrtc.org | 53df136 | 2012-01-26 21:24:23 +0000 | [diff] [blame] | 650 | """Checks common to both upload and commit.""" |
niklase@google.com | da159d6 | 2011-05-30 11:51:34 +0000 | [diff] [blame] | 651 | results = [] |
tkchin | 42f580e | 2015-11-26 23:18:23 -0800 | [diff] [blame] | 652 | # Filter out files that are in objc or ios dirs from being cpplint-ed since |
| 653 | # they do not follow C++ lint rules. |
| 654 | black_list = input_api.DEFAULT_BLACK_LIST + ( |
| 655 | r".*\bobjc[\\\/].*", |
Kári Tristan Helgason | 3fa3517 | 2016-09-09 08:55:05 +0000 | [diff] [blame] | 656 | r".*objc\.[hcm]+$", |
tkchin | 42f580e | 2015-11-26 23:18:23 -0800 | [diff] [blame] | 657 | ) |
| 658 | source_file_filter = lambda x: input_api.FilterSourceFile(x, None, black_list) |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 659 | results.extend(CheckApprovedFilesLintClean( |
tkchin | 42f580e | 2015-11-26 23:18:23 -0800 | [diff] [blame] | 660 | input_api, output_api, source_file_filter)) |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 661 | results.extend(input_api.canned_checks.CheckLicense( |
| 662 | input_api, output_api, _LicenseHeader(input_api))) |
phoglund@webrtc.org | 5d371393 | 2013-03-07 09:59:43 +0000 | [diff] [blame] | 663 | results.extend(input_api.canned_checks.RunPylint(input_api, output_api, |
kjellander@webrtc.org | 177567c | 2016-12-22 10:40:28 +0100 | [diff] [blame] | 664 | black_list=(r'^base[\\\/].*\.py$', |
Henrik Kjellander | 14771ac | 2015-06-02 13:10:04 +0200 | [diff] [blame] | 665 | r'^build[\\\/].*\.py$', |
| 666 | r'^buildtools[\\\/].*\.py$', |
kjellander | 38c65c8 | 2017-04-12 22:43:38 -0700 | [diff] [blame] | 667 | r'^infra[\\\/].*\.py$', |
Henrik Kjellander | 0779e8f | 2016-12-22 12:01:17 +0100 | [diff] [blame] | 668 | r'^ios[\\\/].*\.py$', |
Henrik Kjellander | 14771ac | 2015-06-02 13:10:04 +0200 | [diff] [blame] | 669 | r'^out.*[\\\/].*\.py$', |
| 670 | r'^testing[\\\/].*\.py$', |
| 671 | r'^third_party[\\\/].*\.py$', |
kjellander@webrtc.org | 177567c | 2016-12-22 10:40:28 +0100 | [diff] [blame] | 672 | r'^tools[\\\/].*\.py$', |
kjellander | afd5494 | 2016-12-17 12:21:39 -0800 | [diff] [blame] | 673 | # TODO(phoglund): should arguably be checked. |
Henrik Kjellander | 90fd7d8 | 2017-05-09 08:30:10 +0200 | [diff] [blame] | 674 | r'^tools_webrtc[\\\/]mb[\\\/].*\.py$', |
| 675 | r'^tools_webrtc[\\\/]valgrind[\\\/].*\.py$', |
Henrik Kjellander | 14771ac | 2015-06-02 13:10:04 +0200 | [diff] [blame] | 676 | r'^xcodebuild.*[\\\/].*\.py$',), |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 677 | pylintrc='pylintrc')) |
kjellander | 569cf94 | 2016-02-11 05:02:59 -0800 | [diff] [blame] | 678 | |
nisse | 3d21e23 | 2016-09-02 03:07:06 -0700 | [diff] [blame] | 679 | # TODO(nisse): talk/ is no more, so make below checks simpler? |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 680 | # WebRTC can't use the presubmit_canned_checks.PanProjectChecks function since |
| 681 | # we need to have different license checks in talk/ and webrtc/ directories. |
| 682 | # Instead, hand-picked checks are included below. |
Henrik Kjellander | 6322467 | 2015-09-08 08:03:56 +0200 | [diff] [blame] | 683 | |
tkchin | 3cd9a30 | 2016-06-08 12:40:28 -0700 | [diff] [blame] | 684 | # .m and .mm files are ObjC files. For simplicity we will consider .h files in |
| 685 | # ObjC subdirectories ObjC headers. |
| 686 | objc_filter_list = (r'.+\.m$', r'.+\.mm$', r'.+objc\/.+\.h$') |
Henrik Kjellander | b4af3d6 | 2016-11-16 20:11:29 +0100 | [diff] [blame] | 687 | # Skip long-lines check for DEPS and GN files. |
| 688 | build_file_filter_list = (r'.+\.gn$', r'.+\.gni$', 'DEPS') |
tkchin | 3cd9a30 | 2016-06-08 12:40:28 -0700 | [diff] [blame] | 689 | eighty_char_sources = lambda x: input_api.FilterSourceFile(x, |
| 690 | black_list=build_file_filter_list + objc_filter_list) |
| 691 | hundred_char_sources = lambda x: input_api.FilterSourceFile(x, |
| 692 | white_list=objc_filter_list) |
andrew@webrtc.org | 2442de1 | 2012-01-23 17:45:41 +0000 | [diff] [blame] | 693 | results.extend(input_api.canned_checks.CheckLongLines( |
tkchin | 3cd9a30 | 2016-06-08 12:40:28 -0700 | [diff] [blame] | 694 | input_api, output_api, maxlen=80, source_file_filter=eighty_char_sources)) |
| 695 | results.extend(input_api.canned_checks.CheckLongLines( |
| 696 | input_api, output_api, maxlen=100, |
| 697 | source_file_filter=hundred_char_sources)) |
| 698 | |
andrew@webrtc.org | 2442de1 | 2012-01-23 17:45:41 +0000 | [diff] [blame] | 699 | results.extend(input_api.canned_checks.CheckChangeHasNoTabs( |
| 700 | input_api, output_api)) |
andrew@webrtc.org | 53df136 | 2012-01-26 21:24:23 +0000 | [diff] [blame] | 701 | results.extend(input_api.canned_checks.CheckChangeHasNoStrayWhitespace( |
| 702 | input_api, output_api)) |
kjellander | e5dc62a | 2016-12-14 00:16:21 -0800 | [diff] [blame] | 703 | results.extend(input_api.canned_checks.CheckAuthorizedAuthor( |
| 704 | input_api, output_api)) |
andrew@webrtc.org | 53df136 | 2012-01-26 21:24:23 +0000 | [diff] [blame] | 705 | results.extend(input_api.canned_checks.CheckChangeTodoHasOwner( |
| 706 | input_api, output_api)) |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 707 | results.extend(CheckNativeApiHeaderChanges(input_api, output_api)) |
| 708 | results.extend(CheckNoIOStreamInHeaders(input_api, output_api)) |
| 709 | results.extend(CheckNoPragmaOnce(input_api, output_api)) |
| 710 | results.extend(CheckNoFRIEND_TEST(input_api, output_api)) |
| 711 | results.extend(CheckGnChanges(input_api, output_api)) |
| 712 | results.extend(CheckUnwantedDependencies(input_api, output_api)) |
| 713 | results.extend(CheckJSONParseErrors(input_api, output_api)) |
| 714 | results.extend(RunPythonTests(input_api, output_api)) |
| 715 | results.extend(CheckUsageOfGoogleProtobufNamespace(input_api, output_api)) |
Mirko Bonadei | 866d337 | 2017-09-15 12:35:26 +0200 | [diff] [blame] | 716 | results.extend(CheckOrphanHeaders(input_api, output_api)) |
Mirko Bonadei | a730c1c | 2017-09-18 11:33:13 +0200 | [diff] [blame] | 717 | results.extend(CheckNewlineAtTheEndOfProtoFiles(input_api, output_api)) |
andrew@webrtc.org | 53df136 | 2012-01-26 21:24:23 +0000 | [diff] [blame] | 718 | return results |
andrew@webrtc.org | 2442de1 | 2012-01-23 17:45:41 +0000 | [diff] [blame] | 719 | |
kjellander@webrtc.org | e415864 | 2014-08-06 09:11:18 +0000 | [diff] [blame] | 720 | |
andrew@webrtc.org | 53df136 | 2012-01-26 21:24:23 +0000 | [diff] [blame] | 721 | def CheckChangeOnUpload(input_api, output_api): |
| 722 | results = [] |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 723 | results.extend(CommonChecks(input_api, output_api)) |
Oleh Prypin | 920b653 | 2017-10-05 11:28:51 +0200 | [diff] [blame] | 724 | results.extend(CheckGnGen(input_api, output_api)) |
Henrik Kjellander | 57e5fd2 | 2015-05-25 12:55:39 +0200 | [diff] [blame] | 725 | results.extend( |
| 726 | input_api.canned_checks.CheckGNFormatted(input_api, output_api)) |
niklase@google.com | da159d6 | 2011-05-30 11:51:34 +0000 | [diff] [blame] | 727 | return results |
| 728 | |
kjellander@webrtc.org | e415864 | 2014-08-06 09:11:18 +0000 | [diff] [blame] | 729 | |
andrew@webrtc.org | 2442de1 | 2012-01-23 17:45:41 +0000 | [diff] [blame] | 730 | def CheckChangeOnCommit(input_api, output_api): |
niklase@google.com | 1198db9 | 2011-06-09 07:07:24 +0000 | [diff] [blame] | 731 | results = [] |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 732 | results.extend(CommonChecks(input_api, output_api)) |
| 733 | results.extend(VerifyNativeApiHeadersListIsValid(input_api, output_api)) |
niklase@google.com | 1198db9 | 2011-06-09 07:07:24 +0000 | [diff] [blame] | 734 | results.extend(input_api.canned_checks.CheckOwners(input_api, output_api)) |
andrew@webrtc.org | 53df136 | 2012-01-26 21:24:23 +0000 | [diff] [blame] | 735 | results.extend(input_api.canned_checks.CheckChangeWasUploaded( |
| 736 | input_api, output_api)) |
| 737 | results.extend(input_api.canned_checks.CheckChangeHasDescription( |
| 738 | input_api, output_api)) |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 739 | results.extend(CheckChangeHasBugField(input_api, output_api)) |
| 740 | results.extend(CheckCommitMessageBugEntry(input_api, output_api)) |
kjellander@webrtc.org | 12cb88c | 2014-02-13 11:53:43 +0000 | [diff] [blame] | 741 | results.extend(input_api.canned_checks.CheckTreeIsOpen( |
| 742 | input_api, output_api, |
| 743 | json_url='http://webrtc-status.appspot.com/current?format=json')) |
niklase@google.com | 1198db9 | 2011-06-09 07:07:24 +0000 | [diff] [blame] | 744 | return results |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 745 | |
| 746 | |
charujain | 9893e25 | 2017-09-14 13:33:22 +0200 | [diff] [blame] | 747 | def CheckOrphanHeaders(input_api, output_api): |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 748 | # We need to wait until we have an input_api object and use this |
| 749 | # roundabout construct to import prebubmit_checks_lib because this file is |
| 750 | # eval-ed and thus doesn't have __file__. |
Patrik Höglund | 2f3f722 | 2017-12-19 11:08:56 +0100 | [diff] [blame] | 751 | error_msg = """{} should be listed in {}.""" |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 752 | results = [] |
Patrik Höglund | 7e60de2 | 2018-01-09 14:22:00 +0100 | [diff] [blame] | 753 | orphan_blacklist = [ |
| 754 | os.path.join('tools_webrtc', 'ios', 'SDK'), |
| 755 | ] |
Oleh Prypin | 2f33a56 | 2017-10-04 20:17:54 +0200 | [diff] [blame] | 756 | with _AddToPath(input_api.os_path.join( |
| 757 | input_api.PresubmitLocalPath(), 'tools_webrtc', 'presubmit_checks_lib')): |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 758 | from check_orphan_headers import GetBuildGnPathFromFilePath |
| 759 | from check_orphan_headers import IsHeaderInBuildGn |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 760 | |
Patrik Höglund | 7e60de2 | 2018-01-09 14:22:00 +0100 | [diff] [blame] | 761 | source_file_filter = lambda x: input_api.FilterSourceFile( |
| 762 | x, black_list=orphan_blacklist) |
| 763 | for f in input_api.AffectedSourceFiles(source_file_filter): |
| 764 | if f.LocalPath().endswith('.h'): |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 765 | file_path = os.path.abspath(f.LocalPath()) |
| 766 | root_dir = os.getcwd() |
| 767 | gn_file_path = GetBuildGnPathFromFilePath(file_path, os.path.exists, |
| 768 | root_dir) |
| 769 | in_build_gn = IsHeaderInBuildGn(file_path, gn_file_path) |
| 770 | if not in_build_gn: |
| 771 | results.append(output_api.PresubmitError(error_msg.format( |
Patrik Höglund | 2f3f722 | 2017-12-19 11:08:56 +0100 | [diff] [blame] | 772 | f.LocalPath(), os.path.relpath(gn_file_path)))) |
mbonadei | 74973ed | 2017-05-09 07:58:05 -0700 | [diff] [blame] | 773 | return results |
Mirko Bonadei | 960fd5b | 2017-06-29 14:59:36 +0200 | [diff] [blame] | 774 | |
| 775 | |
Mirko Bonadei | a730c1c | 2017-09-18 11:33:13 +0200 | [diff] [blame] | 776 | def CheckNewlineAtTheEndOfProtoFiles(input_api, output_api): |
Mirko Bonadei | 960fd5b | 2017-06-29 14:59:36 +0200 | [diff] [blame] | 777 | """Checks that all .proto files are terminated with a newline.""" |
| 778 | error_msg = 'File {} must end with exactly one newline.' |
| 779 | results = [] |
| 780 | source_file_filter = lambda x: input_api.FilterSourceFile( |
| 781 | x, white_list=(r'.+\.proto$',)) |
| 782 | for f in input_api.AffectedSourceFiles(source_file_filter): |
| 783 | file_path = f.LocalPath() |
| 784 | with open(file_path) as f: |
| 785 | lines = f.readlines() |
Mirko Bonadei | a730c1c | 2017-09-18 11:33:13 +0200 | [diff] [blame] | 786 | if len(lines) > 0 and not lines[-1].endswith('\n'): |
Mirko Bonadei | 960fd5b | 2017-06-29 14:59:36 +0200 | [diff] [blame] | 787 | results.append(output_api.PresubmitError(error_msg.format(file_path))) |
| 788 | return results |