Associated requests and domains
diff --git a/src/registrar/tests/common.py b/src/registrar/tests/common.py
index bcd45f103..5e418da2b 100644
--- a/src/registrar/tests/common.py
+++ b/src/registrar/tests/common.py
@@ -911,6 +911,7 @@ def completed_domain_request( # noqa
federal_type=None,
action_needed_reason=None,
portfolio=None,
+ organization_name=None,
):
"""A completed domain request."""
if not user:
@@ -954,7 +955,7 @@ def completed_domain_request( # noqa
federal_type="executive",
purpose="Purpose of the site",
is_policy_acknowledged=True,
- organization_name="Testorg",
+ organization_name=organization_name if organization_name else "Testorg",
address_line1="address 1",
address_line2="address 2",
state_territory="NY",
diff --git a/src/registrar/tests/test_admin.py b/src/registrar/tests/test_admin.py
index 25d7e5fd2..83114b3b3 100644
--- a/src/registrar/tests/test_admin.py
+++ b/src/registrar/tests/test_admin.py
@@ -2,6 +2,7 @@
from django.utils import timezone
from django.test import TestCase, RequestFactory, Client
from django.contrib.admin.sites import AdminSite
+from django_webtest import WebTest # type: ignore
from api.tests.common import less_console_noise_decorator
from django.urls import reverse
from registrar.admin import (
@@ -41,13 +42,12 @@
TransitionDomain,
Portfolio,
Suborganization,
+ UserPortfolioPermission,
+ UserDomainRole,
+ SeniorOfficial,
+ PortfolioInvitation,
+ VerifiedByStaff,
)
-from registrar.models.portfolio_invitation import PortfolioInvitation
-from registrar.models.senior_official import SeniorOfficial
-from registrar.models.user_domain_role import UserDomainRole
-from registrar.models.user_portfolio_permission import UserPortfolioPermission
-from registrar.models.utility.portfolio_helper import UserPortfolioPermissionChoices, UserPortfolioRoleChoices
-from registrar.models.verified_by_staff import VerifiedByStaff
from .common import (
MockDbForSharedTests,
AuditedAdminMockData,
@@ -60,10 +60,11 @@
multiple_unalphabetical_domain_objects,
GenericTestHelper,
)
+from registrar.models.utility.portfolio_helper import UserPortfolioPermissionChoices, UserPortfolioRoleChoices
from django.contrib.sessions.backends.db import SessionStore
from django.contrib.auth import get_user_model
from unittest.mock import ANY, patch, Mock
-from django_webtest import WebTest # type: ignore
+
import logging
@@ -973,7 +974,7 @@ def test_get_filters(self):
)
-class TestMyUserAdmin(MockDbForSharedTests):
+class TestMyUserAdmin(MockDbForSharedTests, WebTest):
"""Tests for the MyUserAdmin class as super or staff user
Notes:
@@ -993,6 +994,7 @@ def setUpClass(cls):
def setUp(self):
super().setUp()
+ self.app.set_user(self.superuser.username)
self.client = Client(HTTP_HOST="localhost:8080")
def tearDown(self):
@@ -1227,6 +1229,20 @@ def test_analyst_cannot_see_selects_for_portfolio_role_and_permissions_in_user_f
self.assertNotContains(response, "Portfolio roles:")
self.assertNotContains(response, "Portfolio additional permissions:")
+ @less_console_noise_decorator
+ def test_user_can_see_related_portfolios(self):
+ """Tests if a user can see the portfolios they are associated with on the user page"""
+ portfolio, _ = Portfolio.objects.get_or_create(organization_name="test", creator=self.superuser)
+ permission, _ = UserPortfolioPermission.objects.get_or_create(
+ user=self.superuser, portfolio=portfolio, roles=[UserPortfolioRoleChoices.ORGANIZATION_ADMIN]
+ )
+ response = self.app.get(reverse("admin:registrar_user_change", args=[self.superuser.pk]))
+ expected_href = reverse("admin:registrar_portfolio_change", args=[portfolio.pk])
+ self.assertContains(response, expected_href)
+ self.assertContains(response, str(portfolio))
+ permission.delete()
+ portfolio.delete()
+
class AuditedAdminTest(TestCase):
diff --git a/src/registrar/tests/test_management_scripts.py b/src/registrar/tests/test_management_scripts.py
index 1958454f5..cbdc2c034 100644
--- a/src/registrar/tests/test_management_scripts.py
+++ b/src/registrar/tests/test_management_scripts.py
@@ -1,4 +1,5 @@
import copy
+import boto3_mocking # type: ignore
from datetime import date, datetime, time
from django.core.management import call_command
from django.test import TestCase, override_settings
@@ -8,6 +9,7 @@
from django.utils.module_loading import import_string
import logging
import pyzipper
+from django.core.management.base import CommandError
from registrar.management.commands.clean_tables import Command as CleanTablesCommand
from registrar.management.commands.export_tables import Command as ExportTablesCommand
from registrar.models import (
@@ -23,14 +25,17 @@
VerifiedByStaff,
PublicContact,
FederalAgency,
+ Portfolio,
+ Suborganization,
)
import tablib
from unittest.mock import patch, call, MagicMock, mock_open
from epplibwrapper import commands, common
-from .common import MockEppLib, less_console_noise, completed_domain_request
+from .common import MockEppLib, less_console_noise, completed_domain_request, MockSESClient
from api.tests.common import less_console_noise_decorator
+
logger = logging.getLogger(__name__)
@@ -1408,3 +1413,137 @@ def test_populate_federal_agency_initials_and_fceb_missing_agency(self):
missing_agency.refresh_from_db()
self.assertIsNone(missing_agency.initials)
self.assertIsNone(missing_agency.is_fceb)
+
+
+class TestCreateFederalPortfolio(TestCase):
+
+ @less_console_noise_decorator
+ def setUp(self):
+ self.mock_client = MockSESClient()
+ self.user = User.objects.create(username="testuser")
+ self.federal_agency = FederalAgency.objects.create(agency="Test Federal Agency")
+ self.senior_official = SeniorOfficial.objects.create(
+ first_name="first", last_name="last", email="testuser@igorville.gov", federal_agency=self.federal_agency
+ )
+ with boto3_mocking.clients.handler_for("sesv2", self.mock_client):
+ self.domain_request = completed_domain_request(
+ status=DomainRequest.DomainRequestStatus.IN_REVIEW,
+ generic_org_type=DomainRequest.OrganizationChoices.CITY,
+ federal_agency=self.federal_agency,
+ user=self.user,
+ )
+ self.domain_request.approve()
+ self.domain_info = DomainInformation.objects.filter(domain_request=self.domain_request).get()
+
+ self.domain_request_2 = completed_domain_request(
+ name="sock@igorville.org",
+ status=DomainRequest.DomainRequestStatus.IN_REVIEW,
+ generic_org_type=DomainRequest.OrganizationChoices.CITY,
+ federal_agency=self.federal_agency,
+ user=self.user,
+ organization_name="Test Federal Agency",
+ )
+ self.domain_request_2.approve()
+ self.domain_info_2 = DomainInformation.objects.filter(domain_request=self.domain_request_2).get()
+
+ def tearDown(self):
+ DomainInformation.objects.all().delete()
+ DomainRequest.objects.all().delete()
+ Suborganization.objects.all().delete()
+ Portfolio.objects.all().delete()
+ SeniorOfficial.objects.all().delete()
+ FederalAgency.objects.all().delete()
+ User.objects.all().delete()
+
+ @less_console_noise_decorator
+ def run_create_federal_portfolio(self, agency_name, parse_requests=False, parse_domains=False):
+ with patch(
+ "registrar.management.commands.utility.terminal_helper.TerminalHelper.query_yes_no_exit",
+ return_value=True,
+ ):
+ call_command(
+ "create_federal_portfolio", agency_name, parse_requests=parse_requests, parse_domains=parse_domains
+ )
+
+ def test_create_or_modify_portfolio(self):
+ """Test portfolio creation and modification with suborg and senior official."""
+ self.run_create_federal_portfolio("Test Federal Agency", parse_requests=True)
+
+ portfolio = Portfolio.objects.get(federal_agency=self.federal_agency)
+ self.assertEqual(portfolio.organization_name, self.federal_agency.agency)
+ self.assertEqual(portfolio.organization_type, DomainRequest.OrganizationChoices.FEDERAL)
+ self.assertEqual(portfolio.creator, User.get_default_user())
+ self.assertEqual(portfolio.notes, "Auto-generated record")
+
+ # Test the suborgs
+ suborganizations = Suborganization.objects.filter(portfolio__federal_agency=self.federal_agency)
+ self.assertEqual(suborganizations.count(), 1)
+ self.assertEqual(suborganizations.first().name, "Testorg")
+
+ # Test the senior official
+ self.assertEqual(portfolio.senior_official, self.senior_official)
+
+ def test_handle_portfolio_requests(self):
+ """Verify portfolio association with domain requests."""
+ self.run_create_federal_portfolio("Test Federal Agency", parse_requests=True)
+
+ self.domain_request.refresh_from_db()
+ self.assertIsNotNone(self.domain_request.portfolio)
+ self.assertEqual(self.domain_request.portfolio.federal_agency, self.federal_agency)
+ self.assertEqual(self.domain_request.sub_organization.name, "Testorg")
+
+ def test_handle_portfolio_domains(self):
+ """Check portfolio association with domain information."""
+ self.run_create_federal_portfolio("Test Federal Agency", parse_domains=True)
+
+ self.domain_info.refresh_from_db()
+ self.assertIsNotNone(self.domain_info.portfolio)
+ self.assertEqual(self.domain_info.portfolio.federal_agency, self.federal_agency)
+ self.assertEqual(self.domain_info.sub_organization.name, "Testorg")
+
+ def test_handle_parse_both(self):
+ """Ensure correct parsing of both requests and domains."""
+ self.run_create_federal_portfolio("Test Federal Agency", parse_requests=True, parse_domains=True)
+
+ self.domain_request.refresh_from_db()
+ self.domain_info.refresh_from_db()
+ self.assertIsNotNone(self.domain_request.portfolio)
+ self.assertIsNotNone(self.domain_info.portfolio)
+ self.assertEqual(self.domain_request.portfolio, self.domain_info.portfolio)
+
+ def test_command_error_no_parse_options(self):
+ """Verify error when no parse options are provided."""
+ with self.assertRaisesRegex(
+ CommandError, "You must specify at least one of --parse_requests or --parse_domains."
+ ):
+ self.run_create_federal_portfolio("Test Federal Agency")
+
+ def test_command_error_agency_not_found(self):
+ """Check error handling for non-existent agency."""
+ expected_message = (
+ "Cannot find the federal agency 'Non-existent Agency' in our database. "
+ "The value you enter for `agency_name` must be prepopulated in the FederalAgency table before proceeding."
+ )
+ with self.assertRaisesRegex(ValueError, expected_message):
+ self.run_create_federal_portfolio("Non-existent Agency", parse_requests=True)
+
+ def test_update_existing_portfolio(self):
+ """Test updating an existing portfolio."""
+ # Create an existing portfolio
+ existing_portfolio = Portfolio.objects.create(
+ federal_agency=self.federal_agency,
+ organization_name="Test Federal Agency",
+ organization_type=DomainRequest.OrganizationChoices.CITY,
+ creator=self.user,
+ notes="Old notes",
+ )
+
+ self.run_create_federal_portfolio("Test Federal Agency", parse_requests=True)
+
+ existing_portfolio.refresh_from_db()
+ self.assertEqual(existing_portfolio.organization_name, self.federal_agency.agency)
+ self.assertEqual(existing_portfolio.organization_type, DomainRequest.OrganizationChoices.FEDERAL)
+
+ # Notes and creator should be untouched
+ self.assertEqual(existing_portfolio.notes, "Old notes")
+ self.assertEqual(existing_portfolio.creator, self.user)
diff --git a/src/registrar/views/domain.py b/src/registrar/views/domain.py
index 511c55228..f6c87d659 100644
--- a/src/registrar/views/domain.py
+++ b/src/registrar/views/domain.py
@@ -837,6 +837,23 @@ def _send_domain_invitation_email(self, email: str, requestor: User, add_success
)
return None
+ # Check to see if an invite has already been sent
+ try:
+ invite = DomainInvitation.objects.get(email=email, domain=self.object)
+ # check if the invite has already been accepted
+ if invite.status == DomainInvitation.DomainInvitationStatus.RETRIEVED:
+ add_success = False
+ messages.warning(
+ self.request,
+ f"{email} is already a manager for this domain.",
+ )
+ else:
+ add_success = False
+ # else if it has been sent but not accepted
+ messages.warning(self.request, f"{email} has already been invited to this domain")
+ except Exception:
+ logger.error("An error occured")
+
try:
send_templated_email(
"emails/domain_invitation.txt",
@@ -862,24 +879,13 @@ def _send_domain_invitation_email(self, email: str, requestor: User, add_success
def _make_invitation(self, email_address: str, requestor: User):
"""Make a Domain invitation for this email and redirect with a message."""
- # Check to see if an invite has already been sent (NOTE: we do not want to create an invite just yet.)
try:
- invite = DomainInvitation.objects.get(email=email_address, domain=self.object)
- # that invitation already existed
- if invite is not None:
- messages.warning(
- self.request,
- f"{email_address} has already been invited to this domain.",
- )
- except DomainInvitation.DoesNotExist:
- # Try to send the invitation. If it succeeds, add it to the DomainInvitation table.
- try:
- self._send_domain_invitation_email(email=email_address, requestor=requestor)
- except EmailSendingError:
- messages.warning(self.request, "Could not send email invitation.")
- else:
- # (NOTE: only create a domainInvitation if the e-mail sends correctly)
- DomainInvitation.objects.get_or_create(email=email_address, domain=self.object)
+ self._send_domain_invitation_email(email=email_address, requestor=requestor)
+ except EmailSendingError:
+ messages.warning(self.request, "Could not send email invitation.")
+ else:
+ # (NOTE: only create a domainInvitation if the e-mail sends correctly)
+ DomainInvitation.objects.get_or_create(email=email_address, domain=self.object)
return redirect(self.get_success_url())
def form_valid(self, form):
@@ -919,11 +925,9 @@ def form_valid(self, form):
role=UserDomainRole.Roles.MANAGER,
)
except IntegrityError:
- # User already has the desired role! Do nothing??
- pass
-
- messages.success(self.request, f"Added user {requested_email}.")
-
+ messages.warning(self.request, f"{requested_email} is already a manager for this domain")
+ else:
+ messages.success(self.request, f"Added user {requested_email}.")
return redirect(self.get_success_url())