Merge pull request #1 from atlassian-api/master

Fetch

Author: djachkov

.whitesource

@@ -0,0 +1,8 @@
+{
+  "checkRunSettings": {
+    "vulnerableCheckRunConclusionLevel": "failure"
+  },
+  "issueSettings": {
+    "minSeverityLevel": "LOW"
+  }
+}

atlassian/VERSION

@@ -1 +1 @@
-1.13.29
+1.14.0

atlassian/bamboo.py

@@ -365,10 +365,11 @@ def create_branch(self, plan_key, branch_name, vcs_branch=None, enabled=False, c
         :return: PUT request
         """
         resource = 'plan/{plan_key}/branch/{branch_name}'.format(plan_key=plan_key, branch_name=branch_name)
+        params = {}
         if vcs_branch:
-            params = {'vcsBranch':vcs_branch}
-            params['enabled'] = 'true' if enabled else 'false'
-            params['cleanupEnabled'] = 'true' if cleanup_enabled else 'false'
+            params = dict(vcsBranch=vcs_branch,
+                          enabled='true' if enabled else 'false',
+                          cleanupEnabled='true' if cleanup_enabled else 'false')
         return self.put(self.resource_url(resource), params=params)
 
     def enable_plan(self, plan_key):
@@ -380,26 +381,26 @@ def enable_plan(self, plan_key):
         resource = 'plan/{plan_key}/enable'.format(plan_key=plan_key)
         return self.post(self.resource_url(resource))
 
-    def execute_build(self, plan_key, stage=None, executeAllStages=True, customRevision=None, **bamboo_variables):
+    def execute_build(self, plan_key, stage=None, execute_all_stages=True, custom_revision=None, **bamboo_variables):
         """
         Fire build execution for specified plan. 
         !IMPORTANT! NOTE: for some reason, this method always execute all stages
         :param plan_key: str TST-BLD
         :param stage: str stage-name
-        :param executeAllStages: bool
-        :param customRevision: str revisionName
+        :param execute_all_stages: bool
+        :param custom_revision: str revisionName
         :param bamboo_variables: dict {variable=value} 
         :return: POST request
         """
         headers = self.form_token_headers
         resource = 'queue/{plan_key}'.format(plan_key=plan_key)
         params = {}
         if stage:
-            executeAllStages = False
+            execute_all_stages = False
             params['stage'] = stage
-        if customRevision:
-            params['customRevision'] = customRevision
-        params['executeAllStages'] = 'true' if executeAllStages else 'false'
+        if custom_revision:
+            params['customRevision'] = custom_revision
+        params['executeAllStages'] = 'true' if execute_all_stages else 'false'
         if bamboo_variables:
             for key, value in bamboo_variables.items():
                 params['bamboo.variable.{}'.format(key)] = value

atlassian/bitbucket.py

@@ -6,6 +6,7 @@
 
 
 class Bitbucket(AtlassianRestAPI):
+
     def project_list(self, limit=None):
         """
         Provide the project list
@@ -17,14 +18,24 @@ def project_list(self, limit=None):
             params['limit'] = limit
         return (self.get('rest/api/1.0/projects', params=params) or {}).get('values')
 
+    def repo_list(self, project_key):
+        """
+        Provide the repository list in a specific BB project
+        :param project_key: The Project Key ID you need to list
+        return:
+        """
+        url = 'rest/api/1.0/projects/{projectKey}/repos?limit=1000'.format(
+            projectKey=project_key)
+        return self.get(url)
+
     def project(self, key):
         """
         Provide project info
         :param key:
         :return:
         """
         url = 'rest/api/1.0/projects/{0}'.format(key)
-        return (self.get(url) or {})
+        return self.get(url) or {}
 
     def create_project(self, key, name, description=""):
         """
@@ -41,6 +52,48 @@ def create_project(self, key, name, description=""):
                 }
         return self.post(url, data=data)
 
+    def update_project(self, key, **params):
+        """
+        Update project
+        :param key:
+        :param **params:
+        :return:
+        """
+        data = self.project(key)
+        if not 'errors' in data:
+            data.update(params)
+            url = 'rest/api/1.0/projects/{0}'.format(key)
+            return self.put(url, data=data)
+        else:
+            log.debug('Failed to update project: {0}: Unable to read project'.format(key))
+            return None
+
+    def project_avatar(self, key, content_type='image/png'):
+        """
+        Get project avatar
+
+        :param key:
+        :return:
+        """
+        url = 'rest/api/1.0/projects/{0}/avatar.png'.format(key)
+        headers = dict(self.default_headers)
+        headers['Accept'] = content_type
+        headers['X-Atlassian-Token'] = 'no-check'
+
+        return self.get(url, not_json_response=True, headers=headers) or {}
+
+    def set_project_avatar(self, key, icon, content_type='image/png'):
+        """
+        Set project avatar
+
+        :param key:
+        :return:
+        """
+        headers = {'X-Atlassian-Token': 'no-check'}
+        files = {'avatar': ("avatar.png", icon, content_type)}
+        url = 'rest/api/1.0/projects/{0}/avatar.png'.format(key)
+        return self.post(url, files=files, headers=headers) or {}
+
     def project_users(self, key, limit=99999, filter_str=None):
         """
         Get users who has permission in project
@@ -273,7 +326,8 @@ def project_summary(self, key):
             'key': key,
             'data': self.project(key),
             'users': self.project_users(key),
-            'groups': self.project_groups(key)}
+            'groups': self.project_groups(key),
+            'avatar': self.project_avatar(key)}
 
     def group_members(self, group, limit=99999):
         """
@@ -726,25 +780,25 @@ def get_pullrequest(self, project, repository, pull_request_id):
             pullRequestId=pull_request_id)
         return self.get(url)
 
-    def change_reviewed_status(self, projectKey, repositorySlug, pullRequestId, status, userSlug):
+    def change_reviewed_status(self, project_key, repository_slug, pull_request_id, status, user_slug):
         """
         Change the current user's status for a pull request.
         Implicitly adds the user as a participant if they are not already.
         If the current user is the author, this method will fail.
-        :param projectKey:
-        :param repositorySlug:
-        :param pullRequestId:
+        :param project_key:
+        :param repository_slug:
+        :param pull_request_id:
         :param status:
-        :param userSlug:
+        :param user_slug:
         :return:
         """
-        url = "/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}".format(
-            projectKey=projectKey, repositorySlug=repositorySlug, pullRequestId=pullRequestId, userSlug=userSlug,
+        url = "rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}".format(
+            projectKey=project_key, repositorySlug=repository_slug, pullRequestId=pull_request_id, userSlug=user_slug,
         )
         approved = True if status == "APPROVED" else False
         data = {
             "user": {
-                "name": userSlug
+                "name": user_slug
             },
             "approved": approved,
             "status": status
@@ -1207,7 +1261,7 @@ def upload_file(self, project, repository, content, message, branch, filename):
             filename=filename)
         return self.put(url, files=data)
 
-    def update_file(self, project, repository, content, message, branch, filename, sourceCommitId):
+    def update_file(self, project, repository, content, message, branch, filename, source_commit_id):
         """
         Update existing file for given branch.
         :param project:
@@ -1216,14 +1270,14 @@ def update_file(self, project, repository, content, message, branch, filename, s
         :param message:
         :param branch:
         :param filename:
-        :param sourceCommitId:
+        :param source_commit_id:
         :return:
         """
         data = {
             "content": content,
             "message": message,
             "branch": branch,
-            "sourceCommitId": sourceCommitId
+            "sourceCommitId": source_commit_id
         }
 
         url = 'rest/api/1.0/projects/{project}/repos/{repository}/browse/{filename}'.format(
@@ -1232,33 +1286,34 @@ def update_file(self, project, repository, content, message, branch, filename, s
             filename=filename)
         return self.put(url, files=data)
 
-    def get_code_insights_report(self, projectKey, repositorySlug, commitId, report_key):
+    def get_code_insights_report(self, project_key, repository_slug, commit_id, report_key):
         """
         Retrieve the specified code-insights report.
         :projectKey: str
         :repositorySlug: str
         :commitId: str
         :report_key: str
         """
-        url = "/rest/insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}".format(
-            projectKey=projectKey, repositorySlug=repositorySlug, commitId=commitId, key=report_key
+        url = "rest/insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}".format(
+            projectKey=project_key, repositorySlug=repository_slug, commitId=commit_id, key=report_key
         )
         return self.get(url)
 
-    def delete_code_insights_report(self, projectKey, repositorySlug, commitId, report_key):
+    def delete_code_insights_report(self, project_key, repository_slug, commit_id, report_key):
         """
         Delete a report for the given commit. Also deletes any annotations associated with this report.
         :projectKey: str
         :repositorySlug: str
         :commitId: str
         :report_key: str
         """
-        url = "/rest/insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}".format(
-            projectKey=projectKey, repositorySlug=repositorySlug, commitId=commitId, key=report_key
+        url = "rest/insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}".format(
+            projectKey=project_key, repositorySlug=repository_slug, commitId=commit_id, key=report_key
         )
         return self.delete(url)
 
-    def create_code_insights_report(self, projectKey, repositorySlug, commitId, report_key, report_title, **report_params):
+    def create_code_insights_report(self, project_key, repository_slug, commit_id, report_key, report_title,
+                                    **report_params):
         """
         Create a new insight report, or replace the existing one if a report already exists for the given repository, commit, and report key. 
         A request to replace an existing report will be rejected if the authenticated user was not the creator of the specified report.
@@ -1270,8 +1325,8 @@ def create_code_insights_report(self, projectKey, repositorySlug, commitId, repo
         :report_title: str
         :report_params: 
         """
-        url = "/rest/insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}".format(
-            projectKey=projectKey, repositorySlug=repositorySlug, commitId=commitId, key=report_key
+        url = "rest/insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{key}".format(
+            projectKey=project_key, repositorySlug=repository_slug, commitId=commit_id, key=report_key
         )
         data = {"title": report_title}
         data.update(report_params)

atlassian/jira.py

@@ -205,6 +205,19 @@ def user_delete_property(self, username, key_property):
         params = {'username': username}
         return self.delete(url, params=params)
 
+    def user_update_or_create_property_through_rest_point(self, username, key, value):
+        """
+        ATTENTION!
+        This method used after configuration of rest endpoint on Jira side
+        :param username:
+        :param key:
+        :param value:
+        :return:
+        """
+        url = 'rest/scriptrunner/latest/custom/updateUserProperty'
+        params = {'username': username, 'property': key, 'value': value}
+        return self.get(url, params=params)
+
     def user_update_email(self, username, email):
         """
         Update user email for new domain changes
@@ -363,6 +376,19 @@ def get_project_versions_paginated(self, key, start=None, limit=None, order_by=N
             params['expand'] = expand
         return self.get('rest/api/2/project/{}/version'.format(key), params)
 
+    def add_version(self, project_key, project_id, version, is_archived=False, is_released=False):
+        """
+        Add missing version to project
+        :param project_key: the project key
+        :param project_id: the project id
+        :param version: the new project version to add
+        :is_archived:
+        :is_released:
+        :return:
+        """
+        payload = {'name': version, 'archived': is_archived, 'released': is_released, 'project': project_key, 'projectId': project_id}
+        return self.post("rest/api/2/version", data = payload)
+
     def get_project_roles(self, project_key):
         """
         Provide associated project roles

atlassian/rest_client.py

@@ -20,7 +20,7 @@ class AtlassianRestAPI(object):
     response = None
 
     def __init__(self, url, username=None, password=None, timeout=60, api_root='rest/api', api_version='latest',
-                 verify_ssl=True, session=None, oauth=None, cookies=None, advanced_mode=None):
+                 verify_ssl=True, session=None, oauth=None, cookies=None, advanced_mode=None, kerberos=None):
         if ('atlassian.net' in url or 'jira.com' in url) \
                 and '/wiki' not in url \
                 and self.__class__.__name__ in 'Confluence':
@@ -42,10 +42,29 @@ def __init__(self, url, username=None, password=None, timeout=60, api_root='rest
             self._create_basic_session(username, password)
         elif oauth is not None:
             self._create_oauth_session(oauth)
+        elif kerberos is not None:
+            self._create_kerberos_session(kerberos)
 
     def _create_basic_session(self, username, password):
         self._session.auth = (username, password)
 
+    def _create_kerberos_session(self, kerberos_service):
+        try:
+            import kerberos as kerb
+        except ImportError as e:
+            log.error(e)
+            try:
+                import kerberos_sspi as kerb
+            except ImportError:
+                log.info("Please, fix issue with dependency of kerberos")
+                return
+        __, krb_context = kerb.authGSSClientInit(kerberos_service)
+        kerb.authGSSClientStep(krb_context, "")
+        auth_header = ("Negotiate " + kerb.authGSSClientResponse(krb_context))
+        self._update_header("Authorization", auth_header)
+        response = self._session.get(self.url, verify=self.verify_ssl)
+        response.raise_for_status()
+
     def _create_oauth_session(self, oauth_dict):
         oauth = OAuth1(oauth_dict['consumer_key'],
                        rsa_key=oauth_dict['key_cert'], signature_method=SIGNATURE_RSA,

docs/bitbucket.rst

@@ -9,6 +9,9 @@ Manage projects
     # Project list
     bitbucket.project_list()
 
+    # Repo list
+    bitbucket.repo_list(project_key)
+
     # Project info
     bitbucket.project(key)
 

docs/index.rst

@@ -69,6 +69,29 @@ Alternatively OAuth can be used:
         url='http://localhost:8080',
         oauth=oauth_dict)
 
+Or Kerberos:
+
+.. code-block:: python
+
+    kerberos_service = 'HTTP/[email protected]'
+
+    jira = Jira(
+        url='http://localhost:8080',
+        kerberos=kerberos_service)
+
+    confluence = Confluence(
+        url='http://localhost:8090',
+        kerberos=kerberos_service)
+
+    bitbucket = Bitbucket(
+        url='http://localhost:7990',
+        kerberos=kerberos_service)
+
+    service_desk = ServiceDesk(
+        url='http://localhost:8080',
+        kerberos=kerberos_service)
+
+
 .. toctree::
    :maxdept:2
 
@@ -93,4 +116,4 @@ Alternatively OAuth can be used:
    :alt: PyPI - Downloads
 .. |Docs| image:: https://readthedocs.org/projects/atlassian-python-api/badge/?version=latest
    :target: https://atlassian-python-api.readthedocs.io/en/latest/?badge=latest
-   :alt: Documentation Status
+   :alt: Documentation Status