[Confluence] Get group members (#674)

* Confluence: provide an exact method to extract all users. related to the  #638

* Bump version and polish

* Update atlassian/confluence.py

Thank you! :)

Co-authored-by: Michael Förderer <40258682+Spacetown@users.noreply.github.com>

* Update atlassian/confluence.py

Co-authored-by: Michael Förderer <40258682+Spacetown@users.noreply.github.com>

Co-authored-by: Michael Förderer <40258682+Spacetown@users.noreply.github.com>

Author: gonchik

atlassian/VERSION

@@ -1 +1 @@
-2.4.2
+2.4.3

atlassian/confluence.py

@@ -1737,6 +1737,28 @@ def get_group_members(self, group_name="confluence-users", start=0, limit=1000,
 
         return response.get("results")
 
+    def get_all_members(self, group_name="confluence-users", expand=None):
+        """
+        Get  collection of all users in the given group
+        :param group_name
+        :param expand: OPTIONAL: A comma separated list of properties to expand on the content. status
+        :return:
+        """
+        limit = 50
+        flag = True
+        step = 0
+        members = []
+        while flag:
+            values = self.get_group_members(group_name=group_name, start=len(members), limit=limit, expand=expand)
+            step += 1
+            if len(values) == 0:
+                flag = False
+            else:
+                members.extend(values)
+        if not members:
+            print("Did not get members from {} group, please check permissions or connectivity".format(group_name))
+        return members
+
     def get_space(self, space_key, expand="description.plain,homepage"):
         """
         Get information about a space through space key

examples/bitbucket/bitbucket_check_last_auth_users.py

@@ -25,11 +25,11 @@ def report(all=False, non_auth=False, limit=20):
         else:
             full_date = None
         if full_date:
-            output = "{} ({}) authenticated on {}".format(user.get('displayName'), user.get('emailAddress'), full_date)
+            output = "{} ({}) authenticated on {}".format(user.get("displayName"), user.get("emailAddress"), full_date)
             if all:
                 print(output)
         else:
-            output = "{} ({}) not authenticated yet".format(user.get('displayName'), user.get('emailAddress'))
+            output = "{} ({}) not authenticated yet".format(user.get("displayName"), user.get("emailAddress"))
             if non_auth or all:
                 print(output)
 

examples/confluence/confluence_get_group_members.py

@@ -1,18 +1,28 @@
 # coding=utf-8
 from atlassian import Confluence
+from pprint import pprint
+
+"""This example shows how to get all users from group e.g. group_name """
 
 confluence = Confluence(url="http://localhost:8090", username="admin", password="admin")
-# this example related get all user from group e.g. group_name
-group_name = "confluence-users"
-flag = True
-i = 0
-limit = 50
-result = []
-while flag:
-    response = confluence.get_group_members(group_name=group_name, start=i * limit, limit=limit)
-    if response and len(response):
-        i += 1
-        result.append(response)
-    else:
-        flag = False
-print(result)
+
+
+def get_all_members(group_name):
+    flag = True
+    i = 0
+    limit = 50
+    result = []
+
+    while flag:
+        response = confluence.get_group_members(group_name=group_name, start=i * limit, limit=limit)
+        if response and len(response):
+            i += 1
+            result.append(response)
+        else:
+            flag = False
+    return result
+
+
+if __name__ == "__main__":
+    group_name = "confluence-users"
+    pprint(get_all_members(group_name=group_name))

examples/jira/jira_convert_group_members_into_user_in_role.py

@@ -13,7 +13,7 @@ def convert_group_into_users_in_role(project_key, role_id, group_name):
     users = jira.get_all_users_from_group(group=group_name, limit=1000).get("values")
     for user in users:
         jira.add_user_into_project_role(project_key=project_key, role_id=role_id, user_name=user.get("name"))
-        print("{} added into role_id  {} in {}".format(user.get('name'), role_id, project_key))
+        print("{} added into role_id  {} in {}".format(user.get("name"), role_id, project_key))
 
 
 group_name_to_find = "old-developers"
@@ -27,5 +27,5 @@ def convert_group_into_users_in_role(project_key, role_id, group_name):
         for member in members_of_role:
             if member.get("type") == "atlassian-group-role-actor":
                 if member.get("name") == group_name_to_find:
-                    print('{} has {}'.format(project.get("key"), role.get("name")))
+                    print("{} has {}".format(project.get("key"), role.get("name")))
                     convert_group_into_users_in_role(project.get("key"), role.get("id"), group_name_to_find)

examples/jira/jira_find_screen_similarity.py

@@ -41,18 +41,18 @@ def extract_count(json):
         }
     )
     count_fields_per_screen.append(number_fields)
-    print("Number of available screen fields {} for screen with name  {}".format(number_fields, screen.get('name')))
+    print("Number of available screen fields {} for screen with name  {}".format(number_fields, screen.get("name")))
 
 screens.sort(key=extract_count, reverse=True)
 flipped_fields = {}
 
 print("The same screen of fields based on the count")
 for x in screens:
     if count_fields_per_screen.count(x["available_fields_count"]) > 1:
-        print("Please, check {}/secure/admin/ConfigureFieldScreen.jspa?id={}".format(jira.url, x['screen_id']))
+        print("Please, check {}/secure/admin/ConfigureFieldScreen.jspa?id={}".format(jira.url, x["screen_id"]))
 
 print("=" * 12)
 print("The same field screens based on the hash")
 for x in screens:
     if hashes.count(x["available_fields_hash"]) > 1:
-        print("Please, check {}/secure/admin/ConfigureFieldScreen.jspa?id={}".format(jira.url, x['screen_id']))
+        print("Please, check {}/secure/admin/ConfigureFieldScreen.jspa?id={}".format(jira.url, x["screen_id"]))