- -
+
+
+ –
-
-
-
-
-
Auto-generated email that will be sent to the creator
-
-
- Email sent to the creator
+
+ {{ field.field }}
+
+
+ 
Edit email
+
+
+
{% else %}
{{ field.field }}
{% endif %}
{% endblock field_other %}
{% block after_help_text %}
- {% if field.field.name == "action_needed_reason_email" %}
- {% comment %}
- Store the action needed reason emails in a json-based dictionary.
- This allows us to change the action_needed_reason_email field dynamically, depending on value.
- The alternative to this is an API endpoint.
-
- Given that we have a limited number of emails, doing it this way makes sense.
- {% endcomment %}
- {% if action_needed_reason_emails %}
-
- {% endif %}
- {% elif field.field.name == "creator" %}
+ {% if field.field.name == "creator" %}
+
-
-
+
- + Are you sure you want to edit this email? +
+
+
-
- Edit email
- + The creator of this request already received an email for this status/reason: +
+-
+
- Status: Action needed +
- Reason: {{ original_object.get_action_needed_reason_display }} +
+ If you edit this email's text, the system will send another email to + the creator after you “save” your changes. If you do not want to send another email, click “cancel” below.
-
-
-
-
-
-
-
-
+
- Are you sure you want to edit this email? -
-
-
-
- - The creator of this request already received an email for this status/reason: -
--
-
- Status: Action needed -
- Reason: {{ original_object.get_action_needed_reason_display }} -
- If you edit this email's text, the system will send another email to - the creator after you “save” your changes. If you do not want to send another email, click “cancel” below. -
-
- {{ field.field }}
-
-
+
{% include "django/admin/includes/contact_detail_list.html" with user=original_object.creator no_title_top_padding=field.is_readonly user_verification_type=original_object.creator.get_verification_type_display%}
diff --git a/src/registrar/tests/test_admin_domain.py b/src/registrar/tests/test_admin_domain.py
index 49f095a25..a9b94781f 100644
--- a/src/registrar/tests/test_admin_domain.py
+++ b/src/registrar/tests/test_admin_domain.py
@@ -167,12 +167,6 @@ class TestDomainAdminAsStaff(MockEppLib):
expected_organization_name = "MonkeySeeMonkeyDo"
self.assertContains(response, expected_organization_name)
- # clean up this test's data
- domain.delete()
- domain_information.delete()
- _domain_request.delete()
- _creator.delete()
-
@less_console_noise_decorator
def test_deletion_is_successful(self):
"""
@@ -227,9 +221,6 @@ class TestDomainAdminAsStaff(MockEppLib):
self.assertEqual(domain.state, Domain.State.DELETED)
- # clean up data within this test
- domain.delete()
-
@less_console_noise_decorator
def test_deletion_ready_fsm_failure(self):
"""
@@ -269,9 +260,6 @@ class TestDomainAdminAsStaff(MockEppLib):
self.assertEqual(domain.state, Domain.State.READY)
- # delete data created in this test
- domain.delete()
-
@less_console_noise_decorator
def test_analyst_deletes_domain_idempotent(self):
"""
@@ -330,8 +318,130 @@ class TestDomainAdminAsStaff(MockEppLib):
)
self.assertEqual(domain.state, Domain.State.DELETED)
- # delete data created in this test
- domain.delete()
+
+class TestDomainInformationInline(MockEppLib):
+ """Test DomainAdmin class, specifically the DomainInformationInline class, as staff user.
+
+ Notes:
+ all tests share staffuser; do not change staffuser model in tests
+ tests have available staffuser, client, and admin
+ """
+
+ @classmethod
+ def setUpClass(cls):
+ super().setUpClass()
+ cls.staffuser = create_user()
+ cls.site = AdminSite()
+ cls.admin = DomainAdmin(model=Domain, admin_site=cls.site)
+ cls.factory = RequestFactory()
+
+ def setUp(self):
+ self.client = Client(HTTP_HOST="localhost:8080")
+ self.client.force_login(self.staffuser)
+ super().setUp()
+
+ def tearDown(self):
+ super().tearDown()
+ Host.objects.all().delete()
+ UserDomainRole.objects.all().delete()
+ Domain.objects.all().delete()
+ DomainInformation.objects.all().delete()
+ DomainRequest.objects.all().delete()
+
+ @classmethod
+ def tearDownClass(cls):
+ User.objects.all().delete()
+ super().tearDownClass()
+
+ @less_console_noise_decorator
+ def test_domain_managers_display(self):
+ """Tests the custom domain managers field"""
+ admin_user_1 = User.objects.create(
+ username="testuser1",
+ first_name="Gerald",
+ last_name="Meoward",
+ email="meoward@gov.gov",
+ )
+
+ domain_request = completed_domain_request(
+ status=DomainRequest.DomainRequestStatus.IN_REVIEW, user=self.staffuser, name="fake.gov"
+ )
+ domain_request.approve()
+ _domain_info = DomainInformation.objects.filter(domain=domain_request.approved_domain).get()
+ domain = Domain.objects.filter(domain_info=_domain_info).get()
+
+ UserDomainRole.objects.get_or_create(user=admin_user_1, domain=domain, role=UserDomainRole.Roles.MANAGER)
+
+ admin_user_2 = User.objects.create(
+ username="testuser2",
+ first_name="Arnold",
+ last_name="Poopy",
+ email="poopy@gov.gov",
+ )
+
+ UserDomainRole.objects.get_or_create(user=admin_user_2, domain=domain, role=UserDomainRole.Roles.MANAGER)
+
+ # Get the first inline (DomainInformationInline)
+ inline_instance = self.admin.inlines[0](self.admin.model, self.admin.admin_site)
+
+ # Call the domain_managers method
+ domain_managers = inline_instance.domain_managers(domain.domain_info)
+
+ self.assertIn(
+ f'testuser1',
+ domain_managers,
+ )
+ self.assertIn("Gerald Meoward", domain_managers)
+ self.assertIn("meoward@gov.gov", domain_managers)
+ self.assertIn(f'testuser2', domain_managers)
+ self.assertIn("Arnold Poopy", domain_managers)
+ self.assertIn("poopy@gov.gov", domain_managers)
+
+ @less_console_noise_decorator
+ def test_invited_domain_managers_display(self):
+ """Tests the custom invited domain managers field"""
+ admin_user_1 = User.objects.create(
+ username="testuser1",
+ first_name="Gerald",
+ last_name="Meoward",
+ email="meoward@gov.gov",
+ )
+
+ domain_request = completed_domain_request(
+ status=DomainRequest.DomainRequestStatus.IN_REVIEW, user=self.staffuser, name="fake.gov"
+ )
+ domain_request.approve()
+ _domain_info = DomainInformation.objects.filter(domain=domain_request.approved_domain).get()
+ domain = Domain.objects.filter(domain_info=_domain_info).get()
+
+ # domain, _ = Domain.objects.get_or_create(name="fake.gov", state=Domain.State.READY)
+ UserDomainRole.objects.get_or_create(user=admin_user_1, domain=domain, role=UserDomainRole.Roles.MANAGER)
+
+ admin_user_2 = User.objects.create(
+ username="testuser2",
+ first_name="Arnold",
+ last_name="Poopy",
+ email="poopy@gov.gov",
+ )
+
+ UserDomainRole.objects.get_or_create(user=admin_user_2, domain=domain, role=UserDomainRole.Roles.MANAGER)
+
+ # Get the first inline (DomainInformationInline)
+ inline_instance = self.admin.inlines[0](self.admin.model, self.admin.admin_site)
+
+ # Call the domain_managers method
+ domain_managers = inline_instance.domain_managers(domain.domain_info)
+ # domain_managers = self.admin.get_inlinesdomain_managers(self.domain)
+
+ self.assertIn(
+ f'testuser1',
+ domain_managers,
+ )
+ self.assertIn("Gerald Meoward", domain_managers)
+ self.assertIn("meoward@gov.gov", domain_managers)
+ self.assertIn(f'testuser2', domain_managers)
+ self.assertIn("Arnold Poopy", domain_managers)
+ self.assertIn("poopy@gov.gov", domain_managers)
class TestDomainAdminWithClient(TestCase):
@@ -415,17 +525,6 @@ class TestDomainAdminWithClient(TestCase):
self.assertContains(response, domain.name)
# Check that the fields have the right values.
- # == Check for the creator == #
-
- # Check for the right title, email, and phone number in the response.
- # We only need to check for the end tag
- # (Otherwise this test will fail if we change classes, etc)
- self.assertContains(response, "Treat inspector")
- self.assertContains(response, "meoward.jones@igorville.gov")
- self.assertContains(response, "(555) 123 12345")
-
- # Check for the field itself
- self.assertContains(response, "Meoward Jones")
# == Check for the senior_official == #
self.assertContains(response, "testy@town.com")
@@ -435,11 +534,6 @@ class TestDomainAdminWithClient(TestCase):
# Includes things like readonly fields
self.assertContains(response, "Testy Tester")
- # == Test the other_employees field == #
- self.assertContains(response, "testy2@town.com")
- self.assertContains(response, "Another Tester")
- self.assertContains(response, "(555) 555 5557")
-
# Test for the copy link
self.assertContains(response, "button--clipboard")
diff --git a/src/registrar/tests/test_admin_request.py b/src/registrar/tests/test_admin_request.py
index 28639e69b..a9b073472 100644
--- a/src/registrar/tests/test_admin_request.py
+++ b/src/registrar/tests/test_admin_request.py
@@ -872,23 +872,6 @@ class TestDomainRequestAdmin(MockEppLib):
self.transition_state_and_send_email(domain_request, DomainRequest.DomainRequestStatus.SUBMITTED)
self.assertEqual(len(self.mock_client.EMAILS_SENT), 3)
- @less_console_noise_decorator
- def test_model_displays_action_needed_email(self):
- """Tests if the action needed email is visible for Domain Requests"""
-
- _domain_request = completed_domain_request(
- status=DomainRequest.DomainRequestStatus.ACTION_NEEDED,
- action_needed_reason=DomainRequest.ActionNeededReasons.BAD_NAME,
- )
-
- self.client.force_login(self.staffuser)
- response = self.client.get(
- "/admin/registrar/domainrequest/{}/change/".format(_domain_request.pk),
- follow=True,
- )
-
- self.assertContains(response, "DOMAIN NAME DOES NOT MEET .GOV REQUIREMENTS")
-
@override_settings(IS_PRODUCTION=True)
@less_console_noise_decorator
def test_save_model_sends_submitted_email_with_bcc_on_prod(self):
diff --git a/src/registrar/tests/test_api.py b/src/registrar/tests/test_api.py
index 7a432bcb8..218c63d4f 100644
--- a/src/registrar/tests/test_api.py
+++ b/src/registrar/tests/test_api.py
@@ -1,8 +1,8 @@
from django.urls import reverse
from django.test import TestCase, Client
-from registrar.models import FederalAgency, SeniorOfficial, User
+from registrar.models import FederalAgency, SeniorOfficial, User, DomainRequest
from django.contrib.auth import get_user_model
-from registrar.tests.common import create_superuser, create_user
+from registrar.tests.common import create_superuser, create_user, completed_domain_request
from api.tests.common import less_console_noise_decorator
from registrar.utility.constants import BranchChoices
@@ -108,3 +108,71 @@ class GetFederalPortfolioTypeJsonTest(TestCase):
self.client.login(username="testuser", password=p)
response = self.client.get(self.api_url, {"agency_name": "Test Agency", "organization_type": "federal"})
self.assertEqual(response.status_code, 302)
+
+
+class GetActionNeededEmailForUserJsonTest(TestCase):
+ def setUp(self):
+ self.client = Client()
+ self.superuser = create_superuser()
+ self.analyst_user = create_user()
+ self.agency = FederalAgency.objects.create(agency="Test Agency")
+ self.domain_request = completed_domain_request(
+ federal_agency=self.agency,
+ name="test.gov",
+ status=DomainRequest.DomainRequestStatus.ACTION_NEEDED,
+ )
+
+ self.api_url = reverse("get-action-needed-email-for-user-json")
+
+ def tearDown(self):
+ DomainRequest.objects.all().delete()
+ User.objects.all().delete()
+ FederalAgency.objects.all().delete()
+
+ @less_console_noise_decorator
+ def test_get_action_needed_email_for_user_json_superuser(self):
+ """Test that a superuser can fetch the action needed email."""
+ self.client.force_login(self.superuser)
+
+ response = self.client.get(
+ self.api_url,
+ {
+ "reason": DomainRequest.ActionNeededReasons.ELIGIBILITY_UNCLEAR,
+ "domain_request_id": self.domain_request.id,
+ },
+ )
+ self.assertEqual(response.status_code, 200)
+ data = response.json()
+ self.assertIn("action_needed_email", data)
+ self.assertIn("ORGANIZATION MAY NOT MEET ELIGIBILITY REQUIREMENTS", data["action_needed_email"])
+
+ @less_console_noise_decorator
+ def test_get_action_needed_email_for_user_json_analyst(self):
+ """Test that an analyst can fetch the action needed email."""
+ self.client.force_login(self.analyst_user)
+
+ response = self.client.get(
+ self.api_url,
+ {
+ "reason": DomainRequest.ActionNeededReasons.QUESTIONABLE_SENIOR_OFFICIAL,
+ "domain_request_id": self.domain_request.id,
+ },
+ )
+ self.assertEqual(response.status_code, 200)
+ data = response.json()
+ self.assertIn("action_needed_email", data)
+ self.assertIn("SENIOR OFFICIAL DOES NOT MEET ELIGIBILITY REQUIREMENTS", data["action_needed_email"])
+
+ @less_console_noise_decorator
+ def test_get_action_needed_email_for_user_json_regular(self):
+ """Test that a regular user receives a 403 with an error message."""
+ p = "password"
+ self.client.login(username="testuser", password=p)
+ response = self.client.get(
+ self.api_url,
+ {
+ "reason": DomainRequest.ActionNeededReasons.QUESTIONABLE_SENIOR_OFFICIAL,
+ "domain_request_id": self.domain_request.id,
+ },
+ )
+ self.assertEqual(response.status_code, 302)
diff --git a/src/registrar/utility/admin_helpers.py b/src/registrar/utility/admin_helpers.py
new file mode 100644
index 000000000..0b99bba13
--- /dev/null
+++ b/src/registrar/utility/admin_helpers.py
@@ -0,0 +1,36 @@
+from registrar.models.domain_request import DomainRequest
+from django.template.loader import get_template
+
+
+def get_all_action_needed_reason_emails(request, domain_request):
+ """Returns a dictionary of every action needed reason and its associated email
+ for this particular domain request."""
+
+ emails = {}
+ for action_needed_reason in domain_request.ActionNeededReasons:
+ # Map the action_needed_reason to its default email
+ emails[action_needed_reason.value] = get_action_needed_reason_default_email(
+ request, domain_request, action_needed_reason.value
+ )
+
+ return emails
+
+
+def get_action_needed_reason_default_email(request, domain_request, action_needed_reason):
+ """Returns the default email associated with the given action needed reason"""
+ if not action_needed_reason or action_needed_reason == DomainRequest.ActionNeededReasons.OTHER:
+ return None
+
+ recipient = domain_request.creator
+ # Return the context of the rendered views
+ context = {"domain_request": domain_request, "recipient": recipient}
+
+ # Get the email body
+ template_path = f"emails/action_needed_reasons/{action_needed_reason}.txt"
+
+ email_body_text = get_template(template_path).render(context=context)
+ email_body_text_cleaned = None
+ if email_body_text:
+ email_body_text_cleaned = email_body_text.strip().lstrip("\n")
+
+ return email_body_text_cleaned
diff --git a/src/registrar/views/utility/api_views.py b/src/registrar/views/utility/api_views.py
index 7240cf43f..f9522e2e9 100644
--- a/src/registrar/views/utility/api_views.py
+++ b/src/registrar/views/utility/api_views.py
@@ -1,10 +1,10 @@
import logging
from django.http import JsonResponse
from django.forms.models import model_to_dict
-from registrar.models import FederalAgency, SeniorOfficial
+from registrar.models import FederalAgency, SeniorOfficial, DomainRequest
from django.contrib.admin.views.decorators import staff_member_required
from django.contrib.auth.decorators import login_required
-
+from registrar.utility.admin_helpers import get_all_action_needed_reason_emails
from registrar.models.portfolio import Portfolio
from registrar.utility.constants import BranchChoices
@@ -66,3 +66,27 @@ def get_federal_and_portfolio_types_from_federal_agency_json(request):
}
return JsonResponse(response_data)
+
+
+@login_required
+@staff_member_required
+def get_action_needed_email_for_user_json(request):
+ """Returns a default action needed email for a given user"""
+
+ # This API is only accessible to admins and analysts
+ superuser_perm = request.user.has_perm("registrar.full_access_permission")
+ analyst_perm = request.user.has_perm("registrar.analyst_access_permission")
+ if not request.user.is_authenticated or not any([analyst_perm, superuser_perm]):
+ return JsonResponse({"error": "You do not have access to this resource"}, status=403)
+
+ reason = request.GET.get("reason")
+ domain_request_id = request.GET.get("domain_request_id")
+ if not reason:
+ return JsonResponse({"error": "No reason specified"}, status=404)
+
+ if not domain_request_id:
+ return JsonResponse({"error": "No domain_request_id specified"}, status=404)
+
+ domain_request = DomainRequest.objects.filter(id=domain_request_id).first()
+ emails = get_all_action_needed_reason_emails(request, domain_request)
+ return JsonResponse({"action_needed_email": emails.get(reason)}, status=200)