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 | 5827653 | 2015-10-01 08:24:03 -0700 | [diff] [blame] | 12 | import collections |
rmistry | 3cfd1ad | 2015-03-25 12:53:35 -0700 | [diff] [blame] | 13 | import csv |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 14 | import fnmatch |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 15 | import os |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 16 | import re |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 17 | import subprocess |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 18 | import sys |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 19 | import traceback |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 20 | |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 21 | |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 22 | REVERT_CL_SUBJECT_PREFIX = 'Revert ' |
| 23 | |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 24 | SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com' |
| 25 | |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 26 | # 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] | 27 | PUBLIC_API_OWNERS = ( |
| 28 | 'reed@chromium.org', |
| 29 | 'reed@google.com', |
| 30 | 'bsalomon@chromium.org', |
| 31 | 'bsalomon@google.com', |
rmistry | 83fab47 | 2014-07-18 05:25:56 -0700 | [diff] [blame] | 32 | 'djsollen@chromium.org', |
| 33 | 'djsollen@google.com', |
Ravi Mistry | fbff329 | 2017-01-19 12:00:08 -0500 | [diff] [blame] | 34 | 'hcm@chromium.org', |
| 35 | 'hcm@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=' |
rmistry | d88b0be | 2016-05-20 03:50:01 -0700 | [diff] [blame] | 41 | GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue=' |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 42 | |
halcanary | 6950de6 | 2015-11-07 05:29:00 -0800 | [diff] [blame] | 43 | # Path to CQ bots feature is described in https://bug.skia.org/4364 |
rmistry | 5827653 | 2015-10-01 08:24:03 -0700 | [diff] [blame] | 44 | PATH_PREFIX_TO_EXTRA_TRYBOTS = { |
Eric Boren | 47f0709 | 2017-06-29 15:04:00 -0400 | [diff] [blame] | 45 | 'src/opts/': ('skia.primary:' |
| 46 | 'Test-Debian9-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD'), |
Eric Boren | 5083130 | 2016-11-18 13:10:51 -0500 | [diff] [blame] | 47 | 'include/private/SkAtomics.h': ('skia.primary:' |
Eric Boren | 47f0709 | 2017-06-29 15:04:00 -0400 | [diff] [blame] | 48 | 'Test-Debian9-Clang-GCE-CPU-AVX2-x86_64-Release-TSAN,' |
Ben Wagner | 9d5b100 | 2017-09-28 12:38:28 -0400 | [diff] [blame] | 49 | 'Test-Ubuntu17-Clang-Golo-GPU-QuadroP400-x86_64-Release-TSAN' |
mtklein | ab8296b | 2015-10-07 11:49:00 -0700 | [diff] [blame] | 50 | ), |
| 51 | |
rmistry | 5827653 | 2015-10-01 08:24:03 -0700 | [diff] [blame] | 52 | # Below are examples to show what is possible with this feature. |
| 53 | # 'src/svg/': 'master1:abc;master2:def', |
| 54 | # 'src/svg/parser/': 'master3:ghi,jkl;master4:mno', |
| 55 | # 'src/image/SkImage_Base.h': 'master5:pqr,stu;master1:abc1;master2:def', |
| 56 | } |
| 57 | |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 58 | |
rmistry@google.com | 713276b | 2013-01-25 18:27:34 +0000 | [diff] [blame] | 59 | def _CheckChangeHasEol(input_api, output_api, source_file_filter=None): |
| 60 | """Checks that files end with atleast one \n (LF).""" |
| 61 | eof_files = [] |
| 62 | for f in input_api.AffectedSourceFiles(source_file_filter): |
| 63 | contents = input_api.ReadFile(f, 'rb') |
| 64 | # Check that the file ends in atleast one newline character. |
| 65 | if len(contents) > 1 and contents[-1:] != '\n': |
| 66 | eof_files.append(f.LocalPath()) |
| 67 | |
| 68 | if eof_files: |
| 69 | return [output_api.PresubmitPromptWarning( |
| 70 | 'These files should end in a newline character:', |
| 71 | items=eof_files)] |
| 72 | return [] |
| 73 | |
| 74 | |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 75 | def _PythonChecks(input_api, output_api): |
| 76 | """Run checks on any modified Python files.""" |
Eric Boren | 8e0c2c9 | 2017-09-27 13:03:35 -0400 | [diff] [blame] | 77 | pylint_disabled_files = ( |
| 78 | 'infra/bots/recipes.py', |
| 79 | ) |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 80 | pylint_disabled_warnings = ( |
| 81 | 'F0401', # Unable to import. |
| 82 | 'E0611', # No name in module. |
| 83 | 'W0232', # Class has no __init__ method. |
| 84 | 'E1002', # Use of super on an old style class. |
| 85 | 'W0403', # Relative import used. |
| 86 | 'R0201', # Method could be a function. |
| 87 | 'E1003', # Using class name in super. |
| 88 | 'W0613', # Unused argument. |
borenet | d9fa758 | 2016-02-18 08:05:48 -0800 | [diff] [blame] | 89 | 'W0105', # String statement has no effect. |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 90 | ) |
| 91 | # Run Pylint on only the modified python files. Unfortunately it still runs |
| 92 | # Pylint on the whole file instead of just the modified lines. |
| 93 | affected_python_files = [] |
| 94 | for affected_file in input_api.AffectedSourceFiles(None): |
| 95 | affected_file_path = affected_file.LocalPath() |
| 96 | if affected_file_path.endswith('.py'): |
Eric Boren | 8e0c2c9 | 2017-09-27 13:03:35 -0400 | [diff] [blame] | 97 | if affected_file_path not in pylint_disabled_files: |
| 98 | affected_python_files.append(affected_file_path) |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 99 | return input_api.canned_checks.RunPylint( |
| 100 | input_api, output_api, |
| 101 | disabled_warnings=pylint_disabled_warnings, |
| 102 | white_list=affected_python_files) |
| 103 | |
| 104 | |
rmistry | 01cbf6c | 2015-03-12 07:48:40 -0700 | [diff] [blame] | 105 | def _IfDefChecks(input_api, output_api): |
| 106 | """Ensures if/ifdef are not before includes. See skbug/3362 for details.""" |
| 107 | comment_block_start_pattern = re.compile('^\s*\/\*.*$') |
| 108 | comment_block_middle_pattern = re.compile('^\s+\*.*') |
| 109 | comment_block_end_pattern = re.compile('^\s+\*\/.*$') |
| 110 | single_line_comment_pattern = re.compile('^\s*//.*$') |
| 111 | def is_comment(line): |
| 112 | return (comment_block_start_pattern.match(line) or |
| 113 | comment_block_middle_pattern.match(line) or |
| 114 | comment_block_end_pattern.match(line) or |
| 115 | single_line_comment_pattern.match(line)) |
| 116 | |
| 117 | empty_line_pattern = re.compile('^\s*$') |
| 118 | def is_empty_line(line): |
| 119 | return empty_line_pattern.match(line) |
| 120 | |
| 121 | failing_files = [] |
| 122 | for affected_file in input_api.AffectedSourceFiles(None): |
| 123 | affected_file_path = affected_file.LocalPath() |
| 124 | if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'): |
| 125 | f = open(affected_file_path) |
| 126 | for line in f.xreadlines(): |
| 127 | if is_comment(line) or is_empty_line(line): |
| 128 | continue |
| 129 | # The below will be the first real line after comments and newlines. |
| 130 | if line.startswith('#if 0 '): |
| 131 | pass |
| 132 | elif line.startswith('#if ') or line.startswith('#ifdef '): |
| 133 | failing_files.append(affected_file_path) |
| 134 | break |
| 135 | |
| 136 | results = [] |
| 137 | if failing_files: |
| 138 | results.append( |
| 139 | output_api.PresubmitError( |
| 140 | 'The following files have #if or #ifdef before includes:\n%s\n\n' |
halcanary | 6950de6 | 2015-11-07 05:29:00 -0800 | [diff] [blame] | 141 | 'See https://bug.skia.org/3362 for why this should be fixed.' % |
rmistry | 01cbf6c | 2015-03-12 07:48:40 -0700 | [diff] [blame] | 142 | '\n'.join(failing_files))) |
| 143 | return results |
| 144 | |
| 145 | |
borenet | c7c9180 | 2015-03-25 04:47:02 -0700 | [diff] [blame] | 146 | def _CopyrightChecks(input_api, output_api, source_file_filter=None): |
| 147 | results = [] |
| 148 | year_pattern = r'\d{4}' |
| 149 | year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern) |
| 150 | years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern) |
| 151 | copyright_pattern = ( |
| 152 | r'Copyright (\([cC]\) )?%s \w+' % years_pattern) |
| 153 | |
| 154 | for affected_file in input_api.AffectedSourceFiles(source_file_filter): |
| 155 | if 'third_party' in affected_file.LocalPath(): |
| 156 | continue |
| 157 | contents = input_api.ReadFile(affected_file, 'rb') |
| 158 | if not re.search(copyright_pattern, contents): |
| 159 | results.append(output_api.PresubmitError( |
| 160 | '%s is missing a correct copyright header.' % affected_file)) |
| 161 | return results |
| 162 | |
| 163 | |
mtklein | e4b19c4 | 2015-05-05 10:28:44 -0700 | [diff] [blame] | 164 | def _ToolFlags(input_api, output_api): |
| 165 | """Make sure `{dm,nanobench}_flags.py test` passes if modified.""" |
| 166 | results = [] |
| 167 | sources = lambda x: ('dm_flags.py' in x.LocalPath() or |
| 168 | 'nanobench_flags.py' in x.LocalPath()) |
| 169 | for f in input_api.AffectedSourceFiles(sources): |
| 170 | if 0 != subprocess.call(['python', f.LocalPath(), 'test']): |
| 171 | results.append(output_api.PresubmitError('`python %s test` failed' % f)) |
| 172 | return results |
| 173 | |
| 174 | |
borenet | 2dbbfa5 | 2016-10-14 06:32:09 -0700 | [diff] [blame] | 175 | def _InfraTests(input_api, output_api): |
| 176 | """Run the infra tests.""" |
borenet | 1ed2ae4 | 2016-07-26 11:52:17 -0700 | [diff] [blame] | 177 | results = [] |
mtklein | 3da80f5 | 2016-07-27 04:14:07 -0700 | [diff] [blame] | 178 | if not any(f.LocalPath().startswith('infra') |
| 179 | for f in input_api.AffectedFiles()): |
| 180 | return results |
| 181 | |
borenet | 2dbbfa5 | 2016-10-14 06:32:09 -0700 | [diff] [blame] | 182 | cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')] |
borenet | 60b0a2d | 2016-10-04 12:45:41 -0700 | [diff] [blame] | 183 | try: |
| 184 | subprocess.check_output(cmd) |
| 185 | except subprocess.CalledProcessError as e: |
| 186 | results.append(output_api.PresubmitError( |
| 187 | '`%s` failed:\n%s' % (' '.join(cmd), e.output))) |
| 188 | return results |
| 189 | |
| 190 | |
mtklein | 4db3b79 | 2016-08-03 14:18:22 -0700 | [diff] [blame] | 191 | def _CheckGNFormatted(input_api, output_api): |
| 192 | """Make sure any .gn files we're changing have been formatted.""" |
| 193 | results = [] |
| 194 | for f in input_api.AffectedFiles(): |
Mike Klein | a5fb615 | 2016-10-26 14:17:04 -0400 | [diff] [blame] | 195 | if (not f.LocalPath().endswith('.gn') and |
| 196 | not f.LocalPath().endswith('.gni')): |
mtklein | 4db3b79 | 2016-08-03 14:18:22 -0700 | [diff] [blame] | 197 | continue |
| 198 | |
Mike Klein | 7a1c53d | 2016-10-11 14:03:06 -0400 | [diff] [blame] | 199 | gn = 'gn.bat' if 'win32' in sys.platform else 'gn' |
| 200 | cmd = [gn, 'format', '--dry-run', f.LocalPath()] |
mtklein | 4db3b79 | 2016-08-03 14:18:22 -0700 | [diff] [blame] | 201 | try: |
| 202 | subprocess.check_output(cmd) |
| 203 | except subprocess.CalledProcessError: |
mtklein | d434b01 | 2016-08-10 07:30:58 -0700 | [diff] [blame] | 204 | fix = 'gn format ' + f.LocalPath() |
mtklein | 4db3b79 | 2016-08-03 14:18:22 -0700 | [diff] [blame] | 205 | results.append(output_api.PresubmitError( |
mtklein | d434b01 | 2016-08-10 07:30:58 -0700 | [diff] [blame] | 206 | '`%s` failed, try\n\t%s' % (' '.join(cmd), fix))) |
mtklein | 4db3b79 | 2016-08-03 14:18:22 -0700 | [diff] [blame] | 207 | return results |
| 208 | |
borenet | 1ed2ae4 | 2016-07-26 11:52:17 -0700 | [diff] [blame] | 209 | |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 210 | def _CommonChecks(input_api, output_api): |
| 211 | """Presubmit checks common to upload and commit.""" |
| 212 | results = [] |
| 213 | sources = lambda x: (x.LocalPath().endswith('.h') or |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 214 | x.LocalPath().endswith('.py') or |
| 215 | x.LocalPath().endswith('.sh') or |
mtklein | 18e5580 | 2015-03-25 07:21:20 -0700 | [diff] [blame] | 216 | x.LocalPath().endswith('.m') or |
| 217 | x.LocalPath().endswith('.mm') or |
| 218 | x.LocalPath().endswith('.go') or |
| 219 | x.LocalPath().endswith('.c') or |
| 220 | x.LocalPath().endswith('.cc') or |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 221 | x.LocalPath().endswith('.cpp')) |
| 222 | results.extend( |
rmistry@google.com | 713276b | 2013-01-25 18:27:34 +0000 | [diff] [blame] | 223 | _CheckChangeHasEol( |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 224 | input_api, output_api, source_file_filter=sources)) |
Eric Boren | bb0ef0a | 2014-06-25 11:13:27 -0400 | [diff] [blame] | 225 | results.extend(_PythonChecks(input_api, output_api)) |
rmistry | 01cbf6c | 2015-03-12 07:48:40 -0700 | [diff] [blame] | 226 | results.extend(_IfDefChecks(input_api, output_api)) |
borenet | c7c9180 | 2015-03-25 04:47:02 -0700 | [diff] [blame] | 227 | results.extend(_CopyrightChecks(input_api, output_api, |
| 228 | source_file_filter=sources)) |
mtklein | e4b19c4 | 2015-05-05 10:28:44 -0700 | [diff] [blame] | 229 | results.extend(_ToolFlags(input_api, output_api)) |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 230 | return results |
| 231 | |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 232 | |
| 233 | def CheckChangeOnUpload(input_api, output_api): |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 234 | """Presubmit checks for the change on upload. |
| 235 | |
| 236 | The following are the presubmit checks: |
| 237 | * Check change has one and only one EOL. |
| 238 | """ |
| 239 | results = [] |
| 240 | results.extend(_CommonChecks(input_api, output_api)) |
borenet | 1ed2ae4 | 2016-07-26 11:52:17 -0700 | [diff] [blame] | 241 | # Run on upload, not commit, since the presubmit bot apparently doesn't have |
borenet | 60b0a2d | 2016-10-04 12:45:41 -0700 | [diff] [blame] | 242 | # coverage or Go installed. |
borenet | 2dbbfa5 | 2016-10-14 06:32:09 -0700 | [diff] [blame] | 243 | results.extend(_InfraTests(input_api, output_api)) |
borenet | 60b0a2d | 2016-10-04 12:45:41 -0700 | [diff] [blame] | 244 | |
mtklein | 4db3b79 | 2016-08-03 14:18:22 -0700 | [diff] [blame] | 245 | results.extend(_CheckGNFormatted(input_api, output_api)) |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 246 | return results |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 247 | |
| 248 | |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 249 | def _CheckTreeStatus(input_api, output_api, json_url): |
| 250 | """Check whether to allow commit. |
| 251 | |
| 252 | Args: |
| 253 | input_api: input related apis. |
| 254 | output_api: output related apis. |
| 255 | json_url: url to download json style status. |
| 256 | """ |
| 257 | tree_status_results = input_api.canned_checks.CheckTreeIsOpen( |
| 258 | input_api, output_api, json_url=json_url) |
| 259 | if not tree_status_results: |
| 260 | # Check for caution state only if tree is not closed. |
| 261 | connection = input_api.urllib2.urlopen(json_url) |
| 262 | status = input_api.json.loads(connection.read()) |
| 263 | connection.close() |
rmistry@google.com | f6c5f75 | 2013-03-29 17:26:00 +0000 | [diff] [blame] | 264 | if ('caution' in status['message'].lower() and |
| 265 | os.isatty(sys.stdout.fileno())): |
| 266 | # Display a prompt only if we are in an interactive shell. Without this |
| 267 | # check the commit queue behaves incorrectly because it considers |
| 268 | # prompts to be failures. |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 269 | short_text = 'Tree state is: ' + status['general_state'] |
| 270 | long_text = status['message'] + '\n' + json_url |
| 271 | tree_status_results.append( |
| 272 | output_api.PresubmitPromptWarning( |
| 273 | message=short_text, long_text=long_text)) |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 274 | else: |
| 275 | # Tree status is closed. Put in message about contacting sheriff. |
| 276 | connection = input_api.urllib2.urlopen( |
| 277 | SKIA_TREE_STATUS_URL + '/current-sheriff') |
| 278 | sheriff_details = input_api.json.loads(connection.read()) |
| 279 | if sheriff_details: |
| 280 | tree_status_results[0]._message += ( |
| 281 | '\n\nPlease contact the current Skia sheriff (%s) if you are trying ' |
| 282 | 'to submit a build fix\nand do not know how to submit because the ' |
| 283 | 'tree is closed') % sheriff_details['username'] |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 284 | return tree_status_results |
| 285 | |
| 286 | |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 287 | class CodeReview(object): |
| 288 | """Abstracts which codereview tool is used for the specified issue.""" |
| 289 | |
| 290 | def __init__(self, input_api): |
| 291 | self._issue = input_api.change.issue |
| 292 | self._gerrit = input_api.gerrit |
| 293 | self._rietveld_properties = None |
| 294 | if not self._gerrit: |
| 295 | self._rietveld_properties = input_api.rietveld.get_issue_properties( |
| 296 | issue=int(self._issue), messages=True) |
| 297 | |
| 298 | def GetOwnerEmail(self): |
| 299 | if self._gerrit: |
| 300 | return self._gerrit.GetChangeOwner(self._issue) |
| 301 | else: |
| 302 | return self._rietveld_properties['owner_email'] |
| 303 | |
| 304 | def GetSubject(self): |
| 305 | if self._gerrit: |
| 306 | return self._gerrit.GetChangeInfo(self._issue)['subject'] |
| 307 | else: |
| 308 | return self._rietveld_properties['subject'] |
| 309 | |
| 310 | def GetDescription(self): |
| 311 | if self._gerrit: |
| 312 | return self._gerrit.GetChangeDescription(self._issue) |
| 313 | else: |
| 314 | return self._rietveld_properties['description'] |
| 315 | |
| 316 | def IsDryRun(self): |
| 317 | if self._gerrit: |
| 318 | return self._gerrit.GetChangeInfo( |
| 319 | self._issue)['labels']['Commit-Queue'].get('value', 0) == 1 |
| 320 | else: |
| 321 | return self._rietveld_properties['cq_dry_run'] |
| 322 | |
Ravi Mistry | 39eabb6 | 2016-10-05 08:41:12 -0400 | [diff] [blame] | 323 | def GetReviewers(self): |
| 324 | if self._gerrit: |
| 325 | code_review_label = ( |
| 326 | self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review']) |
| 327 | return [r['email'] for r in code_review_label.get('all', [])] |
| 328 | else: |
| 329 | return self._rietveld_properties['reviewers'] |
| 330 | |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 331 | def GetApprovers(self): |
| 332 | approvers = [] |
| 333 | if self._gerrit: |
Ravi Mistry | 39eabb6 | 2016-10-05 08:41:12 -0400 | [diff] [blame] | 334 | code_review_label = ( |
| 335 | self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review']) |
| 336 | for m in code_review_label.get('all', []): |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 337 | if m.get("value") == 1: |
| 338 | approvers.append(m["email"]) |
| 339 | else: |
| 340 | for m in self._rietveld_properties.get('messages', []): |
| 341 | if 'lgtm' in m['text'].lower(): |
| 342 | approvers.append(m['sender']) |
| 343 | return approvers |
| 344 | |
| 345 | |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 346 | def _CheckOwnerIsInAuthorsFile(input_api, output_api): |
| 347 | results = [] |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 348 | if input_api.change.issue: |
| 349 | cr = CodeReview(input_api) |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 350 | |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 351 | owner_email = cr.GetOwnerEmail() |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 352 | try: |
| 353 | authors_content = '' |
| 354 | for line in open(AUTHORS_FILE_NAME): |
| 355 | if not line.startswith('#'): |
| 356 | authors_content += line |
| 357 | email_fnmatches = re.findall('<(.*)>', authors_content) |
| 358 | for email_fnmatch in email_fnmatches: |
| 359 | if fnmatch.fnmatch(owner_email, email_fnmatch): |
| 360 | # Found a match, the user is in the AUTHORS file break out of the loop |
| 361 | break |
| 362 | else: |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 363 | results.append( |
| 364 | output_api.PresubmitError( |
| 365 | 'The email %s is not in Skia\'s AUTHORS file.\n' |
| 366 | 'Issue owner, this CL must include an addition to the Skia AUTHORS ' |
rmistry | 9806d4d | 2015-10-01 08:10:54 -0700 | [diff] [blame] | 367 | 'file.' |
rmistry | 83fab47 | 2014-07-18 05:25:56 -0700 | [diff] [blame] | 368 | % owner_email)) |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 369 | except IOError: |
| 370 | # Do not fail if authors file cannot be found. |
| 371 | traceback.print_exc() |
| 372 | input_api.logging.error('AUTHORS file not found!') |
| 373 | |
| 374 | return results |
| 375 | |
| 376 | |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 377 | def _CheckLGTMsForPublicAPI(input_api, output_api): |
| 378 | """Check LGTMs for public API changes. |
| 379 | |
| 380 | For public API files make sure there is an LGTM from the list of owners in |
| 381 | PUBLIC_API_OWNERS. |
| 382 | """ |
| 383 | results = [] |
| 384 | requires_owner_check = False |
rmistry | 9407ece | 2014-08-26 14:00:54 -0700 | [diff] [blame] | 385 | for affected_file in input_api.AffectedFiles(): |
| 386 | affected_file_path = affected_file.LocalPath() |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 387 | file_path, file_ext = os.path.splitext(affected_file_path) |
rmistry | 9407ece | 2014-08-26 14:00:54 -0700 | [diff] [blame] | 388 | # We only care about files that end in .h and are under the top-level |
mtklein | bda1267 | 2015-07-28 08:54:12 -0700 | [diff] [blame] | 389 | # include dir, but not include/private. |
| 390 | if (file_ext == '.h' and |
| 391 | 'include' == file_path.split(os.path.sep)[0] and |
| 392 | 'private' not in file_path): |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 393 | requires_owner_check = True |
| 394 | |
| 395 | if not requires_owner_check: |
| 396 | return results |
| 397 | |
| 398 | lgtm_from_owner = False |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 399 | if input_api.change.issue: |
| 400 | cr = CodeReview(input_api) |
| 401 | |
| 402 | if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I): |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 403 | # It is a revert CL, ignore the public api owners check. |
| 404 | return results |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 405 | |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 406 | if cr.IsDryRun(): |
rmistry | 04abf13 | 2015-04-07 07:41:51 -0700 | [diff] [blame] | 407 | # Ignore public api owners check for dry run CLs since they are not |
rmistry | f91b717 | 2015-03-12 09:48:10 -0700 | [diff] [blame] | 408 | # going to be committed. |
| 409 | return results |
| 410 | |
Ravi Mistry | 39eabb6 | 2016-10-05 08:41:12 -0400 | [diff] [blame] | 411 | if input_api.gerrit: |
| 412 | for reviewer in cr.GetReviewers(): |
| 413 | if reviewer in PUBLIC_API_OWNERS: |
| 414 | # If an owner is specified as an reviewer in Gerrit then ignore the |
| 415 | # public api owners check. |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 416 | return results |
Ravi Mistry | 39eabb6 | 2016-10-05 08:41:12 -0400 | [diff] [blame] | 417 | else: |
| 418 | match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M) |
| 419 | if match: |
| 420 | tbr_section = match.group(1).strip().split(' ')[0] |
| 421 | tbr_entries = tbr_section.split(',') |
| 422 | for owner in PUBLIC_API_OWNERS: |
| 423 | if owner in tbr_entries or owner.split('@')[0] in tbr_entries: |
| 424 | # If an owner is specified in the TBR= line then ignore the public |
| 425 | # api owners check. |
| 426 | return results |
rmistry | f2d83ca | 2014-08-26 10:30:29 -0700 | [diff] [blame] | 427 | |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 428 | if cr.GetOwnerEmail() in PUBLIC_API_OWNERS: |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 429 | # An owner created the CL that is an automatic LGTM. |
| 430 | lgtm_from_owner = True |
| 431 | |
rmistry | b398ecc | 2016-08-29 08:13:29 -0700 | [diff] [blame] | 432 | for approver in cr.GetApprovers(): |
| 433 | if approver in PUBLIC_API_OWNERS: |
| 434 | # Found an lgtm in a message from an owner. |
| 435 | lgtm_from_owner = True |
| 436 | break |
commit-bot@chromium.org | cfdc596 | 2014-01-31 17:33:04 +0000 | [diff] [blame] | 437 | |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 438 | if not lgtm_from_owner: |
| 439 | results.append( |
| 440 | output_api.PresubmitError( |
mtklein | bda1267 | 2015-07-28 08:54:12 -0700 | [diff] [blame] | 441 | "If this CL adds to or changes Skia's public API, you need an LGTM " |
| 442 | "from any of %s. If this CL only removes from or doesn't change " |
Ravi Mistry | dbb84c2 | 2016-10-05 12:47:44 -0400 | [diff] [blame] | 443 | "Skia's public API, please add a short note to the CL saying so. " |
| 444 | "Add one of the owners as a reviewer to your CL. For Rietveld CLs " |
| 445 | "you also need to add one of those owners on a TBR= line. If you " |
| 446 | "don't know if this CL affects Skia's public API, treat it like it " |
| 447 | "does." % str(PUBLIC_API_OWNERS))) |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 448 | return results |
| 449 | |
| 450 | |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 451 | def _FooterExists(footers, key, value): |
| 452 | for k, v in footers: |
| 453 | if k == key and v == value: |
| 454 | return True |
| 455 | return False |
| 456 | |
| 457 | |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 458 | def PostUploadHook(cl, change, output_api): |
| 459 | """git cl upload will call this hook after the issue is created/modified. |
| 460 | |
| 461 | This hook does the following: |
| 462 | * Adds a link to preview docs changes if there are any docs changes in the CL. |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 463 | * Adds 'No-Try: true' if the CL contains only docs changes. |
| 464 | * Adds 'No-Tree-Checks: true' for non master branch changes since they do not |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 465 | need to be gated on the master branch's tree. |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 466 | * Adds 'No-Try: true' for non master branch changes since trybots do not yet |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 467 | work on them. |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 468 | * Adds 'No-Presubmit: true' for non master branch changes since those don't |
borenet | af6005c | 2015-06-04 15:15:42 -0700 | [diff] [blame] | 469 | run the presubmit checks. |
rmistry | 5827653 | 2015-10-01 08:24:03 -0700 | [diff] [blame] | 470 | * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS. |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 471 | """ |
| 472 | |
| 473 | results = [] |
| 474 | atleast_one_docs_change = False |
| 475 | all_docs_changes = True |
| 476 | for affected_file in change.AffectedFiles(): |
| 477 | affected_file_path = affected_file.LocalPath() |
| 478 | file_path, _ = os.path.splitext(affected_file_path) |
| 479 | if 'site' == file_path.split(os.path.sep)[0]: |
| 480 | atleast_one_docs_change = True |
| 481 | else: |
| 482 | all_docs_changes = False |
| 483 | if atleast_one_docs_change and not all_docs_changes: |
| 484 | break |
| 485 | |
| 486 | issue = cl.issue |
rmistry | b9a9e87 | 2016-09-01 09:52:32 -0700 | [diff] [blame] | 487 | if issue: |
Eric Boren | bf17eec | 2017-04-03 08:30:35 -0400 | [diff] [blame] | 488 | original_description_lines, footers = cl.GetDescriptionFooters() |
| 489 | new_description_lines = list(original_description_lines) |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 490 | |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 491 | # If the change includes only doc changes then add No-Try: true in the |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 492 | # CL's description if it does not exist yet. |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 493 | if all_docs_changes and not _FooterExists(footers, 'No-Try', 'true'): |
| 494 | new_description_lines.append('No-Try: true') |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 495 | results.append( |
| 496 | output_api.PresubmitNotifyResult( |
| 497 | 'This change has only doc changes. Automatically added ' |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 498 | '\'No-Try: true\' to the CL\'s description')) |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 499 | |
| 500 | # If there is atleast one docs change then add preview link in the CL's |
| 501 | # description if it does not already exist there. |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 502 | docs_preview_link = '%s%s' % (DOCS_PREVIEW_URL, issue) |
| 503 | docs_preview_line = 'Docs-Preview: %s' % docs_preview_link |
Eric Boren | bf17eec | 2017-04-03 08:30:35 -0400 | [diff] [blame] | 504 | if (atleast_one_docs_change and |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 505 | not _FooterExists(footers, 'Docs-Preview', docs_preview_link)): |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 506 | # Automatically add a link to where the docs can be previewed. |
Eric Boren | bf17eec | 2017-04-03 08:30:35 -0400 | [diff] [blame] | 507 | new_description_lines.append(docs_preview_line) |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 508 | results.append( |
| 509 | output_api.PresubmitNotifyResult( |
| 510 | 'Automatically added a link to preview the docs changes to the ' |
| 511 | 'CL\'s description')) |
| 512 | |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 513 | # If the target ref is not master then add 'No-Tree-Checks: true' and |
| 514 | # 'No-Try: true' to the CL's description if it does not already exist there. |
rmistry | b9a9e87 | 2016-09-01 09:52:32 -0700 | [diff] [blame] | 515 | target_ref = cl.GetRemoteBranch()[1] |
| 516 | if target_ref != 'refs/remotes/origin/master': |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 517 | if not _FooterExists(footers, 'No-Tree-Checks', 'true'): |
| 518 | new_description_lines.append('No-Tree-Checks: true') |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 519 | results.append( |
| 520 | output_api.PresubmitNotifyResult( |
| 521 | 'Branch changes do not need to rely on the master branch\'s ' |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 522 | 'tree status. Automatically added \'No-Tree-Checks: true\' to ' |
| 523 | 'the CL\'s description')) |
| 524 | if not _FooterExists(footers, 'No-Try', 'true'): |
| 525 | new_description_lines.append('No-Try: true') |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 526 | results.append( |
| 527 | output_api.PresubmitNotifyResult( |
| 528 | 'Trybots do not yet work for non-master branches. ' |
Ravi Mistry | 355feab | 2017-05-23 14:24:08 -0400 | [diff] [blame] | 529 | 'Automatically added \'No-Try: true\' to the CL\'s ' |
| 530 | 'description')) |
| 531 | if not _FooterExists(footers, 'No-Presubmit', 'true'): |
| 532 | new_description_lines.append('No-Presubmit: true') |
borenet | af6005c | 2015-06-04 15:15:42 -0700 | [diff] [blame] | 533 | results.append( |
| 534 | output_api.PresubmitNotifyResult( |
| 535 | 'Branch changes do not run the presubmit checks.')) |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 536 | |
Ravi Mistry | 6f0751e | 2017-09-12 13:18:12 -0400 | [diff] [blame] | 537 | # Automatically set Cq-Include-Trybots if any of the changed files here |
rmistry | 3b3ee20 | 2016-07-11 08:27:49 -0700 | [diff] [blame] | 538 | # begin with the paths of interest. |
Ravi Mistry | 6f0751e | 2017-09-12 13:18:12 -0400 | [diff] [blame] | 539 | bots_to_include = [] |
rmistry | 5827653 | 2015-10-01 08:24:03 -0700 | [diff] [blame] | 540 | for affected_file in change.AffectedFiles(): |
| 541 | affected_file_path = affected_file.LocalPath() |
| 542 | for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems(): |
| 543 | if affected_file_path.startswith(path_prefix): |
| 544 | results.append( |
| 545 | output_api.PresubmitNotifyResult( |
| 546 | 'Your CL modifies the path %s.\nAutomatically adding %s to ' |
| 547 | 'the CL description.' % (affected_file_path, extra_bots))) |
Ravi Mistry | 6f0751e | 2017-09-12 13:18:12 -0400 | [diff] [blame] | 548 | bots_to_include.append(extra_bots) |
| 549 | if bots_to_include: |
| 550 | output_api.EnsureCQIncludeTrybotsAreAdded( |
| 551 | cl, bots_to_include, new_description_lines) |
rmistry | 896f393 | 2015-02-26 11:52:05 -0800 | [diff] [blame] | 552 | |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 553 | # If the description has changed update it. |
Eric Boren | bf17eec | 2017-04-03 08:30:35 -0400 | [diff] [blame] | 554 | if new_description_lines != original_description_lines: |
Ravi Mistry | ee06ffe | 2017-05-08 12:59:56 -0400 | [diff] [blame] | 555 | # Add a new line separating the new contents from the old contents. |
| 556 | new_description_lines.insert(len(original_description_lines), '') |
Eric Boren | bf17eec | 2017-04-03 08:30:35 -0400 | [diff] [blame] | 557 | cl.UpdateDescriptionFooters(new_description_lines, footers) |
rmistry | d223fb2 | 2015-02-26 10:16:13 -0800 | [diff] [blame] | 558 | |
| 559 | return results |
| 560 | |
| 561 | |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 562 | def CheckChangeOnCommit(input_api, output_api): |
| 563 | """Presubmit checks for the change on commit. |
| 564 | |
| 565 | The following are the presubmit checks: |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 566 | * Check change has one and only one EOL. |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 567 | * Ensures that the Skia tree is open in |
| 568 | http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution' |
| 569 | state and an error if it is in 'Closed' state. |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 570 | """ |
| 571 | results = [] |
rmistry@google.com | 6be0b4c | 2013-01-17 14:50:59 +0000 | [diff] [blame] | 572 | results.extend(_CommonChecks(input_api, output_api)) |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 573 | results.extend( |
rmistry@google.com | c299344 | 2013-01-23 14:35:58 +0000 | [diff] [blame] | 574 | _CheckTreeStatus(input_api, output_api, json_url=( |
rmistry@google.com | 547012d | 2013-04-12 19:45:46 +0000 | [diff] [blame] | 575 | SKIA_TREE_STATUS_URL + '/banner-status?format=json'))) |
rmistry@google.com | fb4a68d | 2013-08-12 14:51:20 +0000 | [diff] [blame] | 576 | results.extend(_CheckLGTMsForPublicAPI(input_api, output_api)) |
commit-bot@chromium.org | 745e08c | 2014-02-03 14:18:32 +0000 | [diff] [blame] | 577 | results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api)) |
Ravi Mistry | a70cb8a | 2017-09-12 13:52:05 -0400 | [diff] [blame] | 578 | # Checks for the presence of 'DO NOT''SUBMIT' in CL description and in |
| 579 | # content of files. |
| 580 | results.extend( |
| 581 | input_api.canned_checks.CheckDoNotSubmit(input_api, output_api)) |
rmistry@google.com | 8e3ff8c | 2013-01-17 12:55:34 +0000 | [diff] [blame] | 582 | return results |