rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 1 | # Copyright (c) 2013 The Chromium Authors. All rights reserved. |
| 2 | # Use of this source code is governed by a BSD-style license that can be |
| 3 | # found in the LICENSE file. |
| 4 | |
| 5 | |
| 6 | """Top-level presubmit script for Skia. |
| 7 | |
| 8 | See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts |
| 9 | for more details about the presubmit API built into gcl. |
| 10 | """ |
| 11 | |
rmistry | 3cfd1ad | 2015-03-25 12:53:35 -0700 | [diff] [blame] | 12 | import csv |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 13 | import fnmatch |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 14 | import os |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 15 | import re |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 16 | import subprocess |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 17 | import sys |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 18 | import traceback |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 19 | |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 20 | |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 21 | REVERT_CL_SUBJECT_PREFIX = 'Revert ' |
| 22 | |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 23 | SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com' |
| 24 | |
rmistry | 3cfd1ad | 2015-03-25 12:53:35 -0700 | [diff] [blame] | 25 | CQ_KEYWORDS_THAT_NEED_APPENDING = ('CQ_INCLUDE_TRYBOTS', 'CQ_EXTRA_TRYBOTS', |
| 26 | 'CQ_EXCLUDE_TRYBOTS', 'CQ_TRYBOTS') |
| 27 | |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 28 | # Please add the complete email address here (and not just 'xyz@' or 'xyz'). |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 29 | PUBLIC_API_OWNERS = ( |
| 30 | 'reed@chromium.org', |
| 31 | 'reed@google.com', |
| 32 | 'bsalomon@chromium.org', |
| 33 | 'bsalomon@google.com', |
rmistry | 83fab47 | 2014-07-18 05:25:56 -0700 | [diff] [blame] | 34 | 'djsollen@chromium.org', |
| 35 | 'djsollen@google.com', |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 36 | ) |
| 37 | |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 38 | AUTHORS_FILE_NAME = 'AUTHORS' |
| 39 | |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 40 | DOCS_PREVIEW_URL = 'https://skia.org/?cl=' |
| 41 | |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 42 | |
rmistry@google.com | 713276b | 2013-01-25 18:27:34 +0000 | [diff] [blame] | 43 | def _CheckChangeHasEol(input_api, output_api, source_file_filter=None): |
| 44 | """Checks that files end with atleast one \n (LF).""" |
| 45 | eof_files = [] |
| 46 | for f in input_api.AffectedSourceFiles(source_file_filter): |
| 47 | contents = input_api.ReadFile(f, 'rb') |
| 48 | # Check that the file ends in atleast one newline character. |
| 49 | if len(contents) > 1 and contents[-1:] != '\n': |
| 50 | eof_files.append(f.LocalPath()) |
| 51 | |
| 52 | if eof_files: |
| 53 | return [output_api.PresubmitPromptWarning( |
| 54 | 'These files should end in a newline character:', |
| 55 | items=eof_files)] |
| 56 | return [] |
| 57 | |
| 58 | |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 59 | def _PythonChecks(input_api, output_api): |
| 60 | """Run checks on any modified Python files.""" |
| 61 | pylint_disabled_warnings = ( |
| 62 | 'F0401', # Unable to import. |
| 63 | 'E0611', # No name in module. |
| 64 | 'W0232', # Class has no __init__ method. |
| 65 | 'E1002', # Use of super on an old style class. |
| 66 | 'W0403', # Relative import used. |
| 67 | 'R0201', # Method could be a function. |
| 68 | 'E1003', # Using class name in super. |
| 69 | 'W0613', # Unused argument. |
| 70 | ) |
| 71 | # Run Pylint on only the modified python files. Unfortunately it still runs |
| 72 | # Pylint on the whole file instead of just the modified lines. |
| 73 | affected_python_files = [] |
| 74 | for affected_file in input_api.AffectedSourceFiles(None): |
| 75 | affected_file_path = affected_file.LocalPath() |
| 76 | if affected_file_path.endswith('.py'): |
| 77 | affected_python_files.append(affected_file_path) |
| 78 | return input_api.canned_checks.RunPylint( |
| 79 | input_api, output_api, |
| 80 | disabled_warnings=pylint_disabled_warnings, |
| 81 | white_list=affected_python_files) |
| 82 | |
| 83 | |
rmistry | 01cbf6c | 2015-03-12 07:48:40 -0700 | [diff] [blame] | 84 | def _IfDefChecks(input_api, output_api): |
| 85 | """Ensures if/ifdef are not before includes. See skbug/3362 for details.""" |
| 86 | comment_block_start_pattern = re.compile('^\s*\/\*.*$') |
| 87 | comment_block_middle_pattern = re.compile('^\s+\*.*') |
| 88 | comment_block_end_pattern = re.compile('^\s+\*\/.*$') |
| 89 | single_line_comment_pattern = re.compile('^\s*//.*$') |
| 90 | def is_comment(line): |
| 91 | return (comment_block_start_pattern.match(line) or |
| 92 | comment_block_middle_pattern.match(line) or |
| 93 | comment_block_end_pattern.match(line) or |
| 94 | single_line_comment_pattern.match(line)) |
| 95 | |
| 96 | empty_line_pattern = re.compile('^\s*$') |
| 97 | def is_empty_line(line): |
| 98 | return empty_line_pattern.match(line) |
| 99 | |
| 100 | failing_files = [] |
| 101 | for affected_file in input_api.AffectedSourceFiles(None): |
| 102 | affected_file_path = affected_file.LocalPath() |
| 103 | if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'): |
| 104 | f = open(affected_file_path) |
| 105 | for line in f.xreadlines(): |
| 106 | if is_comment(line) or is_empty_line(line): |
| 107 | continue |
| 108 | # The below will be the first real line after comments and newlines. |
| 109 | if line.startswith('#if 0 '): |
| 110 | pass |
| 111 | elif line.startswith('#if ') or line.startswith('#ifdef '): |
| 112 | failing_files.append(affected_file_path) |
| 113 | break |
| 114 | |
| 115 | results = [] |
| 116 | if failing_files: |
| 117 | results.append( |
| 118 | output_api.PresubmitError( |
| 119 | 'The following files have #if or #ifdef before includes:\n%s\n\n' |
| 120 | 'See skbug.com/3362 for why this should be fixed.' % |
| 121 | '\n'.join(failing_files))) |
| 122 | return results |
| 123 | |
| 124 | |
borenet | c7c9180 | 2015-03-25 04:47:02 -0700 | [diff] [blame] | 125 | def _CopyrightChecks(input_api, output_api, source_file_filter=None): |
| 126 | results = [] |
| 127 | year_pattern = r'\d{4}' |
| 128 | year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern) |
| 129 | years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern) |
| 130 | copyright_pattern = ( |
| 131 | r'Copyright (\([cC]\) )?%s \w+' % years_pattern) |
| 132 | |
| 133 | for affected_file in input_api.AffectedSourceFiles(source_file_filter): |
| 134 | if 'third_party' in affected_file.LocalPath(): |
| 135 | continue |
| 136 | contents = input_api.ReadFile(affected_file, 'rb') |
| 137 | if not re.search(copyright_pattern, contents): |
| 138 | results.append(output_api.PresubmitError( |
| 139 | '%s is missing a correct copyright header.' % affected_file)) |
| 140 | return results |
| 141 | |
| 142 | |
mtklein | e4b19c4 | 2015-05-05 10:28:44 -0700 | [diff] [blame] | 143 | def _ToolFlags(input_api, output_api): |
| 144 | """Make sure `{dm,nanobench}_flags.py test` passes if modified.""" |
| 145 | results = [] |
| 146 | sources = lambda x: ('dm_flags.py' in x.LocalPath() or |
| 147 | 'nanobench_flags.py' in x.LocalPath()) |
| 148 | for f in input_api.AffectedSourceFiles(sources): |
| 149 | if 0 != subprocess.call(['python', f.LocalPath(), 'test']): |
| 150 | results.append(output_api.PresubmitError('`python %s test` failed' % f)) |
| 151 | return results |
| 152 | |
| 153 | |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 154 | def _CommonChecks(input_api, output_api): |
| 155 | """Presubmit checks common to upload and commit.""" |
| 156 | results = [] |
| 157 | sources = lambda x: (x.LocalPath().endswith('.h') or |
| 158 | x.LocalPath().endswith('.gypi') or |
| 159 | x.LocalPath().endswith('.gyp') or |
| 160 | x.LocalPath().endswith('.py') or |
| 161 | x.LocalPath().endswith('.sh') or |
mtklein | 18e5580 | 2015-03-25 07:21:20 -0700 | [diff] [blame] | 162 | x.LocalPath().endswith('.m') or |
| 163 | x.LocalPath().endswith('.mm') or |
| 164 | x.LocalPath().endswith('.go') or |
| 165 | x.LocalPath().endswith('.c') or |
| 166 | x.LocalPath().endswith('.cc') or |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 167 | x.LocalPath().endswith('.cpp')) |
| 168 | results.extend( |
rmistry@google.com | 713276b | 2013-01-25 18:27:34 +0000 | [diff] [blame] | 169 | _CheckChangeHasEol( |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 170 | input_api, output_api, source_file_filter=sources)) |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 171 | results.extend(_PythonChecks(input_api, output_api)) |
rmistry | 01cbf6c | 2015-03-12 07:48:40 -0700 | [diff] [blame] | 172 | results.extend(_IfDefChecks(input_api, output_api)) |
borenet | c7c9180 | 2015-03-25 04:47:02 -0700 | [diff] [blame] | 173 | results.extend(_CopyrightChecks(input_api, output_api, |
| 174 | source_file_filter=sources)) |
mtklein | e4b19c4 | 2015-05-05 10:28:44 -0700 | [diff] [blame] | 175 | results.extend(_ToolFlags(input_api, output_api)) |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 176 | return results |
| 177 | |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 178 | |
| 179 | def CheckChangeOnUpload(input_api, output_api): |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 180 | """Presubmit checks for the change on upload. |
| 181 | |
| 182 | The following are the presubmit checks: |
| 183 | * Check change has one and only one EOL. |
| 184 | """ |
| 185 | results = [] |
| 186 | results.extend(_CommonChecks(input_api, output_api)) |
| 187 | return results |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 188 | |
| 189 | |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 190 | def _CheckTreeStatus(input_api, output_api, json_url): |
| 191 | """Check whether to allow commit. |
| 192 | |
| 193 | Args: |
| 194 | input_api: input related apis. |
| 195 | output_api: output related apis. |
| 196 | json_url: url to download json style status. |
| 197 | """ |
| 198 | tree_status_results = input_api.canned_checks.CheckTreeIsOpen( |
| 199 | input_api, output_api, json_url=json_url) |
| 200 | if not tree_status_results: |
| 201 | # Check for caution state only if tree is not closed. |
| 202 | connection = input_api.urllib2.urlopen(json_url) |
| 203 | status = input_api.json.loads(connection.read()) |
| 204 | connection.close() |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 205 | if ('caution' in status['message'].lower() and |
| 206 | os.isatty(sys.stdout.fileno())): |
| 207 | # Display a prompt only if we are in an interactive shell. Without this |
| 208 | # check the commit queue behaves incorrectly because it considers |
| 209 | # prompts to be failures. |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 210 | short_text = 'Tree state is: ' + status['general_state'] |
| 211 | long_text = status['message'] + '\n' + json_url |
| 212 | tree_status_results.append( |
| 213 | output_api.PresubmitPromptWarning( |
| 214 | message=short_text, long_text=long_text)) |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 215 | else: |
| 216 | # Tree status is closed. Put in message about contacting sheriff. |
| 217 | connection = input_api.urllib2.urlopen( |
| 218 | SKIA_TREE_STATUS_URL + '/current-sheriff') |
| 219 | sheriff_details = input_api.json.loads(connection.read()) |
| 220 | if sheriff_details: |
| 221 | tree_status_results[0]._message += ( |
| 222 | '\n\nPlease contact the current Skia sheriff (%s) if you are trying ' |
| 223 | 'to submit a build fix\nand do not know how to submit because the ' |
| 224 | 'tree is closed') % sheriff_details['username'] |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 225 | return tree_status_results |
| 226 | |
| 227 | |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 228 | def _CheckOwnerIsInAuthorsFile(input_api, output_api): |
| 229 | results = [] |
| 230 | issue = input_api.change.issue |
| 231 | if issue and input_api.rietveld: |
rmistry | 83fab47 | 2014-07-18 05:25:56 -0700 | [diff] [blame] | 232 | issue_properties = input_api.rietveld.get_issue_properties( |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 233 | issue=int(issue), messages=False) |
| 234 | owner_email = issue_properties['owner_email'] |
| 235 | |
| 236 | try: |
| 237 | authors_content = '' |
| 238 | for line in open(AUTHORS_FILE_NAME): |
| 239 | if not line.startswith('#'): |
| 240 | authors_content += line |
| 241 | email_fnmatches = re.findall('<(.*)>', authors_content) |
| 242 | for email_fnmatch in email_fnmatches: |
| 243 | if fnmatch.fnmatch(owner_email, email_fnmatch): |
| 244 | # Found a match, the user is in the AUTHORS file break out of the loop |
| 245 | break |
| 246 | else: |
| 247 | # TODO(rmistry): Remove the below CLA messaging once a CLA checker has |
| 248 | # been added to the CQ. |
| 249 | results.append( |
| 250 | output_api.PresubmitError( |
| 251 | 'The email %s is not in Skia\'s AUTHORS file.\n' |
| 252 | 'Issue owner, this CL must include an addition to the Skia AUTHORS ' |
| 253 | 'file.\n' |
| 254 | 'Googler reviewers, please check that the AUTHORS entry ' |
| 255 | 'corresponds to an email address in http://goto/cla-signers. If it ' |
| 256 | 'does not then ask the issue owner to sign the CLA at ' |
| 257 | 'https://developers.google.com/open-source/cla/individual ' |
| 258 | '(individual) or ' |
| 259 | 'https://developers.google.com/open-source/cla/corporate ' |
| 260 | '(corporate).' |
rmistry | 83fab47 | 2014-07-18 05:25:56 -0700 | [diff] [blame] | 261 | % owner_email)) |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 262 | except IOError: |
| 263 | # Do not fail if authors file cannot be found. |
| 264 | traceback.print_exc() |
| 265 | input_api.logging.error('AUTHORS file not found!') |
| 266 | |
| 267 | return results |
| 268 | |
| 269 | |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 270 | def _CheckLGTMsForPublicAPI(input_api, output_api): |
| 271 | """Check LGTMs for public API changes. |
| 272 | |
| 273 | For public API files make sure there is an LGTM from the list of owners in |
| 274 | PUBLIC_API_OWNERS. |
| 275 | """ |
| 276 | results = [] |
| 277 | requires_owner_check = False |
rmistry | 9407ece | 2014-08-26 14:00:54 -0700 | [diff] [blame] | 278 | for affected_file in input_api.AffectedFiles(): |
| 279 | affected_file_path = affected_file.LocalPath() |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 280 | file_path, file_ext = os.path.splitext(affected_file_path) |
rmistry | 9407ece | 2014-08-26 14:00:54 -0700 | [diff] [blame] | 281 | # We only care about files that end in .h and are under the top-level |
Mike Klein | 478c9e4 | 2015-07-01 16:35:59 -0400 | [diff] [blame] | 282 | # include dir. |
| 283 | if file_ext == '.h' and 'include' == file_path.split(os.path.sep)[0]: |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 284 | requires_owner_check = True |
| 285 | |
| 286 | if not requires_owner_check: |
| 287 | return results |
| 288 | |
| 289 | lgtm_from_owner = False |
| 290 | issue = input_api.change.issue |
| 291 | if issue and input_api.rietveld: |
| 292 | issue_properties = input_api.rietveld.get_issue_properties( |
| 293 | issue=int(issue), messages=True) |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 294 | if re.match(REVERT_CL_SUBJECT_PREFIX, issue_properties['subject'], re.I): |
| 295 | # It is a revert CL, ignore the public api owners check. |
| 296 | return results |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 297 | |
rmistry | 04abf13 | 2015-04-07 07:41:51 -0700 | [diff] [blame] | 298 | # TODO(rmistry): Stop checking for COMMIT=false once crbug/470609 is |
| 299 | # resolved. |
| 300 | if issue_properties['cq_dry_run'] or re.search( |
| 301 | r'^COMMIT=false$', issue_properties['description'], re.M): |
| 302 | # Ignore public api owners check for dry run CLs since they are not |
rmistry | f91b717 | 2015-03-12 09:48:10 -0700 | [diff] [blame] | 303 | # going to be committed. |
| 304 | return results |
| 305 | |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 306 | match = re.search(r'^TBR=(.*)$', issue_properties['description'], re.M) |
| 307 | if match: |
| 308 | tbr_entries = match.group(1).strip().split(',') |
| 309 | for owner in PUBLIC_API_OWNERS: |
| 310 | if owner in tbr_entries or owner.split('@')[0] in tbr_entries: |
| 311 | # If an owner is specified in the TBR= line then ignore the public |
| 312 | # api owners check. |
| 313 | return results |
| 314 | |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 315 | if issue_properties['owner_email'] in PUBLIC_API_OWNERS: |
| 316 | # An owner created the CL that is an automatic LGTM. |
| 317 | lgtm_from_owner = True |
| 318 | |
| 319 | messages = issue_properties.get('messages') |
| 320 | if messages: |
| 321 | for message in messages: |
| 322 | if (message['sender'] in PUBLIC_API_OWNERS and |
| 323 | 'lgtm' in message['text'].lower()): |
| 324 | # Found an lgtm in a message from an owner. |
| 325 | lgtm_from_owner = True |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 326 | break |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 327 | |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 328 | if not lgtm_from_owner: |
| 329 | results.append( |
| 330 | output_api.PresubmitError( |
Mike Klein | 478c9e4 | 2015-07-01 16:35:59 -0400 | [diff] [blame] | 331 | 'Since the CL is editing public API, you must have an LGTM from ' |
| 332 | 'one of: %s' % str(PUBLIC_API_OWNERS))) |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 333 | return results |
| 334 | |
| 335 | |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 336 | def PostUploadHook(cl, change, output_api): |
| 337 | """git cl upload will call this hook after the issue is created/modified. |
| 338 | |
| 339 | This hook does the following: |
| 340 | * Adds a link to preview docs changes if there are any docs changes in the CL. |
| 341 | * Adds 'NOTRY=true' if the CL contains only docs changes. |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 342 | * Adds 'NOTREECHECKS=true' for non master branch changes since they do not |
| 343 | need to be gated on the master branch's tree. |
| 344 | * Adds 'NOTRY=true' for non master branch changes since trybots do not yet |
| 345 | work on them. |
borenet | af6005c | 2015-06-04 15:15:42 -0700 | [diff] [blame] | 346 | * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't |
| 347 | run the presubmit checks. |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 348 | """ |
| 349 | |
| 350 | results = [] |
| 351 | atleast_one_docs_change = False |
| 352 | all_docs_changes = True |
| 353 | for affected_file in change.AffectedFiles(): |
| 354 | affected_file_path = affected_file.LocalPath() |
| 355 | file_path, _ = os.path.splitext(affected_file_path) |
| 356 | if 'site' == file_path.split(os.path.sep)[0]: |
| 357 | atleast_one_docs_change = True |
| 358 | else: |
| 359 | all_docs_changes = False |
| 360 | if atleast_one_docs_change and not all_docs_changes: |
| 361 | break |
| 362 | |
| 363 | issue = cl.issue |
| 364 | rietveld_obj = cl.RpcServer() |
| 365 | if issue and rietveld_obj: |
| 366 | original_description = rietveld_obj.get_description(issue) |
| 367 | new_description = original_description |
| 368 | |
| 369 | # If the change includes only doc changes then add NOTRY=true in the |
| 370 | # CL's description if it does not exist yet. |
| 371 | if all_docs_changes and not re.search( |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 372 | r'^NOTRY=true$', new_description, re.M | re.I): |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 373 | new_description += '\nNOTRY=true' |
| 374 | results.append( |
| 375 | output_api.PresubmitNotifyResult( |
| 376 | 'This change has only doc changes. Automatically added ' |
| 377 | '\'NOTRY=true\' to the CL\'s description')) |
| 378 | |
| 379 | # If there is atleast one docs change then add preview link in the CL's |
| 380 | # description if it does not already exist there. |
| 381 | if atleast_one_docs_change and not re.search( |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 382 | r'^DOCS_PREVIEW=.*', new_description, re.M | re.I): |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 383 | # Automatically add a link to where the docs can be previewed. |
| 384 | new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue) |
| 385 | results.append( |
| 386 | output_api.PresubmitNotifyResult( |
| 387 | 'Automatically added a link to preview the docs changes to the ' |
| 388 | 'CL\'s description')) |
| 389 | |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 390 | # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true |
| 391 | # to the CL's description if it does not already exist there. |
| 392 | target_ref = rietveld_obj.get_issue_properties(issue, False).get( |
| 393 | 'target_ref', '') |
| 394 | if target_ref != 'refs/heads/master': |
| 395 | if not re.search( |
| 396 | r'^NOTREECHECKS=true$', new_description, re.M | re.I): |
| 397 | new_description += "\nNOTREECHECKS=true" |
| 398 | results.append( |
| 399 | output_api.PresubmitNotifyResult( |
| 400 | 'Branch changes do not need to rely on the master branch\'s ' |
| 401 | 'tree status. Automatically added \'NOTREECHECKS=true\' to the ' |
| 402 | 'CL\'s description')) |
| 403 | if not re.search( |
| 404 | r'^NOTRY=true$', new_description, re.M | re.I): |
| 405 | new_description += "\nNOTRY=true" |
| 406 | results.append( |
| 407 | output_api.PresubmitNotifyResult( |
| 408 | 'Trybots do not yet work for non-master branches. ' |
| 409 | 'Automatically added \'NOTRY=true\' to the CL\'s description')) |
borenet | af6005c | 2015-06-04 15:15:42 -0700 | [diff] [blame] | 410 | if not re.search( |
| 411 | r'^NOPRESUBMIT=true$', new_description, re.M | re.I): |
| 412 | new_description += "\nNOPRESUBMIT=true" |
| 413 | results.append( |
| 414 | output_api.PresubmitNotifyResult( |
| 415 | 'Branch changes do not run the presubmit checks.')) |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 416 | |
rmistry | 3cfd1ad | 2015-03-25 12:53:35 -0700 | [diff] [blame] | 417 | # Read and process the HASHTAGS file. |
rmistry | 57291dc | 2015-04-01 09:12:51 -0700 | [diff] [blame] | 418 | hashtags_fullpath = os.path.join(change._local_root, 'HASHTAGS') |
| 419 | with open(hashtags_fullpath, 'rb') as hashtags_csv: |
rmistry | 3cfd1ad | 2015-03-25 12:53:35 -0700 | [diff] [blame] | 420 | hashtags_reader = csv.reader(hashtags_csv, delimiter=',') |
| 421 | for row in hashtags_reader: |
| 422 | if not row or row[0].startswith('#'): |
| 423 | # Ignore empty lines and comments |
| 424 | continue |
| 425 | hashtag = row[0] |
| 426 | # Search for the hashtag in the description. |
| 427 | if re.search('#%s' % hashtag, new_description, re.M | re.I): |
| 428 | for mapped_text in row[1:]: |
| 429 | # Special case handling for CQ_KEYWORDS_THAT_NEED_APPENDING. |
| 430 | appended_description = _HandleAppendingCQKeywords( |
| 431 | hashtag, mapped_text, new_description, results, output_api) |
| 432 | if appended_description: |
| 433 | new_description = appended_description |
| 434 | continue |
| 435 | |
| 436 | # Add the mapped text if it does not already exist in the |
| 437 | # CL's description. |
| 438 | if not re.search( |
| 439 | r'^%s$' % mapped_text, new_description, re.M | re.I): |
| 440 | new_description += '\n%s' % mapped_text |
| 441 | results.append( |
| 442 | output_api.PresubmitNotifyResult( |
| 443 | 'Found \'#%s\', automatically added \'%s\' to the CL\'s ' |
| 444 | 'description' % (hashtag, mapped_text))) |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 445 | |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 446 | # If the description has changed update it. |
| 447 | if new_description != original_description: |
| 448 | rietveld_obj.update_description(issue, new_description) |
| 449 | |
| 450 | return results |
| 451 | |
| 452 | |
rmistry | 3cfd1ad | 2015-03-25 12:53:35 -0700 | [diff] [blame] | 453 | def _HandleAppendingCQKeywords(hashtag, keyword_and_value, description, |
| 454 | results, output_api): |
| 455 | """Handles the CQ keywords that need appending if specified in hashtags.""" |
| 456 | keyword = keyword_and_value.split('=')[0] |
| 457 | if keyword in CQ_KEYWORDS_THAT_NEED_APPENDING: |
| 458 | # If the keyword is already in the description then append to it. |
| 459 | match = re.search( |
| 460 | r'^%s=(.*)$' % keyword, description, re.M | re.I) |
| 461 | if match: |
| 462 | old_values = match.group(1).split(';') |
| 463 | new_value = keyword_and_value.split('=')[1] |
| 464 | if new_value in old_values: |
| 465 | # Do not need to do anything here. |
| 466 | return description |
| 467 | # Update the description with the new values. |
| 468 | new_description = description.replace( |
| 469 | match.group(0), "%s;%s" % (match.group(0), new_value)) |
| 470 | results.append( |
| 471 | output_api.PresubmitNotifyResult( |
| 472 | 'Found \'#%s\', automatically appended \'%s\' to %s in ' |
| 473 | 'the CL\'s description' % (hashtag, new_value, keyword))) |
| 474 | return new_description |
| 475 | return None |
| 476 | |
| 477 | |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 478 | def CheckChangeOnCommit(input_api, output_api): |
| 479 | """Presubmit checks for the change on commit. |
| 480 | |
| 481 | The following are the presubmit checks: |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 482 | * Check change has one and only one EOL. |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 483 | * Ensures that the Skia tree is open in |
| 484 | http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution' |
| 485 | state and an error if it is in 'Closed' state. |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 486 | """ |
| 487 | results = [] |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 488 | results.extend(_CommonChecks(input_api, output_api)) |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 489 | results.extend( |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 490 | _CheckTreeStatus(input_api, output_api, json_url=( |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 491 | SKIA_TREE_STATUS_URL + '/banner-status?format=json'))) |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 492 | results.extend(_CheckLGTMsForPublicAPI(input_api, output_api)) |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 493 | results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api)) |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 494 | return results |