#2737: Members csv report - [MEOWARD]

src/registrar/config/urls.py

@@ -21,6 +21,7 @@
     ExportDomainRequestDataFull,
     ExportDataTypeUser,
     ExportDataTypeRequests,
+    ExportMembersPortfolio,
 )
 
 # --jsons
@@ -239,6 +240,11 @@
         name="get-rejection-email-for-user-json",
     ),
     path("admin/", admin.site.urls),
+    path(
+        "reports/export_members_portfolio/",
+        ExportMembersPortfolio.as_view(),
+        name="export_members_portfolio",
+    ),
     path(
         "reports/export_data_type_user/",
         ExportDataTypeUser.as_view(),

src/registrar/models/user_portfolio_permission.py

@@ -106,6 +106,36 @@ def get_portfolio_permissions(cls, roles, additional_permissions):
             portfolio_permissions.update(additional_permissions)
         return list(portfolio_permissions)
 
+    @classmethod
+    def get_domain_request_permission_display(cls, roles, additional_permissions):
+        """Class method to return a readable string for domain request permissions"""
+        # Tracks if they can view, create requests, or not do anything
+        all_permissions = UserPortfolioPermission.get_portfolio_permissions(roles, additional_permissions)
+        all_domain_perms = [
+            UserPortfolioPermissionChoices.VIEW_ALL_REQUESTS,
+            UserPortfolioPermissionChoices.EDIT_REQUESTS,
+        ]
+        if all(perm in all_permissions for perm in all_domain_perms):
+            return "Viewer Requester"
+        elif UserPortfolioPermissionChoices.VIEW_ALL_REQUESTS in all_permissions:
+            return "Viewer"
+        else:
+            return "None"
+
+    @classmethod
+    def get_member_permission_display(cls, roles, additional_permissions):
+        """Class method to return a readable string for member permissions"""
+        # Tracks if they can view, create requests, or not do anything
+        all_permissions = UserPortfolioPermission.get_portfolio_permissions(roles, additional_permissions)
+        # Note for reviewers: the reason why this isn't checking on "all" is because
+        # the way perms work for members is different than requests. We need to consolidate this.
+        if UserPortfolioPermissionChoices.EDIT_MEMBERS in all_permissions:
+            return "Manager"
+        elif UserPortfolioPermissionChoices.VIEW_MEMBERS in all_permissions:
+            return "Viewer"
+        else:
+            return "None"
+
     def clean(self):
         """Extends clean method to perform additional validation, which can raise errors in django admin."""
         super().clean()

src/registrar/models/utility/orm_helper.py

@@ -0,0 +1,8 @@
+from django.db.models.expressions import Func
+
+
+class ArrayRemoveNull(Func):
+    """Custom Func to use array_remove to remove null values"""
+
+    function = "array_remove"
+    template = "%(function)s(%(expressions)s, NULL)"

src/registrar/templates/includes/members_table.html

@@ -8,7 +8,7 @@
 <section class="section-outlined members margin-top-0 section-outlined--border-base-light" id="members">
   <div class="section-outlined__header margin-bottom-3 grid-row">
       <!-- ---------- SEARCH ---------- -->
-      <div class="section-outlined__search mobile:grid-col-12 desktop:grid-col-6">
+      <div class="section-outlined__search mobile:grid-col-12 desktop:grid-col-6 {% if is_widescreen_mode %} section-outlined__search--widescreen {% endif %}">
         <section aria-label="Members search component" class="margin-top-2">
           <form class="usa-search usa-search--small" method="POST" role="search">
             {% csrf_token %}
@@ -36,6 +36,15 @@
           </form>
         </section>
       </div>
+      <div class="section-outlined__utility-button mobile-lg:padding-right-105 {% if portfolio %} mobile:grid-col-12 desktop:grid-col-6 desktop:padding-left-3{% endif %}">
+        <section aria-label="Domains report component" class="margin-top-205">
+          <a href="{% url 'export_members_portfolio' %}" class="usa-button usa-button--unstyled usa-button--with-icon usa-button--justify-right" role="button">
+            <svg class="usa-icon usa-icon--big" aria-hidden="true" focusable="false" role="img" width="24" height="24">
+              <use xlink:href="{%static 'img/sprite.svg'%}#file_download"></use>
+            </svg>Export as CSV
+          </a>
+        </section>
+      </div>
     </div>
 
     <!-- ---------- MAIN TABLE ---------- -->

src/registrar/tests/common.py

@@ -1,6 +1,5 @@
 import os
 import logging
-
 from contextlib import contextmanager
 import random
 from string import ascii_uppercase
@@ -29,6 +28,7 @@
     FederalAgency,
     UserPortfolioPermission,
     Portfolio,
+    PortfolioInvitation,
 )
 from epplibwrapper import (
     commands,
@@ -39,6 +39,7 @@
     ErrorCode,
     responses,
 )
+from registrar.models.utility.portfolio_helper import UserPortfolioPermissionChoices, UserPortfolioRoleChoices
 from registrar.models.user_domain_role import UserDomainRole
 
 from registrar.models.utility.contact_error import ContactError, ContactErrorCodes
@@ -196,6 +197,7 @@ def assert_table_sorted(self, o_index, sort_fields):
 
         self.assertEqual(expected_sort_order, returned_sort_order)
 
+    @classmethod
     def _mock_user_request_for_factory(self, request):
         """Adds sessionmiddleware when using factory to associate session information"""
         middleware = SessionMiddleware(lambda req: req)
@@ -531,6 +533,8 @@ class MockDb(TestCase):
     @classmethod
     @less_console_noise_decorator
     def sharedSetUp(cls):
+        cls.mock_client_class = MagicMock()
+        cls.mock_client = cls.mock_client_class.return_value
         username = "test_user"
         first_name = "First"
         last_name = "Last"
@@ -540,16 +544,36 @@ def sharedSetUp(cls):
         cls.user = get_user_model().objects.create(
             username=username, first_name=first_name, last_name=last_name, email=email, title=title, phone=phone
         )
+        cls.meoward_user = get_user_model().objects.create(
+            username="meoward_username", first_name="first_meoward", last_name="last_meoward", email="[email protected]"
+        )
+        cls.lebowski_user = get_user_model().objects.create(
+            username="big_lebowski", first_name="big", last_name="lebowski", email="[email protected]"
+        )
+        cls.tired_user = get_user_model().objects.create(
+            username="ministry_of_bedtime", first_name="tired", last_name="sleepy", email="[email protected]"
+        )
+        # Custom superuser and staff so that these do not conflict with what may be defined on what implements this.
+        cls.custom_superuser = create_superuser(
+            username="cold_superuser", first_name="cold", last_name="icy", email="[email protected]"
+        )
+        cls.custom_staffuser = create_user(
+            username="warm_staff", first_name="warm", last_name="cozy", email="[email protected]"
+        )
+
+        cls.federal_agency_1, _ = FederalAgency.objects.get_or_create(agency="World War I Centennial Commission")
+        cls.federal_agency_2, _ = FederalAgency.objects.get_or_create(agency="Armed Forces Retirement Home")
+
+        cls.portfolio_1, _ = Portfolio.objects.get_or_create(
+            creator=cls.custom_superuser, federal_agency=cls.federal_agency_1
+        )
 
         current_date = get_time_aware_date(datetime(2024, 4, 2))
         # Create start and end dates using timedelta
 
         cls.end_date = current_date + timedelta(days=2)
         cls.start_date = current_date - timedelta(days=2)
 
-        cls.federal_agency_1, _ = FederalAgency.objects.get_or_create(agency="World War I Centennial Commission")
-        cls.federal_agency_2, _ = FederalAgency.objects.get_or_create(agency="Armed Forces Retirement Home")
-
         cls.domain_1, _ = Domain.objects.get_or_create(
             name="cdomain1.gov", state=Domain.State.READY, first_ready=get_time_aware_date(datetime(2024, 4, 2))
         )
@@ -596,9 +620,14 @@ def sharedSetUp(cls):
             federal_agency=cls.federal_agency_1,
             federal_type="executive",
             is_election_board=False,
+            portfolio=cls.portfolio_1,
         )
         cls.domain_information_2, _ = DomainInformation.objects.get_or_create(
-            creator=cls.user, domain=cls.domain_2, generic_org_type="interstate", is_election_board=True
+            creator=cls.user,
+            domain=cls.domain_2,
+            generic_org_type="interstate",
+            is_election_board=True,
+            portfolio=cls.portfolio_1,
         )
         cls.domain_information_3, _ = DomainInformation.objects.get_or_create(
             creator=cls.user,
@@ -671,14 +700,6 @@ def sharedSetUp(cls):
             is_election_board=False,
         )
 
-        cls.meoward_user = get_user_model().objects.create(
-            username="meoward_username", first_name="first_meoward", last_name="last_meoward", email="[email protected]"
-        )
-
-        cls.lebowski_user = get_user_model().objects.create(
-            username="big_lebowski", first_name="big", last_name="lebowski", email="[email protected]"
-        )
-
         _, created = UserDomainRole.objects.get_or_create(
             user=cls.meoward_user, domain=cls.domain_1, role=UserDomainRole.Roles.MANAGER
         )
@@ -709,6 +730,12 @@ def sharedSetUp(cls):
             status=DomainInvitation.DomainInvitationStatus.RETRIEVED,
         )
 
+        _, created = DomainInvitation.objects.get_or_create(
+            email=cls.meoward_user.email,
+            domain=cls.domain_11,
+            status=DomainInvitation.DomainInvitationStatus.RETRIEVED,
+        )
+
         _, created = DomainInvitation.objects.get_or_create(
             email="[email protected]",
             domain=cls.domain_1,
@@ -723,6 +750,85 @@ def sharedSetUp(cls):
             email="[email protected]", domain=cls.domain_10, status=DomainInvitation.DomainInvitationStatus.INVITED
         )
 
+        cls.portfolio_invitation_1, _ = PortfolioInvitation.objects.get_or_create(
+            email=cls.meoward_user.email,
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_MEMBER],
+            additional_permissions=[UserPortfolioPermissionChoices.EDIT_MEMBERS],
+        )
+
+        cls.portfolio_invitation_2, _ = PortfolioInvitation.objects.get_or_create(
+            email=cls.lebowski_user.email,
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_MEMBER],
+            additional_permissions=[UserPortfolioPermissionChoices.VIEW_MEMBERS],
+        )
+
+        cls.portfolio_invitation_3, _ = PortfolioInvitation.objects.get_or_create(
+            email=cls.tired_user.email,
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_MEMBER],
+            additional_permissions=[UserPortfolioPermissionChoices.VIEW_ALL_REQUESTS],
+        )
+
+        cls.portfolio_invitation_4, _ = PortfolioInvitation.objects.get_or_create(
+            email=cls.custom_superuser.email,
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_ADMIN],
+            additional_permissions=[
+                UserPortfolioPermissionChoices.VIEW_MEMBERS,
+                UserPortfolioPermissionChoices.EDIT_MEMBERS,
+                UserPortfolioPermissionChoices.VIEW_ALL_REQUESTS,
+                UserPortfolioPermissionChoices.EDIT_REQUESTS,
+            ],
+        )
+
+        cls.portfolio_invitation_5, _ = PortfolioInvitation.objects.get_or_create(
+            email=cls.custom_staffuser.email,
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_ADMIN],
+        )
+
+        # Add some invitations that we never retireve
+        PortfolioInvitation.objects.get_or_create(
+            email="[email protected]",
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_MEMBER],
+            additional_permissions=[UserPortfolioPermissionChoices.EDIT_MEMBERS],
+        )
+
+        PortfolioInvitation.objects.get_or_create(
+            email="[email protected]",
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_MEMBER],
+            additional_permissions=[UserPortfolioPermissionChoices.VIEW_MEMBERS],
+        )
+
+        PortfolioInvitation.objects.get_or_create(
+            email="[email protected]",
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_MEMBER],
+            additional_permissions=[UserPortfolioPermissionChoices.VIEW_ALL_REQUESTS],
+        )
+
+        PortfolioInvitation.objects.get_or_create(
+            email="[email protected]",
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_ADMIN],
+            additional_permissions=[
+                UserPortfolioPermissionChoices.VIEW_MEMBERS,
+                UserPortfolioPermissionChoices.EDIT_MEMBERS,
+                UserPortfolioPermissionChoices.VIEW_ALL_REQUESTS,
+                UserPortfolioPermissionChoices.EDIT_REQUESTS,
+            ],
+        )
+
+        PortfolioInvitation.objects.get_or_create(
+            email="[email protected]",
+            portfolio=cls.portfolio_1,
+            roles=[UserPortfolioRoleChoices.ORGANIZATION_ADMIN],
+        )
+
         with less_console_noise():
             cls.domain_request_1 = completed_domain_request(
                 status=DomainRequest.DomainRequestStatus.STARTED,
@@ -731,10 +837,12 @@ def sharedSetUp(cls):
             cls.domain_request_2 = completed_domain_request(
                 status=DomainRequest.DomainRequestStatus.IN_REVIEW,
                 name="city2.gov",
+                portfolio=cls.portfolio_1,
             )
             cls.domain_request_3 = completed_domain_request(
                 status=DomainRequest.DomainRequestStatus.STARTED,
                 name="city3.gov",
+                portfolio=cls.portfolio_1,
             )
             cls.domain_request_4 = completed_domain_request(
                 status=DomainRequest.DomainRequestStatus.STARTED,
@@ -749,6 +857,7 @@ def sharedSetUp(cls):
             cls.domain_request_6 = completed_domain_request(
                 status=DomainRequest.DomainRequestStatus.STARTED,
                 name="city6.gov",
+                portfolio=cls.portfolio_1,
             )
             cls.domain_request_3.submit()
             cls.domain_request_4.submit()
@@ -797,6 +906,7 @@ def sharedTearDown(cls):
         UserPortfolioPermission.objects.all().delete()
         User.objects.all().delete()
         DomainInvitation.objects.all().delete()
+        PortfolioInvitation.objects.all().delete()
         cls.federal_agency_1.delete()
         cls.federal_agency_2.delete()
 
@@ -837,17 +947,18 @@ def mock_user():
     return mock_user
 
 
-def create_superuser():
+def create_superuser(**kwargs):
+    """Creates a analyst user with is_staff=True and the group full_access_group"""
     User = get_user_model()
     p = "adminpass"
     user = User.objects.create_user(
-        username="superuser",
-        email="[email protected]",
-        first_name="first",
-        last_name="last",
-        is_staff=True,
-        password=p,
-        phone="8003111234",
+        username=kwargs.get("username", "superuser"),
+        email=kwargs.get("email", "[email protected]"),
+        first_name=kwargs.get("first_name", "first"),
+        last_name=kwargs.get("last_name", "last"),
+        is_staff=kwargs.get("is_staff", True),
+        password=kwargs.get("password", p),
+        phone=kwargs.get("phone", "8003111234"),
     )
     # Retrieve the group or create it if it doesn't exist
     group, _ = UserGroup.objects.get_or_create(name="full_access_group")
@@ -856,18 +967,19 @@ def create_superuser():
     return user
 
 
-def create_user():
+def create_user(**kwargs):
+    """Creates a analyst user with is_staff=True and the group cisa_analysts_group"""
     User = get_user_model()
     p = "userpass"
     user = User.objects.create_user(
-        username="staffuser",
-        email="[email protected]",
-        first_name="first",
-        last_name="last",
-        is_staff=True,
-        title="title",
-        password=p,
-        phone="8003111234",
+        username=kwargs.get("username", "staffuser"),
+        email=kwargs.get("email", "[email protected]"),
+        first_name=kwargs.get("first_name", "first"),
+        last_name=kwargs.get("last_name", "last"),
+        is_staff=kwargs.get("is_staff", True),
+        title=kwargs.get("title", "title"),
+        password=kwargs.get("password", p),
+        phone=kwargs.get("phone", "8003111234"),
     )
     # Retrieve the group or create it if it doesn't exist
     group, _ = UserGroup.objects.get_or_create(name="cisa_analysts_group")