/usr/lib/python3/dist-packages/jira/resources.py is in python3-jira 1.0.10-1.
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 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 | # -*- coding: utf-8 -*-
from __future__ import unicode_literals
from __future__ import print_function
"""
This module implements the Resource classes that translate JSON from JIRA REST resources
into usable objects.
"""
import logging
import re
import time
try: # Python 2.7+
from logging import NullHandler
except ImportError:
class NullHandler(logging.Handler):
def emit(self, record):
pass
import json
from six import iteritems
from six import string_types
from six import text_type
from jira.utils import CaseInsensitiveDict
from jira.utils import json_loads
from jira.utils import threaded_requests
__all__ = (
'Resource',
'Issue',
'Comment',
'Project',
'Attachment',
'Component',
'Dashboard',
'Filter',
'Votes',
'Watchers',
'Worklog',
'IssueLink',
'IssueLinkType',
'IssueType',
'Priority',
'Version',
'Role',
'Resolution',
'SecurityLevel',
'Status',
'User',
'CustomFieldOption',
'RemoteLink'
)
logging.getLogger('jira').addHandler(NullHandler())
def get_error_list(r):
error_list = []
if r.status_code >= 400:
if r.status_code == 403 and "x-authentication-denied-reason" in r.headers:
error_list = [r.headers["x-authentication-denied-reason"]]
elif r.text:
try:
response = json_loads(r)
if 'message' in response:
# JIRA 5.1 errors
error_list = [response['message']]
elif 'errorMessages' in response and len(response['errorMessages']) > 0:
# JIRA 5.0.x error messages sometimes come wrapped in this array
# Sometimes this is present but empty
errorMessages = response['errorMessages']
if isinstance(errorMessages, (list, tuple)):
error_list = errorMessages
else:
error_list = [errorMessages]
elif 'errors' in response and len(response['errors']) > 0:
# JIRA 6.x error messages are found in this array.
error_list = response['errors'].values()
else:
error_list = [r.text]
except ValueError:
error_list = [r.text]
return error_list
class Resource(object):
"""Models a URL-addressable resource in the JIRA REST API.
All Resource objects provide the following:
``find()`` -- get a resource from the server and load it into the current object
(though clients should use the methods in the JIRA class instead of this method directly)
``update()`` -- changes the value of this resource on the server and returns a new resource object for it
``delete()`` -- deletes this resource from the server
``self`` -- the URL of this resource on the server
``raw`` -- dict of properties parsed out of the JSON response from the server
Subclasses will implement ``update()`` and ``delete()`` as appropriate for the specific resource.
All Resources have a resource path of the form:
* ``issue``
* ``project/{0}``
* ``issue/{0}/votes``
* ``issue/{0}/comment/{1}``
where the bracketed numerals are placeholders for ID values that are filled in from the
``ids`` parameter to ``find()``.
"""
JIRA_BASE_URL = '{server}/rest/{rest_path}/{rest_api_version}/{path}'
# A prioritized list of the keys in self.raw most likely to contain a human
# readable name or identifier, or that offer other key information.
_READABLE_IDS = ('displayName', 'key', 'name', 'filename', 'value',
'scope', 'votes', 'id', 'mimeType', 'closed')
def __init__(self, resource, options, session, base_url=JIRA_BASE_URL):
self._resource = resource
self._options = options
self._session = session
self._base_url = base_url
# Explicitly define as None so we know when a resource has actually
# been loaded
self.raw = None
def __str__(self):
"""Return the first value we find that is likely to be human readable."""
if self.raw:
for name in self._READABLE_IDS:
if name in self.raw:
pretty_name = text_type(self.raw[name])
# Include any child to support nested select fields.
if hasattr(self, 'child'):
pretty_name += ' - ' + text_type(self.child)
return pretty_name
# If all else fails, use repr to make sure we get something.
return repr(self)
def __repr__(self):
"""Identify the class and include any and all relevant values."""
names = []
if self.raw:
for name in self._READABLE_IDS:
if name in self.raw:
names.append(name + '=' + repr(self.raw[name]))
if not names:
return '<JIRA %s at %s>' % (self.__class__.__name__,
id(self))
return '<JIRA %s: %s>' % (self.__class__.__name__, ', '.join(names))
def __getattr__(self, item):
"""Allow access of attributes via names."""
try:
return self[item]
except Exception as e:
# Make sure pickling doesn't break
# *MORE INFO*: This conditional wouldn't be necessary if __getattr__ wasn't used. But
# since it is in use (no worries), we need to give the pickle.dump*
# methods what they expect back. They expect to either get a KeyError
# exception or a tuple of args to be passed to the __new__ method upon
# unpickling (i.e. pickle.load* methods).
# *NOTE*: if the __new__ method were to be implemented in this class, this may have
# to be removed or changed.
if item == '__getnewargs__':
raise KeyError(item)
if hasattr(self, 'raw') and item in self.raw:
return self.raw[item]
else:
raise AttributeError("%r object has no attribute %r (%s)" % (self.__class__, item, e))
# def __getstate__(self):
# """
# Pickling the resource; using the raw dict
# """
# return self.raw
#
# def __setstate__(self, raw_pickled):
# """
# Unpickling of the resource
# """
# self._parse_raw(raw_pickled)
#
def find(self, id, params=None):
if params is None:
params = {}
if isinstance(id, tuple):
path = self._resource.format(*id)
else:
path = self._resource.format(id)
url = self._get_url(path)
self._load(url, params=params)
def _get_url(self, path):
options = self._options.copy()
options.update({'path': path})
return self._base_url.format(**options)
def update(self, fields=None, async=None, jira=None, notify=True, **kwargs):
"""Update this resource on the server.
Keyword arguments are marshalled into a dict before being sent. If this
resource doesn't support ``PUT``, a :py:exc:`.JIRAError` will be raised; subclasses that specialize this method
will only raise errors in case of user error.
:param async: if true the request will be added to the queue so it can be executed later using async_run()
"""
if async is None:
async = self._options['async']
data = {}
if fields is not None:
data.update(fields)
data.update(kwargs)
data = json.dumps(data)
if not notify:
querystring = "?notifyUsers=false"
else:
querystring = ""
r = self._session.put(
self.self + querystring, data=data)
if 'autofix' in self._options and \
r.status_code == 400:
user = None
error_list = get_error_list(r)
logging.error(error_list)
if "The reporter specified is not a user." in error_list:
if 'reporter' not in data['fields']:
logging.warning(
"autofix: setting reporter to '%s' and retrying the update." % self._options['autofix'])
data['fields']['reporter'] = {
'name': self._options['autofix']}
if "Issues must be assigned." in error_list:
if 'assignee' not in data['fields']:
logging.warning("autofix: setting assignee to '%s' for %s and retrying the update." % (
self._options['autofix'], self.key))
data['fields']['assignee'] = {
'name': self._options['autofix']}
# for some reason the above approach fails on Jira 5.2.11
# so we need to change the assignee before
if "Issue type is a sub-task but parent issue key or id not specified." in error_list:
logging.warning(
"autofix: trying to fix sub-task without parent by converting to it to bug")
data['fields']['issuetype'] = {"name": "Bug"}
if "The summary is invalid because it contains newline characters." in error_list:
logging.warning("autofix: trying to fix newline in summary")
data['fields'][
'summary'] = self.fields.summary.replace("/n", "")
for error in error_list:
if re.search(u"^User '(.*)' was not found in the system\.", error, re.U):
m = re.search(
u"^User '(.*)' was not found in the system\.", error, re.U)
if m:
user = m.groups()[0]
else:
raise NotImplemented()
if re.search("^User '(.*)' does not exist\.", error):
m = re.search("^User '(.*)' does not exist\.", error)
if m:
user = m.groups()[0]
else:
raise NotImplemented()
if user:
logging.warning(
"Trying to add missing orphan user '%s' in order to complete the previous failed operation." % user)
jira.add_user(user, 'noreply@example.com', 10100, active=False)
# if 'assignee' not in data['fields']:
# logging.warning("autofix: setting assignee to '%s' and retrying the update." % self._options['autofix'])
# data['fields']['assignee'] = {'name': self._options['autofix']}
# EXPERIMENTAL --->
# import grequests
if async:
if not hasattr(self._session, '_async_jobs'):
self._session._async_jobs = set()
self._session._async_jobs.add(threaded_requests.put(
self.self, data=json.dumps(data)))
else:
r = self._session.put(
self.self, data=json.dumps(data))
# TODO(ssbarnea): compare loaded data in order to verify if resource was updated indeed
# we had random test failures (probably) due to caching
time.sleep(4)
self._load(self.self)
def delete(self, params=None):
"""Delete this resource from the server, passing the specified query parameters.
If this resource doesn't support ``DELETE``, a :py:exc:`.JIRAError`
will be raised; subclasses that specialize this method will only raise errors
in case of user error.
"""
if self._options['async']:
if not hasattr(self._session, '_async_jobs'):
self._session._async_jobs = set()
self._session._async_jobs.add(
threaded_requests.delete(url=self.self, params=params))
else:
return self._session.delete(url=self.self, params=params)
def _load(self, url, headers=CaseInsensitiveDict(), params=None, path=None):
r = self._session.get(url, headers=headers, params=params)
try:
j = json_loads(r)
except ValueError as e:
logging.error("%s:\n%s" % (e, r.text))
raise e
if path:
j = j[path]
self._parse_raw(j)
def _parse_raw(self, raw):
self.raw = raw
if not raw:
raise NotImplementedError("We cannot instantiate empty resources: %s" % raw)
dict2resource(raw, self, self._options, self._session)
def _default_headers(self, user_headers):
# result = dict(user_headers)
# esult['accept'] = 'application/json'
return CaseInsensitiveDict(self._options['headers'].items() + user_headers.items())
class Attachment(Resource):
"""An issue attachment."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'attachment/{0}', options, session)
if raw:
self._parse_raw(raw)
def get(self):
"""Return the file content as a string."""
r = self._session.get(self.content, headers={'Accept': '*/*'})
return r.content
def iter_content(self, chunk_size=1024):
"""Return the file content as an iterable stream."""
r = self._session.get(self.content, stream=True)
return r.iter_content(chunk_size)
class Component(Resource):
"""A project component."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'component/{0}', options, session)
if raw:
self._parse_raw(raw)
def delete(self, moveIssuesTo=None):
"""Delete this component from the server.
:param moveIssuesTo: the name of the component to which to move any issues this component is applied
"""
params = {}
if moveIssuesTo is not None:
params['moveIssuesTo'] = moveIssuesTo
super(Component, self).delete(params)
class CustomFieldOption(Resource):
"""An existing option for a custom issue field."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'customFieldOption/{0}', options, session)
if raw:
self._parse_raw(raw)
class Dashboard(Resource):
"""A JIRA dashboard."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'dashboard/{0}', options, session)
if raw:
self._parse_raw(raw)
class Filter(Resource):
"""An issue navigator filter."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'filter/{0}', options, session)
if raw:
self._parse_raw(raw)
class Issue(Resource):
"""A JIRA issue."""
class _IssueFields(object):
def __init__(self):
self.attachment = None
""" :type : list[Attachment] """
self.description = None
""" :type : str """
self.project = None
""" :type : Project """
self.comment = None
""" :type : list[Comment] """
self.issuelinks = None
""" :type : list[IssueLink] """
self.worklog = None
""" :type : list[Worklog] """
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}', options, session)
self.fields = None
""" :type : Issue._IssueFields """
self.id = None
""" :type : int """
self.key = None
""" :type : str """
if raw:
self._parse_raw(raw)
def update(self, fields=None, update=None, async=None, jira=None, notify=True, **fieldargs):
"""Update this issue on the server.
Each keyword argument (other than the predefined ones) is treated as a field name and the argument's value
is treated as the intended value for that field -- if the fields argument is used, all other keyword arguments
will be ignored.
JIRA projects may contain many different issue types. Some issue screens have different requirements for
fields in an issue. This information is available through the :py:meth:`.JIRA.editmeta` method. Further examples
are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Edit+issues
:param fields: a dict containing field names and the values to use
:param update: a dict containing update operations to apply
keyword arguments will generally be merged into fields, except lists, which will be merged into updates
"""
data = {}
if fields is not None:
fields_dict = fields
else:
fields_dict = {}
data['fields'] = fields_dict
if update is not None:
update_dict = update
else:
update_dict = {}
data['update'] = update_dict
for field in sorted(fieldargs.keys()):
value = fieldargs[field]
# apply some heuristics to make certain changes easier
if isinstance(value, string_types):
if field == 'assignee' or field == 'reporter':
fields_dict['assignee'] = {'name': value}
elif field == 'comment':
if 'comment' not in update_dict:
update_dict['comment'] = []
update_dict['comment'].append({
'add': {'body': value}})
else:
fields_dict[field] = value
elif isinstance(value, list):
if field not in update_dict:
update_dict[field] = []
update_dict[field].extend(value)
else:
fields_dict[field] = value
super(Issue, self).update(async=async, jira=jira, notify=notify, fields=data)
def add_field_value(self, field, value):
"""Add a value to a field that supports multiple values, without resetting the existing values.
This should work with: labels, multiple checkbox lists, multiple select
"""
super(Issue, self).update(fields={"update": {field: [{"add": value}]}})
def delete(self, deleteSubtasks=False):
"""Delete this issue from the server.
:param deleteSubtasks: if the issue has subtasks, this argument must be set to true for the call to succeed.
"""
super(Issue, self).delete(params={'deleteSubtasks': deleteSubtasks})
def permalink(self):
"""Get the URL of the issue, the browsable one not the REST one.
:return: URL of the issue
"""
return "%s/browse/%s" % (self._options['server'], self.key)
def __eq__(self, other):
"""Comparison method."""
return self.id == other.id
class Comment(Resource):
"""An issue comment."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}/comment/{1}', options, session)
if raw:
self._parse_raw(raw)
def update(self, fields=None, async=None, jira=None, body='', visibility=None):
data = {}
if body:
data['body'] = body
if visibility:
data['visibility'] = visibility
super(Comment, self).update(data)
class RemoteLink(Resource):
"""A link to a remote application from an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}/remotelink/{1}', options, session)
if raw:
self._parse_raw(raw)
def update(self, object, globalId=None, application=None, relationship=None):
"""Update a RemoteLink. 'object' is required.
For definitions of the allowable fields for 'object' and the keyword arguments 'globalId', 'application' and
'relationship', see https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links.
:param object: the link details to add (see the above link for details)
:param globalId: unique ID for the link (see the above link for details)
:param application: application information for the link (see the above link for details)
:param relationship: relationship description for the link (see the above link for details)
"""
data = {
'object': object}
if globalId is not None:
data['globalId'] = globalId
if application is not None:
data['application'] = application
if relationship is not None:
data['relationship'] = relationship
super(RemoteLink, self).update(**data)
class Votes(Resource):
"""Vote information on an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}/votes', options, session)
if raw:
self._parse_raw(raw)
class Watchers(Resource):
"""Watcher information on an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}/watchers', options, session)
if raw:
self._parse_raw(raw)
def delete(self, username):
"""Remove the specified user from the watchers list."""
super(Watchers, self).delete(params={'username': username})
class TimeTracking(Resource):
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}/worklog/{1}', options, session)
self.remainingEstimate = None
if raw:
self._parse_raw(raw)
class Worklog(Resource):
"""Worklog on an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issue/{0}/worklog/{1}', options, session)
if raw:
self._parse_raw(raw)
def delete(self, adjustEstimate=None, newEstimate=None, increaseBy=None):
"""Delete this worklog entry from its associated issue.
:param adjustEstimate: one of ``new``, ``leave``, ``manual`` or ``auto``.
``auto`` is the default and adjusts the estimate automatically.
``leave`` leaves the estimate unchanged by this deletion.
:param newEstimate: combined with ``adjustEstimate=new``, set the estimate to this value
:param increaseBy: combined with ``adjustEstimate=manual``, increase the remaining estimate by this amount
"""
params = {}
if adjustEstimate is not None:
params['adjustEstimate'] = adjustEstimate
if newEstimate is not None:
params['newEstimate'] = newEstimate
if increaseBy is not None:
params['increaseBy'] = increaseBy
super(Worklog, self).delete(params)
class IssueLink(Resource):
"""Link between two issues."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issueLink/{0}', options, session)
if raw:
self._parse_raw(raw)
class IssueLinkType(Resource):
"""Type of link between two issues."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issueLinkType/{0}', options, session)
if raw:
self._parse_raw(raw)
class IssueType(Resource):
"""Type of an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'issuetype/{0}', options, session)
if raw:
self._parse_raw(raw)
class Priority(Resource):
"""Priority that can be set on an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'priority/{0}', options, session)
if raw:
self._parse_raw(raw)
class Project(Resource):
"""A JIRA project."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'project/{0}', options, session)
if raw:
self._parse_raw(raw)
class Role(Resource):
"""A role inside a project."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'project/{0}/role/{1}', options, session)
if raw:
self._parse_raw(raw)
def update(self, users=None, groups=None):
"""Add the specified users or groups to this project role. One of ``users`` or ``groups`` must be specified.
:param users: a user or users to add to the role
:type users: string, list or tuple
:param groups: a group or groups to add to the role
:type groups: string, list or tuple
"""
if users is not None and isinstance(users, string_types):
users = (users,)
if groups is not None and isinstance(groups, string_types):
groups = (groups,)
data = {
'id': self.id,
'categorisedActors': {
'atlassian-user-role-actor': users,
'atlassian-group-role-actor': groups}}
super(Role, self).update(**data)
class Resolution(Resource):
"""A resolution for an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'resolution/{0}', options, session)
if raw:
self._parse_raw(raw)
class SecurityLevel(Resource):
"""A security level for an issue or project."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'securitylevel/{0}', options, session)
if raw:
self._parse_raw(raw)
class Status(Resource):
"""Status for an issue."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'status/{0}', options, session)
if raw:
self._parse_raw(raw)
class User(Resource):
"""A JIRA user."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'user?username={0}', options, session)
if raw:
self._parse_raw(raw)
def __hash__(self):
"""Hash carculation."""
return hash(str(self.name))
def __eq__(self, other):
"""Comparison."""
return str(self.name) == str(other.name)
class Version(Resource):
"""A version of a project."""
def __init__(self, options, session, raw=None):
Resource.__init__(self, 'version/{0}', options, session)
if raw:
self._parse_raw(raw)
def delete(self, moveFixIssuesTo=None, moveAffectedIssuesTo=None):
"""Delete this project version from the server.
If neither of the arguments are specified, the version is
removed from all issues it is attached to.
:param moveFixIssuesTo: in issues for which this version is a fix
version, add this argument version to the fix version list
:param moveAffectedIssuesTo: in issues for which this version is an
affected version, add this argument version to the affected version list
"""
params = {}
if moveFixIssuesTo is not None:
params['moveFixIssuesTo'] = moveFixIssuesTo
if moveAffectedIssuesTo is not None:
params['moveAffectedIssuesTo'] = moveAffectedIssuesTo
return super(Version, self).delete(params)
def update(self, **args):
"""Update this project version from the server. It is prior used to archive versions."""
data = {}
for field in args:
data[field] = args[field]
super(Version, self).update(**data)
def __eq__(self, other):
"""Comparison."""
return self.id == other.id and self.name == other.name
# GreenHopper
class GreenHopperResource(Resource):
"""A generic GreenHopper resource."""
AGILE_BASE_URL = '{server}/rest/{agile_rest_path}/{agile_rest_api_version}/{path}'
GREENHOPPER_REST_PATH = "greenhopper"
""" Old, private API. Deprecated and will be removed from JIRA on the 1st February 2016. """
AGILE_EXPERIMENTAL_REST_PATH = "greenhopper/experimental-api"
""" Experimental API available in JIRA Agile 6.7.3 - 6.7.6, basically the same as Public API """
AGILE_BASE_REST_PATH = "agile"
""" Public API introduced in JIRA Agile 6.7.7. """
def __init__(self, path, options, session, raw):
self.self = None
Resource.__init__(self, path, options, session, self.AGILE_BASE_URL)
if raw:
self._parse_raw(raw)
# Old GreenHopper API did not contain self - create it for backward compatibility.
if not self.self:
self.self = self._get_url(path.format(raw['id']))
class Sprint(GreenHopperResource):
"""A GreenHopper sprint."""
def __init__(self, options, session, raw=None):
GreenHopperResource.__init__(self, 'sprint/{0}', options, session, raw)
def find(self, id, params=None):
if self._options['agile_rest_path'] != GreenHopperResource.GREENHOPPER_REST_PATH:
Resource.find(self, id, params)
else:
# Old, private GreenHopper API had non-standard way of loading Sprint
url = self._get_url('sprint/%s/edit/model' % id)
self._load(url, params=params, path='sprint')
class Board(GreenHopperResource):
"""A GreenHopper board."""
def __init__(self, options, session, raw=None):
path = 'rapidview/{0}' if options['agile_rest_path'] == self.GREENHOPPER_REST_PATH else 'board/{id}'
GreenHopperResource.__init__(self, path, options, session, raw)
def delete(self, params=None):
if self._options['agile_rest_path'] != GreenHopperResource.GREENHOPPER_REST_PATH:
raise NotImplementedError('JIRA Agile Public API does not support Board removal')
Resource.delete(self, params)
# Utilities
def dict2resource(raw, top=None, options=None, session=None):
"""Convert a dictionary into a Jira Resource object.
Recursively walks a dict structure, transforming the properties into attributes
on a new ``Resource`` object of the appropriate type (if a ``self`` link is present)
or a ``PropertyHolder`` object (if no ``self`` link is present).
"""
if top is None:
top = type(str('PropertyHolder'), (object,), raw)
seqs = tuple, list, set, frozenset
for i, j in iteritems(raw):
if isinstance(j, dict):
if 'self' in j:
resource = cls_for_resource(j['self'])(options, session, j)
setattr(top, i, resource)
elif i == 'timetracking':
setattr(top, 'timetracking', TimeTracking(options, session, j))
else:
setattr(
top, i, dict2resource(j, options=options, session=session))
elif isinstance(j, seqs):
seq_list = []
for seq_elem in j:
if isinstance(seq_elem, dict):
if 'self' in seq_elem:
resource = cls_for_resource(seq_elem['self'])(
options, session, seq_elem)
seq_list.append(resource)
else:
seq_list.append(
dict2resource(seq_elem, options=options, session=session))
else:
seq_list.append(seq_elem)
setattr(top, i, seq_list)
else:
setattr(top, i, j)
return top
resource_class_map = {
# JIRA specific resources
r'attachment/[^/]+$': Attachment,
r'component/[^/]+$': Component,
r'customFieldOption/[^/]+$': CustomFieldOption,
r'dashboard/[^/]+$': Dashboard,
r'filter/[^/]$': Filter,
r'issue/[^/]+$': Issue,
r'issue/[^/]+/comment/[^/]+$': Comment,
r'issue/[^/]+/votes$': Votes,
r'issue/[^/]+/watchers$': Watchers,
r'issue/[^/]+/worklog/[^/]+$': Worklog,
r'issueLink/[^/]+$': IssueLink,
r'issueLinkType/[^/]+$': IssueLinkType,
r'issuetype/[^/]+$': IssueType,
r'priority/[^/]+$': Priority,
r'project/[^/]+$': Project,
r'project/[^/]+/role/[^/]+$': Role,
r'resolution/[^/]+$': Resolution,
r'securitylevel/[^/]+$': SecurityLevel,
r'status/[^/]+$': Status,
r'user\?username.+$': User,
r'version/[^/]+$': Version,
# GreenHopper specific resources
r'sprints/[^/]+$': Sprint,
r'views/[^/]+$': Board}
def cls_for_resource(resource_literal):
for resource in resource_class_map:
if re.search(resource, resource_literal):
return resource_class_map[resource]
else:
# Generic Resource without specialized update/delete behavior
return Resource
|