Add retrieve_org_or_project_list management command (#2098)

* Add `retrieve_org_or_project_list` management command

* Remove permissions sort

* Move functions into utility files

onadata/apps/api/management/commands/retrieve_org_or_project_list.py

@@ -0,0 +1,96 @@
+import json
+from django.core.management.base import (
+    BaseCommand, CommandError, CommandParser)
+from django.utils.translation import gettext as _
+
+from onadata.apps.logger.models import Project
+from onadata.apps.api.models import OrganizationProfile
+from onadata.libs.utils.project_utils import get_project_users
+from onadata.libs.utils.organization_utils import get_organization_members
+
+
+class Command(BaseCommand):
+    help = _(
+        "Retrieve collaborators list from all/a specific"
+        " project(s) or organization(s)")
+
+    def add_arguments(self, parser: CommandParser):
+        parser.add_argument(
+            '--project-ids',
+            '-p',
+            default=None,
+            dest='project_ids',
+            help='Comma separated list of project ID(s) to'
+            ' retrieve collaborators/members from.'
+        )
+        parser.add_argument(
+            '--organization-ids',
+            '-oid',
+            default=None,
+            dest='organization_ids',
+            help='Comma separated list of organization ID(s) to retrieve'
+            ' collaborators/members from.'
+        )
+        parser.add_argument(
+            '--output-file',
+            '-o',
+            dest='output_file',
+            default=None,
+            help='JSON file to output the collaborators/members list too'
+        )
+
+    def handle(self, *args, **options):
+        result = {}
+        project_ids = options.get('project_ids')
+        organization_ids = options.get('organization_ids')
+        output_file = options.get('output_file')
+
+        if project_ids or organization_ids:
+            if project_ids:
+                project_ids = project_ids.split(',')
+
+                for project_id in project_ids:
+                    try:
+                        project = Project.objects.get(id=int(project_id))
+                    except Project.DoesNotExist:
+                        raise CommandError(
+                            f'Project with ID {project_id} does not exist.')
+                    except ValueError:
+                        raise CommandError(
+                            f'Invalid project ID input "{project_id}"')
+                    else:
+                        result[project.name] = get_project_users(project)
+
+            if organization_ids:
+                organization_ids = organization_ids.split(',')
+
+                for org_id in organization_ids:
+                    try:
+                        org = OrganizationProfile.objects.get(
+                            id=int(org_id))
+                    except OrganizationProfile.DoesNotExist:
+                        raise CommandError(
+                            f'Organization with ID {org_id} does not exist.')
+                    except ValueError:
+                        raise CommandError(
+                            f'Invalid organization ID input "{org_id}"')
+                    else:
+                        result[org.name] = get_organization_members(org)
+        else:
+            # Retrieve all Project & Organization members & organizations
+            for project in Project.objects.filter(deleted_at__isnull=True):
+                result[project.name] = get_project_users(project)
+
+            for org in OrganizationProfile.objects.filter(
+                    user__is_active=True):
+                result[org.name] = get_organization_members(org)
+
+        if output_file:
+            with open(output_file, 'w+') as outfile:
+                json.dump(result, outfile)
+            self.stdout.write(
+                f'Outputted members/collaborators list to "{output_file}"'
+            )
+        else:
+            out = json.dumps(result)
+            self.stdout.write(out)

onadata/apps/api/tests/management/commands/test_retrieve_org_or_project_list.py

@@ -0,0 +1,96 @@
+import json
+from django.core.management import call_command
+from django.utils.six import StringIO
+
+from onadata.apps.api.tests.viewsets.test_abstract_viewset import \
+    TestAbstractViewSet
+from onadata.libs.serializers.share_project_serializer import \
+    ShareProjectSerializer
+
+
+class TestRetrieveOrgOrProjectListCommand(TestAbstractViewSet):
+    def test_retrieve_org_or_project_list(self):
+        self._org_create()
+        self._project_create()
+
+        user = self._create_user_profile(
+            {'username': 'alice'}).user
+        share_data = {
+            'project': self.project.id,
+            'username': user.username,
+            'role': 'editor'
+        }
+        serializer = ShareProjectSerializer(data=share_data)
+        self.assertTrue(serializer.is_valid())
+        serializer.save()
+
+        out = StringIO()
+        call_command(
+            'retrieve_org_or_project_list',
+            stdout=out
+        )
+
+        expected_project_data = {
+            self.project.name: {
+                user.username: {
+                    'first_name': user.first_name,
+                    'last_name': user.last_name,
+                    'is_org': False,
+                    'role': 'editor'
+                },
+                self.user.username: {
+                    'first_name': self.user.first_name,
+                    'last_name': self.user.last_name,
+                    'is_org': False,
+                    'role': 'owner'
+                }
+            }
+        }
+
+        expected_org_data = {
+            self.organization.name: {
+                self.user.username: {
+                    'first_name': self.user.first_name,
+                    'last_name': self.user.last_name,
+                    'role': 'owner'
+                },
+                self.organization.user.username: {
+                    'first_name': self.organization.user.first_name,
+                    'last_name': self.organization.user.last_name,
+                    'role': 'owner'
+                }
+            }
+        }
+
+        expected_data = {}
+        expected_data.update(expected_project_data)
+        expected_data.update(expected_org_data)
+
+        self.assertEqual(
+            expected_data,
+            json.loads(out.getvalue())
+        )
+
+        out = StringIO()
+
+        call_command(
+            'retrieve_org_or_project_list',
+            project_ids=f'{self.project.id}',
+            stdout=out
+        )
+        self.assertEqual(
+            expected_project_data,
+            json.loads(out.getvalue())
+        )
+
+        out = StringIO()
+
+        call_command(
+            'retrieve_org_or_project_list',
+            organization_ids=f'{self.organization.id}',
+            stdout=out
+        )
+        self.assertEqual(
+            expected_org_data,
+            json.loads(out.getvalue())
+        )

onadata/libs/utils/organization_utils.py

@@ -0,0 +1,17 @@
+"""
+OrganizationProfile utility functions
+"""
+from onadata.libs.serializers.organization_serializer import \
+    OrganizationSerializer
+
+
+def get_organization_members(organization):
+    ret = {}
+    data = OrganizationSerializer().get_users(organization)
+
+    for user_data in data:
+        username = user_data.pop('user')
+        user_data.pop('gravatar')
+        ret[username] = user_data
+
+    return ret

onadata/libs/utils/project_utils.py

@@ -9,12 +9,36 @@
 
 from onadata.apps.logger.models import Project, XForm
 from onadata.celery import app
-from onadata.libs.permissions import (ROLES, OwnerRole,
-                                      get_object_users_with_permissions)
+from onadata.libs.permissions import (
+    ROLES, OwnerRole, get_object_users_with_permissions,
+    is_organization, get_role)
 from onadata.libs.utils.common_tags import OWNER_TEAM_NAME
 from onadata.libs.utils.common_tools import report_exception
 
 
+def get_project_users(project):
+    ret = {}
+
+    for perm in project.projectuserobjectpermission_set.all():
+        if perm.user.username not in ret:
+            user = perm.user
+
+            ret[user.username] = {
+                'permissions': [],
+                'is_org': is_organization(user.profile),
+                'first_name': user.first_name,
+                'last_name': user.last_name,
+            }
+
+        ret[perm.user.username]['permissions'].append(perm.permission.codename)
+
+    for user in ret.keys():
+        ret[user]['role'] = get_role(ret[user]['permissions'], project)
+        del ret[user]['permissions']
+
+    return ret
+
+
 def set_project_perms_to_xform(xform, project):
     """
     Apply project permissions to a form, this usually happens when a new form