Merge branch 'master' of https://github.com/atlassian-api/atlassian-python-api

Author: Gonchik Tsymzhitov

atlassian/bitbucket.py

@@ -139,6 +139,16 @@ def user_update_username(self, old_username, new_username):
         data = {"name": new_username}
         return self.user_update(old_username, data=data)
 
+    def user_update_email(self, username, email):
+        """
+        Update user email for new domain changes
+        :param username:
+        :param email:
+        :return:
+        """
+        data = {'name': username, 'emailAddress': email}
+        return self.user_update(username, data=data)
+
     def user_create(self, username, email, display_name, password=None, notification=None):
         """
         Create a user in Jira
@@ -219,16 +229,6 @@ def user_update_or_create_property_through_rest_point(self, username, key, value
         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
-        :param username:
-        :param email:
-        :return:
-        """
-        data = {'name': username, 'emailAddress': email}
-        return self.user_update(username, data=data)
-
     def user_deactivate(self, username):
         """
         Disable user
@@ -2054,6 +2054,45 @@ def tempo_timesheets_get_worklogs(self, date_from=None, date_to=None, username=N
         url = 'rest/tempo-timesheets/3/worklogs/'
         return self.get(url, params=params)
 
+    def tempo_4_timesheets_find_worklogs(self, **params):
+        """
+        Find existing worklogs with searching parameters.
+        NOTE: check if you are using correct types for the parameters!
+        :param from: string From Date
+        :param to: string To Date
+        :param worker: Array of strings
+        :param taskId: Array of integers
+        :param taskKey: Array of strings
+        :param projectId: Array of integers
+        :param projectKey: Array of strings
+        :param teamId: Array of integers
+        :param roleId: Array of integers
+        :param accountId: Array of integers
+        :param accountKey: Array of strings
+        :param filterId: Array of integers
+        :param customerId: Array of integers
+        :param categoryId: Array of integers
+        :param categoryTypeId: Array of integers
+        :param epicKey: Array of strings
+        :param updatedFrom: string
+        :param includeSubtasks: boolean
+        :param pageNo: integer
+        :param maxResults: integer
+        :param offset: integer
+        """
+    
+        url = "rest/tempo-timesheets/4/worklogs/search"
+        return self.post(url, data=params)
+
+    def tempo_timesheets_get_worklogs_by_issue(self, issue):
+        """
+        Get Tempo timesheet worklog by issue key or id.
+        :param issue: Issue key or Id
+        :return:
+        """
+        url = "rest/tempo-timesheets/4/worklogs/jira/issue/{issue}".format(issue=issue)
+        return self.get(url)
+
     def tempo_timesheets_write_worklog(self, worker, started, time_spend_in_seconds, issue_id, comment=None):
         """
         Log work for user

atlassian/jira.py

@@ -22,7 +22,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, kerberos=None):
+                 verify_ssl=True, session=None, oauth=None, cookies=None, advanced_mode=None, kerberos=None, standalone=True):
         if ('atlassian.net' in url or 'jira.com' in url) \
                 and '/wiki' not in url \
                 and self.__class__.__name__ in 'Confluence':

atlassian/rest_client.py

@@ -100,6 +100,9 @@ Groups and admins
     # All project administrators
     bitbucket.all_project_administrators()
 
+    # Get users. Use 'user_filter' parameter to get specific users. 
+    bitbucket.get_users(user_filter="username")
+
 Manage code
 -----------
 
@@ -139,6 +142,9 @@ Manage code
     # Add comment into pull request
     bitbucket.add_pull_request_comment(project, repository, pull_request_id, text)
 
+    # Create a new pull request between two branches.
+    bitbucket.open_pull_request(source_project, source_repo, dest_project, dest_repo, source_branch, destination_branch, title, description)
+
     # Get tags for related repo
     bitbucket.get_tags(project, repository, filter='', limit=99999)
 

docs/bitbucket.rst

@@ -188,19 +188,19 @@ Manage issues
 
     # Set issue status by transition_id
     jira.set_issue_status_by_transition_id(issue_key, transition_id)
-    
+
     # Get issue status
     jira.get_issue_status(issue_key)
-    
+
     # Create or Update Issue Links
     jira.create_or_update_issue_remote_links(issue_key, link_url, title, global_id=None, relationship=None)
-    
+
     # Get Issue Link by link ID
     jira.get_issue_remote_link_by_id(issue_key, link_id)
-    
+
     # Update Issue Link by link ID
     jira.update_issue_remote_link_by_id(issue_key, link_id, url, title, global_id=None, relationship=None)
-    
+
     # Delete Issue Links
     jira.delete_issue_remote_link_by_id(issue_key, link_id)
 
@@ -275,3 +275,38 @@ Issue security schemes
     # user has the administrative permission.
     # Use only_levels=True for get the only levels entries
     jira.get_issue_security_scheme(scheme_id, only_levels=False)
+
+TEMPO
+----------------------
+.. code-block:: python
+
+    # Find existing worklogs with the search parameters.
+    # Look at the tempo docs for additional information:
+    # https://www.tempo.io/server-api-documentation/timesheets#operation/searchWorklogs
+    # NOTE: check if you are using correct types for the parameters!
+    #     :param from: string From Date
+    #     :param to: string To Date
+    #     :param worker: Array of strings
+    #     :param taskId: Array of integers
+    #     :param taskKey: Array of strings
+    #     :param projectId: Array of integers
+    #     :param projectKey: Array of strings
+    #     :param teamId: Array of integers
+    #     :param roleId: Array of integers
+    #     :param accountId: Array of integers
+    #     :param accountKey: Array of strings
+    #     :param filterId: Array of integers
+    #     :param customerId: Array of integers
+    #     :param categoryId: Array of integers
+    #     :param categoryTypeId: Array of integers
+    #     :param epicKey: Array of strings
+    #     :param updatedFrom: string
+    #     :param includeSubtasks: boolean
+    #     :param pageNo: integer
+    #     :param maxResults: integer
+    #     :param offset: integer
+    jira.tempo_4_timesheets_find_worklogs(**params)
+
+    # :PRIVATE:
+    # Get Tempo timesheet worklog by issue key or id.
+    jira.tempo_timesheets_get_worklogs_by_issue(issue)

docs/jira.rst

@@ -0,0 +1,11 @@
+# coding=utf-8
+from atlassian import Bitbucket
+
+
+bitbucket = Bitbucket(
+    url='http://localhost:7990',
+    username='admin',
+    password='admin')
+
+data = bitbucket.get_users(user_filter="username")
+print(data)

examples/bitbucket-users.py

@@ -0,0 +1,27 @@
+# coding=utf-8
+from atlassian import Confluence
+from datetime import datetime
+import logging
+
+
+confluence = Confluence(
+    url='http://localhost:8090',
+    username='admin',
+    password='admin',
+)
+
+logging.basicConfig(level=logging.DEBUG)
+
+filename = "test_file.txt"
+with open(filename, "w") as f:
+    f.write(str(datetime.utcnow()))
+
+confluence.attach_file(filename, page_id="123456789")
+
+link = """<p>
+  <ac:link>
+    <ri:attachment ri:filename="{}"/>
+  </ac:link>
+</p>""".format(filename)
+
+confluence.append_page(123456789, "Page Title", link)

examples/confluence-attach-file-as-link.py

@@ -0,0 +1,17 @@
+# coding=utf-8
+from atlassian import Jira
+from pprint import pprint
+import logging
+
+jira = Jira(
+    url='http://localhost:8080',
+    username='admin',
+    password='admin',
+    advanced_mode=True  #  You can use it without advanced mode. 
+    )
+
+logging.basicConfig(level=logging.DEBUG)
+# deprecated_issue_worklog = jira.tempo_timesheets_get_worklogs_by_issue("PROJ-1234")
+latest_issue_worklog = jira.tempo_4_timesheets_find_worklogs(taskKey=["PROJ-1234"])
+# pprint(deprecated_issue_worklog.json())
+pprint(latest_issue_worklog.json())

examples/jira-tempo-timesheet-worklogs.py

@@ -0,0 +1,95 @@
+from atlassian import Jira
+from atlassian import Stash
+from var import config
+import logging
+import time
+
+PROJECT_KEY = 'PROJ'
+REPOS = ['repo1', 'repo2']
+ACCEPTED_ISSUE_STATUSES = ["Closed", "Verified"]
+EXCLUDE_REPO_RULES = config.exclude_parameters
+LAST_COMMIT_CONDITION_IN_DAYS = 75
+ATLASSIAN_USER = config.JIRA_LOGIN
+ATLASSIAN_PASSWORD = config.JIRA_PASSWORD
+
+logging.basicConfig(level=logging.ERROR)
+jira = Jira(
+    url=config.JIRA_URL,
+    username=ATLASSIAN_USER,
+    password=ATLASSIAN_PASSWORD)
+
+stash = Stash(
+    url=config.STASH_URL,
+    username=ATLASSIAN_USER,
+    password=ATLASSIAN_PASSWORD
+)
+
+flag = True
+time_now = int(time.time()) * 1000
+delta_for_time_ms = LAST_COMMIT_CONDITION_IN_DAYS * 24 * 60 * 60 * 1000
+commit_info_key = "com.atlassian.bitbucket.server.bitbucket-branch:latest-commit-metadata"
+out_going_pull_request = "com.atlassian.bitbucket.server.bitbucket-ref-metadata:outgoing-pull-request-metadata"
+branch_related_issues = "com.atlassian.bitbucket.server.bitbucket-jira:branch-list-jira-issues"
+
+
+def is_can_removed_branch(branch_candidate):
+    branch_id_name = branch_candidate.get('id')
+    # Just exclude exist mainstream branches
+    if any(x in branch_id_name for x in EXCLUDE_REPO_RULES):
+        print(branch.get('displayId') + " in exclusion list")
+        return False
+    # skip default branch maybe DevOps made configs in ui
+    if branch_candidate.get('isDefault'):
+        print(branch.get('displayId') + " is default")
+        return False
+    pull_request_info = ((branch_candidate.get('metadata') or {}).get(out_going_pull_request) or {})
+    if pull_request_info.get('pullRequest') is not None or (pull_request_info.get('open') or 0) > 0:
+        print(branch.get('displayId') + " has open PR")
+        return False
+    # skip branches without pull request info
+    if pull_request_info is None or len(pull_request_info) == 0:
+        print(branch.get('displayId') + " without pull request info")
+    #    return False
+
+    author_time_stamp = branch_candidate.get('metadata').get(commit_info_key).get('authorTimestamp')
+    # check latest commit info
+    if time_now - author_time_stamp < delta_for_time_ms:
+        print(branch.get('displayId') + " is too early to remove")
+        return False
+
+    # check issues statuses
+    exclude = False
+    issues_in_metadata = branch_candidate.get('metadata').get(branch_related_issues)
+    for issue in issues_in_metadata:
+        if jira.get_issue_status(issue.get('key')) not in ACCEPTED_ISSUE_STATUSES:
+            print(branch.get('displayId') + " related issue has not Resolution ")
+            return False
+    # so branch can be removed
+    return True
+
+
+if __name__ == '__main__':
+    DRY_RUN = False
+    log = open("candidate_to_remove.csv", "w")
+    log.write("'Branch name', 'Latest commit', 'Related issues has Resolution'\n")
+    for repository in REPOS:
+        step = 0
+        limit = 10
+        while flag:
+            branches = stash.get_branches(PROJECT_KEY, repository, start=step * limit, limit=limit,
+                                          order_by='ALPHABETICAL')
+            if len(branches) == 0:
+                flag = False
+                break
+            for branch in branches:
+                display_id = branch['displayId']
+                committer_time_stamp = branch.get('metadata').get(commit_info_key).get('committerTimestamp') / 1000
+                last_date_commit = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(committer_time_stamp))
+                if is_can_removed_branch(branch):
+                    if not DRY_RUN:
+                        stash.delete_branch(project=PROJECT_KEY, repository=repository, name=display_id,
+                                            end_point=branch['latestCommit'])
+                    log.write("{},{},{}\n".format(display_id, last_date_commit, True))
+            step += 1
+    log.close()
+    print("Done")