1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
# The MIT License
#
# Copyright 2013 Sony Mobile Communications. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
""" Interface to the Gerrit REST API. """
import json
import logging
import requests
GERRIT_MAGIC_JSON_PREFIX = ")]}\'\n"
GERRIT_AUTH_SUFFIX = "/a"
def _decode_response(response):
""" Decode the `response` received from a REST API call.
Strip off Gerrit's magic prefix if it is there, and return decoded
JSON content or raw text if it cannot be decoded as JSON.
Raise requests.HTTPError if the response contains an HTTP error status
code.
"""
response.raise_for_status()
content = response.content
if content.startswith(GERRIT_MAGIC_JSON_PREFIX):
content = content[len(GERRIT_MAGIC_JSON_PREFIX):]
try:
return json.loads(content)
except ValueError:
return content.strip()
class GerritRestAPI(object):
""" Interface to the Gerrit REST API. """
def __init__(self, url, auth=None, verify=True):
""" Constructor.
`url` is assumed to be the full URL to the server, including the
'http(s)://' prefix.
If `auth` is specified, it must be a derivation of the `AuthBase`
class from the `requests` module. The `url` will be adjusted if
necessary to make sure it includes Gerrit's authentication suffix.
If `verify` is False, the underlying requests library will be
configured to not attempt to verify SSL certificates.
"""
headers = {'Accept': 'application/json',
'Accept-Encoding': 'gzip'}
self.kwargs = {'auth': auth,
'verify': verify,
'headers': headers}
self.url = url.rstrip('/')
self.session = requests.session()
if auth:
if not isinstance(auth, requests.auth.AuthBase):
raise ValueError('Invalid auth type; must be derived '
'from requests.auth.AuthBase')
if not self.url.endswith(GERRIT_AUTH_SUFFIX):
self.url += GERRIT_AUTH_SUFFIX
else:
if self.url.endswith(GERRIT_AUTH_SUFFIX):
self.url = self.url[: - len(GERRIT_AUTH_SUFFIX)]
if not self.url.endswith('/'):
self.url += '/'
logging.debug("url %s", self.url)
def make_url(self, endpoint):
""" Make the necessary url from `endpoint`.
Strip leading slashes off the endpoint, and return the full
url.
Raise requests.RequestException on timeout or connection error.
"""
endpoint = endpoint.lstrip('/')
return self.url + endpoint
def get(self, endpoint, **kwargs):
""" Send HTTP GET to `endpoint`.
Return JSON decoded result.
Raise requests.RequestException on timeout or connection error.
"""
kwargs.update(self.kwargs.copy())
response = self.session.get(self.make_url(endpoint), **kwargs)
return _decode_response(response)
def put(self, endpoint, **kwargs):
""" Send HTTP PUT to `endpoint`.
Return JSON decoded result.
Raise requests.RequestException on timeout or connection error.
"""
kwargs.update(self.kwargs.copy())
kwargs["headers"].update(
{"Content-Type": "application/json;charset=UTF-8"})
response = self.session.put(self.make_url(endpoint), **kwargs)
return _decode_response(response)
def post(self, endpoint, **kwargs):
""" Send HTTP POST to `endpoint`.
Return JSON decoded result.
Raise requests.RequestException on timeout or connection error.
"""
kwargs.update(self.kwargs.copy())
kwargs["headers"].update(
{"Content-Type": "application/json;charset=UTF-8"})
response = self.session.post(self.make_url(endpoint), **kwargs)
return _decode_response(response)
def delete(self, endpoint, **kwargs):
""" Send HTTP DELETE to `endpoint`.
Return JSON decoded result.
Raise requests.RequestException on timeout or connection error.
"""
kwargs.update(self.kwargs.copy())
response = self.session.delete(self.make_url(endpoint), **kwargs)
return _decode_response(response)
def review(self, change_id, revision, review):
""" Send HTTP POST with review parameters.
Return JSON decoded result.
Raise requests.RequestException on timeout or connection error.
"""
endpoint = "changes/%s/revisions/%s/review" % (change_id, revision)
self.post(endpoint, data=str(review))
class GerritReview(object):
"""Class to handle inline reviews."""
def __init__(self, message=None, labels=None, comments=None):
""" Initialization.
Format Eg:
labels :
{'Verified': 1, 'Code-Review': -1}
comments :
[{'filename': 'Makefile', 'line': 10, 'message': 'inline message'}]
"""
self.message = message if message else ""
if labels:
if not isinstance(labels, dict):
raise ValueError("labels must be a dict.")
self.labels = labels
else:
self.labels = {}
if comments:
if not isinstance(comments, list):
raise ValueError("comments must be a list.")
self.comments = {}
self.add_comments(comments)
else:
self.comments = {}
def set_message(self, message):
"""Set review message."""
self.message = message
def add_labels(self, labels):
"""Set Labels.
Format Eg: {'Verified': 1, 'Code-Review': -1}
"""
self.labels.update(labels)
def add_comments(self, comments):
"""Add inline comments.
Format Eg:
[{'filename': 'Makefile', 'line': 10, 'message': 'inline message'}]
"""
for comment in comments:
if 'filename' and 'line' and 'message' in comment.keys():
line_msg = {"line": comment['line'],
"message": comment['message']}
file_comment = {comment['filename']: [line_msg]}
if self.comments:
if comment['filename'] in self.comments.keys():
self.comments[comment['filename']].append(line_msg)
else:
self.comments.update(file_comment)
else:
self.comments.update(file_comment)
def __str__(self):
"""Return review in str format."""
review_input = {}
if self.message:
review_input.update({'message': self.message})
if self.labels:
review_input.update({'labels': self.labels})
if self.comments:
review_input.update({'comments': self.comments})
return json.dumps(review_input)
|
