blob: f914f0fe3b195c3d5b8abe57690614dcdf8e19ff [file] [log] [blame]
maruel@chromium.org725f1c32011-04-01 20:24:54 +00001#!/usr/bin/env python
maruel@chromium.org3bbf2942012-01-10 16:52:06 +00002# Copyright (c) 2012 The Chromium Authors. All rights reserved.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
6"""Enables directory-specific presubmit checks to run at upload and/or commit.
7"""
8
stip@chromium.orgf7d31f52014-01-03 20:14:46 +00009__version__ = '1.8.0'
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000010
11# TODO(joi) Add caching where appropriate/needed. The API is designed to allow
12# caching (between all different invocations of presubmit scripts for a given
13# change). We should add it as our presubmit scripts start feeling slow.
14
enne@chromium.orge72c5f52013-04-16 00:36:40 +000015import cpplint
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000016import cPickle # Exposed through the API.
17import cStringIO # Exposed through the API.
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +000018import contextlib
dcheng091b7db2016-06-16 01:27:51 -070019import fnmatch # Exposed through the API.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000020import glob
asvitkine@chromium.org15169952011-09-27 14:30:53 +000021import inspect
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +000022import itertools
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000023import json # Exposed through the API.
maruel@chromium.orgdf1595a2009-06-11 02:00:13 +000024import logging
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000025import marshal # Exposed through the API.
ilevy@chromium.orgbc117312013-04-20 03:57:56 +000026import multiprocessing
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000027import optparse
28import os # Somewhat exposed through the API.
29import pickle # Exposed through the API.
maruel@chromium.orgce8e46b2009-06-26 22:31:51 +000030import random
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000031import re # Exposed through the API.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000032import sys # Parts exposed through API.
33import tempfile # Exposed through the API.
jam@chromium.org2a891dc2009-08-20 20:33:37 +000034import time
maruel@chromium.orgd7dccf52009-06-06 18:51:58 +000035import traceback # Exposed through the API.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000036import types
maruel@chromium.org1487d532009-06-06 00:22:57 +000037import unittest # Exposed through the API.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000038import urllib2 # Exposed through the API.
tandrii@chromium.org015ebae2016-04-25 19:37:22 +000039import urlparse
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +000040from warnings import warn
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000041
42# Local imports.
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000043import auth
maruel@chromium.org35625c72011-03-23 17:34:02 +000044import fix_encoding
maruel@chromium.org5aeb7dd2009-11-17 18:09:01 +000045import gclient_utils
tandrii@chromium.org015ebae2016-04-25 19:37:22 +000046import gerrit_util
dpranke@chromium.org2a009622011-03-01 02:43:31 +000047import owners
Jochen Eisinger76f5fc62017-04-07 16:27:46 +020048import owners_finder
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000049import presubmit_canned_checks
maruel@chromium.org239f4112011-06-03 20:08:23 +000050import rietveld
maruel@chromium.org5aeb7dd2009-11-17 18:09:01 +000051import scm
maruel@chromium.org84f4fe32011-04-06 13:26:45 +000052import subprocess2 as subprocess # Exposed through the API.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000053
54
maruel@chromium.orgce8e46b2009-06-26 22:31:51 +000055# Ask for feedback only once in program lifetime.
56_ASKED_FOR_FEEDBACK = False
57
58
maruel@chromium.org899e1c12011-04-07 17:03:18 +000059class PresubmitFailure(Exception):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000060 pass
61
62
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +000063class CommandData(object):
64 def __init__(self, name, cmd, kwargs, message):
65 self.name = name
66 self.cmd = cmd
67 self.kwargs = kwargs
68 self.message = message
69 self.info = None
70
ilevy@chromium.orgbc117312013-04-20 03:57:56 +000071
maruel@google.comfb2b8eb2009-04-23 21:03:42 +000072def normpath(path):
73 '''Version of os.path.normpath that also changes backward slashes to
74 forward slashes when not running on Windows.
75 '''
76 # This is safe to always do because the Windows version of os.path.normpath
77 # will replace forward slashes with backward slashes.
78 path = path.replace(os.sep, '/')
79 return os.path.normpath(path)
80
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +000081
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +000082def _RightHandSideLinesImpl(affected_files):
83 """Implements RightHandSideLines for InputApi and GclChange."""
84 for af in affected_files:
maruel@chromium.orgab05d582011-02-09 23:41:22 +000085 lines = af.ChangedContents()
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +000086 for line in lines:
maruel@chromium.orgab05d582011-02-09 23:41:22 +000087 yield (af, line[0], line[1])
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +000088
89
dpranke@chromium.org5ac21012011-03-16 02:58:25 +000090class PresubmitOutput(object):
91 def __init__(self, input_stream=None, output_stream=None):
92 self.input_stream = input_stream
93 self.output_stream = output_stream
94 self.reviewers = []
95 self.written_output = []
96 self.error_count = 0
97
98 def prompt_yes_no(self, prompt_string):
99 self.write(prompt_string)
100 if self.input_stream:
101 response = self.input_stream.readline().strip().lower()
102 if response not in ('y', 'yes'):
103 self.fail()
104 else:
105 self.fail()
106
107 def fail(self):
108 self.error_count += 1
109
110 def should_continue(self):
111 return not self.error_count
112
113 def write(self, s):
114 self.written_output.append(s)
115 if self.output_stream:
116 self.output_stream.write(s)
117
118 def getvalue(self):
119 return ''.join(self.written_output)
120
121
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000122# Top level object so multiprocessing can pickle
123# Public access through OutputApi object.
124class _PresubmitResult(object):
125 """Base class for result objects."""
126 fatal = False
127 should_prompt = False
128
129 def __init__(self, message, items=None, long_text=''):
130 """
131 message: A short one-line message to indicate errors.
132 items: A list of short strings to indicate where errors occurred.
133 long_text: multi-line text output, e.g. from another tool
134 """
135 self._message = message
136 self._items = items or []
137 if items:
138 self._items = items
139 self._long_text = long_text.rstrip()
140
141 def handle(self, output):
142 output.write(self._message)
143 output.write('\n')
144 for index, item in enumerate(self._items):
145 output.write(' ')
146 # Write separately in case it's unicode.
147 output.write(str(item))
148 if index < len(self._items) - 1:
149 output.write(' \\')
150 output.write('\n')
151 if self._long_text:
152 output.write('\n***************\n')
153 # Write separately in case it's unicode.
154 output.write(self._long_text)
155 output.write('\n***************\n')
156 if self.fatal:
157 output.fail()
158
159
160# Top level object so multiprocessing can pickle
161# Public access through OutputApi object.
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000162class _PresubmitError(_PresubmitResult):
163 """A hard presubmit error."""
164 fatal = True
165
166
167# Top level object so multiprocessing can pickle
168# Public access through OutputApi object.
169class _PresubmitPromptWarning(_PresubmitResult):
170 """An warning that prompts the user if they want to continue."""
171 should_prompt = True
172
173
174# Top level object so multiprocessing can pickle
175# Public access through OutputApi object.
176class _PresubmitNotifyResult(_PresubmitResult):
177 """Just print something to the screen -- but it's not even a warning."""
178 pass
179
180
181# Top level object so multiprocessing can pickle
182# Public access through OutputApi object.
183class _MailTextResult(_PresubmitResult):
184 """A warning that should be included in the review request email."""
185 def __init__(self, *args, **kwargs):
186 super(_MailTextResult, self).__init__()
187 raise NotImplementedError()
188
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000189class GerritAccessor(object):
190 """Limited Gerrit functionality for canned presubmit checks to work.
191
192 To avoid excessive Gerrit calls, caches the results.
193 """
194
195 def __init__(self, host):
196 self.host = host
197 self.cache = {}
198
199 def _FetchChangeDetail(self, issue):
200 # Separate function to be easily mocked in tests.
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +0100201 try:
202 return gerrit_util.GetChangeDetail(
203 self.host, str(issue),
Andrii Shyshkalov9c3a4642017-01-24 17:41:22 +0100204 ['ALL_REVISIONS', 'DETAILED_LABELS', 'ALL_COMMITS'],
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +0100205 ignore_404=False)
206 except gerrit_util.GerritError as e:
207 if e.http_status == 404:
208 raise Exception('Either Gerrit issue %s doesn\'t exist, or '
209 'no credentials to fetch issue details' % issue)
210 raise
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000211
212 def GetChangeInfo(self, issue):
213 """Returns labels and all revisions (patchsets) for this issue.
214
215 The result is a dictionary according to Gerrit REST Api.
216 https://gerrit-review.googlesource.com/Documentation/rest-api.html
217
218 However, API isn't very clear what's inside, so see tests for example.
219 """
220 assert issue
221 cache_key = int(issue)
222 if cache_key not in self.cache:
223 self.cache[cache_key] = self._FetchChangeDetail(issue)
224 return self.cache[cache_key]
225
226 def GetChangeDescription(self, issue, patchset=None):
227 """If patchset is none, fetches current patchset."""
228 info = self.GetChangeInfo(issue)
229 # info is a reference to cache. We'll modify it here adding description to
230 # it to the right patchset, if it is not yet there.
231
232 # Find revision info for the patchset we want.
233 if patchset is not None:
234 for rev, rev_info in info['revisions'].iteritems():
235 if str(rev_info['_number']) == str(patchset):
236 break
237 else:
238 raise Exception('patchset %s doesn\'t exist in issue %s' % (
239 patchset, issue))
240 else:
241 rev = info['current_revision']
242 rev_info = info['revisions'][rev]
243
Andrii Shyshkalov9c3a4642017-01-24 17:41:22 +0100244 return rev_info['commit']['message']
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000245
246 def GetChangeOwner(self, issue):
247 return self.GetChangeInfo(issue)['owner']['email']
248
249 def GetChangeReviewers(self, issue, approving_only=True):
agable565adb52016-07-22 14:48:07 -0700250 cr = self.GetChangeInfo(issue)['labels']['Code-Review']
251 max_value = max(int(k) for k in cr['values'].keys())
Aaron Gablef5644a92016-12-02 15:31:58 -0800252 return [r.get('email') for r in cr.get('all', [])
agable565adb52016-07-22 14:48:07 -0700253 if not approving_only or r.get('value', 0) == max_value]
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000254
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000255
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000256class OutputApi(object):
wez@chromium.orga6d011e2013-03-26 17:31:49 +0000257 """An instance of OutputApi gets passed to presubmit scripts so that they
258 can output various types of results.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000259 """
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000260 PresubmitResult = _PresubmitResult
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000261 PresubmitError = _PresubmitError
262 PresubmitPromptWarning = _PresubmitPromptWarning
263 PresubmitNotifyResult = _PresubmitNotifyResult
264 MailTextResult = _MailTextResult
265
wez@chromium.orga6d011e2013-03-26 17:31:49 +0000266 def __init__(self, is_committing):
267 self.is_committing = is_committing
268
wez@chromium.orga6d011e2013-03-26 17:31:49 +0000269 def PresubmitPromptOrNotify(self, *args, **kwargs):
270 """Warn the user when uploading, but only notify if committing."""
271 if self.is_committing:
272 return self.PresubmitNotifyResult(*args, **kwargs)
273 return self.PresubmitPromptWarning(*args, **kwargs)
274
Kenneth Russell61e2ed42017-02-15 11:47:13 -0800275 def EnsureCQIncludeTrybotsAreAdded(self, cl, bots_to_include, message):
276 """Helper for any PostUploadHook wishing to add CQ_INCLUDE_TRYBOTS.
277
278 Merges the bots_to_include into the current CQ_INCLUDE_TRYBOTS list,
279 keeping it alphabetically sorted. Returns the results that should be
280 returned from the PostUploadHook.
281
282 Args:
283 cl: The git_cl.Changelist object.
284 bots_to_include: A list of strings of bots to include, in the form
285 "master:slave".
286 message: A message to be printed in the case that
287 CQ_INCLUDE_TRYBOTS was updated.
288 """
289 description = cl.GetDescription(force=True)
290 all_bots = []
291 include_re = re.compile(r'^CQ_INCLUDE_TRYBOTS=(.*)', re.M | re.I)
292 m = include_re.search(description)
293 if m:
294 all_bots = [i.strip() for i in m.group(1).split(';') if i.strip()]
295 if set(all_bots) >= set(bots_to_include):
296 return []
297 # Sort the bots to keep them in some consistent order -- not required.
298 all_bots = sorted(set(all_bots) | set(bots_to_include))
299 new_include_trybots = 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(all_bots)
300 if m:
301 new_description = include_re.sub(new_include_trybots, description)
302 else:
303 new_description = description + '\n' + new_include_trybots + '\n'
304 cl.UpdateDescription(new_description, force=True)
305 return [self.PresubmitNotifyResult(message)]
306
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000307
308class InputApi(object):
309 """An instance of this object is passed to presubmit scripts so they can
310 know stuff about the change they're looking at.
311 """
maruel@chromium.orgb17b55b2010-11-03 14:42:37 +0000312 # Method could be a function
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -0800313 # pylint: disable=no-self-use
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000314
maruel@chromium.org3410d912009-06-09 20:56:16 +0000315 # File extensions that are considered source files from a style guide
316 # perspective. Don't modify this list from a presubmit script!
maruel@chromium.orgc33455a2011-06-24 19:14:18 +0000317 #
318 # Files without an extension aren't included in the list. If you want to
319 # filter them as source files, add r"(^|.*?[\\\/])[^.]+$" to the white list.
320 # Note that ALL CAPS files are black listed in DEFAULT_BLACK_LIST below.
maruel@chromium.org3410d912009-06-09 20:56:16 +0000321 DEFAULT_WHITE_LIST = (
322 # C++ and friends
maruel@chromium.orgfe1211a2011-05-28 18:54:17 +0000323 r".+\.c$", r".+\.cc$", r".+\.cpp$", r".+\.h$", r".+\.m$", r".+\.mm$",
324 r".+\.inl$", r".+\.asm$", r".+\.hxx$", r".+\.hpp$", r".+\.s$", r".+\.S$",
maruel@chromium.org3410d912009-06-09 20:56:16 +0000325 # Scripts
maruel@chromium.orgfe1211a2011-05-28 18:54:17 +0000326 r".+\.js$", r".+\.py$", r".+\.sh$", r".+\.rb$", r".+\.pl$", r".+\.pm$",
maruel@chromium.org3410d912009-06-09 20:56:16 +0000327 # Other
estade@chromium.orgae7af922012-01-27 14:51:13 +0000328 r".+\.java$", r".+\.mk$", r".+\.am$", r".+\.css$"
maruel@chromium.org3410d912009-06-09 20:56:16 +0000329 )
330
331 # Path regexp that should be excluded from being considered containing source
332 # files. Don't modify this list from a presubmit script!
333 DEFAULT_BLACK_LIST = (
gavinp@chromium.org656326d2012-08-13 00:43:57 +0000334 r"testing_support[\\\/]google_appengine[\\\/].*",
maruel@chromium.org3410d912009-06-09 20:56:16 +0000335 r".*\bexperimental[\\\/].*",
primiano@chromium.orgb9658c32015-10-06 10:50:13 +0000336 # Exclude third_party/.* but NOT third_party/WebKit (crbug.com/539768).
337 r".*\bthird_party[\\\/](?!WebKit[\\\/]).*",
maruel@chromium.org3410d912009-06-09 20:56:16 +0000338 # Output directories (just in case)
339 r".*\bDebug[\\\/].*",
340 r".*\bRelease[\\\/].*",
341 r".*\bxcodebuild[\\\/].*",
thakis@chromium.orgc1c96352013-10-09 19:50:27 +0000342 r".*\bout[\\\/].*",
maruel@chromium.org3410d912009-06-09 20:56:16 +0000343 # All caps files like README and LICENCE.
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000344 r".*\b[A-Z0-9_]{2,}$",
maruel@chromium.orgdf1595a2009-06-11 02:00:13 +0000345 # SCM (can happen in dual SCM configuration). (Slightly over aggressive)
maruel@chromium.org5d0dc432011-01-03 02:40:37 +0000346 r"(|.*[\\\/])\.git[\\\/].*",
347 r"(|.*[\\\/])\.svn[\\\/].*",
maruel@chromium.org7ccb4bb2011-11-07 20:26:20 +0000348 # There is no point in processing a patch file.
349 r".+\.diff$",
350 r".+\.patch$",
maruel@chromium.org3410d912009-06-09 20:56:16 +0000351 )
352
maruel@chromium.orgcc73ad62011-07-06 17:39:26 +0000353 def __init__(self, change, presubmit_path, is_committing,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000354 rietveld_obj, verbose, gerrit_obj=None, dry_run=None):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000355 """Builds an InputApi object.
356
357 Args:
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000358 change: A presubmit.Change object.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000359 presubmit_path: The path to the presubmit script being processed.
maruel@chromium.orgd7dccf52009-06-06 18:51:58 +0000360 is_committing: True if the change is about to be committed.
maruel@chromium.org239f4112011-06-03 20:08:23 +0000361 rietveld_obj: rietveld.Rietveld client object
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000362 gerrit_obj: provides basic Gerrit codereview functionality.
363 dry_run: if true, some Checks will be skipped.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000364 """
maruel@chromium.org9711bba2009-05-22 23:51:39 +0000365 # Version number of the presubmit_support script.
366 self.version = [int(x) for x in __version__.split('.')]
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000367 self.change = change
maruel@chromium.orgd7dccf52009-06-06 18:51:58 +0000368 self.is_committing = is_committing
maruel@chromium.org239f4112011-06-03 20:08:23 +0000369 self.rietveld = rietveld_obj
tandrii@chromium.org37b07a72016-04-29 16:42:28 +0000370 self.gerrit = gerrit_obj
tandrii@chromium.org57bafac2016-04-28 05:09:03 +0000371 self.dry_run = dry_run
maruel@chromium.orgcab38e92011-04-09 00:30:51 +0000372 # TBD
373 self.host_url = 'http://codereview.chromium.org'
374 if self.rietveld:
maruel@chromium.org239f4112011-06-03 20:08:23 +0000375 self.host_url = self.rietveld.url
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000376
377 # We expose various modules and functions as attributes of the input_api
378 # so that presubmit scripts don't have to import them.
379 self.basename = os.path.basename
380 self.cPickle = cPickle
enne@chromium.orge72c5f52013-04-16 00:36:40 +0000381 self.cpplint = cpplint
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000382 self.cStringIO = cStringIO
dcheng091b7db2016-06-16 01:27:51 -0700383 self.fnmatch = fnmatch
dpranke@chromium.org17cc2442012-10-17 21:12:09 +0000384 self.glob = glob.glob
maruel@chromium.orgfb11c7b2010-03-18 18:22:14 +0000385 self.json = json
maruel@chromium.org6fba34d2011-06-02 13:45:12 +0000386 self.logging = logging.getLogger('PRESUBMIT')
maruel@chromium.org2b5ce562011-03-31 16:15:44 +0000387 self.os_listdir = os.listdir
388 self.os_walk = os.walk
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000389 self.os_path = os.path
pgervais@chromium.orgbd0cace2014-10-02 23:23:46 +0000390 self.os_stat = os.stat
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000391 self.pickle = pickle
392 self.marshal = marshal
393 self.re = re
394 self.subprocess = subprocess
395 self.tempfile = tempfile
dpranke@chromium.org0d1bdea2011-03-24 22:54:38 +0000396 self.time = time
maruel@chromium.orgd7dccf52009-06-06 18:51:58 +0000397 self.traceback = traceback
maruel@chromium.org1487d532009-06-06 00:22:57 +0000398 self.unittest = unittest
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000399 self.urllib2 = urllib2
400
maruel@chromium.orgc0b22972009-06-25 16:19:14 +0000401 # To easily fork python.
402 self.python_executable = sys.executable
403 self.environ = os.environ
404
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000405 # InputApi.platform is the platform you're currently running on.
406 self.platform = sys.platform
407
iannucci@chromium.org0af3bb32015-06-12 20:44:35 +0000408 self.cpu_count = multiprocessing.cpu_count()
409
iannucci@chromium.orgd61a4952015-07-01 23:21:26 +0000410 # this is done here because in RunTests, the current working directory has
411 # changed, which causes Pool() to explode fantastically when run on windows
412 # (because it tries to load the __main__ module, which imports lots of
413 # things relative to the current working directory).
414 self._run_tests_pool = multiprocessing.Pool(self.cpu_count)
415
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000416 # The local path of the currently-being-processed presubmit script.
maruel@chromium.org3d235242009-05-15 12:40:48 +0000417 self._current_presubmit_path = os.path.dirname(presubmit_path)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000418
419 # We carry the canned checks so presubmit scripts can easily use them.
420 self.canned_checks = presubmit_canned_checks
421
Jochen Eisinger72606f82017-04-04 10:44:18 +0200422
dpranke@chromium.org2a009622011-03-01 02:43:31 +0000423 # TODO(dpranke): figure out a list of all approved owners for a repo
424 # in order to be able to handle wildcard OWNERS files?
425 self.owners_db = owners.Database(change.RepositoryRoot(),
Jochen Eisinger72606f82017-04-04 10:44:18 +0200426 fopen=file, os_path=self.os_path)
Jochen Eisinger76f5fc62017-04-07 16:27:46 +0200427 self.owners_finder = owners_finder.OwnersFinder
maruel@chromium.org899e1c12011-04-07 17:03:18 +0000428 self.verbose = verbose
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000429 self.Command = CommandData
dpranke@chromium.org2a009622011-03-01 02:43:31 +0000430
enne@chromium.orge72c5f52013-04-16 00:36:40 +0000431 # Replace <hash_map> and <hash_set> as headers that need to be included
danakj@chromium.org18278522013-06-11 22:42:32 +0000432 # with "base/containers/hash_tables.h" instead.
enne@chromium.orge72c5f52013-04-16 00:36:40 +0000433 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -0800434 # pylint: disable=protected-access
enne@chromium.orge72c5f52013-04-16 00:36:40 +0000435 self.cpplint._re_pattern_templates = [
danakj@chromium.org18278522013-06-11 22:42:32 +0000436 (a, b, 'base/containers/hash_tables.h')
enne@chromium.orge72c5f52013-04-16 00:36:40 +0000437 if header in ('<hash_map>', '<hash_set>') else (a, b, header)
438 for (a, b, header) in cpplint._re_pattern_templates
439 ]
440
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000441 def PresubmitLocalPath(self):
442 """Returns the local path of the presubmit script currently being run.
443
444 This is useful if you don't want to hard-code absolute paths in the
445 presubmit script. For example, It can be used to find another file
446 relative to the PRESUBMIT.py script, so the whole tree can be branched and
447 the presubmit script still works, without editing its content.
448 """
maruel@chromium.org3d235242009-05-15 12:40:48 +0000449 return self._current_presubmit_path
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000450
agable0b65e732016-11-22 09:25:46 -0800451 def AffectedFiles(self, include_deletes=True, file_filter=None):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000452 """Same as input_api.change.AffectedFiles() except only lists files
453 (and optionally directories) in the same directory as the current presubmit
454 script, or subdirectories thereof.
455 """
maruel@chromium.org3d235242009-05-15 12:40:48 +0000456 dir_with_slash = normpath("%s/" % self.PresubmitLocalPath())
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000457 if len(dir_with_slash) == 1:
458 dir_with_slash = ''
sail@chromium.org5538e022011-05-12 17:53:16 +0000459
maruel@chromium.org4661e0c2009-06-04 00:45:26 +0000460 return filter(
461 lambda x: normpath(x.AbsoluteLocalPath()).startswith(dir_with_slash),
agable0b65e732016-11-22 09:25:46 -0800462 self.change.AffectedFiles(include_deletes, file_filter))
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000463
agable0b65e732016-11-22 09:25:46 -0800464 def LocalPaths(self):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000465 """Returns local paths of input_api.AffectedFiles()."""
agable0b65e732016-11-22 09:25:46 -0800466 paths = [af.LocalPath() for af in self.AffectedFiles()]
pgervais@chromium.org2f64f782014-04-25 00:12:33 +0000467 logging.debug("LocalPaths: %s", paths)
468 return paths
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000469
agable0b65e732016-11-22 09:25:46 -0800470 def AbsoluteLocalPaths(self):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000471 """Returns absolute local paths of input_api.AffectedFiles()."""
agable0b65e732016-11-22 09:25:46 -0800472 return [af.AbsoluteLocalPath() for af in self.AffectedFiles()]
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000473
agable0b65e732016-11-22 09:25:46 -0800474 def AffectedTestableFiles(self, include_deletes=None):
475 """Same as input_api.change.AffectedTestableFiles() except only lists files
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000476 in the same directory as the current presubmit script, or subdirectories
477 thereof.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000478 """
maruel@chromium.org77c4f0f2009-05-29 18:53:04 +0000479 if include_deletes is not None:
agable0b65e732016-11-22 09:25:46 -0800480 warn("AffectedTestableFiles(include_deletes=%s)"
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +0000481 " is deprecated and ignored" % str(include_deletes),
482 category=DeprecationWarning,
483 stacklevel=2)
agable0b65e732016-11-22 09:25:46 -0800484 return filter(lambda x: x.IsTestableFile(),
485 self.AffectedFiles(include_deletes=False))
486
487 def AffectedTextFiles(self, include_deletes=None):
488 """An alias to AffectedTestableFiles for backwards compatibility."""
489 return self.AffectedTestableFiles(include_deletes=include_deletes)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000490
maruel@chromium.org3410d912009-06-09 20:56:16 +0000491 def FilterSourceFile(self, affected_file, white_list=None, black_list=None):
492 """Filters out files that aren't considered "source file".
493
494 If white_list or black_list is None, InputApi.DEFAULT_WHITE_LIST
495 and InputApi.DEFAULT_BLACK_LIST is used respectively.
496
497 The lists will be compiled as regular expression and
498 AffectedFile.LocalPath() needs to pass both list.
499
500 Note: Copy-paste this function to suit your needs or use a lambda function.
501 """
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +0000502 def Find(affected_file, items):
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000503 local_path = affected_file.LocalPath()
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +0000504 for item in items:
maruel@chromium.orgdf1595a2009-06-11 02:00:13 +0000505 if self.re.match(item, local_path):
maruel@chromium.org3410d912009-06-09 20:56:16 +0000506 return True
507 return False
508 return (Find(affected_file, white_list or self.DEFAULT_WHITE_LIST) and
509 not Find(affected_file, black_list or self.DEFAULT_BLACK_LIST))
510
511 def AffectedSourceFiles(self, source_file):
agable0b65e732016-11-22 09:25:46 -0800512 """Filter the list of AffectedTestableFiles by the function source_file.
maruel@chromium.org3410d912009-06-09 20:56:16 +0000513
514 If source_file is None, InputApi.FilterSourceFile() is used.
515 """
516 if not source_file:
517 source_file = self.FilterSourceFile
agable0b65e732016-11-22 09:25:46 -0800518 return filter(source_file, self.AffectedTestableFiles())
maruel@chromium.org3410d912009-06-09 20:56:16 +0000519
520 def RightHandSideLines(self, source_file_filter=None):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000521 """An iterator over all text lines in "new" version of changed files.
522
523 Only lists lines from new or modified text files in the change that are
524 contained by the directory of the currently executing presubmit script.
525
526 This is useful for doing line-by-line regex checks, like checking for
527 trailing whitespace.
528
529 Yields:
530 a 3 tuple:
531 the AffectedFile instance of the current file;
532 integer line number (1-based); and
533 the contents of the line as a string.
maruel@chromium.org1487d532009-06-06 00:22:57 +0000534
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000535 Note: The carriage return (LF or CR) is stripped off.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000536 """
maruel@chromium.org3410d912009-06-09 20:56:16 +0000537 files = self.AffectedSourceFiles(source_file_filter)
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +0000538 return _RightHandSideLinesImpl(files)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000539
maruel@chromium.orge3608df2009-11-10 20:22:57 +0000540 def ReadFile(self, file_item, mode='r'):
maruel@chromium.org44a17ad2009-06-08 14:14:35 +0000541 """Reads an arbitrary file.
thestig@chromium.orgda8cddd2009-08-13 00:25:55 +0000542
maruel@chromium.org44a17ad2009-06-08 14:14:35 +0000543 Deny reading anything outside the repository.
544 """
maruel@chromium.orge3608df2009-11-10 20:22:57 +0000545 if isinstance(file_item, AffectedFile):
546 file_item = file_item.AbsoluteLocalPath()
547 if not file_item.startswith(self.change.RepositoryRoot()):
maruel@chromium.org44a17ad2009-06-08 14:14:35 +0000548 raise IOError('Access outside the repository root is denied.')
maruel@chromium.org5aeb7dd2009-11-17 18:09:01 +0000549 return gclient_utils.FileRead(file_item, mode)
maruel@chromium.org44a17ad2009-06-08 14:14:35 +0000550
maruel@chromium.orgcc73ad62011-07-06 17:39:26 +0000551 @property
552 def tbr(self):
553 """Returns if a change is TBR'ed."""
554 return 'TBR' in self.change.tags
555
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +0000556 def RunTests(self, tests_mix, parallel=True):
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000557 tests = []
558 msgs = []
559 for t in tests_mix:
560 if isinstance(t, OutputApi.PresubmitResult):
561 msgs.append(t)
562 else:
563 assert issubclass(t.message, _PresubmitResult)
564 tests.append(t)
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +0000565 if self.verbose:
566 t.info = _PresubmitNotifyResult
ilevy@chromium.org5678d332013-05-18 01:34:14 +0000567 if len(tests) > 1 and parallel:
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000568 # async recipe works around multiprocessing bug handling Ctrl-C
iannucci@chromium.orgd61a4952015-07-01 23:21:26 +0000569 msgs.extend(self._run_tests_pool.map_async(CallCommand, tests).get(99999))
ilevy@chromium.orgbc117312013-04-20 03:57:56 +0000570 else:
571 msgs.extend(map(CallCommand, tests))
572 return [m for m in msgs if m]
573
scottmg86099d72016-09-01 09:16:51 -0700574 def ShutdownPool(self):
575 self._run_tests_pool.close()
576 self._run_tests_pool.join()
577 self._run_tests_pool = None
578
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000579
nick@chromium.orgff526192013-06-10 19:30:26 +0000580class _DiffCache(object):
581 """Caches diffs retrieved from a particular SCM."""
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000582 def __init__(self, upstream=None):
583 """Stores the upstream revision against which all diffs will be computed."""
584 self._upstream = upstream
nick@chromium.orgff526192013-06-10 19:30:26 +0000585
586 def GetDiff(self, path, local_root):
587 """Get the diff for a particular path."""
588 raise NotImplementedError()
589
Daniel Cheng7a1f04d2017-03-21 19:12:31 -0700590 def GetOldContents(self, path, local_root):
591 """Get the old version for a particular path."""
592 raise NotImplementedError()
593
nick@chromium.orgff526192013-06-10 19:30:26 +0000594
nick@chromium.orgff526192013-06-10 19:30:26 +0000595class _GitDiffCache(_DiffCache):
596 """DiffCache implementation for git; gets all file diffs at once."""
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000597 def __init__(self, upstream):
598 super(_GitDiffCache, self).__init__(upstream=upstream)
nick@chromium.orgff526192013-06-10 19:30:26 +0000599 self._diffs_by_file = None
600
601 def GetDiff(self, path, local_root):
602 if not self._diffs_by_file:
603 # Compute a single diff for all files and parse the output; should
604 # with git this is much faster than computing one diff for each file.
605 diffs = {}
606
607 # Don't specify any filenames below, because there are command line length
608 # limits on some platforms and GenerateDiff would fail.
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000609 unified_diff = scm.GIT.GenerateDiff(local_root, files=[], full_move=True,
610 branch=self._upstream)
nick@chromium.orgff526192013-06-10 19:30:26 +0000611
612 # This regex matches the path twice, separated by a space. Note that
613 # filename itself may contain spaces.
614 file_marker = re.compile('^diff --git (?P<filename>.*) (?P=filename)$')
615 current_diff = []
616 keep_line_endings = True
617 for x in unified_diff.splitlines(keep_line_endings):
618 match = file_marker.match(x)
619 if match:
620 # Marks the start of a new per-file section.
621 diffs[match.group('filename')] = current_diff = [x]
622 elif x.startswith('diff --git'):
623 raise PresubmitFailure('Unexpected diff line: %s' % x)
624 else:
625 current_diff.append(x)
626
627 self._diffs_by_file = dict(
628 (normpath(path), ''.join(diff)) for path, diff in diffs.items())
629
630 if path not in self._diffs_by_file:
631 raise PresubmitFailure(
632 'Unified diff did not contain entry for file %s' % path)
633
634 return self._diffs_by_file[path]
635
Daniel Cheng7a1f04d2017-03-21 19:12:31 -0700636 def GetOldContents(self, path, local_root):
637 return scm.GIT.GetOldContents(local_root, path, branch=self._upstream)
638
nick@chromium.orgff526192013-06-10 19:30:26 +0000639
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000640class AffectedFile(object):
641 """Representation of a file in a change."""
nick@chromium.orgff526192013-06-10 19:30:26 +0000642
643 DIFF_CACHE = _DiffCache
644
maruel@chromium.orgb17b55b2010-11-03 14:42:37 +0000645 # Method could be a function
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -0800646 # pylint: disable=no-self-use
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000647 def __init__(self, path, action, repository_root, diff_cache):
maruel@chromium.org15bdffa2009-05-29 11:16:29 +0000648 self._path = path
649 self._action = action
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000650 self._local_root = repository_root
maruel@chromium.org15bdffa2009-05-29 11:16:29 +0000651 self._is_directory = None
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000652 self._cached_changed_contents = None
653 self._cached_new_contents = None
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000654 self._diff_cache = diff_cache
tobiasjs2836bcf2016-08-16 04:08:16 -0700655 logging.debug('%s(%s)', self.__class__.__name__, self._path)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000656
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000657 def LocalPath(self):
658 """Returns the path of this file on the local disk relative to client root.
659 """
maruel@chromium.org15bdffa2009-05-29 11:16:29 +0000660 return normpath(self._path)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000661
662 def AbsoluteLocalPath(self):
663 """Returns the absolute path of this file on the local disk.
664 """
chase@chromium.org8e416c82009-10-06 04:30:44 +0000665 return os.path.abspath(os.path.join(self._local_root, self.LocalPath()))
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000666
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000667 def Action(self):
668 """Returns the action on this opened file, e.g. A, M, D, etc."""
maruel@chromium.org15bdffa2009-05-29 11:16:29 +0000669 return self._action
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000670
agable0b65e732016-11-22 09:25:46 -0800671 def IsTestableFile(self):
maruel@chromium.org77c4f0f2009-05-29 18:53:04 +0000672 """Returns True if the file is a text file and not a binary file.
thestig@chromium.orgda8cddd2009-08-13 00:25:55 +0000673
maruel@chromium.org77c4f0f2009-05-29 18:53:04 +0000674 Deleted files are not text file."""
maruel@chromium.org1e08c002009-05-28 19:09:33 +0000675 raise NotImplementedError() # Implement when needed
676
agable0b65e732016-11-22 09:25:46 -0800677 def IsTextFile(self):
678 """An alias to IsTestableFile for backwards compatibility."""
679 return self.IsTestableFile()
680
Daniel Cheng7a1f04d2017-03-21 19:12:31 -0700681 def OldContents(self):
682 """Returns an iterator over the lines in the old version of file.
683
Daniel Cheng2da34fe2017-03-21 20:42:12 -0700684 The old version is the file before any modifications in the user's
685 workspace, i.e. the "left hand side".
Daniel Cheng7a1f04d2017-03-21 19:12:31 -0700686
687 Contents will be empty if the file is a directory or does not exist.
688 Note: The carriage returns (LF or CR) are stripped off.
689 """
690 return self._diff_cache.GetOldContents(self.LocalPath(),
691 self._local_root).splitlines()
692
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000693 def NewContents(self):
694 """Returns an iterator over the lines in the new version of file.
695
696 The new version is the file in the user's workspace, i.e. the "right hand
697 side".
698
699 Contents will be empty if the file is a directory or does not exist.
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000700 Note: The carriage returns (LF or CR) are stripped off.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000701 """
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000702 if self._cached_new_contents is None:
703 self._cached_new_contents = []
agable0b65e732016-11-22 09:25:46 -0800704 try:
705 self._cached_new_contents = gclient_utils.FileRead(
706 self.AbsoluteLocalPath(), 'rU').splitlines()
707 except IOError:
708 pass # File not found? That's fine; maybe it was deleted.
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000709 return self._cached_new_contents[:]
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000710
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000711 def ChangedContents(self):
712 """Returns a list of tuples (line number, line text) of all new lines.
713
714 This relies on the scm diff output describing each changed code section
715 with a line of the form
716
717 ^@@ <old line num>,<old size> <new line num>,<new size> @@$
718 """
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000719 if self._cached_changed_contents is not None:
720 return self._cached_changed_contents[:]
721 self._cached_changed_contents = []
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000722 line_num = 0
723
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000724 for line in self.GenerateScmDiff().splitlines():
725 m = re.match(r'^@@ [0-9\,\+\-]+ \+([0-9]+)\,[0-9]+ @@', line)
726 if m:
727 line_num = int(m.groups(1)[0])
728 continue
729 if line.startswith('+') and not line.startswith('++'):
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000730 self._cached_changed_contents.append((line_num, line[1:]))
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000731 if not line.startswith('-'):
732 line_num += 1
nick@chromium.org2a3ab7e2011-04-27 22:06:27 +0000733 return self._cached_changed_contents[:]
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000734
maruel@chromium.org5de13972009-06-10 18:16:06 +0000735 def __str__(self):
736 return self.LocalPath()
737
maruel@chromium.orgab05d582011-02-09 23:41:22 +0000738 def GenerateScmDiff(self):
nick@chromium.orgff526192013-06-10 19:30:26 +0000739 return self._diff_cache.GetDiff(self.LocalPath(), self._local_root)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000740
maruel@chromium.org58407af2011-04-12 23:15:57 +0000741
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000742class GitAffectedFile(AffectedFile):
743 """Representation of a file in a change out of a git checkout."""
maruel@chromium.orgb17b55b2010-11-03 14:42:37 +0000744 # Method 'NNN' is abstract in class 'NNN' but is not overridden
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -0800745 # pylint: disable=abstract-method
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000746
nick@chromium.orgff526192013-06-10 19:30:26 +0000747 DIFF_CACHE = _GitDiffCache
748
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000749 def __init__(self, *args, **kwargs):
750 AffectedFile.__init__(self, *args, **kwargs)
751 self._server_path = None
agable0b65e732016-11-22 09:25:46 -0800752 self._is_testable_file = None
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000753
agable0b65e732016-11-22 09:25:46 -0800754 def IsTestableFile(self):
755 if self._is_testable_file is None:
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000756 if self.Action() == 'D':
agable0b65e732016-11-22 09:25:46 -0800757 # A deleted file is not testable.
758 self._is_testable_file = False
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000759 else:
agable0b65e732016-11-22 09:25:46 -0800760 self._is_testable_file = os.path.isfile(self.AbsoluteLocalPath())
761 return self._is_testable_file
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000762
maruel@chromium.orgc1938752011-04-12 23:11:13 +0000763
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000764class Change(object):
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000765 """Describe a change.
766
767 Used directly by the presubmit scripts to query the current change being
768 tested.
thestig@chromium.orgda8cddd2009-08-13 00:25:55 +0000769
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000770 Instance members:
nick@chromium.orgff526192013-06-10 19:30:26 +0000771 tags: Dictionary of KEY=VALUE pairs found in the change description.
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000772 self.KEY: equivalent to tags['KEY']
773 """
774
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000775 _AFFECTED_FILES = AffectedFile
776
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000777 # Matches key/value (or "tag") lines in changelist descriptions.
maruel@chromium.org428342a2011-11-10 15:46:33 +0000778 TAG_LINE_RE = re.compile(
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +0000779 '^[ \t]*(?P<key>[A-Z][A-Z_0-9]*)[ \t]*=[ \t]*(?P<value>.*?)[ \t]*$')
maruel@chromium.orgc1938752011-04-12 23:11:13 +0000780 scm = ''
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000781
maruel@chromium.org58407af2011-04-12 23:15:57 +0000782 def __init__(
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000783 self, name, description, local_root, files, issue, patchset, author,
784 upstream=None):
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000785 if files is None:
786 files = []
787 self._name = name
chase@chromium.org8e416c82009-10-06 04:30:44 +0000788 # Convert root into an absolute path.
789 self._local_root = os.path.abspath(local_root)
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000790 self._upstream = upstream
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000791 self.issue = issue
792 self.patchset = patchset
maruel@chromium.org58407af2011-04-12 23:15:57 +0000793 self.author_email = author
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000794
isherman@chromium.orgb5cded62014-03-25 17:47:57 +0000795 self._full_description = ''
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000796 self.tags = {}
isherman@chromium.orgb5cded62014-03-25 17:47:57 +0000797 self._description_without_tags = ''
798 self.SetDescriptionText(description)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000799
maruel@chromium.orge085d812011-10-10 19:49:15 +0000800 assert all(
801 (isinstance(f, (list, tuple)) and len(f) == 2) for f in files), files
802
agable@chromium.orgea84ef12014-04-30 19:55:12 +0000803 diff_cache = self._AFFECTED_FILES.DIFF_CACHE(self._upstream)
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000804 self._affected_files = [
nick@chromium.orgff526192013-06-10 19:30:26 +0000805 self._AFFECTED_FILES(path, action.strip(), self._local_root, diff_cache)
806 for action, path in files
maruel@chromium.orgdbbeedc2009-05-22 20:26:17 +0000807 ]
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000808
maruel@chromium.org92022ec2009-06-11 01:59:28 +0000809 def Name(self):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000810 """Returns the change name."""
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000811 return self._name
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000812
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000813 def DescriptionText(self):
814 """Returns the user-entered changelist description, minus tags.
815
816 Any line in the user-provided description starting with e.g. "FOO="
817 (whitespace permitted before and around) is considered a tag line. Such
818 lines are stripped out of the description this function returns.
819 """
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000820 return self._description_without_tags
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000821
822 def FullDescriptionText(self):
823 """Returns the complete changelist description including tags."""
maruel@chromium.org6ebe68a2009-05-27 23:43:40 +0000824 return self._full_description
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000825
isherman@chromium.orgb5cded62014-03-25 17:47:57 +0000826 def SetDescriptionText(self, description):
827 """Sets the full description text (including tags) to |description|.
pgervais@chromium.org92c30092014-04-15 00:30:37 +0000828
isherman@chromium.orgb5cded62014-03-25 17:47:57 +0000829 Also updates the list of tags."""
830 self._full_description = description
831
832 # From the description text, build up a dictionary of key/value pairs
833 # plus the description minus all key/value or "tag" lines.
834 description_without_tags = []
835 self.tags = {}
836 for line in self._full_description.splitlines():
837 m = self.TAG_LINE_RE.match(line)
838 if m:
839 self.tags[m.group('key')] = m.group('value')
840 else:
841 description_without_tags.append(line)
842
843 # Change back to text and remove whitespace at end.
844 self._description_without_tags = (
845 '\n'.join(description_without_tags).rstrip())
846
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000847 def RepositoryRoot(self):
maruel@chromium.org92022ec2009-06-11 01:59:28 +0000848 """Returns the repository (checkout) root directory for this change,
849 as an absolute path.
850 """
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000851 return self._local_root
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000852
853 def __getattr__(self, attr):
maruel@chromium.org92022ec2009-06-11 01:59:28 +0000854 """Return tags directly as attributes on the object."""
855 if not re.match(r"^[A-Z_]*$", attr):
856 raise AttributeError(self, attr)
maruel@chromium.orge1a524f2009-05-27 14:43:46 +0000857 return self.tags.get(attr)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000858
agable@chromium.org40a3d0b2014-05-15 01:59:16 +0000859 def AllFiles(self, root=None):
860 """List all files under source control in the repo."""
861 raise NotImplementedError()
862
agable0b65e732016-11-22 09:25:46 -0800863 def AffectedFiles(self, include_deletes=True, file_filter=None):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000864 """Returns a list of AffectedFile instances for all files in the change.
865
866 Args:
867 include_deletes: If false, deleted files will be filtered out.
sail@chromium.org5538e022011-05-12 17:53:16 +0000868 file_filter: An additional filter to apply.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000869
870 Returns:
871 [AffectedFile(path, action), AffectedFile(path, action)]
872 """
agable0b65e732016-11-22 09:25:46 -0800873 affected = filter(file_filter, self._affected_files)
sail@chromium.org5538e022011-05-12 17:53:16 +0000874
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000875 if include_deletes:
876 return affected
Lei Zhang9611c4c2017-04-04 01:41:56 -0700877 return filter(lambda x: x.Action() != 'D', affected)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000878
agable0b65e732016-11-22 09:25:46 -0800879 def AffectedTestableFiles(self, include_deletes=None):
maruel@chromium.org77c4f0f2009-05-29 18:53:04 +0000880 """Return a list of the existing text files in a change."""
881 if include_deletes is not None:
agable0b65e732016-11-22 09:25:46 -0800882 warn("AffectedTeestableFiles(include_deletes=%s)"
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +0000883 " is deprecated and ignored" % str(include_deletes),
884 category=DeprecationWarning,
885 stacklevel=2)
agable0b65e732016-11-22 09:25:46 -0800886 return filter(lambda x: x.IsTestableFile(),
887 self.AffectedFiles(include_deletes=False))
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000888
agable0b65e732016-11-22 09:25:46 -0800889 def AffectedTextFiles(self, include_deletes=None):
890 """An alias to AffectedTestableFiles for backwards compatibility."""
891 return self.AffectedTestableFiles(include_deletes=include_deletes)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000892
agable0b65e732016-11-22 09:25:46 -0800893 def LocalPaths(self):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000894 """Convenience function."""
agable0b65e732016-11-22 09:25:46 -0800895 return [af.LocalPath() for af in self.AffectedFiles()]
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000896
agable0b65e732016-11-22 09:25:46 -0800897 def AbsoluteLocalPaths(self):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000898 """Convenience function."""
agable0b65e732016-11-22 09:25:46 -0800899 return [af.AbsoluteLocalPath() for af in self.AffectedFiles()]
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000900
901 def RightHandSideLines(self):
902 """An iterator over all text lines in "new" version of changed files.
903
904 Lists lines from new or modified text files in the change.
905
906 This is useful for doing line-by-line regex checks, like checking for
907 trailing whitespace.
908
909 Yields:
910 a 3 tuple:
911 the AffectedFile instance of the current file;
912 integer line number (1-based); and
913 the contents of the line as a string.
914 """
maruel@chromium.orgcb2985f2010-11-03 14:08:31 +0000915 return _RightHandSideLinesImpl(
916 x for x in self.AffectedFiles(include_deletes=False)
agable0b65e732016-11-22 09:25:46 -0800917 if x.IsTestableFile())
agable@chromium.org40a3d0b2014-05-15 01:59:16 +0000918
maruel@chromium.org4ff922a2009-06-12 20:20:19 +0000919
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000920class GitChange(Change):
921 _AFFECTED_FILES = GitAffectedFile
maruel@chromium.orgc1938752011-04-12 23:11:13 +0000922 scm = 'git'
thestig@chromium.orgda8cddd2009-08-13 00:25:55 +0000923
agable@chromium.org40a3d0b2014-05-15 01:59:16 +0000924 def AllFiles(self, root=None):
925 """List all files under source control in the repo."""
926 root = root or self.RepositoryRoot()
927 return subprocess.check_output(
928 ['git', 'ls-files', '--', '.'], cwd=root).splitlines()
929
maruel@chromium.orgc70a2202009-06-17 12:55:10 +0000930
maruel@chromium.org4661e0c2009-06-04 00:45:26 +0000931def ListRelevantPresubmitFiles(files, root):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000932 """Finds all presubmit files that apply to a given set of source files.
933
maruel@chromium.orgb1901a62010-06-16 00:18:47 +0000934 If inherit-review-settings-ok is present right under root, looks for
935 PRESUBMIT.py in directories enclosing root.
936
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000937 Args:
938 files: An iterable container containing file paths.
maruel@chromium.org4661e0c2009-06-04 00:45:26 +0000939 root: Path where to stop searching.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000940
941 Return:
maruel@chromium.org4661e0c2009-06-04 00:45:26 +0000942 List of absolute paths of the existing PRESUBMIT.py scripts.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000943 """
maruel@chromium.orgb1901a62010-06-16 00:18:47 +0000944 files = [normpath(os.path.join(root, f)) for f in files]
945
946 # List all the individual directories containing files.
947 directories = set([os.path.dirname(f) for f in files])
948
949 # Ignore root if inherit-review-settings-ok is present.
950 if os.path.isfile(os.path.join(root, 'inherit-review-settings-ok')):
951 root = None
952
953 # Collect all unique directories that may contain PRESUBMIT.py.
954 candidates = set()
955 for directory in directories:
956 while True:
957 if directory in candidates:
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000958 break
maruel@chromium.orgb1901a62010-06-16 00:18:47 +0000959 candidates.add(directory)
960 if directory == root:
maruel@chromium.org4661e0c2009-06-04 00:45:26 +0000961 break
maruel@chromium.orgb1901a62010-06-16 00:18:47 +0000962 parent_dir = os.path.dirname(directory)
963 if parent_dir == directory:
964 # We hit the system root directory.
965 break
966 directory = parent_dir
967
968 # Look for PRESUBMIT.py in all candidate directories.
969 results = []
970 for directory in sorted(list(candidates)):
tobiasjsff061c02016-08-17 03:23:57 -0700971 try:
972 for f in os.listdir(directory):
973 p = os.path.join(directory, f)
974 if os.path.isfile(p) and re.match(
975 r'PRESUBMIT.*\.py$', f) and not f.startswith('PRESUBMIT_test'):
976 results.append(p)
977 except OSError:
978 pass
maruel@chromium.orgb1901a62010-06-16 00:18:47 +0000979
tobiasjs2836bcf2016-08-16 04:08:16 -0700980 logging.debug('Presubmit files: %s', ','.join(results))
maruel@chromium.orgb1901a62010-06-16 00:18:47 +0000981 return results
maruel@google.comfb2b8eb2009-04-23 21:03:42 +0000982
983
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +0000984class GetTryMastersExecuter(object):
985 @staticmethod
986 def ExecPresubmitScript(script_text, presubmit_path, project, change):
987 """Executes GetPreferredTryMasters() from a single presubmit script.
988
989 Args:
990 script_text: The text of the presubmit script.
991 presubmit_path: Project script to run.
992 project: Project name to pass to presubmit script for bot selection.
993
994 Return:
995 A map of try masters to map of builders to set of tests.
996 """
997 context = {}
998 try:
999 exec script_text in context
1000 except Exception, e:
1001 raise PresubmitFailure('"%s" had an exception.\n%s'
1002 % (presubmit_path, e))
1003
1004 function_name = 'GetPreferredTryMasters'
1005 if function_name not in context:
1006 return {}
1007 get_preferred_try_masters = context[function_name]
1008 if not len(inspect.getargspec(get_preferred_try_masters)[0]) == 2:
1009 raise PresubmitFailure(
1010 'Expected function "GetPreferredTryMasters" to take two arguments.')
1011 return get_preferred_try_masters(project, change)
1012
1013
rmistry@google.com5626a922015-02-26 14:03:30 +00001014class GetPostUploadExecuter(object):
1015 @staticmethod
1016 def ExecPresubmitScript(script_text, presubmit_path, cl, change):
1017 """Executes PostUploadHook() from a single presubmit script.
1018
1019 Args:
1020 script_text: The text of the presubmit script.
1021 presubmit_path: Project script to run.
1022 cl: The Changelist object.
1023 change: The Change object.
1024
1025 Return:
1026 A list of results objects.
1027 """
1028 context = {}
1029 try:
1030 exec script_text in context
1031 except Exception, e:
1032 raise PresubmitFailure('"%s" had an exception.\n%s'
1033 % (presubmit_path, e))
1034
1035 function_name = 'PostUploadHook'
1036 if function_name not in context:
1037 return {}
1038 post_upload_hook = context[function_name]
1039 if not len(inspect.getargspec(post_upload_hook)[0]) == 3:
1040 raise PresubmitFailure(
1041 'Expected function "PostUploadHook" to take three arguments.')
1042 return post_upload_hook(cl, change, OutputApi(False))
1043
1044
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00001045def _MergeMasters(masters1, masters2):
1046 """Merges two master maps. Merges also the tests of each builder."""
1047 result = {}
1048 for (master, builders) in itertools.chain(masters1.iteritems(),
1049 masters2.iteritems()):
1050 new_builders = result.setdefault(master, {})
1051 for (builder, tests) in builders.iteritems():
1052 new_builders.setdefault(builder, set([])).update(tests)
1053 return result
1054
1055
1056def DoGetTryMasters(change,
1057 changed_files,
1058 repository_root,
1059 default_presubmit,
1060 project,
1061 verbose,
1062 output_stream):
1063 """Get the list of try masters from the presubmit scripts.
1064
1065 Args:
1066 changed_files: List of modified files.
1067 repository_root: The repository root.
1068 default_presubmit: A default presubmit script to execute in any case.
1069 project: Optional name of a project used in selecting trybots.
1070 verbose: Prints debug info.
1071 output_stream: A stream to write debug output to.
1072
1073 Return:
1074 Map of try masters to map of builders to set of tests.
1075 """
1076 presubmit_files = ListRelevantPresubmitFiles(changed_files, repository_root)
1077 if not presubmit_files and verbose:
1078 output_stream.write("Warning, no PRESUBMIT.py found.\n")
1079 results = {}
1080 executer = GetTryMastersExecuter()
1081
1082 if default_presubmit:
1083 if verbose:
1084 output_stream.write("Running default presubmit script.\n")
1085 fake_path = os.path.join(repository_root, 'PRESUBMIT.py')
1086 results = _MergeMasters(results, executer.ExecPresubmitScript(
1087 default_presubmit, fake_path, project, change))
1088 for filename in presubmit_files:
1089 filename = os.path.abspath(filename)
1090 if verbose:
1091 output_stream.write("Running %s\n" % filename)
1092 # Accept CRLF presubmit script.
1093 presubmit_script = gclient_utils.FileRead(filename, 'rU')
1094 results = _MergeMasters(results, executer.ExecPresubmitScript(
1095 presubmit_script, filename, project, change))
1096
1097 # Make sets to lists again for later JSON serialization.
1098 for builders in results.itervalues():
1099 for builder in builders:
1100 builders[builder] = list(builders[builder])
1101
1102 if results and verbose:
1103 output_stream.write('%s\n' % str(results))
1104 return results
1105
1106
rmistry@google.com5626a922015-02-26 14:03:30 +00001107def DoPostUploadExecuter(change,
1108 cl,
1109 repository_root,
1110 verbose,
1111 output_stream):
1112 """Execute the post upload hook.
1113
1114 Args:
1115 change: The Change object.
1116 cl: The Changelist object.
1117 repository_root: The repository root.
1118 verbose: Prints debug info.
1119 output_stream: A stream to write debug output to.
1120 """
1121 presubmit_files = ListRelevantPresubmitFiles(
1122 change.LocalPaths(), repository_root)
1123 if not presubmit_files and verbose:
1124 output_stream.write("Warning, no PRESUBMIT.py found.\n")
1125 results = []
1126 executer = GetPostUploadExecuter()
1127 # The root presubmit file should be executed after the ones in subdirectories.
1128 # i.e. the specific post upload hooks should run before the general ones.
1129 # Thus, reverse the order provided by ListRelevantPresubmitFiles.
1130 presubmit_files.reverse()
1131
1132 for filename in presubmit_files:
1133 filename = os.path.abspath(filename)
1134 if verbose:
1135 output_stream.write("Running %s\n" % filename)
1136 # Accept CRLF presubmit script.
1137 presubmit_script = gclient_utils.FileRead(filename, 'rU')
1138 results.extend(executer.ExecPresubmitScript(
1139 presubmit_script, filename, cl, change))
1140 output_stream.write('\n')
1141 if results:
1142 output_stream.write('** Post Upload Hook Messages **\n')
1143 for result in results:
1144 result.handle(output_stream)
1145 output_stream.write('\n')
1146
1147 return results
1148
1149
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001150class PresubmitExecuter(object):
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001151 def __init__(self, change, committing, rietveld_obj, verbose,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001152 gerrit_obj=None, dry_run=None):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001153 """
1154 Args:
maruel@chromium.org4ff922a2009-06-12 20:20:19 +00001155 change: The Change object.
agable92bec4f2016-08-24 09:27:27 -07001156 committing: True if 'git cl land' is running, False if 'git cl upload' is.
maruel@chromium.org239f4112011-06-03 20:08:23 +00001157 rietveld_obj: rietveld.Rietveld client object.
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001158 gerrit_obj: provides basic Gerrit codereview functionality.
1159 dry_run: if true, some Checks will be skipped.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001160 """
maruel@chromium.org4ff922a2009-06-12 20:20:19 +00001161 self.change = change
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001162 self.committing = committing
maruel@chromium.org239f4112011-06-03 20:08:23 +00001163 self.rietveld = rietveld_obj
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001164 self.gerrit = gerrit_obj
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001165 self.verbose = verbose
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001166 self.dry_run = dry_run
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001167
1168 def ExecPresubmitScript(self, script_text, presubmit_path):
1169 """Executes a single presubmit script.
1170
1171 Args:
1172 script_text: The text of the presubmit script.
1173 presubmit_path: The path to the presubmit file (this will be reported via
1174 input_api.PresubmitLocalPath()).
1175
1176 Return:
1177 A list of result objects, empty if no problems.
1178 """
thakis@chromium.orgc6ef53a2014-11-04 00:13:54 +00001179
chase@chromium.org8e416c82009-10-06 04:30:44 +00001180 # Change to the presubmit file's directory to support local imports.
1181 main_path = os.getcwd()
1182 os.chdir(os.path.dirname(presubmit_path))
1183
1184 # Load the presubmit script into context.
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001185 input_api = InputApi(self.change, presubmit_path, self.committing,
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001186 self.rietveld, self.verbose,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001187 gerrit_obj=self.gerrit, dry_run=self.dry_run)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001188 context = {}
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001189 try:
1190 exec script_text in context
1191 except Exception, e:
1192 raise PresubmitFailure('"%s" had an exception.\n%s' % (presubmit_path, e))
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001193
1194 # These function names must change if we make substantial changes to
1195 # the presubmit API that are not backwards compatible.
1196 if self.committing:
1197 function_name = 'CheckChangeOnCommit'
1198 else:
1199 function_name = 'CheckChangeOnUpload'
1200 if function_name in context:
wez@chromium.orga6d011e2013-03-26 17:31:49 +00001201 context['__args'] = (input_api, OutputApi(self.committing))
tobiasjs2836bcf2016-08-16 04:08:16 -07001202 logging.debug('Running %s in %s', function_name, presubmit_path)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001203 result = eval(function_name + '(*__args)', context)
tobiasjs2836bcf2016-08-16 04:08:16 -07001204 logging.debug('Running %s done.', function_name)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001205 if not (isinstance(result, types.TupleType) or
1206 isinstance(result, types.ListType)):
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001207 raise PresubmitFailure(
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001208 'Presubmit functions must return a tuple or list')
1209 for item in result:
1210 if not isinstance(item, OutputApi.PresubmitResult):
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001211 raise PresubmitFailure(
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001212 'All presubmit results must be of types derived from '
1213 'output_api.PresubmitResult')
1214 else:
1215 result = () # no error since the script doesn't care about current event.
1216
scottmg86099d72016-09-01 09:16:51 -07001217 input_api.ShutdownPool()
1218
chase@chromium.org8e416c82009-10-06 04:30:44 +00001219 # Return the process to the original working directory.
1220 os.chdir(main_path)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001221 return result
1222
maruel@chromium.org4ff922a2009-06-12 20:20:19 +00001223def DoPresubmitChecks(change,
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001224 committing,
1225 verbose,
1226 output_stream,
maruel@chromium.org0ff1fab2009-05-22 13:08:15 +00001227 input_stream,
maruel@chromium.orgb0dfd352009-06-10 14:12:54 +00001228 default_presubmit,
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001229 may_prompt,
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001230 rietveld_obj,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001231 gerrit_obj=None,
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001232 dry_run=None):
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001233 """Runs all presubmit checks that apply to the files in the change.
1234
1235 This finds all PRESUBMIT.py files in directories enclosing the files in the
1236 change (up to the repository root) and calls the relevant entrypoint function
1237 depending on whether the change is being committed or uploaded.
1238
1239 Prints errors, warnings and notifications. Prompts the user for warnings
1240 when needed.
1241
1242 Args:
maruel@chromium.org4ff922a2009-06-12 20:20:19 +00001243 change: The Change object.
agable92bec4f2016-08-24 09:27:27 -07001244 committing: True if 'git cl land' is running, False if 'git cl upload' is.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001245 verbose: Prints debug info.
1246 output_stream: A stream to write output from presubmit tests to.
1247 input_stream: A stream to read input from the user.
maruel@chromium.org0ff1fab2009-05-22 13:08:15 +00001248 default_presubmit: A default presubmit script to execute in any case.
Quinten Yearsley516fe7f2016-12-14 11:50:18 -08001249 may_prompt: Enable (y/n) questions on warning or error. If False,
1250 any questions are answered with yes by default.
maruel@chromium.org239f4112011-06-03 20:08:23 +00001251 rietveld_obj: rietveld.Rietveld object.
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001252 gerrit_obj: provides basic Gerrit codereview functionality.
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001253 dry_run: if true, some Checks will be skipped.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001254
maruel@chromium.orgce8e46b2009-06-26 22:31:51 +00001255 Warning:
1256 If may_prompt is true, output_stream SHOULD be sys.stdout and input_stream
1257 SHOULD be sys.stdin.
1258
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001259 Return:
dpranke@chromium.org5ac21012011-03-16 02:58:25 +00001260 A PresubmitOutput object. Use output.should_continue() to figure out
1261 if there were errors or warnings and the caller should abort.
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001262 """
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001263 old_environ = os.environ
1264 try:
1265 # Make sure python subprocesses won't generate .pyc files.
1266 os.environ = os.environ.copy()
1267 os.environ['PYTHONDONTWRITEBYTECODE'] = '1'
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001268
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001269 output = PresubmitOutput(input_stream, output_stream)
1270 if committing:
1271 output.write("Running presubmit commit checks ...\n")
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001272 else:
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001273 output.write("Running presubmit upload checks ...\n")
1274 start_time = time.time()
1275 presubmit_files = ListRelevantPresubmitFiles(
agable0b65e732016-11-22 09:25:46 -08001276 change.AbsoluteLocalPaths(), change.RepositoryRoot())
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001277 if not presubmit_files and verbose:
maruel@chromium.orgfae707b2011-09-15 18:57:58 +00001278 output.write("Warning, no PRESUBMIT.py found.\n")
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001279 results = []
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001280 executer = PresubmitExecuter(change, committing, rietveld_obj, verbose,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001281 gerrit_obj, dry_run)
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001282 if default_presubmit:
1283 if verbose:
1284 output.write("Running default presubmit script.\n")
1285 fake_path = os.path.join(change.RepositoryRoot(), 'PRESUBMIT.py')
1286 results += executer.ExecPresubmitScript(default_presubmit, fake_path)
1287 for filename in presubmit_files:
1288 filename = os.path.abspath(filename)
1289 if verbose:
1290 output.write("Running %s\n" % filename)
1291 # Accept CRLF presubmit script.
1292 presubmit_script = gclient_utils.FileRead(filename, 'rU')
1293 results += executer.ExecPresubmitScript(presubmit_script, filename)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001294
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001295 errors = []
1296 notifications = []
1297 warnings = []
1298 for result in results:
1299 if result.fatal:
1300 errors.append(result)
1301 elif result.should_prompt:
1302 warnings.append(result)
1303 else:
1304 notifications.append(result)
pam@chromium.orged9a0832009-09-09 22:48:55 +00001305
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001306 output.write('\n')
1307 for name, items in (('Messages', notifications),
1308 ('Warnings', warnings),
1309 ('ERRORS', errors)):
1310 if items:
1311 output.write('** Presubmit %s **\n' % name)
1312 for item in items:
1313 item.handle(output)
1314 output.write('\n')
pam@chromium.orged9a0832009-09-09 22:48:55 +00001315
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001316 total_time = time.time() - start_time
1317 if total_time > 1.0:
1318 output.write("Presubmit checks took %.1fs to calculate.\n\n" % total_time)
maruel@chromium.orgce8e46b2009-06-26 22:31:51 +00001319
Quinten Yearsley516fe7f2016-12-14 11:50:18 -08001320 if errors:
1321 output.fail()
1322 elif warnings:
1323 output.write('There were presubmit warnings. ')
1324 if may_prompt:
1325 output.prompt_yes_no('Are you sure you wish to continue? (y/N): ')
1326 else:
1327 output.write('Presubmit checks passed.\n')
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001328
1329 global _ASKED_FOR_FEEDBACK
1330 # Ask for feedback one time out of 5.
1331 if (len(results) and random.randint(0, 4) == 0 and not _ASKED_FOR_FEEDBACK):
maruel@chromium.org1ce8e662014-01-14 15:23:00 +00001332 output.write(
1333 'Was the presubmit check useful? If not, run "git cl presubmit -v"\n'
1334 'to figure out which PRESUBMIT.py was run, then run git blame\n'
1335 'on the file to figure out who to ask for help.\n')
maruel@chromium.orgea7c8552011-04-18 14:12:07 +00001336 _ASKED_FOR_FEEDBACK = True
1337 return output
1338 finally:
1339 os.environ = old_environ
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001340
1341
1342def ScanSubDirs(mask, recursive):
1343 if not recursive:
pgervais@chromium.orge57b09d2014-05-07 00:58:13 +00001344 return [x for x in glob.glob(mask) if x not in ('.svn', '.git')]
Lei Zhang9611c4c2017-04-04 01:41:56 -07001345
1346 results = []
1347 for root, dirs, files in os.walk('.'):
1348 if '.svn' in dirs:
1349 dirs.remove('.svn')
1350 if '.git' in dirs:
1351 dirs.remove('.git')
1352 for name in files:
1353 if fnmatch.fnmatch(name, mask):
1354 results.append(os.path.join(root, name))
1355 return results
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001356
1357
1358def ParseFiles(args, recursive):
tobiasjs2836bcf2016-08-16 04:08:16 -07001359 logging.debug('Searching for %s', args)
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001360 files = []
1361 for arg in args:
maruel@chromium.orge3608df2009-11-10 20:22:57 +00001362 files.extend([('M', f) for f in ScanSubDirs(arg, recursive)])
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001363 return files
1364
1365
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001366def load_files(options, args):
1367 """Tries to determine the SCM."""
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001368 files = []
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001369 if args:
1370 files = ParseFiles(args, options.recursive)
agable0b65e732016-11-22 09:25:46 -08001371 change_scm = scm.determine_scm(options.root)
1372 if change_scm == 'git':
maruel@chromium.org9b31f162012-01-26 19:02:31 +00001373 change_class = GitChange
agable@chromium.org2da1ade2014-04-30 17:40:45 +00001374 upstream = options.upstream or None
maruel@chromium.org9b31f162012-01-26 19:02:31 +00001375 if not files:
agable@chromium.org2da1ade2014-04-30 17:40:45 +00001376 files = scm.GIT.CaptureStatus([], options.root, upstream)
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001377 else:
tobiasjs2836bcf2016-08-16 04:08:16 -07001378 logging.info('Doesn\'t seem under source control. Got %d files', len(args))
maruel@chromium.org9b31f162012-01-26 19:02:31 +00001379 if not files:
1380 return None, None
1381 change_class = Change
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001382 return change_class, files
1383
1384
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +00001385class NonexistantCannedCheckFilter(Exception):
1386 pass
1387
1388
1389@contextlib.contextmanager
1390def canned_check_filter(method_names):
1391 filtered = {}
1392 try:
1393 for method_name in method_names:
1394 if not hasattr(presubmit_canned_checks, method_name):
1395 raise NonexistantCannedCheckFilter(method_name)
1396 filtered[method_name] = getattr(presubmit_canned_checks, method_name)
1397 setattr(presubmit_canned_checks, method_name, lambda *_a, **_kw: [])
1398 yield
1399 finally:
1400 for name, method in filtered.iteritems():
1401 setattr(presubmit_canned_checks, name, method)
1402
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +00001403
ilevy@chromium.orgbc117312013-04-20 03:57:56 +00001404def CallCommand(cmd_data):
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +00001405 """Runs an external program, potentially from a child process created by the
1406 multiprocessing module.
1407
1408 multiprocessing needs a top level function with a single argument.
1409 """
ilevy@chromium.orgbc117312013-04-20 03:57:56 +00001410 cmd_data.kwargs['stdout'] = subprocess.PIPE
1411 cmd_data.kwargs['stderr'] = subprocess.STDOUT
1412 try:
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +00001413 start = time.time()
ilevy@chromium.orgbc117312013-04-20 03:57:56 +00001414 (out, _), code = subprocess.communicate(cmd_data.cmd, **cmd_data.kwargs)
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +00001415 duration = time.time() - start
ilevy@chromium.orgbc117312013-04-20 03:57:56 +00001416 except OSError as e:
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +00001417 duration = time.time() - start
ilevy@chromium.orgbc117312013-04-20 03:57:56 +00001418 return cmd_data.message(
maruel@chromium.orgffeb2f32013-12-03 13:55:22 +00001419 '%s exec failure (%4.2fs)\n %s' % (cmd_data.name, duration, e))
1420 if code != 0:
1421 return cmd_data.message(
1422 '%s (%4.2fs) failed\n%s' % (cmd_data.name, duration, out))
1423 if cmd_data.info:
1424 return cmd_data.info('%s (%4.2fs)' % (cmd_data.name, duration))
ilevy@chromium.orgbc117312013-04-20 03:57:56 +00001425
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +00001426
sbc@chromium.org013731e2015-02-26 18:28:43 +00001427def main(argv=None):
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001428 parser = optparse.OptionParser(usage="%prog [options] <files...>",
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001429 version="%prog " + str(__version__))
maruel@chromium.orgc70a2202009-06-17 12:55:10 +00001430 parser.add_option("-c", "--commit", action="store_true", default=False,
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001431 help="Use commit instead of upload checks")
maruel@chromium.orgc70a2202009-06-17 12:55:10 +00001432 parser.add_option("-u", "--upload", action="store_false", dest='commit',
1433 help="Use upload instead of commit checks")
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001434 parser.add_option("-r", "--recursive", action="store_true",
1435 help="Act recursively")
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001436 parser.add_option("-v", "--verbose", action="count", default=0,
1437 help="Use 2 times for more debug info")
maruel@chromium.org4ff922a2009-06-12 20:20:19 +00001438 parser.add_option("--name", default='no name')
maruel@chromium.org58407af2011-04-12 23:15:57 +00001439 parser.add_option("--author")
maruel@chromium.org4ff922a2009-06-12 20:20:19 +00001440 parser.add_option("--description", default='')
1441 parser.add_option("--issue", type='int', default=0)
1442 parser.add_option("--patchset", type='int', default=0)
maruel@chromium.orgb1901a62010-06-16 00:18:47 +00001443 parser.add_option("--root", default=os.getcwd(),
1444 help="Search for PRESUBMIT.py up to this directory. "
1445 "If inherit-review-settings-ok is present in this "
1446 "directory, parent directories up to the root file "
1447 "system directories will also be searched.")
agable@chromium.org2da1ade2014-04-30 17:40:45 +00001448 parser.add_option("--upstream",
1449 help="Git only: the base ref or upstream branch against "
1450 "which the diff should be computed.")
maruel@chromium.orgc70a2202009-06-17 12:55:10 +00001451 parser.add_option("--default_presubmit")
1452 parser.add_option("--may_prompt", action='store_true', default=False)
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +00001453 parser.add_option("--skip_canned", action='append', default=[],
1454 help="A list of checks to skip which appear in "
1455 "presubmit_canned_checks. Can be provided multiple times "
1456 "to skip multiple canned checks.")
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001457 parser.add_option("--dry_run", action='store_true',
1458 help=optparse.SUPPRESS_HELP)
tandrii@chromium.org015ebae2016-04-25 19:37:22 +00001459 parser.add_option("--gerrit_url", help=optparse.SUPPRESS_HELP)
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001460 parser.add_option("--gerrit_fetch", action='store_true',
1461 help=optparse.SUPPRESS_HELP)
maruel@chromium.org239f4112011-06-03 20:08:23 +00001462 parser.add_option("--rietveld_url", help=optparse.SUPPRESS_HELP)
1463 parser.add_option("--rietveld_email", help=optparse.SUPPRESS_HELP)
iannucci@chromium.org720fd7a2013-04-24 04:13:50 +00001464 parser.add_option("--rietveld_fetch", action='store_true', default=False,
1465 help=optparse.SUPPRESS_HELP)
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001466 # These are for OAuth2 authentication for bots. See also apply_issue.py
1467 parser.add_option("--rietveld_email_file", help=optparse.SUPPRESS_HELP)
1468 parser.add_option("--rietveld_private_key_file", help=optparse.SUPPRESS_HELP)
1469
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001470 auth.add_auth_options(parser)
maruel@chromium.org82e5f282011-03-17 14:08:55 +00001471 options, args = parser.parse_args(argv)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001472 auth_config = auth.extract_auth_config_from_options(options)
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001473
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001474 if options.verbose >= 2:
maruel@chromium.org7444c502011-02-09 14:02:11 +00001475 logging.basicConfig(level=logging.DEBUG)
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001476 elif options.verbose:
1477 logging.basicConfig(level=logging.INFO)
1478 else:
1479 logging.basicConfig(level=logging.ERROR)
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001480
tandrii@chromium.org015ebae2016-04-25 19:37:22 +00001481 if (any((options.rietveld_url, options.rietveld_email_file,
1482 options.rietveld_fetch, options.rietveld_private_key_file))
1483 and any((options.gerrit_url, options.gerrit_fetch))):
1484 parser.error('Options for only codereview --rietveld_* or --gerrit_* '
1485 'allowed')
1486
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001487 if options.rietveld_email and options.rietveld_email_file:
1488 parser.error("Only one of --rietveld_email or --rietveld_email_file "
1489 "can be passed to this program.")
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001490 if options.rietveld_email_file:
1491 with open(options.rietveld_email_file, "rb") as f:
1492 options.rietveld_email = f.read().strip()
1493
maruel@chromium.org5c8c6de2011-03-18 16:20:18 +00001494 change_class, files = load_files(options, args)
1495 if not change_class:
1496 parser.error('For unversioned directory, <files> is not optional.')
tobiasjs2836bcf2016-08-16 04:08:16 -07001497 logging.info('Found %d file(s).', len(files))
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001498
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001499 rietveld_obj, gerrit_obj = None, None
1500
maruel@chromium.org239f4112011-06-03 20:08:23 +00001501 if options.rietveld_url:
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001502 # The empty password is permitted: '' is not None.
djacques@chromium.org7b654f52014-04-15 04:02:32 +00001503 if options.rietveld_private_key_file:
pgervais@chromium.org92c30092014-04-15 00:30:37 +00001504 rietveld_obj = rietveld.JwtOAuth2Rietveld(
1505 options.rietveld_url,
1506 options.rietveld_email,
1507 options.rietveld_private_key_file)
1508 else:
djacques@chromium.org7b654f52014-04-15 04:02:32 +00001509 rietveld_obj = rietveld.CachingRietveld(
1510 options.rietveld_url,
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001511 auth_config,
1512 options.rietveld_email)
iannucci@chromium.org720fd7a2013-04-24 04:13:50 +00001513 if options.rietveld_fetch:
1514 assert options.issue
1515 props = rietveld_obj.get_issue_properties(options.issue, False)
1516 options.author = props['owner_email']
1517 options.description = props['description']
1518 logging.info('Got author: "%s"', options.author)
1519 logging.info('Got description: """\n%s\n"""', options.description)
tandrii@chromium.org015ebae2016-04-25 19:37:22 +00001520
1521 if options.gerrit_url and options.gerrit_fetch:
tandrii@chromium.org83b1b232016-04-29 16:33:19 +00001522 assert options.issue and options.patchset
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001523 rietveld_obj = None
1524 gerrit_obj = GerritAccessor(urlparse.urlparse(options.gerrit_url).netloc)
1525 options.author = gerrit_obj.GetChangeOwner(options.issue)
1526 options.description = gerrit_obj.GetChangeDescription(options.issue,
1527 options.patchset)
tandrii@chromium.org015ebae2016-04-25 19:37:22 +00001528 logging.info('Got author: "%s"', options.author)
1529 logging.info('Got description: """\n%s\n"""', options.description)
1530
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001531 try:
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +00001532 with canned_check_filter(options.skip_canned):
1533 results = DoPresubmitChecks(
1534 change_class(options.name,
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001535 options.description,
1536 options.root,
1537 files,
1538 options.issue,
1539 options.patchset,
1540 options.author,
1541 upstream=options.upstream),
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +00001542 options.commit,
1543 options.verbose,
1544 sys.stdout,
1545 sys.stdin,
1546 options.default_presubmit,
1547 options.may_prompt,
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001548 rietveld_obj,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001549 gerrit_obj,
tandrii@chromium.org57bafac2016-04-28 05:09:03 +00001550 options.dry_run)
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001551 return not results.should_continue()
iannucci@chromium.org8a4a2bc2013-03-08 08:13:20 +00001552 except NonexistantCannedCheckFilter, e:
1553 print >> sys.stderr, (
1554 'Attempted to skip nonexistent canned presubmit check: %s' % e.message)
1555 return 2
maruel@chromium.org899e1c12011-04-07 17:03:18 +00001556 except PresubmitFailure, e:
1557 print >> sys.stderr, e
1558 print >> sys.stderr, 'Maybe your depot_tools is out of date?'
1559 print >> sys.stderr, 'If all fails, contact maruel@'
1560 return 2
maruel@google.comfb2b8eb2009-04-23 21:03:42 +00001561
1562
1563if __name__ == '__main__':
maruel@chromium.org35625c72011-03-23 17:34:02 +00001564 fix_encoding.fix_encoding()
sbc@chromium.org013731e2015-02-26 18:28:43 +00001565 try:
1566 sys.exit(main())
1567 except KeyboardInterrupt:
1568 sys.stderr.write('interrupted\n')
sergiybf8a3b382016-07-05 11:21:30 -07001569 sys.exit(2)