Source code for jira.client

#!/usr/bin/python
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from __future__ import print_function

from requests.auth import AuthBase

"""
This module implements a friendly (well, friendlier) interface between the raw JSON
responses from JIRA and the Resource/dict abstractions provided by this library. Users
will construct a JIRA object as described below. Full API documentation can be found
at: https://jira-python.readthedocs.org/en/latest/
"""
try:
    from functools import lru_cache
except ImportError:
    from functools32 import lru_cache
from functools import wraps

import imghdr
import mimetypes

import collections
import copy
import json
import logging
import os
import re
import tempfile
try:  # Python 2.7+
    from logging import NullHandler
except ImportError:
    class NullHandler(logging.Handler):

        def emit(self, record):
            pass
import calendar
import datetime
import hashlib
from numbers import Number
import requests
import sys
import time
import warnings

from requests.utils import get_netrc_auth
from six import iteritems
from six.moves.urllib.parse import urlparse

# GreenHopper specific resources
from jira.exceptions import JIRAError
from jira.resilientsession import raise_on_error
from jira.resilientsession import ResilientSession
# JIRA specific resources
from jira.resources import Attachment
from jira.resources import Board
from jira.resources import Comment
from jira.resources import Component
from jira.resources import Customer
from jira.resources import CustomFieldOption
from jira.resources import Dashboard
from jira.resources import Filter
from jira.resources import GreenHopperResource
from jira.resources import Issue
from jira.resources import IssueLink
from jira.resources import IssueLinkType
from jira.resources import IssueType
from jira.resources import Priority
from jira.resources import Project
from jira.resources import RemoteLink
from jira.resources import RequestType
from jira.resources import Resolution
from jira.resources import Resource
from jira.resources import Role
from jira.resources import SecurityLevel
from jira.resources import ServiceDesk
from jira.resources import Sprint
from jira.resources import Status
from jira.resources import StatusCategory
from jira.resources import User
from jira.resources import Version
from jira.resources import Votes
from jira.resources import Watchers
from jira.resources import Worklog

from jira import __version__
from jira.utils import CaseInsensitiveDict
from jira.utils import json_loads
from jira.utils import threaded_requests
from pkg_resources import parse_version

from collections import OrderedDict

from six import integer_types
from six import string_types

# six.moves does not play well with pyinstaller, see https://github.com/pycontribs/jira/issues/38
try:
    # noinspection PyUnresolvedReferences
    from requests_toolbelt import MultipartEncoder
except ImportError:
    pass

try:
    from requests_jwt import JWTAuth
except ImportError:
    pass

# warnings.simplefilter('default')

# encoding = sys.getdefaultencoding()
# if encoding != 'UTF8':
#    warnings.warning("Python default encoding is '%s' instead of 'UTF8' " \
#    "which means that there is a big change of having problems. " \
#    "Possible workaround http://stackoverflow.com/a/17628350/99834" % encoding)

logging.getLogger('jira').addHandler(NullHandler())


def translate_resource_args(func):
    """Decorator that converts Issue and Project resources to their keys when used as arguments."""
    @wraps(func)
    def wrapper(*args, **kwargs):
        """
        :type args: *Any
        :type kwargs: **Any
        :return: Any
        """
        arg_list = []
        for arg in args:
            if isinstance(arg, (Issue, Project)):
                arg_list.append(arg.key)
            else:
                arg_list.append(arg)
        result = func(*arg_list, **kwargs)
        return result

    return wrapper


def _field_worker(fields=None,
                  **fieldargs
                  ):
    """
    :type fields: Optional[Dict[str, Any]]
    :type fieldargs: **Any
    :return: Union[Dict[str, Dict[str, Any]], Dict[str, Dict[str, str]]]
    """
    if fields is not None:
        return {'fields': fields}
    return {'fields': fieldargs}


class ResultList(list):

    def __init__(self, iterable=None, _startAt=0, _maxResults=0, _total=0, _isLast=None):
        """
        :type iterable: Any
        :type _startAt: int
        :type _maxResults: int
        :type _total: int
        :type isLast: Optional[bool]
        """
        if iterable is not None:
            list.__init__(self, iterable)
        else:
            list.__init__(self)

        self.startAt = _startAt
        self.maxResults = _maxResults
        # Optional parameters:
        self.isLast = _isLast
        self.total = _total

        self.iterable = iterable or []
        self.current = self.startAt

    def __next__(self):
        """
        :return: int
        """
        self.current += 1
        if self.current > self.total:
            raise StopIteration
        else:
            return self.iterable[self.current - 1]
    # Python 2 and 3 compat
    next = __next__


class QshGenerator(object):

    def __init__(self, context_path):
        self.context_path = context_path

    def __call__(self, req):
        parse_result = urlparse(req.url)

        path = parse_result.path[len(self.context_path):] if len(self.context_path) > 1 else parse_result.path
        # Per Atlassian docs, use %20 for whitespace when generating qsh for URL
        # https://developer.atlassian.com/cloud/jira/platform/understanding-jwt/#qsh
        query = '&'.join(sorted(parse_result.query.split("&"))).replace('+', '%20')
        qsh = '%(method)s&%(path)s&%(query)s' % {'method': req.method.upper(), 'path': path, 'query': query}

        return hashlib.sha256(qsh.encode('utf-8')).hexdigest()


class JiraCookieAuth(AuthBase):
    """Jira Cookie Authentication

    Allows using cookie authentication as described by
    https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-cookie-based-authentication

    """

    def __init__(self, session, _get_session, auth):
        self._session = session
        self._get_session = _get_session
        self.__auth = auth

    def handle_401(self, response, **kwargs):
        if response.status_code != 401:
            return response
        self.init_session()
        response = self.process_original_request(response.request.copy())
        return response

    def process_original_request(self, original_request):
        self.update_cookies(original_request)
        return self.send_request(original_request)

    def update_cookies(self, original_request):
        # Cookie header needs first to be deleted for the header to be updated using
        # the prepare_cookies method. See request.PrepareRequest.prepare_cookies
        if 'Cookie' in original_request.headers:
            del original_request.headers['Cookie']
        original_request.prepare_cookies(self.cookies)

    def init_session(self):
        self.start_session()

    def __call__(self, request):
        request.register_hook('response', self.handle_401)
        return request

    def send_request(self, request):
        return self._session.send(request)

    @property
    def cookies(self):
        return self._session.cookies

    def start_session(self):
        self._get_session(self.__auth)


[docs]class JIRA(object): """User interface to JIRA. Clients interact with JIRA by constructing an instance of this object and calling its methods. For addressable resources in JIRA -- those with "self" links -- an appropriate subclass of :py:class:`Resource` will be returned with customized ``update()`` and ``delete()`` methods, along with attribute access to fields. This means that calls of the form ``issue.fields.summary`` will be resolved into the proper lookups to return the JSON value at that mapping. Methods that do not return resources will return a dict constructed from the JSON response or a scalar value; see each method's documentation for details on what that method returns. Without any arguments, this client will connect anonymously to the JIRA instance started by the Atlassian Plugin SDK from one of the 'atlas-run', ``atlas-debug``, or ``atlas-run-standalone`` commands. By default, this instance runs at ``http://localhost:2990/jira``. The ``options`` argument can be used to set the JIRA instance to use. Authentication is handled with the ``basic_auth`` argument. If authentication is supplied (and is accepted by JIRA), the client will remember it for subsequent requests. For quick command line access to a server, see the ``jirashell`` script included with this distribution. The easiest way to instantiate is using ``j = JIRA("https://jira.atlassian.com")`` :param options: Specify the server and properties this client will use. Use a dict with any of the following properties: * server -- the server address and context path to use. Defaults to ``http://localhost:2990/jira``. * rest_path -- the root REST path to use. Defaults to ``api``, where the JIRA REST resources live. * rest_api_version -- the version of the REST resources under rest_path to use. Defaults to ``2``. * agile_rest_path - the REST path to use for JIRA Agile requests. Defaults to ``greenhopper`` (old, private API). Check `GreenHopperResource` for other supported values. * verify -- Verify SSL certs. Defaults to ``True``. * client_cert -- a tuple of (cert,key) for the requests library for client side SSL * check_update -- Check whether using the newest python-jira library version. * cookies -- A dict of custom cookies that are sent in all requests to the server. :param basic_auth: A tuple of username and password to use when establishing a session via HTTP BASIC authentication. :param oauth: A dict of properties for OAuth authentication. The following properties are required: * access_token -- OAuth access token for the user * access_token_secret -- OAuth access token secret to sign with the key * consumer_key -- key of the OAuth application link defined in JIRA * key_cert -- private key file to sign requests with (should be the pair of the public key supplied to JIRA in the OAuth application link) :param kerberos: If true it will enable Kerberos authentication. :param kerberos_options: A dict of properties for Kerberos authentication. The following properties are possible: * mutual_authentication -- string DISABLED or OPTIONAL. Example kerberos_options structure: ``{'mutual_authentication': 'DISABLED'}`` :param jwt: A dict of properties for JWT authentication supported by Atlassian Connect. The following properties are required: * secret -- shared secret as delivered during 'installed' lifecycle event (see https://developer.atlassian.com/static/connect/docs/latest/modules/lifecycle.html for details) * payload -- dict of fields to be inserted in the JWT payload, e.g. 'iss' Example jwt structure: ``{'secret': SHARED_SECRET, 'payload': {'iss': PLUGIN_KEY}}`` :param validate: If true it will validate your credentials first. Remember that if you are accessing JIRA as anonymous it will fail to instantiate. :param get_server_info: If true it will fetch server version info first to determine if some API calls are available. :param async_: To enable asynchronous requests for those actions where we implemented it, like issue update() or delete(). :param async_workers: Set the number of worker threads for async operations. :param timeout: Set a read/connect timeout for the underlying calls to JIRA (default: None) Obviously this means that you cannot rely on the return code when this is enabled. """ DEFAULT_OPTIONS = { "server": "http://localhost:2990/jira", "auth_url": '/rest/auth/1/session', "context_path": "/", "rest_path": "api", "rest_api_version": "2", "agile_rest_path": GreenHopperResource.GREENHOPPER_REST_PATH, "agile_rest_api_version": "1.0", "verify": True, "resilient": True, "async": False, "async_workers": 5, "client_cert": None, "check_update": False, # amount of seconds to wait for loading a resource after updating it # used to avoid server side caching issues, used to be 4 seconds. "delay_reload": 0, "headers": { 'Cache-Control': 'no-cache', # 'Accept': 'application/json;charset=UTF-8', # default for REST 'Content-Type': 'application/json', # ;charset=UTF-8', # 'Accept': 'application/json', # default for REST # 'Pragma': 'no-cache', # 'Expires': 'Thu, 01 Jan 1970 00:00:00 GMT' 'X-Atlassian-Token': 'no-check'}} checked_version = False # TODO(ssbarnea): remove these two variables and use the ones defined in resources JIRA_BASE_URL = Resource.JIRA_BASE_URL AGILE_BASE_URL = GreenHopperResource.AGILE_BASE_URL def __init__(self, server=None, options=None, basic_auth=None, oauth=None, jwt=None, kerberos=False, kerberos_options=None, validate=False, get_server_info=True, async_=False, async_workers=5, logging=True, max_retries=3, proxies=None, timeout=None, auth=None, ): """Construct a JIRA client instance. Without any arguments, this client will connect anonymously to the JIRA instance started by the Atlassian Plugin SDK from one of the 'atlas-run', ``atlas-debug``, or ``atlas-run-standalone`` commands. By default, this instance runs at ``http://localhost:2990/jira``. The ``options`` argument can be used to set the JIRA instance to use. Authentication is handled with the ``basic_auth`` argument. If authentication is supplied (and is accepted by JIRA), the client will remember it for subsequent requests. For quick command line access to a server, see the ``jirashell`` script included with this distribution. The easiest way to instantiate is using j = JIRA("https://jira.atlasian.com") :param server: The server address and context path to use. Defaults to ``http://localhost:2990/jira``. :type server: Optional[str] :param options: Specify the server and properties this client will use. Use a dict with any of the following properties: * server -- the server address and context path to use. Defaults to ``http://localhost:2990/jira``. * rest_path -- the root REST path to use. Defaults to ``api``, where the JIRA REST resources live. * rest_api_version -- the version of the REST resources under rest_path to use. Defaults to ``2``. * agile_rest_path - the REST path to use for JIRA Agile requests. Defaults to ``greenhopper`` (old, private API). Check `GreenHopperResource` for other supported values. * verify -- Verify SSL certs. Defaults to ``True``. * client_cert -- a tuple of (cert,key) for the requests library for client side SSL * check_update -- Check whether using the newest python-jira library version. :type options: Optional[Dict[str, Any]] :param basic_auth: A tuple of username and password to use when establishing a session via HTTP BASIC authentication. :type basic_auth: Union[Dict, None, Tuple[str, str]] :param oauth: A dict of properties for OAuth authentication. The following properties are required: * access_token -- OAuth access token for the user * access_token_secret -- OAuth access token secret to sign with the key * consumer_key -- key of the OAuth application link defined in JIRA * key_cert -- private key file to sign requests with (should be the pair of the public key supplied to JIRA in the OAuth application link) :type oauth: Optional[Any] :param kerberos: If true it will enable Kerberos authentication. :type kerberos: bool :param kerberos_options: A dict of properties for Kerberos authentication. The following properties are possible: * mutual_authentication -- string DISABLED or OPTIONAL. Example kerberos_options structure: ``{'mutual_authentication': 'DISABLED'}`` :type kerberos_options: Optional[Dict[str,str]] :param jwt: A dict of properties for JWT authentication supported by Atlassian Connect. The following properties are required: * secret -- shared secret as delivered during 'installed' lifecycle event (see https://developer.atlassian.com/static/connect/docs/latest/modules/lifecycle.html for details) * payload -- dict of fields to be inserted in the JWT payload, e.g. 'iss' Example jwt structure: ``{'secret': SHARED_SECRET, 'payload': {'iss': PLUGIN_KEY}}`` :type jwt: Optional[Any] :param validate: If true it will validate your credentials first. Remember that if you are accessing JIRA as anonymous it will fail to instantiate. :type validate: bool :param get_server_info: If true it will fetch server version info first to determine if some API calls are available. :type get_server_info: bool :param async_: To enable async requests for those actions where we implemented it, like issue update() or delete(). :type async_: bool :param async_workers: Set the number of worker threads for async operations. :type async_workers: int :param timeout: Set a read/connect timeout for the underlying calls to JIRA (default: None) :type timeout: Optional[Any] Obviously this means that you cannot rely on the return code when this is enabled. :param max_retries: Sets the amount Retries for the HTTP sessions initiated by the client. (Default: 3) :type max_retries: int :param proxies: Sets the proxies for the HTTP session. :type proxies: Optional[Any] :param auth: Set a cookie auth token if this is required. :type auth: Optional[Tuple[str,str]] :param logging: Determine whether or not logging should be enabled. (Default: True) :type logging: bool """ # force a copy of the tuple to be used in __del__() because # sys.version_info could have already been deleted in __del__() self.sys_version_info = tuple([i for i in sys.version_info]) if options is None: options = {} if server and hasattr(server, 'keys'): warnings.warn( "Old API usage, use JIRA(url) or JIRA(options={'server': url}, when using dictionary always use named parameters.", DeprecationWarning) options = server server = None if server: options['server'] = server if async_: options['async'] = async_ options['async_workers'] = async_workers self.logging = logging self._options = copy.copy(JIRA.DEFAULT_OPTIONS) self._options.update(options) self._rank = None # Rip off trailing slash since all urls depend on that if self._options['server'].endswith('/'): self._options['server'] = self._options['server'][:-1] context_path = urlparse(self._options['server']).path if len(context_path) > 0: self._options['context_path'] = context_path self._try_magic() if oauth: self._create_oauth_session(oauth, timeout) elif basic_auth: self._create_http_basic_session(*basic_auth, timeout=timeout) self._session.headers.update(self._options['headers']) elif jwt: self._create_jwt_session(jwt, timeout) elif kerberos: self._create_kerberos_session(timeout, kerberos_options=kerberos_options) elif auth: self._create_cookie_auth(auth, timeout) validate = True # always log in for cookie based auth, as we need a first request to be logged in else: verify = self._options['verify'] self._session = ResilientSession(timeout=timeout) self._session.verify = verify self._session.headers.update(self._options['headers']) if 'cookies' in self._options: self._session.cookies.update(self._options['cookies']) self._session.max_retries = max_retries if proxies: self._session.proxies = proxies if validate: # This will raise an Exception if you are not allowed to login. # It's better to fail faster than later. user = self.session(auth) if user.raw is None: auth_method = ( oauth or basic_auth or jwt or kerberos or auth or "anonymous" ) raise JIRAError("Can not log in with %s" % str(auth_method)) self.deploymentType = None if get_server_info: # We need version in order to know what API calls are available or not si = self.server_info() try: self._version = tuple(si['versionNumbers']) except Exception as e: logging.error("invalid server_info: %s", si) raise e self.deploymentType = si.get('deploymentType') else: self._version = (0, 0, 0) if self._options['check_update'] and not JIRA.checked_version: self._check_update_() JIRA.checked_version = True self._fields = {} for f in self.fields(): if 'clauseNames' in f: for name in f['clauseNames']: self._fields[name] = f['id'] def _create_cookie_auth(self, auth, timeout): self._session = ResilientSession(timeout=timeout) self._session.auth = JiraCookieAuth(self._session, self.session, auth) self._session.verify = self._options['verify'] self._session.cert = self._options['client_cert'] def _check_update_(self): """Check if the current version of the library is outdated.""" try: data = requests.get("https://pypi.python.org/pypi/jira/json", timeout=2.001).json() released_version = data['info']['version'] if parse_version(released_version) > parse_version(__version__): warnings.warn( "You are running an outdated version of JIRA Python %s. Current version is %s. Do not file any bugs against older versions." % ( __version__, released_version)) except requests.RequestException: pass except Exception as e: logging.warning(e) def __del__(self): """Destructor for JIRA instance.""" self.close()
[docs] def close(self): session = getattr(self, "_session", None) if session is not None: try: session.close() except TypeError: # TypeError: "'NoneType' object is not callable" # Could still happen here because other references are also # in the process to be torn down, see warning section in # https://docs.python.org/2/reference/datamodel.html#object.__del__ pass self._session = None
def _check_for_html_error(self, content): # JIRA has the bad habit of returning errors in pages with 200 and # embedding the error in a huge webpage. if '<!-- SecurityTokenMissing -->' in content: logging.warning("Got SecurityTokenMissing") raise JIRAError("SecurityTokenMissing: %s" % content) return False return True def _get_sprint_field_id(self): sprint_field_name = "Sprint" sprint_field_id = [f['schema']['customId'] for f in self.fields() if f['name'] == sprint_field_name][0] return sprint_field_id def _fetch_pages(self, item_type, items_key, request_path, startAt=0, maxResults=50, params=None, base=JIRA_BASE_URL, ): """Fetch pages. :param item_type: Type of single item. ResultList of such items will be returned. :type item_type: type :param items_key: Path to the items in JSON returned from server. Set it to None, if response is an array, and not a JSON object. :type items_key: Optional[str] :param request_path: path in request URL :type request_path: str :param startAt: index of the first record to be fetched. (Default: 0) :type startAt: int :param maxResults: Maximum number of items to return. If maxResults evaluates as False, it will try to get all items in batches. (Default:50) :type maxResults: int :param params: Params to be used in all requests. Should not contain startAt and maxResults, as they will be added for each request created from this function. :type params: Dict[str, Any] :param base: base URL :type base: str :rtype: ResultList """ async_class = None if self._options['async']: try: from requests_futures.sessions import FuturesSession async_class = FuturesSession except ImportError: pass async_workers = self._options['async_workers'] page_params = params.copy() if params else {} if startAt: page_params['startAt'] = startAt if maxResults: page_params['maxResults'] = maxResults resource = self._get_json(request_path, params=page_params, base=base) next_items_page = self._get_items_from_page(item_type, items_key, resource) items = next_items_page if True: # isinstance(resource, dict): if isinstance(resource, dict): total = resource.get('total') # 'isLast' is the optional key added to responses in JIRA Agile 6.7.6. So far not used in basic JIRA API. is_last = resource.get('isLast', False) start_at_from_response = resource.get('startAt', 0) max_results_from_response = resource.get('maxResults', 1) else: # if is a list total = 1 is_last = True start_at_from_response = 0 max_results_from_response = 1 # If maxResults evaluates as False, get all items in batches if not maxResults: page_size = max_results_from_response or len(items) page_start = (startAt or start_at_from_response or 0) + page_size if async_class is not None and not is_last and ( total is not None and len(items) < total): async_fetches = [] future_session = async_class(session=self._session, max_workers=async_workers) for start_index in range(page_start, total, page_size): page_params = params.copy() page_params['startAt'] = start_index page_params['maxResults'] = page_size url = self._get_url(request_path) r = future_session.get(url, params=page_params) async_fetches.append(r) for future in async_fetches: response = future.result() resource = json_loads(response) if resource: next_items_page = self._get_items_from_page( item_type, items_key, resource) items.extend(next_items_page) while async_class is None and not is_last and ( total is None or page_start < total) and len( next_items_page) == page_size: page_params['startAt'] = page_start page_params['maxResults'] = page_size resource = self._get_json(request_path, params=page_params, base=base) if resource: next_items_page = self._get_items_from_page( item_type, items_key, resource) items.extend(next_items_page) page_start += page_size else: # if resource is an empty dictionary we assume no-results break return ResultList(items, start_at_from_response, max_results_from_response, total, is_last) else: # it seams that search_users can return a list() containing a single user! return ResultList([item_type(self._options, self._session, resource)], 0, 1, 1, True) def _get_items_from_page(self, item_type, items_key, resource, ): """ :type item_type: type :type items_key: str :type resource: Dict[str, Any] :rtype: Union[List[Dashboard], List[Issue]] """ try: return [item_type(self._options, self._session, raw_issue_json) for raw_issue_json in (resource[items_key] if items_key else resource)] except KeyError as e: # improving the error text so we know why it happened raise KeyError(str(e) + " : " + json.dumps(resource)) # Information about this client
[docs] def client_info(self): """Get the server this client is connected to.""" return self._options['server']
# Universal resource loading
[docs] def find(self, resource_format, ids=None): """Find Resource object for any addressable resource on the server. This method is a universal resource locator for any REST-ful resource in JIRA. The argument ``resource_format`` is a string of the form ``resource``, ``resource/{0}``, ``resource/{0}/sub``, ``resource/{0}/sub/{1}``, etc. The format placeholders will be populated from the ``ids`` argument if present. The existing authentication session will be used. The return value is an untyped Resource object, which will not support specialized :py:meth:`.Resource.update` or :py:meth:`.Resource.delete` behavior. Moreover, it will not know to return an issue Resource if the client uses the resource issue path. For this reason, it is intended to support resources that are not included in the standard Atlassian REST API. :param resource_format: the subpath to the resource string :type resource_format: str :param ids: values to substitute in the ``resource_format`` string :type ids: tuple or None :rtype: Resource """ resource = Resource(resource_format, self._options, self._session) resource.find(ids) return resource
[docs] def async_do(self, size=10): """Execute all asynchronous jobs and wait for them to finish. By default it will run on 10 threads. :param size: number of threads to run on. """ if hasattr(self._session, '_async_jobs'): logging.info("Executing asynchronous %s jobs found in queue by using %s threads..." % ( len(self._session._async_jobs), size)) threaded_requests.map(self._session._async_jobs, size=size)
# Application properties # non-resource
[docs] def application_properties(self, key=None): """Return the mutable server application properties. :param key: the single property to return a value for :type key: Optional[str] :rtype: Union[Dict[str, str], List[Dict[str, str]]] """ params = {} if key is not None: params['key'] = key return self._get_json('application-properties', params=params)
[docs] def set_application_property(self, key, value): """Set the application property. :param key: key of the property to set :type key: str :param value: value to assign to the property :type value: str """ url = self._options['server'] + \ '/rest/api/latest/application-properties/' + key payload = { 'id': key, 'value': value} return self._session.put( url, data=json.dumps(payload))
# Attachments
[docs] def attachment(self, id): """Get an attachment Resource from the server for the specified ID. :param id: The Attachment ID :type id: str :rtype: Attachment """ return self._find_for_resource(Attachment, id)
# non-resource
[docs] def attachment_meta(self): """Get the attachment metadata. :rtype: Dict[str, int] """ return self._get_json('attachment/meta')
[docs] @translate_resource_args def add_attachment(self, issue, attachment, filename=None): """Attach an attachment to an issue and returns a Resource for it. The client will *not* attempt to open or validate the attachment; it expects a file-like object to be ready for its use. The user is still responsible for tidying up (e.g., closing the file, killing the socket, etc.) :param issue: the issue to attach the attachment to :type issue: str :param attachment: file-like object to attach to the issue, also works if it is a string with the filename. :type attachment: BufferedReader :param filename: optional name for the attached file. If omitted, the file object's ``name`` attribute is used. If you acquired the file-like object by any other method than ``open()``, make sure that a name is specified in one way or the other. :type filename: str :rtype: Attachment """ if isinstance(attachment, string_types): attachment = open(attachment, "rb") if hasattr(attachment, 'read') and hasattr(attachment, 'mode') and attachment.mode != 'rb': logging.warning( "%s was not opened in 'rb' mode, attaching file may fail." % attachment.name) url = self._get_url('issue/' + str(issue) + '/attachments') fname = filename if not fname: fname = os.path.basename(attachment.name) if 'MultipartEncoder' not in globals(): method = 'old' r = self._session.post( url, files={ 'file': (fname, attachment, 'application/octet-stream')}, headers=CaseInsensitiveDict({'content-type': None, 'X-Atlassian-Token': 'nocheck'})) else: method = 'MultipartEncoder' def file_stream(): """Returns files stream of attachment. :rtype: MultipartEncoder """ return MultipartEncoder( fields={ 'file': (fname, attachment, 'application/octet-stream')}) m = file_stream() r = self._session.post( url, data=m, headers=CaseInsensitiveDict({'content-type': m.content_type, 'X-Atlassian-Token': 'nocheck'}), retry_data=file_stream) js = json_loads(r) if not js or not isinstance(js, collections.Iterable): raise JIRAError("Unable to parse JSON: %s" % js) attachment = Attachment(self._options, self._session, js[0]) if attachment.size == 0: raise JIRAError("Added empty attachment via %s method?!: r: %s\nattachment: %s" % (method, r, attachment)) return attachment
[docs] def delete_attachment(self, id): """Delete attachment by id. :param id: ID of the attachment to delete :type id: str """ url = self._get_url('attachment/' + str(id)) return self._session.delete(url)
# Components
[docs] def component(self, id): """Get a component Resource from the server. :param id: ID of the component to get :type id: str """ return self._find_for_resource(Component, id)
[docs] @translate_resource_args def create_component(self, name, project, description=None, leadUserName=None, assigneeType=None, isAssigneeTypeValid=False, ): """Create a component inside a project and return a Resource for it. :param name: name of the component :type name: str :param project: key of the project to create the component in :type project: str :param description: a description of the component :type description: str :param leadUserName: the username of the user responsible for this component :type leadUserName: Optional[str] :param assigneeType: see the ComponentBean.AssigneeType class for valid values :type assigneeType: Optional[str] :param isAssigneeTypeValid: boolean specifying whether the assignee type is acceptable (Default: False) :type isAssigneeTypeValid: bool :rtype: Component """ data = { 'name': name, 'project': project, 'isAssigneeTypeValid': isAssigneeTypeValid} if description is not None: data['description'] = description if leadUserName is not None: data['leadUserName'] = leadUserName if assigneeType is not None: data['assigneeType'] = assigneeType url = self._get_url('component') r = self._session.post( url, data=json.dumps(data)) component = Component(self._options, self._session, raw=json_loads(r)) return component
[docs] def delete_component(self, id): """Delete component by id. :param id: ID of the component to use :type id: str :rtype: Response """ url = self._get_url('component/' + str(id)) return self._session.delete(url)
# Custom field options
[docs] def custom_field_option(self, id): """Get a custom field option Resource from the server. :param id: ID of the custom field to use :type id: str :rtype: CustomFieldOption """ return self._find_for_resource(CustomFieldOption, id)
# Dashboards
[docs] def dashboards(self, filter=None, startAt=0, maxResults=20): """Return a ResultList of Dashboard resources and a ``total`` count. :param filter: either "favourite" or "my", the type of dashboards to return :type filter: Optional[str] :param startAt: index of the first dashboard to return (Default: 0) :type startAt: int :param maxResults: maximum number of dashboards to return. If maxResults evaluates as False, it will try to get all items in batches. (Default: 20) :type maxResults: int :rtype: ResultList """ params = {} if filter is not None: params['filter'] = filter return self._fetch_pages(Dashboard, 'dashboards', 'dashboard', startAt, maxResults, params)
[docs] def dashboard(self, id): """Get a dashboard Resource from the server. :param id: ID of the dashboard to get. :type id: str :rtype: Dashboard """ return self._find_for_resource(Dashboard, id)
# Fields # non-resource
[docs] def fields(self): """Return a list of all issue fields. :rtype: List[Dict[str, Any]] """ return self._get_json('field')
# Filters
[docs] def filter(self, id): """Get a filter Resource from the server. :param id: ID of the filter to get. :type id: str :rtype: Filter """ return self._find_for_resource(Filter, id)
[docs] def favourite_filters(self): """Get a list of filter Resources which are the favourites of the currently authenticated user. :rtype: List[Filter] """ r_json = self._get_json('filter/favourite') filters = [Filter(self._options, self._session, raw_filter_json) for raw_filter_json in r_json] return filters
[docs] def create_filter(self, name=None, description=None, jql=None, favourite=None): """Create a new filter and return a filter Resource for it. :param name: name of the new filter :type name: str :param description: useful human readable description of the new filter :type description: str :param jql: query string that defines the filter :type jql: str :param favourite: whether to add this filter to the current user's favorites :type favourite: bool :rtype: Filter """ data = {} if name is not None: data['name'] = name if description is not None: data['description'] = description if jql is not None: data['jql'] = jql if favourite is not None: data['favourite'] = favourite url = self._get_url('filter') r = self._session.post( url, data=json.dumps(data)) raw_filter_json = json_loads(r) return Filter(self._options, self._session, raw=raw_filter_json)
[docs] def update_filter(self, filter_id, name=None, description=None, jql=None, favourite=None): """Update a filter and return a filter Resource for it. :param name: name of the new filter :type name: Optional[str] :param description: useful human readable description of the new filter :type description: Optional[str] :param jql: query string that defines the filter :type jql: Optional[str] :param favourite: whether to add this filter to the current user's favorites :type favourite: Optional[bool] """ filter = self.filter(filter_id) data = {} data['name'] = name or filter.name data['description'] = description or filter.description data['jql'] = jql or filter.jql data['favourite'] = favourite or filter.favourite url = self._get_url('filter/%s' % filter_id) r = self._session.put(url, headers={'content-type': 'application/json'}, data=json.dumps(data)) raw_filter_json = json.loads(r.text) return Filter(self._options, self._session, raw=raw_filter_json)
# Groups # non-resource
[docs] def groups(self, query=None, exclude=None, maxResults=9999): """Return a list of groups matching the specified criteria. :param query: filter groups by name with this string :type query: Optional[str] :param exclude: filter out groups by name with this string :type exclude: Optional[Any] :param maxResults: maximum results to return. (Default: 9999) :type maxResults: int :rtype: List[str] """ params = {} groups = [] if query is not None: params['query'] = query if exclude is not None: params['exclude'] = exclude if maxResults is not None: params['maxResults'] = maxResults for group in self._get_json('groups/picker', params=params)['groups']: groups.append(group['name']) return sorted(groups)
[docs] def group_members(self, group): """Return a hash or users with their information. Requires JIRA 6.0 or will raise NotImplemented. :param group: Name of the group. :type group: str """ if self._version < (6, 0, 0): raise NotImplementedError( "Group members is not implemented in JIRA before version 6.0, upgrade the instance, if possible.") params = {'groupname': group, 'expand': "users"} r = self._get_json('group', params=params) size = r['users']['size'] end_index = r['users']['end-index'] while end_index < size - 1: params = {'groupname': group, 'expand': "users[%s:%s]" % ( end_index + 1, end_index + 50)} r2 = self._get_json('group', params=params) for user in r2['users']['items']: r['users']['items'].append(user) end_index = r2['users']['end-index'] size = r['users']['size'] result = {} for user in r['users']['items']: result[user['key']] = {'name': user['name'], 'fullname': user['displayName'], 'email': user.get('emailAddress', 'hidden'), 'active': user['active']} return OrderedDict(sorted(result.items(), key=lambda t: t[0]))
[docs] def add_group(self, groupname): """Create a new group in JIRA. :param groupname: The name of the group you wish to create. :type groupname: str :return: Boolean - True if successful. :rtype: bool """ url = self._options['server'] + '/rest/api/latest/group' # implementation based on # https://docs.atlassian.com/jira/REST/ondemand/#d2e5173 x = OrderedDict() x['name'] = groupname payload = json.dumps(x) self._session.post(url, data=payload) return True
[docs] def remove_group(self, groupname): """Delete a group from the JIRA instance. :param groupname: The group to be deleted from the JIRA instance. :type groupname: str :return: Boolean. Returns True on success. :rtype: bool """ # implementation based on # https://docs.atlassian.com/jira/REST/ondemand/#d2e5173 url = self._options['server'] + '/rest/api/latest/group' x = {'groupname': groupname} self._session.delete(url, params=x) return True
# Issues
[docs] def issue(self, id, fields=None, expand=None): """Get an issue Resource from the server. :param id: ID or key of the issue to get :type id: Union[Issue, str] :param fields: comma-separated string of issue fields to include in the results :type fields: Optional[str] :param expand: extra information to fetch inside each resource :type expand: Optional[str] :rtype: Issue """ # this allows us to pass Issue objects to issue() if isinstance(id, Issue): return id issue = Issue(self._options, self._session) params = {} if fields is not None: params['fields'] = fields if expand is not None: params['expand'] = expand issue.find(id, params=params) return issue
[docs] def create_issue(self, fields=None, prefetch=True, **fieldargs): """Create a new issue and return an issue Resource for it. 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. By default, the client will immediately reload the issue Resource created by this method in order to return a complete Issue object to the caller; this behavior can be controlled through the 'prefetch' argument. JIRA projects may contain many different issue types. Some issue screens have different requirements for fields in a new issue. This information is available through the 'createmeta' method. Further examples are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Create+Issue :param fields: a dict containing field names and the values to use. If present, all other keyword arguments will be ignored :type fields: Optional[Dict[str, Any]] :param prefetch: whether to reload the created issue Resource so that all of its data is present in the value returned from this method :type prefetch: bool :rtype: Issue """ data = _field_worker(fields, **fieldargs) p = data['fields']['project'] if isinstance(p, string_types) or isinstance(p, integer_types): data['fields']['project'] = {'id': self.project(p).id} p = data['fields']['issuetype'] if isinstance(p, integer_types): data['fields']['issuetype'] = {'id': p} if isinstance(p, string_types) or isinstance(p, integer_types): data['fields']['issuetype'] = {'id': self.issue_type_by_name(p).id} url = self._get_url('issue') r = self._session.post(url, data=json.dumps(data)) raw_issue_json = json_loads(r) if 'key' not in raw_issue_json: raise JIRAError(r.status_code, response=r, url=url, text=json.dumps(data)) if prefetch: return self.issue(raw_issue_json['key']) else: return Issue(self._options, self._session, raw=raw_issue_json)
[docs] def create_issues(self, field_list, prefetch=True): """Bulk create new issues and return an issue Resource for each successfully created issue. See `create_issue` documentation for field information. :param field_list: a list of dicts each containing field names and the values to use. Each dict is an individual issue to create and is subject to its minimum requirements. :type field_list: List[Dict[str, Any]] :param prefetch: whether to reload the created issue Resource for each created issue so that all of its data is present in the value returned from this method. :type prefetch: bool :rtype: List[Dict[str, Any]] """ data = {'issueUpdates': []} for field_dict in field_list: issue_data = _field_worker(field_dict) p = issue_data['fields']['project'] if isinstance(p, string_types) or isinstance(p, integer_types): issue_data['fields']['project'] = {'id': self.project(p).id} p = issue_data['fields']['issuetype'] if isinstance(p, integer_types): issue_data['fields']['issuetype'] = {'id': p} if isinstance(p, string_types) or isinstance(p, integer_types): issue_data['fields']['issuetype'] = {'id': self.issue_type_by_name(p).id} data['issueUpdates'].append(issue_data) url = self._get_url('issue/bulk') try: r = self._session.post(url, data=json.dumps(data)) raw_issue_json = json_loads(r) # Catching case where none of the issues has been created. See https://github.com/pycontribs/jira/issues/350 except JIRAError as je: if je.status_code == 400: raw_issue_json = json.loads(je.response.text) else: raise issue_list = [] errors = {} for error in raw_issue_json['errors']: errors[error['failedElementNumber']] = error['elementErrors']['errors'] for index, fields in enumerate(field_list): if index in errors: issue_list.append({'status': 'Error', 'error': errors[index], 'issue': None, 'input_fields': fields}) else: issue = raw_issue_json['issues'].pop(0) if prefetch: issue = self.issue(issue['key']) else: issue = Issue(self._options, self._session, raw=issue) issue_list.append({'status': 'Success', 'issue': issue, 'error': None, 'input_fields': fields}) return issue_list
[docs] def supports_service_desk(self): """Returns whether or not the JIRA instance supports service desk. :rtype: bool """ url = self._options['server'] + '/rest/servicedeskapi/info' headers = {'X-ExperimentalApi': 'opt-in'} try: r = self._session.get(url, headers=headers) return r.status_code == 200 except JIRAError: return False
[docs] def create_customer(self, email, displayName): """Create a new customer and return an issue Resource for it. :param email: Customer Email :type email: str :param displayName: Customer display name :type displayName: str :rtype: Customer """ url = self._options['server'] + '/rest/servicedeskapi/customer' headers = {'X-ExperimentalApi': 'opt-in'} r = self._session.post(url, headers=headers, data=json.dumps({ 'email': email, 'displayName': displayName })) raw_customer_json = json_loads(r) if r.status_code != 201: raise JIRAError(r.status_code, request=r) return Customer(self._options, self._session, raw=raw_customer_json)
[docs] def service_desks(self): """Get a list of ServiceDesk Resources from the server visible to the current authenticated user. :rtype: List[ServiceDesk] """ url = self._options['server'] + '/rest/servicedeskapi/servicedesk' headers = {'X-ExperimentalApi': 'opt-in'} r_json = json_loads(self._session.get(url, headers=headers)) projects = [ServiceDesk(self._options, self._session, raw_project_json) for raw_project_json in r_json['values']] return projects
[docs] def service_desk(self, id): """Get a Service Desk Resource from the server. :param id: ID or key of the Service Desk to get :type id: str :rtype: ServiceDesk """ return self._find_for_resource(ServiceDesk, id)
[docs] def create_customer_request(self, fields=None, prefetch=True, **fieldargs): """Create a new customer request and return an issue Resource for it. 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. By default, the client will immediately reload the issue Resource created by this method in order to return a complete Issue object to the caller; this behavior can be controlled through the 'prefetch' argument. JIRA projects may contain many different issue types. Some issue screens have different requirements for fields in a new issue. This information is available through the 'createmeta' method. Further examples are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Create+Issue :param fields: a dict containing field names and the values to use. If present, all other keyword arguments will be ignored :type fields: Dict[str, Any] :param prefetch: whether to reload the created issue Resource so that all of its data is present in the value returned from this method :type prefetch: bool :rtype: Issue """ data = fields p = data['serviceDeskId'] service_desk = None if isinstance(p, string_types) or isinstance(p, integer_types): service_desk = self.service_desk(p) elif isinstance(p, ServiceDesk): service_desk = p data['serviceDeskId'] = service_desk.id p = data['requestTypeId'] if isinstance(p, integer_types): data['requestTypeId'] = p elif isinstance(p, string_types): data['requestTypeId'] = self.request_type_by_name( service_desk, p).id url = self._options['server'] + '/rest/servicedeskapi/request' headers = {'X-ExperimentalApi': 'opt-in'} r = self._session.post(url, headers=headers, data=json.dumps(data)) raw_issue_json = json_loads(r) if 'issueKey' not in raw_issue_json: raise JIRAError(r.status_code, request=r) if prefetch: return self.issue(raw_issue_json['issueKey']) else: return Issue(self._options, self._session, raw=raw_issue_json)
[docs] def createmeta(self, projectKeys=None, projectIds=[], issuetypeIds=None, issuetypeNames=None, expand=None, ): """Get the metadata required to create issues, optionally filtered by projects and issue types. :param projectKeys: keys of the projects to filter the results with. Can be a single value or a comma-delimited string. May be combined with projectIds. :type projectKeys: Union[None, Tuple[str, str], str] :param projectIds: IDs of the projects to filter the results with. Can be a single value or a comma-delimited string. May be combined with projectKeys. :type projectIds: Union[List, Tuple[str, str]] :param issuetypeIds: IDs of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeNames. :type issuetypeIds: Optional[List[str]] :param issuetypeNames: Names of the issue types to filter the results with. Can be a single value or a comma-delimited string. May be combined with issuetypeIds. :type issuetypeNames: Optional[str] :param expand: extra information to fetch inside each resource. :type expand: Optional[str] :rtype: Dict[str, Any] """ params = {} if projectKeys is not None: params['projectKeys'] = projectKeys if projectIds is not None: if isinstance(projectIds, string_types): projectIds = projectIds.split(',') params['projectIds'] = projectIds if issuetypeIds is not None: params['issuetypeIds'] = issuetypeIds if issuetypeNames is not None: params['issuetypeNames'] = issuetypeNames if expand is not None: params['expand'] = expand return self._get_json('issue/createmeta', params)
# non-resource
[docs] @translate_resource_args def assign_issue(self, issue, assignee): """Assign an issue to a user. None will set it to unassigned. -1 will set it to Automatic. :param issue: the issue ID or key to assign :type issue: int or str :param assignee: the user to assign the issue to :type assignee: str :rtype: bool """ url = self._options['server'] + \ '/rest/api/latest/issue/' + str(issue) + '/assignee' payload = {'name': assignee} r = self._session.put( url, data=json.dumps(payload)) raise_on_error(r) return True
[docs] @translate_resource_args def comments(self, issue): """Get a list of comment Resources. :param issue: the issue to get comments from :type issue: str :rtype: List[Comment] """ r_json = self._get_json('issue/' + str(issue) + '/comment') comments = [Comment(self._options, self._session, raw_comment_json) for raw_comment_json in r_json['comments']] return comments
[docs] @translate_resource_args def comment(self, issue, comment): """Get a comment Resource from the server for the specified ID. :param issue: ID or key of the issue to get the comment from :param comment: ID of the comment to get """ return self._find_for_resource(Comment, (issue, comment))
[docs] @translate_resource_args def add_comment(self, issue, body, visibility=None, is_internal=False): """Add a comment from the current authenticated user on the specified issue and return a Resource for it. The issue identifier and comment body are required. :param issue: ID or key of the issue to add the comment to :type issue: str :param body: Text of the comment to add :type body: str :param visibility: a dict containing two entries: "type" and "value". "type" is 'role' (or 'group' if the JIRA server has configured comment visibility for groups) and 'value' is the name of the role (or group) to which viewing of this comment will be restricted. :type visibility: Optional[Dict[str, str]] :param is_internal: Defines whether a comment has to be marked as 'Internal' in Jira Service Desk (Default: False) :type is_internal: bool :rtype: Comment """ data = { 'body': body, } if is_internal: data.update({ 'properties': [ {'key': 'sd.public.comment', 'value': {'internal': is_internal}} ] }) if visibility is not None: data['visibility'] = visibility url = self._get_url('issue/' + str(issue) + '/comment') r = self._session.post( url, data=json.dumps(data) ) comment = Comment(self._options, self._session, raw=json_loads(r)) return comment
# non-resource
[docs] @translate_resource_args def editmeta(self, issue): """Get the edit metadata for an issue. :param issue: the issue to get metadata for :rtype: Dict[str, Dict[str, Dict[str, Any]]] """ return self._get_json('issue/' + str(issue) + '/editmeta')
# removed the @translate_resource_args because it prevents us from finding # information for building a proper link # non-resource
[docs] @translate_resource_args def transitions(self, issue, id=None, expand=None): """Get a list of the transitions available on the specified issue to the current user. :param issue: ID or key of the issue to get the transitions from :param id: if present, get only the transition matching this ID :param expand: extra information to fetch inside each transition """ params = {} if id is not None: params['transitionId'] = id if expand is not None: params['expand'] = expand return self._get_json('issue/' + str(issue) + '/transitions', params=params)['transitions']
[docs] def find_transitionid_by_name(self, issue, transition_name): """Get a transitionid available on the specified issue to the current user. Look at https://developer.atlassian.com/static/rest/jira/6.1.html#d2e1074 for json reference :param issue: ID or key of the issue to get the transitions from :param trans_name: iname of transition we are looking for """ transitions_json = self.transitions(issue) id = None for transition in transitions_json: if transition["name"].lower() == transition_name.lower(): id = transition["id"] break return id
[docs] @translate_resource_args def transition_issue(self, issue, transition, fields=None, comment=None, worklog=None, **fieldargs): """Perform a transition on an issue. 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. Field values will be set on the issue as part of the transition process. :param issue: ID or key of the issue to perform the transition on :param transition: ID or name of the transition to perform :param comment: *Optional* String to add as comment to the issue when performing the transition. :param fields: a dict containing field names and the values to use. If present, all other keyword arguments will be ignored """ transitionId = None try: transitionId = int(transition) except Exception: # cannot cast to int, so try to find transitionId by name transitionId = self.find_transitionid_by_name(issue, transition) if transitionId is None: raise JIRAError("Invalid transition name. %s" % transition) data = { 'transition': { 'id': transitionId}} if comment: data['update'] = {'comment': [{'add': {'body': comment}}]} if worklog: data['update'] = {'worklog': [{'add': {'timeSpent': worklog}}]} if fields is not None: data['fields'] = fields else: fields_dict = {} for field in fieldargs: fields_dict[field] = fieldargs[field] data['fields'] = fields_dict url = self._get_url('issue/' + str(issue) + '/transitions') r = self._session.post( url, data=json.dumps(data)) try: r_json = json_loads(r) except ValueError as e: logging.error("%s\n%s" % (e, r.text)) raise e return r_json
[docs] @translate_resource_args def votes(self, issue): """Get a votes Resource from the server. :param issue: ID or key of the issue to get the votes for :rtype: Votes """ return self._find_for_resource(Votes, issue)
[docs] @translate_resource_args def add_vote(self, issue): """Register a vote for the current authenticated user on an issue. :param issue: ID or key of the issue to vote on :rtype: Response """ url = self._get_url('issue/' + str(issue) + '/votes') return self._session.post(url)
[docs] @translate_resource_args def remove_vote(self, issue): """Remove the current authenticated user's vote from an issue. :param issue: ID or key of the issue to remove vote on """ url = self._get_url('issue/' + str(issue) + '/votes') self._session.delete(url)
[docs] @translate_resource_args def watchers(self, issue): """Get a watchers Resource from the server for an issue. :param issue: ID or key of the issue to get the watchers for :rtype: Watchers """ return self._find_for_resource(Watchers, issue)
[docs] @translate_resource_args def add_watcher(self, issue, watcher): """Add a user to an issue's watchers list. :param issue: ID or key of the issue affected :param watcher: username of the user to add to the watchers list """ url = self._get_url('issue/' + str(issue) + '/watchers') self._session.post( url, data=json.dumps(watcher))
[docs] @translate_resource_args def remove_watcher(self, issue, watcher): """Remove a user from an issue's watch list. :param issue: ID or key of the issue affected :param watcher: username of the user to remove from the watchers list :rtype: Response """ url = self._get_url('issue/' + str(issue) + '/watchers') params = {'username': watcher} result = self._session.delete(url, params=params) return result
[docs] @translate_resource_args def worklogs(self, issue): """Get a list of worklog Resources from the server for an issue. :param issue: ID or key of the issue to get worklogs from :rtype: List[Worklog] """ r_json = self._get_json('issue/' + str(issue) + '/worklog') worklogs = [Worklog(self._options, self._session, raw_worklog_json) for raw_worklog_json in r_json['worklogs']] return worklogs
[docs] @translate_resource_args def worklog(self, issue, id): """Get a specific worklog Resource from the server. :param issue: ID or key of the issue to get the worklog from :param id: ID of the worklog to get :rtype: Worklog """ return self._find_for_resource(Worklog, (issue, id))
[docs] @translate_resource_args def add_worklog(self, issue, timeSpent=None, timeSpentSeconds=None, adjustEstimate=None, newEstimate=None, reduceBy=None, comment=None, started=None, user=None, ): """Add a new worklog entry on an issue and return a Resource for it. :param issue: the issue to add the worklog to :param timeSpent: a worklog entry with this amount of time spent, e.g. "2d" :param adjustEstimate: (optional) allows the user to provide specific instructions to update the remaining time estimate of the issue. The value can either be ``new``, ``leave``, ``manual`` or ``auto`` (default). :param newEstimate: the new value for the remaining estimate field. e.g. "2d" :param reduceBy: the amount to reduce the remaining estimate by e.g. "2d" :param started: Moment when the work is logged, if not specified will default to now :param comment: optional worklog comment :rtype: Worklog """ params = {} if adjustEstimate is not None: params['adjustEstimate'] = adjustEstimate if newEstimate is not None: params['newEstimate'] = newEstimate if reduceBy is not None: params['reduceBy'] = reduceBy data = {} if timeSpent is not None: data['timeSpent'] = timeSpent if timeSpentSeconds is not None: data['timeSpentSeconds'] = timeSpentSeconds if comment is not None: data['comment'] = comment elif user: # we log user inside comment as it doesn't always work data['comment'] = user if started is not None: # based on REST Browser it needs: "2014-06-03T08:21:01.273+0000" if started.tzinfo is None: data['started'] = started.strftime("%Y-%m-%dT%H:%M:%S.000+0000") else: data['started'] = started.strftime("%Y-%m-%dT%H:%M:%S.000%z") if user is not None: data['author'] = {"name": user, 'self': self.JIRA_BASE_URL + '/rest/api/latest/user?username=' + user, 'displayName': user, 'active': False } data['updateAuthor'] = data['author'] # report bug to Atlassian: author and updateAuthor parameters are # ignored. url = self._get_url('issue/{0}/worklog'.format(issue)) r = self._session.post(url, params=params, data=json.dumps(data)) return Worklog(self._options, self._session, json_loads(r))
# Issue links # Issue link types # Issue types
[docs] def issue_types(self): """Get a list of issue type Resources from the server. :rtype: List[IssueType] """ r_json = self._get_json('issuetype') issue_types = [IssueType( self._options, self._session, raw_type_json) for raw_type_json in r_json] return issue_types
[docs] def issue_type(self, id): """Get an issue type Resource from the server. :param id: ID of the issue type to get :rtype: IssueType """ return self._find_for_resource(IssueType, id)
[docs] def issue_type_by_name(self, name): """ :param name: Name of the issue type :type name: str :rtype: IssueType """ issue_types = self.issue_types() try: issue_type = [it for it in issue_types if it.name == name][0] except IndexError: raise KeyError("Issue type '%s' is unknown." % name) return issue_type
[docs] def request_types(self, service_desk): """ Returns request types supported by a service desk instance. :param service_desk: The service desk instance. :type service_desk: ServiceDesk :rtype: List[RequestType] """ if hasattr(service_desk, 'id'): service_desk = service_desk.id url = (self._options['server'] + '/rest/servicedeskapi/servicedesk/%s/requesttype' % service_desk) headers = {'X-ExperimentalApi': 'opt-in'} r_json = json_loads(self._session.get(url, headers=headers)) request_types = [ RequestType(self._options, self._session, raw_type_json) for raw_type_json in r_json['values']] return request_types
[docs] def request_type_by_name(self, service_desk, name): request_types = self.request_types(service_desk) try: request_type = [rt for rt in request_types if rt.name == name][0] except IndexError: raise KeyError("Request type '%s' is unknown." % name) return request_type
# User permissions # non-resource
[docs] def my_permissions(self, projectKey=None, projectId=None, issueKey=None, issueId=None, ): """Get a dict of all available permissions on the server. :param projectKey: limit returned permissions to the specified project :type projectKey: Optional[str] :param projectId: limit returned permissions to the specified project :type projectId: Optional[str] :param issueKey: limit returned permissions to the specified issue :type issueKey: Optional[str] :param issueId: limit returned permissions to the specified issue :type issueId: Optional[str] :rtype: Dict[str, Dict[str, Dict[str, str]]] """ params = {} if projectKey is not None: params['projectKey'] = projectKey if projectId is not None: params['projectId'] = projectId if issueKey is not None: params['issueKey'] = issueKey if issueId is not None: params['issueId'] = issueId return self._get_json('mypermissions', params=params)
# Priorities
[docs] def priorities(self): """Get a list of priority Resources from the server. :rtype: List[Priority] """ r_json = self._get_json('priority') priorities = [Priority( self._options, self._session, raw_priority_json) for raw_priority_json in r_json] return priorities
[docs] def priority(self, id): """Get a priority Resource from the server. :param id: ID of the priority to get :type id: str :rtype: Priority """ return self._find_for_resource(Priority, id)
# Projects
[docs] def projects(self): """Get a list of project Resources from the server visible to the current authenticated user. :rtype: List[Project] """ r_json = self._get_json('project') projects = [Project( self._options, self._session, raw_project_json) for raw_project_json in r_json] return projects
[docs] def project(self, id): """Get a project Resource from the server. :param id: ID or key of the project to get :rtype: Project """ return self._find_for_resource(Project, id)
# non-resource
[docs] @translate_resource_args def project_avatars(self, project): """Get a dict of all avatars for a project visible to the current authenticated user. :param project: ID or key of the project to get avatars for """ return self._get_json('project/' + project + '/avatars')
[docs] @translate_resource_args def create_temp_project_avatar(self, project, filename, size, avatar_img, contentType=None, auto_confirm=False): """Register an image file as a project avatar. The avatar created is temporary and must be confirmed before it can be used. Avatar images are specified by a filename, size, and file object. By default, the client will attempt to autodetect the picture's content type: this mechanism relies on libmagic and will not work out of the box on Windows systems (see http://filemagic.readthedocs.org/en/latest/guide.html for details on how to install support). The ``contentType`` argument can be used to explicitly set the value (note that JIRA will reject any type other than the well-known ones for images, e.g. ``image/jpg``, ``image/png``, etc.) This method returns a dict of properties that can be used to crop a subarea of a larger image for use. This dict should be saved and passed to :py:meth:`confirm_project_avatar` to finish the avatar creation process. If you want to cut out the middleman and confirm the avatar with JIRA's default cropping, pass the 'auto_confirm' argument with a truthy value and :py:meth:`confirm_project_avatar` will be called for you before this method returns. :param project: ID or key of the project to create the avatar in :param filename: name of the avatar file :param size: size of the avatar file :param avatar_img: file-like object holding the avatar :param contentType: explicit specification for the avatar image's content-type :param auto_confirm: whether to automatically confirm the temporary avatar by calling :py:meth:`confirm_project_avatar` with the return value of this method. (Default: False) :type auto_confirm: bool """ size_from_file = os.path.getsize(filename) if size != size_from_file: size = size_from_file params = { 'filename': filename, 'size': size} headers = {'X-Atlassian-Token': 'no-check'} if contentType is not None: headers['content-type'] = contentType else: # try to detect content-type, this may return None headers['content-type'] = self._get_mime_type(avatar_img) url = self._get_url('project/' + project + '/avatar/temporary') r = self._session.post( url, params=params, headers=headers, data=avatar_img) cropping_properties = json_loads(r) if auto_confirm: return self.confirm_project_avatar(project, cropping_properties) else: return cropping_properties
[docs] @translate_resource_args def confirm_project_avatar(self, project, cropping_properties): """Confirm the temporary avatar image previously uploaded with the specified cropping. After a successful registry with :py:meth:`create_temp_project_avatar`, use this method to confirm the avatar for use. The final avatar can be a subarea of the uploaded image, which is customized with the ``cropping_properties``: the return value of :py:meth:`create_temp_project_avatar` should be used for this argument. :param project: ID or key of the project to confirm the avatar in :param cropping_properties: a dict of cropping properties from :py:meth:`create_temp_project_avatar` """ data = cropping_properties url = self._get_url('project/' + project + '/avatar') r = self._session.post( url, data=json.dumps(data)) return json_loads(r)
[docs] @translate_resource_args def set_project_avatar(self, project, avatar): """Set a project's avatar. :param project: ID or key of the project to set the avatar on :param avatar: ID of the avatar to set """ self._set_avatar( None, self._get_url('project/' + project + '/avatar'), avatar)
[docs] @translate_resource_args def delete_project_avatar(self, project, avatar): """Delete a project's avatar. :param project: ID or key of the project to delete the avatar from :param avatar: ID of the avatar to delete """ url = self._get_url('project/' + project + '/avatar/' + avatar) return self._session.delete(url)
[docs] @translate_resource_args def project_components(self, project): """Get a list of component Resources present on a project. :param project: ID or key of the project to get components from :type project: str :rtype: List[Component] """ r_json = self._get_json('project/' + project + '/components') components = [Component( self._options, self._session, raw_comp_json) for raw_comp_json in r_json] return components
[docs] @translate_resource_args def project_versions(self, project): """Get a list of version Resources present on a project. :param project: ID or key of the project to get versions from :type project: str :rtype: List[Version] """ r_json = self._get_json('project/' + project + '/versions') versions = [ Version(self._options, self._session, raw_ver_json) for raw_ver_json in r_json] return versions
# non-resource
[docs] @translate_resource_args def project_roles(self, project): """Get a dict of role names to resource locations for a project. :param project: ID or key of the project to get roles from """ path = 'project/' + project + '/role' _rolesdict = self._get_json(path) rolesdict = {} for k, v in _rolesdict.items(): tmp = {} tmp['id'] = v.split("/")[-1] tmp['url'] = v rolesdict[k] = tmp return rolesdict
# TODO(ssbarnea): return a list of Roles()
[docs] @translate_resource_args def project_role(self, project, id): """Get a role Resource. :param project: ID or key of the project to get the role from :param id: ID of the role to get """ if isinstance(id, Number): id = "%s" % id return self._find_for_resource(Role, (project, id))
# Resolutions
[docs] def resolutions(self): """Get a list of resolution Resources from the server. :rtype: List[Resolution] """ r_json = self._get_json('resolution') resolutions = [Resolution( self._options, self._session, raw_res_json) for raw_res_json in r_json] return resolutions
[docs] def resolution(self, id): """Get a resolution Resource from the server. :param id: ID of the resolution to get :type id: str :rtype: Resolution """ return self._find_for_resource(Resolution, id)
# Search
[docs] def search_issues(self, jql_str, startAt=0, maxResults=50, validate_query=True, fields=None, expand=None, json_result=None, ): """Get a :class:`~jira.client.ResultList` of issue Resources matching a JQL search string. :param jql_str: The JQL search string. :type jql_str: str :param startAt: Index of the first issue to return. (Default: 0) :type startAt: int :param maxResults: Maximum number of issues to return. Total number of results is available in the ``total`` attribute of the returned :class:`~jira.client.ResultList`. If maxResults evaluates as False, it will try to get all issues in batches. (Default: 50) :type maxResults: int :param validate_query: Whether or not the query should be validated. (Default: True) :type validate_query: bool :param fields: comma-separated string or list of issue fields to include in the results. Default is to include all fields. :type fields: Optional[str or list] :param expand: extra information to fetch inside each resource :type expand: Optional[str] :param json_result: JSON response will be returned when this parameter is set to True. Otherwise, :class:`~jira.client.ResultList` will be returned. :type json_result: bool :rtype: dict or :class:`~jira.client.ResultList` """ if isinstance(fields, string_types): fields = fields.split(",") else: fields = list(fields or []) # this will translate JQL field names to REST API Name # most people do know the JQL names so this will help them use the API easier untranslate = {} # use to add friendly aliases when we get the results back if self._fields: for i, field in enumerate(fields): if field in self._fields: untranslate[self._fields[field]] = fields[i] fields[i] = self._fields[field] search_params = { "jql": jql_str, "startAt": startAt, "validateQuery": validate_query, "fields": fields, "expand": expand} if json_result: search_params["maxResults"] = maxResults if not maxResults: warnings.warn('All issues cannot be fetched at once, when json_result parameter is set', Warning) return self._get_json('search', params=search_params) issues = self._fetch_pages(Issue, 'issues', 'search', startAt, maxResults, search_params) if untranslate: for i in issues: for k, v in iteritems(untranslate): if k in i.raw.get('fields', {}): i.raw['fields'][v] = i.raw['fields'][k] return issues
# Security levels
[docs] def security_level(self, id): """Get a security level Resource. :param id: ID of the security level to get """ return self._find_for_resource(SecurityLevel, id)
# Server info # non-resource
[docs] def server_info(self): """Get a dict of server information for this JIRA instance. :rtype: Dict[str, Any] """ retry = 0 j = self._get_json('serverInfo') while not j and retry < 3: logging.warning("Bug https://jira.atlassian.com/browse/JRA-59676 trying again...") retry += 1 j = self._get_json('serverInfo') return j
[docs] def myself(self): """Get a dict of server information for this JIRA instance.""" return self._get_json('myself')
# Status
[docs] def statuses(self): """Get a list of status Resources from the server. :rtype: List[Status] """ r_json = self._get_json('status') statuses = [Status(self._options, self._session, raw_stat_json) for raw_stat_json in r_json] return statuses
[docs] def status(self, id): # type: (str) -> Status """Get a status Resource from the server. :param id: ID of the status resource to get """ return self._find_for_resource(Status, id)
# Category
[docs] def statuscategories(self): """Get a list of status category Resources from the server. :rtype: List[StatusCategory] """ r_json = self._get_json('statuscategory') statuscategories = [StatusCategory(self._options, self._session, raw_stat_json) for raw_stat_json in r_json] return statuscategories
[docs] def statuscategory(self, id): """Get a status category Resource from the server. :param id: ID of the status category resource to get :type id: int :rtype: StatusCategory """ return self._find_for_resource(StatusCategory, id)
# Users
[docs] def user(self, id, expand=None): """Get a user Resource from the server. :param id: ID of the user to get :param id: str :param expand: Extra information to fetch inside each resource :type expand: Optional[Any] :rtype: User """ user = User(self._options, self._session) params = {} if expand is not None: params['expand'] = expand user.find(id, params=params) return user
[docs] def search_assignable_users_for_projects(self, username, projectKeys, startAt=0, maxResults=50): """Get a list of user Resources that match the search string and can be assigned issues for projects. :param username: A string to match usernames against :type username: str :param projectKeys: Comma-separated list of project keys to check for issue assignment permissions :type projectKeys: str :param startAt: Index of the first user to return (Default: 0) :type startAt: int :param maxResults: Maximum number of users to return. If maxResults evaluates as False, it will try to get all users in batches. (Default: 50) :type maxResults: int :rtype: ResultList """ params = { 'username': username, 'projectKeys': projectKeys} return self._fetch_pages(User, None, 'user/assignable/multiProjectSearch', startAt, maxResults, params)
[docs] def search_assignable_users_for_issues(self, username, project=None, issueKey=None, expand=None, startAt=0, maxResults=50, ): """Get a list of user Resources that match the search string for assigning or creating issues. This method is intended to find users that are eligible to create issues in a project or be assigned to an existing issue. When searching for eligible creators, specify a project. When searching for eligible assignees, specify an issue key. :param username: A string to match usernames against :type username: str :param project: Filter returned users by permission in this project (expected if a result will be used to create an issue) :type project: Optional[str] :param issueKey: Filter returned users by this issue (expected if a result will be used to edit this issue) :type issueKey: Optional[str] :param expand: Extra information to fetch inside each resource :type expand: Optional[Any] :param startAt: Index of the first user to return (Default: 0) :type startAt: int :param maxResults: maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches. (Default: 50) :rtype: ResultList """ params = { 'username': username} if project is not None: params['project'] = project if issueKey is not None: params['issueKey'] = issueKey if expand is not None: params['expand'] = expand return self._fetch_pages(User, None, 'user/assignable/search', startAt, maxResults, params)
# non-resource
[docs] def user_avatars(self, username): """Get a dict of avatars for the specified user. :param username: the username to get avatars for """ return self._get_json('user/avatars', params={'username': username})
[docs] def create_temp_user_avatar(self, user, filename, size, avatar_img, contentType=None, auto_confirm=False, ): """Register an image file as a user avatar. The avatar created is temporary and must be confirmed before it can be used. Avatar images are specified by a filename, size, and file object. By default, the client will attempt to autodetect the picture's content type: this mechanism relies on ``libmagic`` and will not work out of the box on Windows systems (see http://filemagic.readthedocs.org/en/latest/guide.html for details on how to install support). The ``contentType`` argument can be used to explicitly set the value (note that JIRA will reject any type other than the well-known ones for images, e.g. ``image/jpg``, ``image/png``, etc.) This method returns a dict of properties that can be used to crop a subarea of a larger image for use. This dict should be saved and passed to :py:meth:`confirm_user_avatar` to finish the avatar creation process. If you want to cut out the middleman and confirm the avatar with JIRA's default cropping, pass the ``auto_confirm`` argument with a truthy value and :py:meth:`confirm_user_avatar` will be called for you before this method returns. :param user: User to register the avatar for :type user: str :param filename: name of the avatar file :type filename: str :param size: size of the avatar file :type size: int :param avatar_img: file-like object containing the avatar :type avatar_img: bytes :param contentType: explicit specification for the avatar image's content-type :type contentType: Optional[Any] :param auto_confirm: whether to automatically confirm the temporary avatar by calling :py:meth:`confirm_user_avatar` with the return value of this method. (Default: False) :type auto_confirm: bool :rtype: NoReturn """ size_from_file = os.path.getsize(filename) if size != size_from_file: size = size_from_file # remove path from filename filename = os.path.split(filename)[1] params = { 'username': user, 'filename': filename, 'size': size} headers = {'X-Atlassian-Token': 'no-check'} if contentType is not None: headers['content-type'] = contentType else: # try to detect content-type, this may return None headers['content-type'] = self._get_mime_type(avatar_img) url = self._get_url('user/avatar/temporary') r = self._session.post( url, params=params, headers=headers, data=avatar_img) cropping_properties = json_loads(r) if auto_confirm: return self.confirm_user_avatar(user, cropping_properties) else: return cropping_properties
[docs] def confirm_user_avatar(self, user, cropping_properties): """Confirm the temporary avatar image previously uploaded with the specified cropping. After a successful registry with :py:meth:`create_temp_user_avatar`, use this method to confirm the avatar for use. The final avatar can be a subarea of the uploaded image, which is customized with the ``cropping_properties``: the return value of :py:meth:`create_temp_user_avatar` should be used for this argument. :param user: the user to confirm the avatar for :type user: str :param cropping_properties: a dict of cropping properties from :py:meth:`create_temp_user_avatar` :type cropping_properties: Dict[str,Any] """ data = cropping_properties url = self._get_url('user/avatar') r = self._session.post(url, params={'username': user}, data=json.dumps(data)) return json_loads(r)
[docs] def set_user_avatar(self, username, avatar): """Set a user's avatar. :param username: the user to set the avatar for :param avatar: ID of the avatar to set """ self._set_avatar( {'username': username}, self._get_url('user/avatar'), avatar)
[docs] def delete_user_avatar(self, username, avatar): """Delete a user's avatar. :param username: the user to delete the avatar from :param avatar: ID of the avatar to remove """ params = {'username': username} url = self._get_url('user/avatar/' + avatar) return self._session.delete(url, params=params)
[docs] def search_users(self, user, startAt=0, maxResults=50, includeActive=True, includeInactive=False): """Get a list of user Resources that match the specified search string. :param user: a string to match usernames, name or email against. :type user: str :param startAt: index of the first user to return. :type startAt: int :param maxResults: maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches. :type maxResults: int :param includeActive: If true, then active users are included in the results. (Default: True) :type includeActive: bool :param includeInactive: If true, then inactive users are included in the results. (Default: False) :type includeInactive: bool :rtype: ResultList """ params = { 'username': user, 'includeActive': includeActive, 'includeInactive': includeInactive} return self._fetch_pages(User, None, 'user/search', startAt, maxResults, params)
[docs] def search_allowed_users_for_issue(self, user, issueKey=None, projectKey=None, startAt=0, maxResults=50): """Get a list of user Resources that match a username string and have browse permission for the issue or project. :param user: a string to match usernames against. :type user: str :param issueKey: find users with browse permission for this issue. :type issueKey: Optional[str] :param projectKey: find users with browse permission for this project. :type projectKey: Optional[str] :param startAt: index of the first user to return. (Default: 0) :type startAt: int :param maxResults: maximum number of users to return. If maxResults evaluates as False, it will try to get all items in batches. (Default: 50) :type maxResults: int """ params = { 'username': user} if issueKey is not None: params['issueKey'] = issueKey if projectKey is not None: params['projectKey'] = projectKey return self._fetch_pages(User, None, 'user/viewissue/search', startAt, maxResults, params)
# Versions
[docs] @translate_resource_args def create_version(self, name, project, description=None, releaseDate=None, startDate=None, archived=False, released=False, ): """Create a version in a project and return a Resource for it. :param name: name of the version to create :type name: str :param project: key of the project to create the version in :type project: str :param description: a description of the version :type description: str :param releaseDate: the release date assigned to the version :type releaseDate: Optional[Any] :param startDate: The start date for the version :type startDate: Optional[Any] :param archived: Denotes whether a version should be archived. (Default: False) :type archived: bool :param released: Denotes whether a version is released. (Default: False) :type released: bool :rtype: Version """ data = { 'name': name, 'project': project, 'archived': archived, 'released': released} if description is not None: data['description'] = description if releaseDate is not None: data['releaseDate'] = releaseDate if startDate is not None: data['startDate'] = startDate url = self._get_url('version') r = self._session.post( url, data=json.dumps(data)) time.sleep(1) version = Version(self._options, self._session, raw=json_loads(r)) return version
[docs] def move_version(self, id, after=None, position=None): """Move a version within a project's ordered version list and return a new version Resource for it. One, but not both, of ``after`` and ``position`` must be specified. :param id: ID of the version to move :param after: the self attribute of a version to place the specified version after (that is, higher in the list) :param position: the absolute position to move this version to: must be one of ``First``, ``Last``, ``Earlier``, or ``Later`` """ data = {} if after is not None: data['after'] = after elif position is not None: data['position'] = position url = self._get_url('version/' + id + '/move') r = self._session.post( url, data=json.dumps(data)) version = Version(self._options, self._session, raw=json_loads(r)) return version
[docs] def version(self, id, expand=None): """Get a version Resource. :param id: ID of the version to get :type id: str :param expand: extra information to fetch inside each resource :type expand: Optional[Any] :rtype: Version """ version = Version(self._options, self._session) params = {} if expand is not None: params['expand'] = expand version.find(id, params=params) return version
[docs] def version_count_unresolved_issues(self, id): """Get the number of unresolved issues for a version. :param id: ID of the version to count issues for """ return self._get_json('version/' + id + '/unresolvedIssueCount')['issuesUnresolvedCount']
# Session authentication
[docs] def session(self, auth=None): """Get a dict of the current authenticated user's session information. :param auth: Tuple of username and password. :type auth: Optional[Tuple[str,str]] :rtype: User """ url = '{server}{auth_url}'.format(**self._options) if isinstance(self._session.auth, tuple) or auth: if not auth: auth = self._session.auth username, password = auth authentication_data = {'username': username, 'password': password} r = self._session.post(url, data=json.dumps(authentication_data)) else: r = self._session.get(url) user = User(self._options, self._session, json_loads(r)) return user
[docs] def kill_session(self): """Destroy the session of the current authenticated user.""" url = self._options['server'] + '/rest/auth/latest/session' return self._session.delete(url)
# Websudo
[docs] def kill_websudo(self): """Destroy the user's current WebSudo session. Works only for non-cloud deployments, for others does nothing. :rtype: Optional[Any] """ if self.deploymentType != 'Cloud': url = self._options['server'] + '/rest/auth/1/websudo' return self._session.delete(url)
# Utilities def _create_http_basic_session(self, username, password, timeout=None): """ Creates a basic http session. :param username: Username for the session :type username: str :param password: Password for the username :type password: str :param timeout: If set determines the timeout period for the Session. :type timeout: Optional[int] :rtype: NoReturn """ verify = self._options['verify'] self._session = ResilientSession(timeout=timeout) self._session.verify = verify self._session.auth = (username, password) self._session.cert = self._options['client_cert'] def _create_oauth_session(self, oauth, timeout): verify = self._options['verify'] from oauthlib.oauth1 import SIGNATURE_RSA from requests_oauthlib import OAuth1 oauth = OAuth1( oauth['consumer_key'], rsa_key=oauth['key_cert'], signature_method=SIGNATURE_RSA, resource_owner_key=oauth['access_token'], resource_owner_secret=oauth['access_token_secret']) self._session = ResilientSession(timeout) self._session.verify = verify self._session.auth = oauth def _create_kerberos_session(self, timeout, kerberos_options=None): verify = self._options['verify'] if kerberos_options is None: kerberos_options = {} from requests_kerberos import DISABLED from requests_kerberos import HTTPKerberosAuth from requests_kerberos import OPTIONAL if kerberos_options.get('mutual_authentication', 'OPTIONAL') == 'OPTIONAL': mutual_authentication = OPTIONAL elif kerberos_options.get('mutual_authentication') == 'DISABLED': mutual_authentication = DISABLED else: raise ValueError("Unknown value for mutual_authentication: %s" % kerberos_options['mutual_authentication']) self._session = ResilientSession(timeout=timeout) self._session.verify = verify self._session.auth = HTTPKerberosAuth(mutual_authentication=mutual_authentication) @staticmethod def _timestamp(dt=None): t = datetime.datetime.utcnow() if dt is not None: t += dt return calendar.timegm(t.timetuple()) def _create_jwt_session(self, jwt, timeout): try: jwt_auth = JWTAuth(jwt['secret'], alg='HS256') except NameError as e: logging.error("JWT authentication requires requests_jwt") raise e jwt_auth.set_header_format('JWT %s') jwt_auth.add_field("iat", lambda req: JIRA._timestamp()) jwt_auth.add_field("exp", lambda req: JIRA._timestamp(datetime.timedelta(minutes=3))) jwt_auth.add_field("qsh", QshGenerator(self._options['context_path'])) for f in jwt['payload'].items(): jwt_auth.add_field(f[0], f[1]) self._session = ResilientSession(timeout=timeout) self._session.verify = self._options['verify'] self._session.auth = jwt_auth def _set_avatar(self, params, url, avatar): data = { 'id': avatar} return self._session.put(url, params=params, data=json.dumps(data)) def _get_url(self, path, base=JIRA_BASE_URL): """ Returns the full url based on JIRA base url and the path provided :param path: The subpath desired. :type path: str :param base: The base url which should be prepended to the path :type base: Optional[str] :return Fully qualified URL :rtype: str """ options = self._options.copy() options.update({'path': path}) return base.format(**options) def _get_json(self, path, params=None, base=JIRA_BASE_URL, ): """Get the json for a given path and params. :param path: The subpath required :type path: str :param params: Parameters to filter the json query. :type params: Optional[Dict[str, Any]] :param base: The Base JIRA URL, defaults to the instance base. :type base: Optional[str] :rtype: Union[Dict[str, Any], List[Dict[str, str]]] """ url = self._get_url(path, base) r = self._session.get(url, params=params) try: r_json = json_loads(r) except ValueError as e: logging.error("%s\n%s" % (e, r.text)) raise e return r_json def _find_for_resource(self, resource_cls, ids, expand=None): resource = resource_cls(self._options, self._session) params = {} if expand is not None: params['expand'] = expand resource.find(id=ids, params=params) if not resource: raise JIRAError("Unable to find resource %s(%s)", resource_cls, ids) return resource def _try_magic(self): try: import magic import weakref except ImportError: self._magic = None else: try: _magic = magic.Magic(flags=magic.MAGIC_MIME_TYPE) def cleanup(x): _magic.close() self._magic_weakref = weakref.ref(self, cleanup) self._magic = _magic except TypeError: self._magic = None except AttributeError: self._magic = None def _get_mime_type(self, buff): """Get the MIME type for a given stream of bytes :param buff: Stream of bytes :type buff: bytes :rtype: str """ if self._magic is not None: return self._magic.id_buffer(buff) else: try: return mimetypes.guess_type("f." + imghdr.what(0, buff))[0] except (IOError, TypeError): logging.warning("Couldn't detect content type of avatar image" ". Specify the 'contentType' parameter explicitly.") return None
[docs] def rename_user(self, old_user, new_user): """Rename a JIRA user. :param old_user: Old username login :type old_user: str :param new_user: New username login :type new_user: str """ if self._version > (6, 0, 0): url = self._options['server'] + '/rest/api/latest/user' payload = { "name": new_user} params = { 'username': old_user} # raw displayName logging.debug("renaming %s" % self.user(old_user).emailAddress) r = self._session.put(url, params=params, data=json.dumps(payload)) raise_on_error(r) else: raise NotImplementedError("Support for renaming users in Jira " "< 6.0.0 has been removed.")
[docs] def delete_user(self, username): """Deletes a JIRA User. :param username: Username to delete :type username: str :return: Success of user deletion :rtype: bool """ url = self._options['server'] + '/rest/api/latest/user/?username=%s' % username r = self._session.delete(url) if 200 <= r.status_code <= 299: return True else: logging.error(r.status_code) return False
[docs] def deactivate_user(self, username): """Disable/deactivate the user. :param username: User to be deactivated. :type username: str :rtype: Union[str, int] """ if self.deploymentType == 'Cloud': # Disabling users now needs cookie auth in the Cloud - see https://jira.atlassian.com/browse/ID-6230 if 'authCookie' not in vars(self): user = self.session() if user.raw is None: raise JIRAError("Can not log in!") self.authCookie = '%s=%s' % (user.raw['session']['name'], user.raw['session']['value']) url = self._options['server'] + '/admin/rest/um/1/user/deactivate?username=%s' % (username) # We can't use our existing session here - this endpoint is fragile and objects to extra headers try: r = requests.post(url, headers={'Cookie': self.authCookie, 'Content-Type': 'application/json'}, data={}) if r.status_code == 200: return True else: logging.warning( 'Got response from deactivating %s: %s' % (username, r.status_code)) return r.status_code except Exception as e: logging.error( "Error Deactivating %s: %s" % (username, e)) raise JIRAError("Error Deactivating %s: %s" % (username, e)) else: url = self._options['server'] + '/secure/admin/user/EditUser.jspa' self._options['headers']['Content-Type'] = 'application/x-www-form-urlencoded; charset=UTF-8' user = self.user(username) userInfo = { 'inline': 'true', 'decorator': 'dialog', 'username': user.name, 'fullName': user.displayName, 'email': user.emailAddress, 'editName': user.name } try: r = self._session.post(url, headers=self._options['headers'], data=userInfo) if r.status_code == 200: return True else: logging.warning( 'Got response from deactivating %s: %s' % (username, r.status_code)) return r.status_code except Exception as e: logging.error( "Error Deactivating %s: %s" % (username, e)) raise JIRAError("Error Deactivating %s: %s" % (username, e))
[docs] def reindex(self, force=False, background=True): """Start jira re-indexing. Returns True if reindexing is in progress or not needed, or False. If you call reindex() without any parameters it will perform a background reindex only if JIRA thinks it should do it. :param force: reindex even if JIRA doesn't say this is needed, False by default. :param background: reindex in background, slower but does not impact the users, defaults to True. """ # /secure/admin/IndexAdmin.jspa # /secure/admin/jira/IndexProgress.jspa?taskId=1 if background: indexingStrategy = 'background' else: indexingStrategy = 'stoptheworld' url = self._options['server'] + '/secure/admin/jira/IndexReIndex.jspa' r = self._session.get(url, headers=self._options['headers']) if r.status_code == 503: # logging.warning("JIRA returned 503, this could mean that a full reindex is in progress.") return 503 if not r.text.find("To perform the re-index now, please go to the") and force is False: return True if r.text.find('All issues are being re-indexed'): logging.warning("JIRA re-indexing is already running.") return True # still reindexing is considered still a success if r.text.find('To perform the re-index now, please go to the') or force: r = self._session.post(url, headers=self._options['headers'], params={"indexingStrategy": indexingStrategy, "reindex": "Re-Index"}) if r.text.find('All issues are being re-indexed') != -1: return True else: logging.error("Failed to reindex jira, probably a bug.") return False
[docs] def backup(self, filename='backup.zip', attachments=False): """Will call jira export to backup as zipped xml. Returning with success does not mean that the backup process finished.""" if self.deploymentType == 'Cloud': url = self._options['server'] + '/rest/backup/1/export/runbackup' payload = json.dumps({"cbAttachments": attachments}) self._options['headers']['X-Requested-With'] = 'XMLHttpRequest' else: url = self._options['server'] + '/secure/admin/XmlBackup.jspa' payload = {'filename': filename} try: r = self._session.post(url, headers=self._options['headers'], data=payload) if r.status_code == 200: return True else: logging.warning( 'Got %s response from calling backup.' % r.status_code) return r.status_code except Exception as e: logging.error("I see %s", e)
[docs] def backup_progress(self): """Return status of cloud backup as a dict. Is there a way to get progress for Server version? """ epoch_time = int(time.time() * 1000) if self.deploymentType == 'Cloud': url = self._options['server'] + '/rest/obm/1.0/getprogress?_=%i' % epoch_time else: logging.warning( 'This functionality is not available in Server version') return None r = self._session.get( url, headers=self._options['headers']) # This is weird. I used to get xml, but now I'm getting json try: return json.loads(r.text) except Exception: import defusedxml.ElementTree as etree progress = {} try: root = etree.fromstring(r.text) except etree.ParseError as pe: logging.warning('Unable to find backup info. You probably need to initiate a new backup. %s' % pe) return None for k in root.keys(): progress[k] = root.get(k) return progress
[docs] def backup_complete(self): """Return boolean based on 'alternativePercentage' and 'size' returned from backup_progress (cloud only).""" if self.deploymentType != 'Cloud': logging.warning( 'This functionality is not available in Server version') return None status = self.backup_progress() perc_complete = int(re.search(r"\s([0-9]*)\s", status['alternativePercentage']).group(1)) file_size = int(status['size']) return perc_complete >= 100 and file_size > 0
[docs] def backup_download(self, filename=None): """Download backup file from WebDAV (cloud only).""" if self.deploymentType != 'Cloud': logging.warning( 'This functionality is not available in Server version') return None remote_file = self.backup_progress()['fileName'] local_file = filename or remote_file url = self._options['server'] + '/webdav/backupmanager/' + remote_file try: logging.debug('Writing file to %s' % local_file) with open(local_file, 'wb') as file: try: resp = self._session.get(url, headers=self._options['headers'], stream=True) except Exception: raise JIRAError() if not resp.ok: logging.error("Something went wrong with download: %s" % resp.text) raise JIRAError(resp.text) for block in resp.iter_content(1024): file.write(block) except JIRAError as je: logging.error('Unable to access remote backup file: %s' % je) except IOError as ioe: logging.error(ioe) return None
[docs] def current_user(self): """Returns the username of the current user. :rtype: str """ if not hasattr(self, '_serverInfo') or 'username' not in self._serverInfo: url = self._get_url('serverInfo') r = self._session.get(url, headers=self._options['headers']) r_json = json_loads(r) if 'x-ausername' in r.headers: r_json['username'] = r.headers['x-ausername'] else: r_json['username'] = None self._serverInfo = r_json # del r_json['self'] # this isn't really an addressable resource return self._serverInfo['username']
[docs] def delete_project(self, pid): """Delete project from Jira. :param pid: JIRA projectID or Project or slug :type pid: str :return: True if project was deleted :rtype: bool :raises JIRAError: If project not found or not enough permissions :raises ValueError: If pid parameter is not Project, slug or ProjectID """ # allows us to call it with Project objects if hasattr(pid, 'id'): pid = pid.id # Check if pid is a number - then we assume that it is # projectID try: str(int(pid)) == pid except Exception as e: # pid looks like a slug, lets verify that r_json = self._get_json('project') for e in r_json: if e['key'] == pid or e['name'] == pid: pid = e['id'] break else: # pid is not a Project # not a projectID and not a slug - we raise error here raise ValueError('Parameter pid="%s" is not a Project, ' 'projectID or slug' % pid) uri = '/rest/api/2/project/%s' % pid url = self._options['server'] + uri try: r = self._session.delete( url, headers={'Content-Type': 'application/json'} ) except JIRAError as je: if '403' in str(je): raise JIRAError('Not enough permissions to delete project') if '404' in str(je): raise JIRAError('Project not found in Jira') raise je if r.status_code == 204: return True
def _gain_sudo_session(self, options, destination): url = self._options['server'] + '/secure/admin/WebSudoAuthenticate.jspa' if not self._session.auth: self._session.auth = get_netrc_auth(url) payload = { 'webSudoPassword': self._session.auth[1], 'webSudoDestination': destination, 'webSudoIsPost': 'true'} payload.update(options) return self._session.post( url, headers=CaseInsensitiveDict({'content-type': 'application/x-www-form-urlencoded'}), data=payload)
[docs] @lru_cache(maxsize=None) def templates(self): url = self._options['server'] + \ '/rest/project-templates/latest/templates' r = self._session.get(url) data = json_loads(r) templates = {} # if 'projectTemplates' in data: # template_ = data['projectTemplates'] # el if 'projectTemplatesGroupedByType' in data: for group in data['projectTemplatesGroupedByType']: for t in group['projectTemplates']: templates[t['name']] = t return templates
[docs] def create_project(self, key, name=None, assignee=None, type="Software", template_name=None): """Create a project with the specified parameters. :param key: Mandatory. Must match JIRA project key requirements, usually only 2-10 uppercase characters. :type: str :param name: If not specified it will use the key value. :type name: Optional[str] :param assignee: If not specified it will use current user. :type assignee: Optional[str] :param type: Determines the type of project should be created. :type type: Optional[str] :param template_name: is used to create a project based on one of the existing project templates. If `template_name` is not specified, then it should use one of the default values. :type template_name: Optional[str] :return: Should evaluate to False if it fails otherwise it will be the new project id. :rtype: Union[bool,int] """ if assignee is None: assignee = self.current_user() if name is None: name = key possible_templates = ['Basic', 'JIRA Classic', 'JIRA Default Schemes', 'Basic software development'] if template_name is not None: possible_templates = [template_name] # https://confluence.atlassian.com/jirakb/creating-a-project-via-rest-based-on-jira-default-schemes-744325852.html templates = self.templates() # TODO(ssbarnea): find a better logic to pick a default fallback template template_key = list(templates.values())[0]['projectTemplateModuleCompleteKey'] for template_name, template_dic in templates.items(): if template_name in possible_templates: template_key = template_dic['projectTemplateModuleCompleteKey'] break payload = {'name': name, 'key': key, 'keyEdited': 'false', # 'projectTemplate': 'com.atlassian.jira-core-project-templates:jira-issuetracking', # 'permissionScheme': '', 'projectTemplateWebItemKey': template_key, 'projectTemplateModuleKey': template_key, 'lead': assignee, # 'assigneeType': '2', } if self._version[0] > 6: # JIRA versions before 7 will throw an error if we specify type parameter payload['type'] = type headers = CaseInsensitiveDict( {'Content-Type': 'application/x-www-form-urlencoded'}) url = self._options['server'] + \ '/rest/project-templates/latest/templates' r = self._session.post(url, data=payload, headers=headers) if r.status_code == 200: r_json = json_loads(r) return r_json f = tempfile.NamedTemporaryFile( suffix='.html', prefix='python-jira-error-create-project-', delete=False) f.write(r.text) if self.logging: logging.error( "Unexpected result while running create project. Server response saved in %s for further investigation [HTTP response=%s]." % ( f.name, r.status_code)) return False
[docs] def add_user(self, username, email, directoryId=1, password=None, fullname=None, notify=False, active=True, ignore_existing=False, application_keys=None, ): """Create a new JIRA user. :param username: the username of the new user :type username: str :param email: email address of the new user :type email: str :param directoryId: The directory ID the new user should be a part of (Default: 1) :type directoryId: int :param password: Optional, the password for the new user :type password: Optional[str] :param fullname: Optional, the full name of the new user :type fullname: Optional[str] :param notify: Whether or not to send a notification to the new user. (Default: False) :type notify: bool :param active: Whether or not to make the new user active upon creation. (Default: True) :type active: bool :param ignore_existing: Whether or not to ignore and existing user. (Default: False) :type ignore_existing: bool :param applicationKeys: Keys of products user should have access to :type applicationKeys: Optional[list] :return: Whether or not the user creation was successful. :rtype: bool :raises JIRAError: If username already exists and `ignore_existing` has not been set to `True`. """ if not fullname: fullname = username # TODO(ssbarnea): default the directoryID to the first directory in jira instead # of 1 which is the internal one. url = self._options['server'] + '/rest/api/latest/user' # implementation based on # https://docs.atlassian.com/jira/REST/ondemand/#d2e5173 x = OrderedDict() x['displayName'] = fullname x['emailAddress'] = email x['name'] = username if password: x['password'] = password if notify: x['notification'] = 'True' if application_keys is not None: x['applicationKeys'] = application_keys payload = json.dumps(x) try: self._session.post(url, data=payload) except JIRAError as e: err = e.response.json()['errors'] if 'username' in err and err['username'] == 'A user with that username already exists.' and ignore_existing: return True raise e return True
[docs] def add_user_to_group(self, username, group): """Add a user to an existing group. :param username: Username that will be added to specified group. :type username: str :param group: Group that the user will be added to. :type group: str :return: json response from Jira server for success or a value that evaluates as False in case of failure. :rtype: Union[bool,Dict[str,Any]] """ url = self._options['server'] + '/rest/api/latest/group/user' x = {'groupname': group} y = {'name': username} payload = json.dumps(y) r = json_loads(self._session.post(url, params=x, data=payload)) if 'name' not in r or r['name'] != group: return False else: return r
[docs] def remove_user_from_group(self, username, groupname): """Remove a user from a group. :param username: The user to remove from the group. :param groupname: The group that the user will be removed from. """ url = self._options['server'] + '/rest/api/latest/group/user' x = {'groupname': groupname, 'username': username} self._session.delete(url, params=x) return True
# Experimental # Experimental support for iDalko Grid, expect API to change as it's using private APIs currently # https://support.idalko.com/browse/IGRID-1017
[docs] def get_igrid(self, issueid, customfield, schemeid): url = self._options['server'] + '/rest/idalko-igrid/1.0/datagrid/data' if str(customfield).isdigit(): customfield = "customfield_%s" % customfield params = { '_issueId': issueid, '_fieldId': customfield, '_confSchemeId': schemeid} r = self._session.get( url, headers=self._options['headers'], params=params) return json_loads(r)
# Jira Agile specific methods (GreenHopper) """ Define the functions that interact with GreenHopper. """
[docs] @translate_resource_args def boards(self, startAt=0, maxResults=50, type=None, name=None, projectKeyOrID=None): """Get a list of board resources. :param startAt: The starting index of the returned boards. Base index: 0. :param maxResults: The maximum number of boards to return per page. Default: 50 :param type: Filters results to boards of the specified type. Valid values: scrum, kanban. :param name: Filters results to boards that match or partially match the specified name. :param projectKeyOrID: Filters results to boards that match the specified project key or ID. :rtype: ResultList[Board] When old GreenHopper private API is used, paging is not enabled and all parameters are ignored. """ params = {} if type: params['type'] = type if name: params['name'] = name if projectKeyOrID: params['projectKeyOrId'] = projectKeyOrID if self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: # Old, private API did not support pagination, all records were present in response, # and no parameters were supported. if startAt or maxResults or params: warnings.warn('Old private GreenHopper API is used, all parameters will be ignored.', Warning) r_json = self._get_json('rapidviews/list', base=self.AGILE_BASE_URL) boards = [Board(self._options, self._session, raw_boards_json) for raw_boards_json in r_json['views']] return ResultList(boards, 0, len(boards), len(boards), True) else: return self._fetch_pages(Board, 'values', 'board', startAt, maxResults, params, base=self.AGILE_BASE_URL)
[docs] @translate_resource_args def sprints(self, board_id, extended=False, startAt=0, maxResults=50, state=None): """Get a list of sprint GreenHopperResources. :param board_id: the board to get sprints from :param extended: Used only by old GreenHopper API to fetch additional information like startDate, endDate, completeDate, much slower because it requires an additional requests for each sprint. New JIRA Agile API always returns this information without a need for additional requests. :param startAt: the index of the first sprint to return (0 based) :param maxResults: the maximum number of sprints to return :param state: Filters results to sprints in specified states. Valid values: `future`, `active`, `closed`. You can define multiple states separated by commas :type board_id: int :type extended: bool :type startAt: int :type maxResults: int :type state: str :rtype: list of :class:`~jira.resources.Sprint` :return: (content depends on API version, but always contains id, name, state, startDate and endDate) When old GreenHopper private API is used, paging is not enabled, and `startAt`, `maxResults` and `state` parameters are ignored. """ params = {} if state: params['state'] = state if self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: r_json = self._get_json('sprintquery/%s?includeHistoricSprints=true&includeFutureSprints=true' % board_id, base=self.AGILE_BASE_URL) if params: warnings.warn('Old private GreenHopper API is used, parameters %s will be ignored.' % params, Warning) if extended: sprints = [Sprint(self._options, self._session, self.sprint_info(None, raw_sprints_json['id'])) for raw_sprints_json in r_json['sprints']] else: sprints = [Sprint(self._options, self._session, raw_sprints_json) for raw_sprints_json in r_json['sprints']] return ResultList(sprints, 0, len(sprints), len(sprints), True) else: return self._fetch_pages(Sprint, 'values', 'board/%s/sprint' % board_id, startAt, maxResults, params, self.AGILE_BASE_URL)
[docs] def sprints_by_name(self, id, extended=False): sprints = {} for s in self.sprints(id, extended=extended): if s.name not in sprints: sprints[s.name] = s.raw else: raise Exception return sprints
[docs] def update_sprint(self, id, name=None, startDate=None, endDate=None, state=None): payload = {} if name: payload['name'] = name if startDate: payload['startDate'] = startDate if endDate: payload['endDate'] = endDate if state: if self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: raise NotImplementedError('Public JIRA API does not support state update') payload['state'] = state url = self._get_url('sprint/%s' % id, base=self.AGILE_BASE_URL) r = self._session.put( url, data=json.dumps(payload)) return json_loads(r)
[docs] def incompletedIssuesEstimateSum(self, board_id, sprint_id): """Return the total incompleted points this sprint.""" return self._get_json('rapid/charts/sprintreport?rapidViewId=%s&sprintId=%s' % (board_id, sprint_id), base=self.AGILE_BASE_URL)['contents']['incompletedIssuesEstimateSum']['value']
[docs] def removed_issues(self, board_id, sprint_id): """Return the completed issues for the sprint.""" r_json = self._get_json('rapid/charts/sprintreport?rapidViewId=%s&sprintId=%s' % (board_id, sprint_id), base=self.AGILE_BASE_URL) issues = [Issue(self._options, self._session, raw_issues_json) for raw_issues_json in r_json['contents']['puntedIssues']] return issues
[docs] def removedIssuesEstimateSum(self, board_id, sprint_id): """Return the total incompleted points this sprint.""" return self._get_json('rapid/charts/sprintreport?rapidViewId=%s&sprintId=%s' % (board_id, sprint_id), base=self.AGILE_BASE_URL)['contents']['puntedIssuesEstimateSum']['value']
# TODO(ssbarnea): remove sprint_info() method, sprint() method suit the convention more
[docs] def sprint_info(self, board_id, sprint_id): """Return the information about a sprint. :param board_id: the board retrieving issues from. Deprecated and ignored. :param sprint_id: the sprint retrieving issues from """ sprint = Sprint(self._options, self._session) sprint.find(sprint_id) return sprint.raw
[docs] def sprint(self, id): """Return the information about a sprint. :param sprint_id: the sprint retrieving issues from :type sprint_id: int :rtype: :class:`~jira.resources.Sprint` """ sprint = Sprint(self._options, self._session) sprint.find(id) return sprint
# TODO(ssbarnea): remove this as we do have Board.delete()
[docs] def delete_board(self, id): """Delete an agile board.""" board = Board(self._options, self._session, raw={'id': id}) board.delete()
[docs] def create_board(self, name, project_ids, preset="scrum", location_type='user', location_id=None): """Create a new board for the ``project_ids``. :param name: name of the board :type name: str :param project_ids: the projects to create the board in :type project_ids: str :param preset: What preset to use for this board. (Default: "scrum") :type preset: 'kanban', 'scrum', 'diy' :param location_type: the location type. Available in cloud. (Default: "user") :type location_type: 'user', 'project' :param location_id: the id of project that the board should be located under. Omit this for a 'user' location_type. Available in cloud. :type location_id: Optional[str] :return: The newly created board :rtype: Board """ if self._options['agile_rest_path'] != GreenHopperResource.GREENHOPPER_REST_PATH: raise NotImplementedError('JIRA Agile Public API does not support this request') payload = {} if isinstance(project_ids, string_types): ids = [] for p in project_ids.split(','): ids.append(self.project(p).id) project_ids = ','.join(ids) if location_id is not None: location_id = self.project(location_id).id payload['name'] = name if isinstance(project_ids, string_types): project_ids = project_ids.split(',') payload['projectIds'] = project_ids payload['preset'] = preset if self.deploymentType == 'Cloud': payload['locationType'] = location_type payload['locationId'] = location_id url = self._get_url( 'rapidview/create/presets', base=self.AGILE_BASE_URL) r = self._session.post( url, data=json.dumps(payload)) raw_issue_json = json_loads(r) return Board(self._options, self._session, raw=raw_issue_json)
[docs] def create_sprint(self, name, board_id, startDate=None, endDate=None): """Create a new sprint for the ``board_id``. :param name: Name of the sprint :type name: str :param board_id: Which board the sprint should be assigned. :type board_id: int :param startDate: Start date for the sprint. :type startDate: Optional[Any] :param endDate: End date for the sprint. :type endDate: Optional[Any] :return: The newly created Sprint :rtype: Sprint """ payload = {'name': name} if startDate: payload["startDate"] = startDate if endDate: payload["endDate"] = endDate if self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: url = self._get_url('sprint/%s' % board_id, base=self.AGILE_BASE_URL) r = self._session.post(url) raw_issue_json = json_loads(r) """ now r contains something like: { "id": 742, "name": "Sprint 89", "state": "FUTURE", "linkedPagesCount": 0, "startDate": "None", "endDate": "None", "completeDate": "None", "remoteLinks": [] }""" url = self._get_url( 'sprint/%s' % raw_issue_json['id'], base=self.AGILE_BASE_URL) r = self._session.put( url, data=json.dumps(payload)) raw_issue_json = json_loads(r) else: url = self._get_url('sprint', base=self.AGILE_BASE_URL) payload['originBoardId'] = board_id r = self._session.post(url, data=json.dumps(payload)) raw_issue_json = json_loads(r) return Sprint(self._options, self._session, raw=raw_issue_json)
[docs] def add_issues_to_sprint(self, sprint_id, issue_keys): """Add the issues in ``issue_keys`` to the ``sprint_id``. The sprint must be started but not completed. If a sprint was completed, then have to also edit the history of the issue so that it was added to the sprint before it was completed, preferably before it started. A completed sprint's issues also all have a resolution set before the completion date. If a sprint was not started, then have to edit the marker and copy the rank of each issue too. :param sprint_id: the sprint to add issues to :type sprint_id: int :param issue_keys: the issues to add to the sprint :type issue_keys: List[str] :rtype: Response """ if self._options['agile_rest_path'] == GreenHopperResource.AGILE_BASE_REST_PATH: url = self._get_url('sprint/%s/issue' % sprint_id, base=self.AGILE_BASE_URL) payload = {'issues': issue_keys} try: self._session.post(url, data=json.dumps(payload)) except JIRAError as e: if e.status_code == 404: warnings.warn('Status code 404 may mean, that too old JIRA Agile version is installed.' ' At least version 6.7.10 is required.') raise elif self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: # In old, private API the function does not exist anymore and we need to use # issue.update() to perform this operation # Workaround based on https://answers.atlassian.com/questions/277651/jira-agile-rest-api-example sprint_field_id = self._get_sprint_field_id() data = {'idOrKeys': issue_keys, 'customFieldId': sprint_field_id, 'sprintId': sprint_id, 'addToBacklog': False} url = self._get_url('sprint/rank', base=self.AGILE_BASE_URL) return self._session.put(url, data=json.dumps(data)) else: raise NotImplementedError('No API for adding issues to sprint for agile_rest_path="%s"' % self._options['agile_rest_path'])
[docs] def add_issues_to_epic(self, epic_id, issue_keys, ignore_epics=True): """Add the issues in ``issue_keys`` to the ``epic_id``. :param epic_id: The ID for the epic where issues should be added. :type epic_id: int :param issue_keys: The issues to add to the epic :type issue_keys: str :param ignore_epics: ignore any issues listed in ``issue_keys`` that are epics. (Default: True) :type ignore_epics: bool """ if self._options['agile_rest_path'] != GreenHopperResource.GREENHOPPER_REST_PATH: # TODO(ssbarnea): simulate functionality using issue.update()? raise NotImplementedError('JIRA Agile Public API does not support this request') data = {} data['issueKeys'] = issue_keys data['ignoreEpics'] = ignore_epics url = self._get_url('epics/%s/add' % epic_id, base=self.AGILE_BASE_URL) return self._session.put( url, data=json.dumps(data))
# TODO(ssbarnea): Both GreenHopper and new JIRA Agile API support moving more than one issue.
[docs] def rank(self, issue, next_issue): """Rank an issue before another using the default Ranking field, the one named 'Rank'. :param issue: issue key of the issue to be ranked before the second one. :param next_issue: issue key of the second issue. """ if not self._rank: for field in self.fields(): if field['name'] == 'Rank': if field['schema']['custom'] == "com.pyxis.greenhopper.jira:gh-lexo-rank": self._rank = field['schema']['customId'] break elif field['schema']['custom'] == "com.pyxis.greenhopper.jira:gh-global-rank": # Obsolete since JIRA v6.3.13.1 self._rank = field['schema']['customId'] if self._options['agile_rest_path'] == GreenHopperResource.AGILE_BASE_REST_PATH: url = self._get_url('issue/rank', base=self.AGILE_BASE_URL) payload = {'issues': [issue], 'rankBeforeIssue': next_issue, 'rankCustomFieldId': self._rank} try: return self._session.put(url, data=json.dumps(payload)) except JIRAError as e: if e.status_code == 404: warnings.warn('Status code 404 may mean, that too old JIRA Agile version is installed.' ' At least version 6.7.10 is required.') raise elif self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: data = { "issueKeys": [issue], "rankBeforeKey": next_issue, "customFieldId": self._rank} url = self._get_url('rank', base=self.AGILE_BASE_URL) return self._session.put(url, data=json.dumps(data)) else: raise NotImplementedError('No API for ranking issues for agile_rest_path="%s"' % self._options['agile_rest_path'])
[docs] def move_to_backlog(self, issue_keys): """Move issues in ``issue_keys`` to the backlog, removing them from all sprints that have not been completed. :param issue_keys: the issues to move to the backlog :param issue_keys: str :raises JIRAError: If moving issues to backlog fails """ if self._options['agile_rest_path'] == GreenHopperResource.AGILE_BASE_REST_PATH: url = self._get_url('backlog/issue', base=self.AGILE_BASE_URL) payload = {'issues': issue_keys} try: self._session.post(url, data=json.dumps(payload)) except JIRAError as e: if e.status_code == 404: warnings.warn('Status code 404 may mean, that too old JIRA Agile version is installed.' ' At least version 6.7.10 is required.') raise elif self._options['agile_rest_path'] == GreenHopperResource.GREENHOPPER_REST_PATH: # In old, private API the function does not exist anymore and we need to use # issue.update() to perform this operation # Workaround based on https://answers.atlassian.com/questions/277651/jira-agile-rest-api-example sprint_field_id = self._get_sprint_field_id() data = {'idOrKeys': issue_keys, 'customFieldId': sprint_field_id, 'addToBacklog': True} url = self._get_url('sprint/rank', base=self.AGILE_BASE_URL) return self._session.put(url, data=json.dumps(data)) else: raise NotImplementedError('No API for moving issues to backlog for agile_rest_path="%s"' % self._options['agile_rest_path'])
class GreenHopper(JIRA): def __init__(self, options=None, basic_auth=None, oauth=None, async_=None): warnings.warn( "GreenHopper() class is deprecated, just use JIRA() instead.", DeprecationWarning) JIRA.__init__( self, options=options, basic_auth=basic_auth, oauth=oauth, async_=async_)