blob: eff98e319fddaaae433dabf64b2a3f80bc72373f [file] [log] [blame]
szager@chromium.orgb4696232013-10-16 19:45:35 +00001# Copyright (c) 2013 The Chromium OS 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"""
6Utilities for requesting information for a gerrit server via https.
7
8https://gerrit-review.googlesource.com/Documentation/rest-api.html
9"""
10
11import base64
Dan Jacques8d11e482016-11-15 14:25:56 -080012import contextlib
phajdan.jr@chromium.orgff7840a2015-11-04 16:35:22 +000013import cookielib
szager@chromium.orgb4696232013-10-16 19:45:35 +000014import httplib
15import json
16import logging
17import netrc
18import os
nodir@chromium.orgce32b6e2014-05-12 20:31:32 +000019import re
Dan Jacques8d11e482016-11-15 14:25:56 -080020import shutil
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +000021import socket
szager@chromium.orgf202a252014-05-27 18:55:52 +000022import stat
23import sys
Dan Jacques8d11e482016-11-15 14:25:56 -080024import tempfile
szager@chromium.orgb4696232013-10-16 19:45:35 +000025import time
26import urllib
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +000027import urlparse
szager@chromium.orgb4696232013-10-16 19:45:35 +000028from cStringIO import StringIO
29
Dan Jacques8d11e482016-11-15 14:25:56 -080030import gclient_utils
szager@chromium.orgf202a252014-05-27 18:55:52 +000031
szager@chromium.orgb4696232013-10-16 19:45:35 +000032LOGGER = logging.getLogger()
33TRY_LIMIT = 5
34
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +000035
szager@chromium.orgb4696232013-10-16 19:45:35 +000036# Controls the transport protocol used to communicate with gerrit.
37# This is parameterized primarily to enable GerritTestCase.
38GERRIT_PROTOCOL = 'https'
39
40
Dan Jacques1d949fd2016-11-15 10:41:48 -080041
szager@chromium.orgb4696232013-10-16 19:45:35 +000042class GerritError(Exception):
43 """Exception class for errors commuicating with the gerrit-on-borg service."""
44 def __init__(self, http_status, *args, **kwargs):
45 super(GerritError, self).__init__(*args, **kwargs)
46 self.http_status = http_status
47 self.message = '(%d) %s' % (self.http_status, self.message)
48
49
nodir@chromium.orgce32b6e2014-05-12 20:31:32 +000050class GerritAuthenticationError(GerritError):
51 """Exception class for authentication errors during Gerrit communication."""
52
53
szager@chromium.orgb4696232013-10-16 19:45:35 +000054def _QueryString(param_dict, first_param=None):
55 """Encodes query parameters in the key:val[+key:val...] format specified here:
56
57 https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#list-changes
58 """
59 q = [urllib.quote(first_param)] if first_param else []
60 q.extend(['%s:%s' % (key, val) for key, val in param_dict.iteritems()])
61 return '+'.join(q)
62
63
64def GetConnectionClass(protocol=None):
65 if protocol is None:
66 protocol = GERRIT_PROTOCOL
67 if protocol == 'https':
68 return httplib.HTTPSConnection
69 elif protocol == 'http':
70 return httplib.HTTPConnection
71 else:
72 raise RuntimeError(
73 "Don't know how to work with protocol '%s'" % protocol)
74
75
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +000076class Authenticator(object):
77 """Base authenticator class for authenticator implementations to subclass."""
78
79 def get_auth_header(self, host):
80 raise NotImplementedError()
81
82 @staticmethod
83 def get():
84 """Returns: (Authenticator) The identified Authenticator to use.
85
86 Probes the local system and its environment and identifies the
87 Authenticator instance to use.
88 """
89 if GceAuthenticator.is_gce():
90 return GceAuthenticator()
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +000091 return CookiesAuthenticator()
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +000092
93
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +000094class CookiesAuthenticator(Authenticator):
95 """Authenticator implementation that uses ".netrc" or ".gitcookies" for token.
96
97 Expected case for developer workstations.
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +000098 """
99
100 def __init__(self):
101 self.netrc = self._get_netrc()
phajdan.jr@chromium.orgff7840a2015-11-04 16:35:22 +0000102 self.gitcookies = self._get_gitcookies()
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000103
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000104 @classmethod
105 def get_new_password_message(cls, host):
106 assert not host.startswith('http')
107 # Assume *.googlesource.com pattern.
108 parts = host.split('.')
109 if not parts[0].endswith('-review'):
110 parts[0] += '-review'
111 url = 'https://%s/new-password' % ('.'.join(parts))
112 return 'You can (re)generate your credentails by visiting %s' % url
113
114 @classmethod
115 def get_netrc_path(cls):
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000116 path = '_netrc' if sys.platform.startswith('win') else '.netrc'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000117 return os.path.expanduser(os.path.join('~', path))
118
119 @classmethod
120 def _get_netrc(cls):
Dan Jacques8d11e482016-11-15 14:25:56 -0800121 # Buffer the '.netrc' path. Use an empty file if it doesn't exist.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000122 path = cls.get_netrc_path()
Dan Jacques8d11e482016-11-15 14:25:56 -0800123 content = ''
124 if os.path.exists(path):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000125 st = os.stat(path)
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000126 if st.st_mode & (stat.S_IRWXG | stat.S_IRWXO):
127 print >> sys.stderr, (
128 'WARNING: netrc file %s cannot be used because its file '
129 'permissions are insecure. netrc file permissions should be '
130 '600.' % path)
Dan Jacques8d11e482016-11-15 14:25:56 -0800131 with open(path) as fd:
132 content = fd.read()
133
134 # Load the '.netrc' file. We strip comments from it because processing them
135 # can trigger a bug in Windows. See crbug.com/664664.
136 content = '\n'.join(l for l in content.splitlines()
137 if l.strip() and not l.strip().startswith('#'))
138 with tempdir() as tdir:
139 netrc_path = os.path.join(tdir, 'netrc')
140 with open(netrc_path, 'w') as fd:
141 fd.write(content)
142 os.chmod(netrc_path, (stat.S_IRUSR | stat.S_IWUSR))
143 return cls._get_netrc_from_path(netrc_path)
144
145 @classmethod
146 def _get_netrc_from_path(cls, path):
147 try:
148 return netrc.netrc(path)
149 except IOError:
150 print >> sys.stderr, 'WARNING: Could not read netrc file %s' % path
151 return netrc.netrc(os.devnull)
152 except netrc.NetrcParseError as e:
153 print >> sys.stderr, ('ERROR: Cannot use netrc file %s due to a '
154 'parsing error: %s' % (path, e))
155 return netrc.netrc(os.devnull)
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000156
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000157 @classmethod
158 def get_gitcookies_path(cls):
159 return os.path.join(os.environ['HOME'], '.gitcookies')
160
161 @classmethod
162 def _get_gitcookies(cls):
phajdan.jr@chromium.orgff7840a2015-11-04 16:35:22 +0000163 gitcookies = {}
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000164 path = cls.get_gitcookies_path()
165 if not os.path.exists(path):
166 return gitcookies
167
phajdan.jr@chromium.orgff7840a2015-11-04 16:35:22 +0000168 try:
169 f = open(path, 'rb')
170 except IOError:
171 return gitcookies
172
173 with f:
174 for line in f:
175 try:
176 fields = line.strip().split('\t')
177 if line.strip().startswith('#') or len(fields) != 7:
178 continue
179 domain, xpath, key, value = fields[0], fields[2], fields[5], fields[6]
180 if xpath == '/' and key == 'o':
181 login, secret_token = value.split('=', 1)
182 gitcookies[domain] = (login, secret_token)
183 except (IndexError, ValueError, TypeError) as exc:
184 logging.warning(exc)
185
186 return gitcookies
187
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000188 def get_auth_header(self, host):
phajdan.jr@chromium.orgff7840a2015-11-04 16:35:22 +0000189 auth = None
190 for domain, creds in self.gitcookies.iteritems():
191 if cookielib.domain_match(host, domain):
192 auth = (creds[0], None, creds[1])
193 break
194
195 if not auth:
196 auth = self.netrc.authenticators(host)
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000197 if auth:
198 return 'Basic %s' % (base64.b64encode('%s:%s' % (auth[0], auth[2])))
199 return None
200
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +0000201# Backwards compatibility just in case somebody imports this outside of
202# depot_tools.
203NetrcAuthenticator = CookiesAuthenticator
204
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000205
206class GceAuthenticator(Authenticator):
207 """Authenticator implementation that uses GCE metadata service for token.
208 """
209
210 _INFO_URL = 'http://metadata.google.internal'
211 _ACQUIRE_URL = ('http://metadata/computeMetadata/v1/instance/'
212 'service-accounts/default/token')
213 _ACQUIRE_HEADERS = {"Metadata-Flavor": "Google"}
214
215 _cache_is_gce = None
216 _token_cache = None
217 _token_expiration = None
218
219 @classmethod
220 def is_gce(cls):
221 if cls._cache_is_gce is None:
222 cls._cache_is_gce = cls._test_is_gce()
223 return cls._cache_is_gce
224
225 @classmethod
226 def _test_is_gce(cls):
227 # Based on https://cloud.google.com/compute/docs/metadata#runninggce
228 try:
229 resp = cls._get(cls._INFO_URL)
230 except socket.error:
231 # Could not resolve URL.
232 return False
233 return resp.getheader('Metadata-Flavor', None) == 'Google'
234
235 @staticmethod
236 def _get(url, **kwargs):
237 next_delay_sec = 1
238 for i in xrange(TRY_LIMIT):
239 if i > 0:
240 # Retry server error status codes.
241 LOGGER.info('Encountered server error; retrying after %d second(s).',
242 next_delay_sec)
243 time.sleep(next_delay_sec)
244 next_delay_sec *= 2
245
246 p = urlparse.urlparse(url)
247 c = GetConnectionClass(protocol=p.scheme)(p.netloc)
248 c.request('GET', url, **kwargs)
249 resp = c.getresponse()
250 LOGGER.debug('GET [%s] #%d/%d (%d)', url, i+1, TRY_LIMIT, resp.status)
251 if resp.status < httplib.INTERNAL_SERVER_ERROR:
252 return resp
253
254
255 @classmethod
256 def _get_token_dict(cls):
257 if cls._token_cache:
258 # If it expires within 25 seconds, refresh.
259 if cls._token_expiration < time.time() - 25:
260 return cls._token_cache
261
262 resp = cls._get(cls._ACQUIRE_URL, headers=cls._ACQUIRE_HEADERS)
263 if resp.status != httplib.OK:
264 return None
265 cls._token_cache = json.load(resp)
266 cls._token_expiration = cls._token_cache['expires_in'] + time.time()
267 return cls._token_cache
268
269 def get_auth_header(self, _host):
270 token_dict = self._get_token_dict()
271 if not token_dict:
272 return None
273 return '%(token_type)s %(access_token)s' % token_dict
274
275
276
szager@chromium.orgb4696232013-10-16 19:45:35 +0000277def CreateHttpConn(host, path, reqtype='GET', headers=None, body=None):
278 """Opens an https connection to a gerrit service, and sends a request."""
279 headers = headers or {}
280 bare_host = host.partition(':')[0]
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000281
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000282 auth = Authenticator.get().get_auth_header(bare_host)
szager@chromium.orgb4696232013-10-16 19:45:35 +0000283 if auth:
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000284 headers.setdefault('Authorization', auth)
szager@chromium.orgb4696232013-10-16 19:45:35 +0000285 else:
dnj@chromium.orga5a2c8a2015-09-29 16:22:55 +0000286 LOGGER.debug('No authorization found for %s.' % bare_host)
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000287
Dan Jacques6d5bcc22016-11-14 15:32:04 -0800288 url = path
289 if not url.startswith('/'):
290 url = '/' + url
291 if 'Authorization' in headers and not url.startswith('/a/'):
292 url = '/a%s' % url
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000293
szager@chromium.orgb4696232013-10-16 19:45:35 +0000294 if body:
295 body = json.JSONEncoder().encode(body)
296 headers.setdefault('Content-Type', 'application/json')
297 if LOGGER.isEnabledFor(logging.DEBUG):
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000298 LOGGER.debug('%s %s://%s%s' % (reqtype, GERRIT_PROTOCOL, host, url))
szager@chromium.orgb4696232013-10-16 19:45:35 +0000299 for key, val in headers.iteritems():
300 if key == 'Authorization':
301 val = 'HIDDEN'
302 LOGGER.debug('%s: %s' % (key, val))
303 if body:
304 LOGGER.debug(body)
305 conn = GetConnectionClass()(host)
306 conn.req_host = host
307 conn.req_params = {
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000308 'url': url,
szager@chromium.orgb4696232013-10-16 19:45:35 +0000309 'method': reqtype,
310 'headers': headers,
311 'body': body,
312 }
313 conn.request(**conn.req_params)
314 return conn
315
316
317def ReadHttpResponse(conn, expect_status=200, ignore_404=True):
318 """Reads an http response from a connection into a string buffer.
319
320 Args:
321 conn: An HTTPSConnection or HTTPConnection created by CreateHttpConn, above.
322 expect_status: Success is indicated by this status in the response.
323 ignore_404: For many requests, gerrit-on-borg will return 404 if the request
324 doesn't match the database contents. In most such cases, we
325 want the API to return None rather than raise an Exception.
326 Returns: A string buffer containing the connection's reply.
327 """
328
329 sleep_time = 0.5
330 for idx in range(TRY_LIMIT):
331 response = conn.getresponse()
nodir@chromium.orgce32b6e2014-05-12 20:31:32 +0000332
333 # Check if this is an authentication issue.
334 www_authenticate = response.getheader('www-authenticate')
335 if (response.status in (httplib.UNAUTHORIZED, httplib.FOUND) and
336 www_authenticate):
337 auth_match = re.search('realm="([^"]+)"', www_authenticate, re.I)
338 host = auth_match.group(1) if auth_match else conn.req_host
339 reason = ('Authentication failed. Please make sure your .netrc file '
340 'has credentials for %s' % host)
341 raise GerritAuthenticationError(response.status, reason)
342
szager@chromium.orgb4696232013-10-16 19:45:35 +0000343 # If response.status < 500 then the result is final; break retry loop.
344 if response.status < 500:
345 break
346 # A status >=500 is assumed to be a possible transient error; retry.
347 http_version = 'HTTP/%s' % ('1.1' if response.version == 11 else '1.0')
348 msg = (
qyearsley12fa6ff2016-08-24 09:18:40 -0700349 'A transient error occurred while querying %s:\n'
szager@chromium.orgb4696232013-10-16 19:45:35 +0000350 '%s %s %s\n'
351 '%s %d %s' % (
352 conn.host, conn.req_params['method'], conn.req_params['url'],
353 http_version, http_version, response.status, response.reason))
354 if TRY_LIMIT - idx > 1:
355 msg += '\n... will retry %d more times.' % (TRY_LIMIT - idx - 1)
356 time.sleep(sleep_time)
357 sleep_time = sleep_time * 2
358 req_host = conn.req_host
359 req_params = conn.req_params
360 conn = GetConnectionClass()(req_host)
361 conn.req_host = req_host
362 conn.req_params = req_params
363 conn.request(**req_params)
364 LOGGER.warn(msg)
365 if ignore_404 and response.status == 404:
366 return StringIO()
367 if response.status != expect_status:
nodir@chromium.orga7798032014-04-30 23:40:53 +0000368 reason = '%s: %s' % (response.reason, response.read())
369 raise GerritError(response.status, reason)
szager@chromium.orgb4696232013-10-16 19:45:35 +0000370 return StringIO(response.read())
371
372
373def ReadHttpJsonResponse(conn, expect_status=200, ignore_404=True):
374 """Parses an https response as json."""
375 fh = ReadHttpResponse(
376 conn, expect_status=expect_status, ignore_404=ignore_404)
377 # The first line of the response should always be: )]}'
378 s = fh.readline()
379 if s and s.rstrip() != ")]}'":
380 raise GerritError(200, 'Unexpected json output: %s' % s)
381 s = fh.read()
382 if not s:
383 return None
384 return json.loads(s)
385
386
387def QueryChanges(host, param_dict, first_param=None, limit=None, o_params=None,
388 sortkey=None):
389 """
390 Queries a gerrit-on-borg server for changes matching query terms.
391
392 Args:
393 param_dict: A dictionary of search parameters, as documented here:
394 http://gerrit-documentation.googlecode.com/svn/Documentation/2.6/user-search.html
395 first_param: A change identifier
396 limit: Maximum number of results to return.
397 o_params: A list of additional output specifiers, as documented here:
398 https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#list-changes
399 Returns:
400 A list of json-decoded query results.
401 """
402 # Note that no attempt is made to escape special characters; YMMV.
403 if not param_dict and not first_param:
404 raise RuntimeError('QueryChanges requires search parameters')
405 path = 'changes/?q=%s' % _QueryString(param_dict, first_param)
406 if sortkey:
407 path = '%s&N=%s' % (path, sortkey)
408 if limit:
409 path = '%s&n=%d' % (path, limit)
410 if o_params:
411 path = '%s&%s' % (path, '&'.join(['o=%s' % p for p in o_params]))
412 # Don't ignore 404; a query should always return a list, even if it's empty.
413 return ReadHttpJsonResponse(CreateHttpConn(host, path), ignore_404=False)
414
415
deymo@chromium.orgf8be2762013-11-06 01:01:59 +0000416def GenerateAllChanges(host, param_dict, first_param=None, limit=500,
417 o_params=None, sortkey=None):
418 """
419 Queries a gerrit-on-borg server for all the changes matching the query terms.
420
421 A single query to gerrit-on-borg is limited on the number of results by the
422 limit parameter on the request (see QueryChanges) and the server maximum
423 limit. This function uses the "_more_changes" and "_sortkey" attributes on
424 the returned changes to iterate all of them making multiple queries to the
425 server, regardless the query limit.
426
427 Args:
428 param_dict, first_param: Refer to QueryChanges().
429 limit: Maximum number of requested changes per query.
430 o_params: Refer to QueryChanges().
431 sortkey: The value of the "_sortkey" attribute where starts from. None to
432 start from the first change.
433
434 Returns:
435 A generator object to the list of returned changes, possibly unbound.
436 """
437 more_changes = True
438 while more_changes:
439 page = QueryChanges(host, param_dict, first_param, limit, o_params, sortkey)
440 for cl in page:
441 yield cl
442
443 more_changes = [cl for cl in page if '_more_changes' in cl]
444 if len(more_changes) > 1:
445 raise GerritError(
446 200,
447 'Received %d changes with a _more_changes attribute set but should '
448 'receive at most one.' % len(more_changes))
449 if more_changes:
450 sortkey = more_changes[0]['_sortkey']
451
452
szager@chromium.orgb4696232013-10-16 19:45:35 +0000453def MultiQueryChanges(host, param_dict, change_list, limit=None, o_params=None,
454 sortkey=None):
455 """Initiate a query composed of multiple sets of query parameters."""
456 if not change_list:
457 raise RuntimeError(
458 "MultiQueryChanges requires a list of change numbers/id's")
459 q = ['q=%s' % '+OR+'.join([urllib.quote(str(x)) for x in change_list])]
460 if param_dict:
461 q.append(_QueryString(param_dict))
462 if limit:
463 q.append('n=%d' % limit)
464 if sortkey:
465 q.append('N=%s' % sortkey)
466 if o_params:
467 q.extend(['o=%s' % p for p in o_params])
468 path = 'changes/?%s' % '&'.join(q)
469 try:
470 result = ReadHttpJsonResponse(CreateHttpConn(host, path), ignore_404=False)
471 except GerritError as e:
472 msg = '%s:\n%s' % (e.message, path)
473 raise GerritError(e.http_status, msg)
474 return result
475
476
477def GetGerritFetchUrl(host):
478 """Given a gerrit host name returns URL of a gerrit instance to fetch from."""
479 return '%s://%s/' % (GERRIT_PROTOCOL, host)
480
481
482def GetChangePageUrl(host, change_number):
483 """Given a gerrit host name and change number, return change page url."""
484 return '%s://%s/#/c/%d/' % (GERRIT_PROTOCOL, host, change_number)
485
486
487def GetChangeUrl(host, change):
488 """Given a gerrit host name and change id, return an url for the change."""
489 return '%s://%s/a/changes/%s' % (GERRIT_PROTOCOL, host, change)
490
491
492def GetChange(host, change):
493 """Query a gerrit server for information about a single change."""
494 path = 'changes/%s' % change
495 return ReadHttpJsonResponse(CreateHttpConn(host, path))
496
497
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +0100498def GetChangeDetail(host, change, o_params=None, ignore_404=True):
szager@chromium.orgb4696232013-10-16 19:45:35 +0000499 """Query a gerrit server for extended information about a single change."""
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +0100500 # TODO(tandrii): cahnge ignore_404 to False by default.
szager@chromium.orgb4696232013-10-16 19:45:35 +0000501 path = 'changes/%s/detail' % change
502 if o_params:
503 path += '?%s' % '&'.join(['o=%s' % p for p in o_params])
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +0100504 return ReadHttpJsonResponse(CreateHttpConn(host, path), ignore_404=ignore_404)
szager@chromium.orgb4696232013-10-16 19:45:35 +0000505
506
agable32978d92016-11-01 12:55:02 -0700507def GetChangeCommit(host, change, revision='current'):
508 """Query a gerrit server for a revision associated with a change."""
509 path = 'changes/%s/revisions/%s/commit?links' % (change, revision)
510 return ReadHttpJsonResponse(CreateHttpConn(host, path))
511
512
tandrii@chromium.org2d3da632016-04-25 19:23:27 +0000513def GetChangeDescriptionFromGitiles(url, revision):
514 """Query Gitiles for actual commit message for a given url and ref.
515
516 url must be obtained from call to GetChangeDetail for a specific
517 revision (patchset) under 'fetch' key.
518 """
519 parsed = urlparse.urlparse(url)
520 path = '%s/+/%s?format=json' % (parsed.path, revision)
tandrii@chromium.orgc767e3f2016-04-26 14:28:49 +0000521 # Note: Gerrit instances that Chrome infrastructure uses thus far have all
522 # enabled Gitiles, which allowes us to execute this call. This isn't true for
523 # all Gerrit instances out there. Thus, if line below fails, consider adding a
524 # fallback onto actually fetching ref from remote using pure git.
tandrii@chromium.org2d3da632016-04-25 19:23:27 +0000525 return ReadHttpJsonResponse(CreateHttpConn(parsed.netloc, path))['message']
526
527
szager@chromium.orgb4696232013-10-16 19:45:35 +0000528def GetChangeCurrentRevision(host, change):
529 """Get information about the latest revision for a given change."""
530 return QueryChanges(host, {}, change, o_params=('CURRENT_REVISION',))
531
532
533def GetChangeRevisions(host, change):
534 """Get information about all revisions associated with a change."""
535 return QueryChanges(host, {}, change, o_params=('ALL_REVISIONS',))
536
537
538def GetChangeReview(host, change, revision=None):
539 """Get the current review information for a change."""
540 if not revision:
541 jmsg = GetChangeRevisions(host, change)
542 if not jmsg:
543 return None
544 elif len(jmsg) > 1:
545 raise GerritError(200, 'Multiple changes found for ChangeId %s.' % change)
546 revision = jmsg[0]['current_revision']
547 path = 'changes/%s/revisions/%s/review'
548 return ReadHttpJsonResponse(CreateHttpConn(host, path))
549
550
551def AbandonChange(host, change, msg=''):
552 """Abandon a gerrit change."""
553 path = 'changes/%s/abandon' % change
tandrii@chromium.orgc7da66a2016-03-24 09:52:24 +0000554 body = {'message': msg} if msg else {}
szager@chromium.orgb4696232013-10-16 19:45:35 +0000555 conn = CreateHttpConn(host, path, reqtype='POST', body=body)
556 return ReadHttpJsonResponse(conn, ignore_404=False)
557
558
559def RestoreChange(host, change, msg=''):
560 """Restore a previously abandoned change."""
561 path = 'changes/%s/restore' % change
tandrii@chromium.orgc7da66a2016-03-24 09:52:24 +0000562 body = {'message': msg} if msg else {}
szager@chromium.orgb4696232013-10-16 19:45:35 +0000563 conn = CreateHttpConn(host, path, reqtype='POST', body=body)
564 return ReadHttpJsonResponse(conn, ignore_404=False)
565
566
567def SubmitChange(host, change, wait_for_merge=True):
568 """Submits a gerrit change via Gerrit."""
569 path = 'changes/%s/submit' % change
570 body = {'wait_for_merge': wait_for_merge}
571 conn = CreateHttpConn(host, path, reqtype='POST', body=body)
572 return ReadHttpJsonResponse(conn, ignore_404=False)
573
574
dsansomee2d6fd92016-09-08 00:10:47 -0700575def HasPendingChangeEdit(host, change):
576 conn = CreateHttpConn(host, 'changes/%s/edit' % change)
577 try:
578 ReadHttpResponse(conn, ignore_404=False)
579 except GerritError as e:
580 # On success, gerrit returns status 204; anything else is an error.
581 if e.http_status != 204:
582 raise
583 return False
584 else:
585 return True
586
587
588def DeletePendingChangeEdit(host, change):
589 conn = CreateHttpConn(host, 'changes/%s/edit' % change, reqtype='DELETE')
590 try:
591 ReadHttpResponse(conn, ignore_404=False)
592 except GerritError as e:
593 # On success, gerrit returns status 204; if the edit was already deleted it
594 # returns 404. Anything else is an error.
595 if e.http_status not in (204, 404):
596 raise
597
598
scottmg@chromium.org6d1266e2016-04-26 11:12:26 +0000599def SetCommitMessage(host, change, description):
600 """Updates a commit message."""
601 # First, edit the commit message in a draft.
602 path = 'changes/%s/edit:message' % change
603 body = {'message': description}
604 conn = CreateHttpConn(host, path, reqtype='PUT', body=body)
605 try:
606 ReadHttpResponse(conn, ignore_404=False)
607 except GerritError as e:
608 # On success, gerrit returns status 204; anything else is an error.
609 if e.http_status != 204:
610 raise
611 else:
612 raise GerritError(
613 'Unexpectedly received a 200 http status while editing message in '
614 'change %s' % change)
615
616 # And then publish it.
617 path = 'changes/%s/edit:publish' % change
618 conn = CreateHttpConn(host, path, reqtype='POST', body={})
619 try:
620 ReadHttpResponse(conn, ignore_404=False)
621 except GerritError as e:
622 # On success, gerrit returns status 204; anything else is an error.
623 if e.http_status != 204:
624 raise
625 else:
626 raise GerritError(
627 'Unexpectedly received a 200 http status while publishing message '
628 'change in %s' % change)
629
630
szager@chromium.orgb4696232013-10-16 19:45:35 +0000631def GetReviewers(host, change):
632 """Get information about all reviewers attached to a change."""
633 path = 'changes/%s/reviewers' % change
634 return ReadHttpJsonResponse(CreateHttpConn(host, path))
635
636
637def GetReview(host, change, revision):
638 """Get review information about a specific revision of a change."""
639 path = 'changes/%s/revisions/%s/review' % (change, revision)
640 return ReadHttpJsonResponse(CreateHttpConn(host, path))
641
642
tandrii88189772016-09-29 04:29:57 -0700643def AddReviewers(host, change, add=None, is_reviewer=True):
szager@chromium.orgb4696232013-10-16 19:45:35 +0000644 """Add reviewers to a change."""
Aaron Gabledf86e302016-11-08 10:48:03 -0800645 errors = None
szager@chromium.orgb4696232013-10-16 19:45:35 +0000646 if not add:
Aaron Gabledf86e302016-11-08 10:48:03 -0800647 return None
szager@chromium.orgb4696232013-10-16 19:45:35 +0000648 if isinstance(add, basestring):
649 add = (add,)
650 path = 'changes/%s/reviewers' % change
651 for r in add:
Aaron Gabledf86e302016-11-08 10:48:03 -0800652 state = 'REVIEWER' if is_reviewer else 'CC'
tandrii88189772016-09-29 04:29:57 -0700653 body = {
654 'reviewer': r,
Aaron Gabledf86e302016-11-08 10:48:03 -0800655 'state': state,
tandrii88189772016-09-29 04:29:57 -0700656 }
Aaron Gabledf86e302016-11-08 10:48:03 -0800657 try:
658 conn = CreateHttpConn(host, path, reqtype='POST', body=body)
659 _ = ReadHttpJsonResponse(conn, ignore_404=False)
660 except GerritError as e:
661 if e.http_status == 422: # "Unprocessable Entity"
662 LOGGER.warn('Failed to add "%s" as a %s' % (r, state.lower()))
663 errors = True
664 else:
665 raise
666 return errors
szager@chromium.orgb4696232013-10-16 19:45:35 +0000667
668
669def RemoveReviewers(host, change, remove=None):
670 """Remove reveiewers from a change."""
671 if not remove:
672 return
673 if isinstance(remove, basestring):
674 remove = (remove,)
675 for r in remove:
676 path = 'changes/%s/reviewers/%s' % (change, r)
677 conn = CreateHttpConn(host, path, reqtype='DELETE')
678 try:
679 ReadHttpResponse(conn, ignore_404=False)
680 except GerritError as e:
681 # On success, gerrit returns status 204; anything else is an error.
682 if e.http_status != 204:
683 raise
684 else:
685 raise GerritError(
686 'Unexpectedly received a 200 http status while deleting reviewer "%s"'
687 ' from change %s' % (r, change))
688
689
690def SetReview(host, change, msg=None, labels=None, notify=None):
691 """Set labels and/or add a message to a code review."""
692 if not msg and not labels:
693 return
694 path = 'changes/%s/revisions/current/review' % change
695 body = {}
696 if msg:
697 body['message'] = msg
698 if labels:
699 body['labels'] = labels
700 if notify:
701 body['notify'] = notify
702 conn = CreateHttpConn(host, path, reqtype='POST', body=body)
703 response = ReadHttpJsonResponse(conn)
704 if labels:
705 for key, val in labels.iteritems():
706 if ('labels' not in response or key not in response['labels'] or
707 int(response['labels'][key] != int(val))):
708 raise GerritError(200, 'Unable to set "%s" label on change %s.' % (
709 key, change))
710
711
712def ResetReviewLabels(host, change, label, value='0', message=None,
713 notify=None):
714 """Reset the value of a given label for all reviewers on a change."""
715 # This is tricky, because we want to work on the "current revision", but
716 # there's always the risk that "current revision" will change in between
717 # API calls. So, we check "current revision" at the beginning and end; if
718 # it has changed, raise an exception.
719 jmsg = GetChangeCurrentRevision(host, change)
720 if not jmsg:
721 raise GerritError(
722 200, 'Could not get review information for change "%s"' % change)
723 value = str(value)
724 revision = jmsg[0]['current_revision']
725 path = 'changes/%s/revisions/%s/review' % (change, revision)
726 message = message or (
727 '%s label set to %s programmatically.' % (label, value))
728 jmsg = GetReview(host, change, revision)
729 if not jmsg:
730 raise GerritError(200, 'Could not get review information for revison %s '
731 'of change %s' % (revision, change))
732 for review in jmsg.get('labels', {}).get(label, {}).get('all', []):
733 if str(review.get('value', value)) != value:
734 body = {
735 'message': message,
736 'labels': {label: value},
737 'on_behalf_of': review['_account_id'],
738 }
739 if notify:
740 body['notify'] = notify
741 conn = CreateHttpConn(
742 host, path, reqtype='POST', body=body)
743 response = ReadHttpJsonResponse(conn)
744 if str(response['labels'][label]) != value:
745 username = review.get('email', jmsg.get('name', ''))
746 raise GerritError(200, 'Unable to set %s label for user "%s"'
747 ' on change %s.' % (label, username, change))
748 jmsg = GetChangeCurrentRevision(host, change)
749 if not jmsg:
750 raise GerritError(
751 200, 'Could not get review information for change "%s"' % change)
752 elif jmsg[0]['current_revision'] != revision:
753 raise GerritError(200, 'While resetting labels on change "%s", '
754 'a new patchset was uploaded.' % change)
Dan Jacques8d11e482016-11-15 14:25:56 -0800755
756
757@contextlib.contextmanager
758def tempdir():
759 tdir = None
760 try:
761 tdir = tempfile.mkdtemp(suffix='gerrit_util')
762 yield tdir
763 finally:
764 if tdir:
765 gclient_utils.rmtree(tdir)