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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
|
"""
Simple wrappers around request methods.
"""
from functools import update_wrapper
import logging
import os.path
import re
import pty
import sys
import tempfile
import click
import requests
import git_pw
from git_pw import config
if 0: # noqa
from typing import Any # noqa
from typing import Callable # noqa
from typing import Dict # noqa
from typing import IO # noqa
from typing import List # noqa
from typing import Optional # noqa
from typing import Tuple # noqa
from typing import Union # noqa
Filters = List[Tuple[str, str]]
CONF = config.CONF
LOG = logging.getLogger(__name__)
class HTTPTokenAuth(requests.auth.AuthBase):
"""Attaches HTTP Token Authentication to the given Request object."""
def __init__(self, token):
self.token = token
def __call__(self, r):
r.headers['Authorization'] = self._token_auth_str(self.token)
return r
@staticmethod
def _token_auth_str(token): # type: (str) -> str
"""Return a Token auth string."""
return 'Token {}'.format(token.strip())
def _get_auth(): # type: () -> requests.auth.AuthBase
if CONF.token:
return HTTPTokenAuth(CONF.token)
elif CONF.username and CONF.password:
return requests.auth.HTTPBasicAuth(CONF.username, CONF.password)
else:
LOG.error('Authentication information missing')
LOG.error('You must configure authentication via git-config or via '
'--token or --username, --password')
sys.exit(1)
def _get_headers(): # type: () -> Dict[str, str]
return {
'User-Agent': 'git-pw ({})'.format(git_pw.__version__),
}
def _get_server(): # type: () -> str
if CONF.server:
server = CONF.server.rstrip('/')
if not re.match(r'.*/api/\d\.\d$', server):
LOG.warning('Server version missing')
LOG.warning('You should provide the server version in the URL '
'configured via git-config or --server')
LOG.warning('This will be required in git-pw 2.0')
if not re.match(r'.*/api(/\d\.\d)?$', server):
# NOTE(stephenfin): We've already handled this particular error
# above so we don't warn twice. We also don't stick on a version
# number since the user clearly wants the latest
server += '/api'
return server
else:
LOG.error('Server information missing')
LOG.error('You must provide server information via git-config or via '
'--server')
sys.exit(1)
def _get_project(): # type: () -> str
if CONF.project and CONF.project.strip() == '*':
return '' # just don't bother filtering on project
elif CONF.project:
return CONF.project.strip()
else:
LOG.error('Project information missing')
LOG.error('You must provide project information via git-config or '
'via --project')
LOG.error('To list all projects, set project to "*"')
sys.exit(1)
def _handle_error(operation, exc):
if exc.response is not None and exc.response.content:
# server errors should always be reported
if exc.response.status_code in range(500, 512): # 5xx Server Error
LOG.error('Server error. Please report this issue to '
'https://github.com/getpatchwork/patchwork')
raise
# we make the assumption that all responses will be JSON encoded
if exc.response.status_code == 404:
LOG.error('Resource not found')
else:
LOG.error(exc.response.json())
else:
LOG.error('Failed to %s resource. Is your configuration '
'correct?' % operation)
LOG.error("Use the '--debug' flag for more information")
if CONF.debug:
raise
else:
sys.exit(1)
def _get(url, params=None, stream=False):
# type: (str, Filters, bool) -> requests.Response
"""Make GET request and handle errors."""
LOG.debug('GET %s', url)
try:
# TODO(stephenfin): We only use a subset of the types possible for
# 'params' (namely a list of tuples) but it doesn't seem possible to
# indicate this
rsp = requests.get(
url, auth=_get_auth(), headers=_get_headers(), stream=stream,
params=params) # type: ignore
rsp.raise_for_status()
except requests.exceptions.RequestException as exc:
_handle_error('fetch', exc)
LOG.debug('Got response')
return rsp
def _post(url, data):
# type: (str, dict) -> requests.Response
"""Make POST request and handle errors."""
LOG.debug('POST %s, data=%r', url, data)
try:
rsp = requests.post(url, auth=_get_auth(), headers=_get_headers(),
data=data)
rsp.raise_for_status()
except requests.exceptions.RequestException as exc:
_handle_error('create', exc)
LOG.debug('Got response')
return rsp
def _patch(url, data):
# type: (str, dict) -> requests.Response
"""Make PATCH request and handle errors."""
LOG.debug('PATCH %s, data=%r', url, data)
try:
rsp = requests.patch(url, auth=_get_auth(), headers=_get_headers(),
data=data)
rsp.raise_for_status()
except requests.exceptions.RequestException as exc:
_handle_error('update', exc)
LOG.debug('Got response')
return rsp
def _delete(url):
# type: (str) -> requests.Response
"""Make DELETE request and handle errors."""
LOG.debug('DELETE %s', url)
try:
rsp = requests.delete(url, auth=_get_auth(), headers=_get_headers())
rsp.raise_for_status()
except requests.exceptions.RequestException as exc:
_handle_error('delete', exc)
LOG.debug('Got response')
return rsp
def version():
# type: () -> Optional[Tuple[int, int]]
"""Get the version of the server from the URL, if present."""
server = _get_server()
version = re.match(r'.*/(\d)\.(\d)$', server)
if version:
return (int(version.group(1)), int(version.group(2)))
# return the oldest version we support if no version provided
return (1, 0)
def download(url, params=None, output=None):
# type: (str, Filters, IO) -> Optional[str]
"""Retrieve a specific API resource and save it to a file/stdout.
The ``Content-Disposition`` header is assumed to be present and
will be used for the output filename, if not writing to stdout.
Arguments:
url: The resource URL.
params: Additional parameters.
output: The output file. If provided, the caller is responsible for
closing. If None, a temporary file will be used.
Returns:
A path to an output file containing the content, else None if stdout
used.
"""
rsp = _get(url, params, stream=True)
# we don't catch anything here because we should break if these are missing
header = re.search(
'filename=(.+)', rsp.headers.get('content-disposition') or '',
)
if not header:
LOG.error('Filename was expected but was not provided in response')
sys.exit(1)
if output:
output_path = None
if output.fileno() != pty.STDOUT_FILENO:
LOG.debug('Saving to %s', output.name)
output_path = output.name
# we use iter_content because patches can be binary
for block in rsp.iter_content(1024):
output.write(block)
else:
output_path = os.path.join(
tempfile.mkdtemp(prefix='git-pw'), header.group(1),
)
with open(output_path, 'wb') as output_file:
LOG.debug('Saving to %s', output_path)
# we use iter_content because patches can be binary
for block in rsp.iter_content(1024):
output_file.write(block)
return output_path
def index(resource_type, params=None):
# type: (str, Filters) -> dict
"""List API resources.
GET /{resource}/
All resources are JSON bodies, thus we can access them in a similar
fashion.
Arguments:
resource_type: The resource endpoint name.
params: Additional parameters, filters.
Returns:
A list of dictionaries, representing the summary view of each resource.
"""
# NOTE(stephenfin): All resources must have a trailing '/'
url = '/'.join([_get_server(), resource_type, ''])
# NOTE(stephenfin): Not all endpoints in the Patchwork API allow filtering
# by project, but all the ones we care about here do.
params = params or []
params.append(('project', _get_project()))
return _get(url, params).json()
def detail(resource_type, resource_id, params=None):
# type: (str, int, Filters) -> Dict
"""Retrieve a specific API resource.
GET /{resource}/{resourceID}/
Arguments:
resource_type: The resource endpoint name.
resource_id: The ID for the specific resource.
params: Additional parameters.
Returns:
A dictionary representing the detailed view of a given resource.
"""
# NOTE(stephenfin): All resources must have a trailing '/'
url = '/'.join([_get_server(), resource_type, str(resource_id), ''])
return _get(url, params, stream=False).json()
def create(resource_type, data):
# type: (str, dict) -> dict
"""Create a new API resource.
POST /{resource}/
Arguments:
resource_type: The resource endpoint name.
params: Fields to update.
Returns:
A dictionary representing the detailed view of a given resource.
"""
# NOTE(stephenfin): All resources must have a trailing '/'
url = '/'.join([_get_server(), resource_type, ''])
return _post(url, data).json()
def delete(resource_type, resource_id):
# type: (str, Union[str, int]) -> None
"""Delete a specific API resource.
DELETE /{resource}/{resourceID}/
Arguments:
resource_type: The resource endpoint name.
resource_id: The ID for the specific resource.
Returns:
A dictionary representing the detailed view of a given resource.
"""
# NOTE(stephenfin): All resources must have a trailing '/'
url = '/'.join([_get_server(), resource_type, str(resource_id), ''])
_delete(url)
def update(resource_type, resource_id, data):
# type: (str, Union[int, str], dict) -> dict
"""Update a specific API resource.
PATCH /{resource}/{resourceID}/
Arguments:
resource_type: The resource endpoint name.
resource_id: The ID for the specific resource.
params: Fields to update.
Returns:
A dictionary representing the detailed view of a given resource.
"""
# NOTE(stephenfin): All resources must have a trailing '/'
url = '/'.join([_get_server(), resource_type, str(resource_id), ''])
return _patch(url, data).json()
def validate_minimum_version(min_version, msg):
# type: (Tuple[int, int], str) -> Callable[[Any], Any]
def inner(f):
@click.pass_context
def new_func(ctx, *args, **kwargs):
if version() < min_version:
LOG.error(msg)
sys.exit(1)
return ctx.invoke(f, *args, **kwargs)
return update_wrapper(new_func, f)
return inner
def validate_multiple_filter_support(f):
@click.pass_context
def new_func(ctx, *args, **kwargs):
if version() >= (1, 1):
return ctx.invoke(f, *args, **kwargs)
for param in ctx.command.params:
if not param.multiple:
continue
if param.name in ('headers'):
continue
value = list(kwargs[param.name] or [])
if value and len(value) > 1 and value != param.default:
msg = ('The `--%s` filter was specified multiple times. '
'Filtering by multiple %ss is not supported with API '
'version 1.0. If the server supports it, use version '
'1.1 instead. Refer to https://git.io/vN3vX for more '
'information.')
LOG.warning(msg, param.name, param.name)
return ctx.invoke(f, *args, **kwargs)
return update_wrapper(new_func, f)
def retrieve_filter_ids(resource_type, filter_name, filter_value):
"""Retrieve IDs for items passed through by filter.
Some filters require client-side filtering, e.g. filtering patches by
submitter names.
Arguments:
resource_type: The filter's resource endpoint name.
filter_name: The name of the filter.
filter_value: The value of the filter.
Returns:
A list of querystring key-value pairs to use in the actual request.
"""
if len(filter_value) < 3:
# protect agaisnt really generic (and essentially meaningless) queries
LOG.error('Filters must be at least 3 characters long')
sys.exit(1)
# NOTE(stephenfin): This purposefully ignores the possiblity of a second
# page because it's unlikely and likely unnecessary
items = index(resource_type, [('q', filter_value)])
if len(items) == 0:
LOG.warning('No matching %s found: %s', filter_name, filter_value)
elif len(items) > 1 and version() < (1, 1):
# we don't support multiple filters in 1.0
msg = ('More than one match for found for `--%s=%s`. '
'Filtering by multiple %ss is not supported with '
'API version 1.0. If the server supports it, use '
'version 1.1 instead. Refer to https://git.io/vN3vX '
'for more information.')
LOG.warning(msg, filter_name, filter_value, filter_name)
return [(filter_name, item['id']) for item in items]
|