/usr/lib/python3/dist-packages/gitlab/v3/cli.py is in python3-gitlab 1:1.3.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2013-2017 Gauvain Pocentek <gauvain@pocentek.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from __future__ import print_function
from __future__ import absolute_import
import inspect
import operator
import sys
import six
import gitlab
import gitlab.base
from gitlab import cli
import gitlab.v3.objects
EXTRA_ACTIONS = {
gitlab.v3.objects.Group: {
'search': {'required': ['query']}},
gitlab.v3.objects.ProjectBranch: {
'protect': {'required': ['id', 'project-id']},
'unprotect': {'required': ['id', 'project-id']}},
gitlab.v3.objects.ProjectBuild: {
'cancel': {'required': ['id', 'project-id']},
'retry': {'required': ['id', 'project-id']},
'artifacts': {'required': ['id', 'project-id']},
'trace': {'required': ['id', 'project-id']}},
gitlab.v3.objects.ProjectCommit: {
'diff': {'required': ['id', 'project-id']},
'blob': {'required': ['id', 'project-id', 'filepath']},
'builds': {'required': ['id', 'project-id']},
'cherrypick': {'required': ['id', 'project-id', 'branch']}},
gitlab.v3.objects.ProjectIssue: {
'subscribe': {'required': ['id', 'project-id']},
'unsubscribe': {'required': ['id', 'project-id']},
'move': {'required': ['id', 'project-id', 'to-project-id']}},
gitlab.v3.objects.ProjectMergeRequest: {
'closes-issues': {'required': ['id', 'project-id']},
'cancel': {'required': ['id', 'project-id']},
'merge': {'required': ['id', 'project-id'],
'optional': ['merge-commit-message',
'should-remove-source-branch',
'merged-when-build-succeeds']}},
gitlab.v3.objects.ProjectMilestone: {
'issues': {'required': ['id', 'project-id']}},
gitlab.v3.objects.Project: {
'search': {'required': ['query']},
'owned': {},
'all': {'optional': [('all', bool)]},
'starred': {},
'star': {'required': ['id']},
'unstar': {'required': ['id']},
'archive': {'required': ['id']},
'unarchive': {'required': ['id']},
'share': {'required': ['id', 'group-id', 'group-access']},
'upload': {'required': ['id', 'filename', 'filepath']}},
gitlab.v3.objects.User: {
'block': {'required': ['id']},
'unblock': {'required': ['id']},
'search': {'required': ['query']},
'get-by-username': {'required': ['query']}},
}
class GitlabCLI(object):
def _get_id(self, cls, args):
try:
id = args.pop(cls.idAttr)
except Exception:
cli.die("Missing --%s argument" % cls.idAttr.replace('_', '-'))
return id
def do_create(self, cls, gl, what, args):
if not cls.canCreate:
cli.die("%s objects can't be created" % what)
try:
o = cls.create(gl, args)
except Exception as e:
cli.die("Impossible to create object", e)
return o
def do_list(self, cls, gl, what, args):
if not cls.canList:
cli.die("%s objects can't be listed" % what)
try:
l = cls.list(gl, **args)
except Exception as e:
cli.die("Impossible to list objects", e)
return l
def do_get(self, cls, gl, what, args):
if cls.canGet is False:
cli.die("%s objects can't be retrieved" % what)
id = None
if cls not in [gitlab.v3.objects.CurrentUser] and cls.getRequiresId:
id = self._get_id(cls, args)
try:
o = cls.get(gl, id, **args)
except Exception as e:
cli.die("Impossible to get object", e)
return o
def do_delete(self, cls, gl, what, args):
if not cls.canDelete:
cli.die("%s objects can't be deleted" % what)
id = args.pop(cls.idAttr)
try:
gl.delete(cls, id, **args)
except Exception as e:
cli.die("Impossible to destroy object", e)
def do_update(self, cls, gl, what, args):
if not cls.canUpdate:
cli.die("%s objects can't be updated" % what)
o = self.do_get(cls, gl, what, args)
try:
for k, v in args.items():
o.__dict__[k] = v
o.save()
except Exception as e:
cli.die("Impossible to update object", e)
return o
def do_group_search(self, cls, gl, what, args):
try:
return gl.groups.search(args['query'])
except Exception as e:
cli.die("Impossible to search projects", e)
def do_project_search(self, cls, gl, what, args):
try:
return gl.projects.search(args['query'])
except Exception as e:
cli.die("Impossible to search projects", e)
def do_project_all(self, cls, gl, what, args):
try:
return gl.projects.all(all=args.get('all', False))
except Exception as e:
cli.die("Impossible to list all projects", e)
def do_project_starred(self, cls, gl, what, args):
try:
return gl.projects.starred()
except Exception as e:
cli.die("Impossible to list starred projects", e)
def do_project_owned(self, cls, gl, what, args):
try:
return gl.projects.owned()
except Exception as e:
cli.die("Impossible to list owned projects", e)
def do_project_star(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.star()
except Exception as e:
cli.die("Impossible to star project", e)
def do_project_unstar(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.unstar()
except Exception as e:
cli.die("Impossible to unstar project", e)
def do_project_archive(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.archive_()
except Exception as e:
cli.die("Impossible to archive project", e)
def do_project_unarchive(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.unarchive_()
except Exception as e:
cli.die("Impossible to unarchive project", e)
def do_project_share(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.share(args['group_id'], args['group_access'])
except Exception as e:
cli.die("Impossible to share project", e)
def do_user_block(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.block()
except Exception as e:
cli.die("Impossible to block user", e)
def do_user_unblock(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.unblock()
except Exception as e:
cli.die("Impossible to block user", e)
def do_project_commit_diff(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return [x['diff'] for x in o.diff()]
except Exception as e:
cli.die("Impossible to get commit diff", e)
def do_project_commit_blob(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.blob(args['filepath'])
except Exception as e:
cli.die("Impossible to get commit blob", e)
def do_project_commit_builds(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.builds()
except Exception as e:
cli.die("Impossible to get commit builds", e)
def do_project_commit_cherrypick(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.cherry_pick(branch=args['branch'])
except Exception as e:
cli.die("Impossible to cherry-pick commit", e)
def do_project_build_cancel(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.cancel()
except Exception as e:
cli.die("Impossible to cancel project build", e)
def do_project_build_retry(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.retry()
except Exception as e:
cli.die("Impossible to retry project build", e)
def do_project_build_artifacts(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.artifacts()
except Exception as e:
cli.die("Impossible to get project build artifacts", e)
def do_project_build_trace(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.trace()
except Exception as e:
cli.die("Impossible to get project build trace", e)
def do_project_issue_subscribe(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.subscribe()
except Exception as e:
cli.die("Impossible to subscribe to issue", e)
def do_project_issue_unsubscribe(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.unsubscribe()
except Exception as e:
cli.die("Impossible to subscribe to issue", e)
def do_project_issue_move(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
o.move(args['to_project_id'])
except Exception as e:
cli.die("Impossible to move issue", e)
def do_project_merge_request_closesissues(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.closes_issues()
except Exception as e:
cli.die("Impossible to list issues closed by merge request", e)
def do_project_merge_request_cancel(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.cancel_merge_when_build_succeeds()
except Exception as e:
cli.die("Impossible to cancel merge request", e)
def do_project_merge_request_merge(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
should_remove = args.get('should_remove_source_branch', False)
build_succeeds = args.get('merged_when_build_succeeds', False)
return o.merge(
merge_commit_message=args.get('merge_commit_message', ''),
should_remove_source_branch=should_remove,
merged_when_build_succeeds=build_succeeds)
except Exception as e:
cli.die("Impossible to validate merge request", e)
def do_project_milestone_issues(self, cls, gl, what, args):
try:
o = self.do_get(cls, gl, what, args)
return o.issues()
except Exception as e:
cli.die("Impossible to get milestone issues", e)
def do_user_search(self, cls, gl, what, args):
try:
return gl.users.search(args['query'])
except Exception as e:
cli.die("Impossible to search users", e)
def do_user_getbyusername(self, cls, gl, what, args):
try:
return gl.users.search(args['query'])
except Exception as e:
cli.die("Impossible to get user %s" % args['query'], e)
def do_project_upload(self, cls, gl, what, args):
try:
project = gl.projects.get(args["id"])
except Exception as e:
cli.die("Could not load project '{!r}'".format(args["id"]), e)
try:
res = project.upload(filename=args["filename"],
filepath=args["filepath"])
except Exception as e:
cli.die("Could not upload file into project", e)
return res
def _populate_sub_parser_by_class(cls, sub_parser):
for action_name in ['list', 'get', 'create', 'update', 'delete']:
attr = 'can' + action_name.capitalize()
if not getattr(cls, attr):
continue
sub_parser_action = sub_parser.add_parser(action_name)
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=True)
for x in cls.requiredUrlAttrs]
sub_parser_action.add_argument("--sudo", required=False)
if action_name == "list":
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=True)
for x in cls.requiredListAttrs]
sub_parser_action.add_argument("--page", required=False)
sub_parser_action.add_argument("--per-page", required=False)
sub_parser_action.add_argument("--all", required=False,
action='store_true')
if action_name in ["get", "delete"]:
if cls not in [gitlab.v3.objects.CurrentUser]:
if cls.getRequiresId:
id_attr = cls.idAttr.replace('_', '-')
sub_parser_action.add_argument("--%s" % id_attr,
required=True)
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=True)
for x in cls.requiredGetAttrs if x != cls.idAttr]
if action_name == "get":
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=False)
for x in cls.optionalGetAttrs]
if action_name == "list":
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=False)
for x in cls.optionalListAttrs]
if action_name == "create":
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=True)
for x in cls.requiredCreateAttrs]
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=False)
for x in cls.optionalCreateAttrs]
if action_name == "update":
id_attr = cls.idAttr.replace('_', '-')
sub_parser_action.add_argument("--%s" % id_attr,
required=True)
attrs = (cls.requiredUpdateAttrs
if (cls.requiredUpdateAttrs or cls.optionalUpdateAttrs)
else cls.requiredCreateAttrs)
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=True)
for x in attrs if x != cls.idAttr]
attrs = (cls.optionalUpdateAttrs
if (cls.requiredUpdateAttrs or cls.optionalUpdateAttrs)
else cls.optionalCreateAttrs)
[sub_parser_action.add_argument("--%s" % x.replace('_', '-'),
required=False)
for x in attrs]
if cls in EXTRA_ACTIONS:
def _add_arg(parser, required, data):
extra_args = {}
if isinstance(data, tuple):
if data[1] is bool:
extra_args = {'action': 'store_true'}
data = data[0]
parser.add_argument("--%s" % data, required=required, **extra_args)
for action_name in sorted(EXTRA_ACTIONS[cls]):
sub_parser_action = sub_parser.add_parser(action_name)
d = EXTRA_ACTIONS[cls][action_name]
[_add_arg(sub_parser_action, True, arg)
for arg in d.get('required', [])]
[_add_arg(sub_parser_action, False, arg)
for arg in d.get('optional', [])]
def extend_parser(parser):
subparsers = parser.add_subparsers(title='object', dest='what',
help="Object to manipulate.")
subparsers.required = True
# populate argparse for all Gitlab Object
classes = []
for cls in gitlab.v3.objects.__dict__.values():
try:
if gitlab.base.GitlabObject in inspect.getmro(cls):
classes.append(cls)
except AttributeError:
pass
classes.sort(key=operator.attrgetter("__name__"))
for cls in classes:
arg_name = cli.cls_to_what(cls)
object_group = subparsers.add_parser(arg_name)
object_subparsers = object_group.add_subparsers(
dest='action', help="Action to execute.")
_populate_sub_parser_by_class(cls, object_subparsers)
object_subparsers.required = True
return parser
def run(gl, what, action, args, verbose, *fargs, **kwargs):
try:
cls = gitlab.v3.objects.__dict__[cli.what_to_cls(what)]
except ImportError:
cli.die("Unknown object: %s" % what)
g_cli = GitlabCLI()
method = None
what = what.replace('-', '_')
action = action.lower().replace('-', '')
for test in ["do_%s_%s" % (what, action),
"do_%s" % action]:
if hasattr(g_cli, test):
method = test
break
if method is None:
sys.stderr.write("Don't know how to deal with this!\n")
sys.exit(1)
ret_val = getattr(g_cli, method)(cls, gl, what, args)
if isinstance(ret_val, list):
for o in ret_val:
if isinstance(o, gitlab.GitlabObject):
o.display(verbose)
print("")
else:
print(o)
elif isinstance(ret_val, dict):
for k, v in six.iteritems(ret_val):
print("{} = {}".format(k, v))
elif isinstance(ret_val, gitlab.base.GitlabObject):
ret_val.display(verbose)
elif isinstance(ret_val, six.string_types):
print(ret_val)
|