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
|
"""
Patch subcommands.
"""
import logging
import pty
import sys
import arrow
import click
from git_pw import api
from git_pw import config
from git_pw import utils
CONF = config.CONF
LOG = logging.getLogger(__name__)
_list_headers = (
'ID', 'Date', 'Name', 'Submitter', 'State', 'Archived', 'Delegate')
_sort_fields = (
'id', '-id', 'name', '-name', 'date', '-date')
_default_states = (
'new', 'under-review', 'accepted', 'rejected', 'rfc', 'not-applicable',
'changes-requested', 'awaiting-upstream', 'superseded', 'deferred')
@click.command(name='apply', context_settings=dict(
ignore_unknown_options=True,
))
@click.argument('patch_id', type=click.INT)
@click.option('--series', type=click.INT, metavar='SERIES',
help='Series to include dependencies from. Defaults to latest.')
@click.option('--deps/--no-deps', default=True,
help='When applying the patch, include dependencies if '
'available. Defaults to using the most recent series.')
@click.argument('args', nargs=-1, type=click.UNPROCESSED)
def apply_cmd(patch_id, series, deps, args):
"""Apply patch.
Apply a patch locally using the 'git-am' command. Any additional ARGS
provided will be passed to the 'git-am' command.
"""
LOG.debug('Applying patch: id=%d, series=%s, deps=%r, args=%s', patch_id,
series, deps, ' '.join(args))
patch = api.detail('patches', patch_id)
if deps and not series:
series = '*'
elif not deps:
series = None
mbox = api.download(patch['mbox'], {'series': series})
utils.git_am(mbox, args)
@click.command(name='download')
@click.argument('patch_id', type=click.INT)
@click.argument('output', type=click.File('wb'), required=False)
@click.option('--diff', 'fmt', flag_value='diff',
help='Show patch in diff format.')
@click.option('--mbox', 'fmt', flag_value='mbox', default=True,
help='Show patch in mbox format.')
def download_cmd(patch_id, output, fmt):
"""Download patch in diff or mbox format.
Download a patch but do not apply it. ``OUTPUT`` is optional and can be an
output path or ``-`` to output to ``stdout``. If ``OUTPUT`` is not
provided, the output path will be automatically chosen.
"""
LOG.debug('Downloading patch: id=%d, format=%s', patch_id, fmt)
path = None
patch = api.detail('patches', patch_id)
if fmt == 'diff':
if output:
output.write(patch['diff'])
if output.fileno() != pty.STDOUT_FILENO:
path = output.name
else:
# TODO(stephenfin): We discard the 'diff' field so we can get the
# filename and save to the correct file. We should expose this
# information via the API
path = api.download(
patch['mbox'].replace('mbox', 'raw'), output=output,
)
else:
path = api.download(patch['mbox'], output=output)
if path:
LOG.info('Downloaded patch to %s', path)
def _show_patch(patch, fmt):
def _format_series(series):
return '%-4d %s' % (series.get('id'), series.get('name') or '-')
output = [
('ID', patch.get('id')),
('Message ID', patch.get('msgid')),
('Date', patch.get('date')),
('Name', patch.get('name')),
('URL', patch.get('web_url')),
('Submitter', '%s (%s)' % (patch.get('submitter').get('name'),
patch.get('submitter').get('email'))),
('State', patch.get('state')),
('Archived', patch.get('archived')),
('Project', patch.get('project').get('name')),
('Delegate', (patch.get('delegate').get('username')
if patch.get('delegate') else '')),
('Commit Ref', patch.get('commit_ref'))]
prefix = 'Series'
for series in patch.get('series'):
output.append((prefix, _format_series(series)))
prefix = ''
utils.echo(output, ['Property', 'Value'], fmt=fmt)
@click.command(name='show')
@utils.format_options
@click.argument('patch_id', type=click.INT)
def show_cmd(fmt, patch_id):
"""Show information about patch.
Retrieve Patchwork metadata for a patch.
"""
LOG.debug('Showing patch: id=%d', patch_id)
patch = api.detail('patches', patch_id)
_show_patch(patch, fmt)
def _get_states():
return CONF.states.split(',') if CONF.states else _default_states
@click.command(name='update')
@click.argument('patch_ids', type=click.INT, nargs=-1, required=True)
@click.option('--commit-ref', metavar='COMMIT_REF',
help='Set the patch commit reference hash')
@click.option('--state', metavar='STATE', type=click.Choice(_get_states()),
help="Set the patch state. Should be a slugified representation "
"of a state. The available states are instance dependant and "
"can be configured using 'git config pw.states'.")
@click.option('--delegate', metavar='DELEGATE',
help='Set the patch delegate. Should be unique user identifier: '
'either a username or a user\'s email address.')
@click.option('--archived', metavar='ARCHIVED', type=click.BOOL,
help='Set the patch archived state.')
@utils.format_options
def update_cmd(patch_ids, commit_ref, state, delegate, archived, fmt):
"""Update one or more patches.
Updates one or more Patches on the Patchwork instance. Some operations may
require admin or maintainer permissions.
"""
for patch_id in patch_ids:
LOG.debug('Updating patch: id=%d, commit_ref=%s, state=%s, '
'archived=%s', patch_id, commit_ref, state, archived)
if delegate:
users = api.index('users', [('q', delegate)])
if len(users) == 0:
LOG.error('No matching delegates found: %s', delegate)
sys.exit(1)
elif len(users) > 1:
LOG.error('More than one delegate found: %s', delegate)
sys.exit(1)
delegate = users[0]['id']
data = []
for key, value in [('commit_ref', commit_ref), ('state', state),
('archived', archived), ('delegate', delegate)]:
if value is None:
continue
data.append((key, value))
patch = api.update('patches', patch_id, data)
_show_patch(patch, fmt)
@click.command(name='list')
@click.option('--state', 'states', metavar='STATE', multiple=True,
default=['under-review', 'new'],
help='Show only patches matching these states. Should be '
'slugified representations of states. The available states '
'are instance dependant.')
@click.option('--submitter', 'submitters', metavar='SUBMITTER', multiple=True,
help='Show only patches by these submitters. Should be an '
'email, name or ID.')
@click.option('--delegate', 'delegates', metavar='DELEGATE', multiple=True,
help='Show only patches with these delegates. Should be an '
'email or username.')
@click.option('--hash', 'hashes', metavar='HASH', multiple=True,
help='Show only patches with these hashes.')
@click.option('--archived', default=False, is_flag=True,
help='Include patches that are archived.')
@utils.pagination_options(sort_fields=_sort_fields, default_sort='-date')
@utils.format_options(headers=_list_headers)
@click.argument('name', required=False)
@api.validate_multiple_filter_support
def list_cmd(states, submitters, delegates, hashes, archived, limit, page,
sort, fmt, headers, name):
"""List patches.
List patches on the Patchwork instance.
"""
LOG.debug('List patches: states=%s, submitters=%s, delegates=%s, '
'hashes=%s, archived=%r', ','.join(states), ','.join(submitters),
','.join(delegates), ','.join(hashes), archived)
params = []
for state in states:
params.append(('state', state))
for submitter in submitters:
if submitter.isdigit():
params.append(('submitter', submitter))
else:
# we support server-side filtering by email (but not name) in 1.1
if api.version() >= (1, 1) and '@' in submitter:
params.append(('submitter', submitter))
else:
params.extend(
api.retrieve_filter_ids('people', 'submitter', submitter))
for delegate in delegates:
if delegate.isdigit():
params.append(('delegate', delegate))
else:
# we support server-side filtering by username (but not email) in
# 1.1
if api.version() >= (1, 1) and '@' not in delegate:
params.append(('delegate', delegate))
else:
params.extend(
api.retrieve_filter_ids('users', 'delegate', delegate))
for hash_ in hashes:
params.append(('hash', hash_))
params.extend([
('q', name),
('archived', 'true' if archived else 'false'),
('page', page),
('per_page', limit),
('order', sort),
])
patches = api.index('patches', params)
# Format and print output
output = []
for patch in patches:
item = [
patch.get('id'),
arrow.get(patch.get('date')).humanize(),
utils.trim(patch.get('name')),
'%s (%s)' % (patch.get('submitter').get('name'),
patch.get('submitter').get('email')),
patch.get('state'),
'yes' if patch.get('archived') else 'no',
(patch.get('delegate') or {}).get('username', ''),
]
output.append([])
for idx, header in enumerate(_list_headers):
if header not in headers:
continue
output[-1].append(item[idx])
utils.echo_via_pager(output, headers, fmt=fmt)
|