From 36f3d3e8a909588b06ea5efc1e78e6e1c2e4ee0a Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Mon, 16 Dec 2024 10:25:25 -0600 Subject: [PATCH 01/10] add warning to domain requests when status cannot be changed --- src/registrar/admin.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index 0e8e4847a..5e8148664 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2543,6 +2543,31 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): # Further filter the queryset by the portfolio qs = qs.filter(portfolio=portfolio_id) return qs + + def change_view(self, request, object_id, form_url="", extra_context=None): + """Extend the change_view for DomainRequest objects in django admin. + Customize to display notification that statu cannot be changed from 'Approved'.""" + + # Fetch the Contact instance + domain_request: models.DomainRequest = models.DomainRequest.objects.get(pk=object_id) + if domain_request.approved_domain and domain_request.approved_domain.state == models.Domain.State.READY: + domain = domain_request.approved_domain + # get change url for domain + app_label = domain_request.approved_domain._meta.app_label + model_name = domain._meta.model_name + obj_id = domain.id + change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) + + message += f"

The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa + message += f"{domain}

" + + message_html = mark_safe(message) # nosec + messages.warning( + request, + message_html, + ) + + return super().change_view(request, object_id, form_url, extra_context=extra_context) class TransitionDomainAdmin(ListHeaderAdmin): From ead90c15411ac2f9d1cadc478bc85992642b4e7a Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Mon, 16 Dec 2024 14:11:42 -0600 Subject: [PATCH 02/10] tests for approved domain warning --- src/registrar/admin.py | 50 ++++++++++------------- src/registrar/tests/test_admin_request.py | 38 ++++++++++++++++- 2 files changed, 59 insertions(+), 29 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index 5e8148664..ce3b0220c 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2429,8 +2429,28 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): return response def change_view(self, request, object_id, form_url="", extra_context=None): - """Display restricted warning, - Setup the auditlog trail and pass it in extra context.""" + """Display restricted warning, setup the auditlog trail and pass it in extra context, + display warning that status cannot be changed from 'Approved' if domain is in Ready state""" + + # Fetch the Contact instance + domain_request: models.DomainRequest = models.DomainRequest.objects.get(pk=object_id) + if domain_request.approved_domain and domain_request.approved_domain.state == models.Domain.State.READY: + domain = domain_request.approved_domain + # get change url for domain + app_label = domain_request.approved_domain._meta.app_label + model_name = domain._meta.model_name + obj_id = domain.id + change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) + + message = f"
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa + message += f"{domain}
    • " + + message_html = mark_safe(message) # nosec + messages.warning( + request, + message_html, + ) + obj = self.get_object(request, object_id) self.display_restricted_warning(request, obj) @@ -2543,32 +2563,6 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): # Further filter the queryset by the portfolio qs = qs.filter(portfolio=portfolio_id) return qs - - def change_view(self, request, object_id, form_url="", extra_context=None): - """Extend the change_view for DomainRequest objects in django admin. - Customize to display notification that statu cannot be changed from 'Approved'.""" - - # Fetch the Contact instance - domain_request: models.DomainRequest = models.DomainRequest.objects.get(pk=object_id) - if domain_request.approved_domain and domain_request.approved_domain.state == models.Domain.State.READY: - domain = domain_request.approved_domain - # get change url for domain - app_label = domain_request.approved_domain._meta.app_label - model_name = domain._meta.model_name - obj_id = domain.id - change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) - - message += f"

    The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa - message += f"{domain}

    " - - message_html = mark_safe(message) # nosec - messages.warning( - request, - message_html, - ) - - return super().change_view(request, object_id, form_url, extra_context=extra_context) - class TransitionDomainAdmin(ListHeaderAdmin): """Custom transition domain admin class.""" diff --git a/src/registrar/tests/test_admin_request.py b/src/registrar/tests/test_admin_request.py index df0902719..d744dd00a 100644 --- a/src/registrar/tests/test_admin_request.py +++ b/src/registrar/tests/test_admin_request.py @@ -25,6 +25,8 @@ from registrar.models import ( Portfolio, AllowedEmail, ) +from registrar.models.host import Host +from registrar.models.public_contact import PublicContact from .common import ( MockSESClient, completed_domain_request, @@ -36,7 +38,7 @@ from .common import ( MockEppLib, GenericTestHelper, ) -from unittest.mock import patch +from unittest.mock import ANY, patch from django.conf import settings import boto3_mocking # type: ignore @@ -76,6 +78,8 @@ class TestDomainRequestAdmin(MockEppLib): def tearDown(self): super().tearDown() + Host.objects.all().delete() + PublicContact.objects.all().delete() Domain.objects.all().delete() DomainInformation.objects.all().delete() DomainRequest.objects.all().delete() @@ -91,6 +95,7 @@ class TestDomainRequestAdmin(MockEppLib): User.objects.all().delete() AllowedEmail.objects.all().delete() + @less_console_noise_decorator def test_domain_request_senior_official_is_alphabetically_sorted(self): """Tests if the senior offical dropdown is alphanetically sorted in the django admin display""" @@ -1810,6 +1815,37 @@ class TestDomainRequestAdmin(MockEppLib): request, "Cannot edit a domain request with a restricted creator.", ) + + # @less_console_noise_decorator + def test_approved_domain_request_with_ready_domain_has_warning_message(self): + """Tests if the domain request has a warning message when the approved domain is in Ready state""" + # Create an instance of the model + domain_request = completed_domain_request(status=DomainRequest.DomainRequestStatus.IN_REVIEW) + # Approve the domain request + domain_request.approve() + domain_request.save() + + # Add nameservers to get to Ready state + domain_request.approved_domain.nameservers = [ + ("ns1.city.gov", ["1.1.1.1"]), + ("ns2.city.gov", ["1.1.1.2"]), + ] + domain_request.approved_domain.save() + + with boto3_mocking.clients.handler_for("sesv2", self.mock_client): + with patch("django.contrib.messages.warning") as mock_warning: + # Create a request object + self.client.force_login(self.superuser) + self.client.get( + "/admin/registrar/domainrequest/{}/change/".format(domain_request.pk), + follow=True, + ) + + # Assert that the error message was called with the correct argument + mock_warning.assert_called_once_with( + ANY, # don't care about the request argument + "
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: city.gov
    • " # care about this message + ) def trigger_saving_approved_to_another_state(self, domain_is_active, another_state, rejection_reason=None): """Helper method that triggers domain request state changes from approved to another state, From ec39b159ecfffb7786b2530ce127037084edee68 Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Mon, 16 Dec 2024 14:19:12 -0600 Subject: [PATCH 03/10] make test less brittle --- src/registrar/tests/test_admin_request.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/registrar/tests/test_admin_request.py b/src/registrar/tests/test_admin_request.py index d744dd00a..bbf6c1923 100644 --- a/src/registrar/tests/test_admin_request.py +++ b/src/registrar/tests/test_admin_request.py @@ -1844,7 +1844,7 @@ class TestDomainRequestAdmin(MockEppLib): # Assert that the error message was called with the correct argument mock_warning.assert_called_once_with( ANY, # don't care about the request argument - "
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: city.gov
    • " # care about this message + f"
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: {domain_request.approved_domain.name}
    • ", # noqa ) def trigger_saving_approved_to_another_state(self, domain_is_active, another_state, rejection_reason=None): From 24354fd7f12ee89db24c73162c3f979c31f653d3 Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Tue, 17 Dec 2024 13:03:22 -0600 Subject: [PATCH 04/10] linter fixes --- src/registrar/admin.py | 5 +++-- src/registrar/tests/test_admin_request.py | 5 ++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index ce3b0220c..c04975cb9 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2442,7 +2442,7 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): obj_id = domain.id change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) - message = f"
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa + message = f"
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa message += f"{domain}
    • " message_html = mark_safe(message) # nosec @@ -2450,7 +2450,7 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): request, message_html, ) - + obj = self.get_object(request, object_id) self.display_restricted_warning(request, obj) @@ -2564,6 +2564,7 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): qs = qs.filter(portfolio=portfolio_id) return qs + class TransitionDomainAdmin(ListHeaderAdmin): """Custom transition domain admin class.""" diff --git a/src/registrar/tests/test_admin_request.py b/src/registrar/tests/test_admin_request.py index bbf6c1923..e109d3f96 100644 --- a/src/registrar/tests/test_admin_request.py +++ b/src/registrar/tests/test_admin_request.py @@ -95,7 +95,6 @@ class TestDomainRequestAdmin(MockEppLib): User.objects.all().delete() AllowedEmail.objects.all().delete() - @less_console_noise_decorator def test_domain_request_senior_official_is_alphabetically_sorted(self): """Tests if the senior offical dropdown is alphanetically sorted in the django admin display""" @@ -1815,7 +1814,7 @@ class TestDomainRequestAdmin(MockEppLib): request, "Cannot edit a domain request with a restricted creator.", ) - + # @less_console_noise_decorator def test_approved_domain_request_with_ready_domain_has_warning_message(self): """Tests if the domain request has a warning message when the approved domain is in Ready state""" @@ -1834,7 +1833,7 @@ class TestDomainRequestAdmin(MockEppLib): with boto3_mocking.clients.handler_for("sesv2", self.mock_client): with patch("django.contrib.messages.warning") as mock_warning: - # Create a request object + # Create a request object self.client.force_login(self.superuser) self.client.get( "/admin/registrar/domainrequest/{}/change/".format(domain_request.pk), From f277efc6c43adf072ebe26091c50e66ffbcaf8c3 Mon Sep 17 00:00:00 2001 From: Matt-Spence Date: Mon, 23 Dec 2024 14:57:37 -0600 Subject: [PATCH 05/10] Update src/registrar/admin.py Co-authored-by: zandercymatics <141044360+zandercymatics@users.noreply.github.com> --- src/registrar/admin.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index c04975cb9..117f689f8 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2442,10 +2442,12 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): obj_id = domain.id change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) - message = f"
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa - message += f"{domain}
    • " - - message_html = mark_safe(message) # nosec +message = format_html( + "
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status:" + "{}
    • ", + mark_safe(change_url), + escape(str(domain)) +) messages.warning( request, message_html, From ee2bff6492d87ccccc0e1ddbb1f0948f7a885108 Mon Sep 17 00:00:00 2001 From: Matthew Spence Date: Mon, 23 Dec 2024 15:31:04 -0600 Subject: [PATCH 06/10] fix warning html --- src/registrar/admin.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index 117f689f8..c5aae7d2d 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2442,16 +2442,16 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): obj_id = domain.id change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) -message = format_html( - "
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status:" - "{}
    • ", - mark_safe(change_url), - escape(str(domain)) -) - messages.warning( - request, - message_html, - ) + message = format_html( + "The status of this domain request cannot be changed because it has been joined to a domain in Ready status:" + "{}", + mark_safe(change_url), + escape(str(domain)) + ) + messages.warning( + request, + message, + ) obj = self.get_object(request, object_id) self.display_restricted_warning(request, obj) From 887a9dfc3318a037b01520cbf474893b66548ab0 Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Mon, 30 Dec 2024 10:18:08 -0600 Subject: [PATCH 07/10] linter changes --- src/registrar/admin.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index 2b58cb5fc..bbebbdb80 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2632,10 +2632,10 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) message = format_html( - "The status of this domain request cannot be changed because it has been joined to a domain in Ready status:" + "The status of this domain request cannot be changed because it has been joined to a domain in Ready status:" # noqa: E501 "{}", - mark_safe(change_url), - escape(str(domain)) + mark_safe(change_url), # nosec + escape(str(domain)), ) messages.warning( request, From 7fd5bacb0394322c86bc9d3c7b283fb648f03c1e Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Tue, 31 Dec 2024 11:11:24 -0600 Subject: [PATCH 08/10] fix broken test --- src/registrar/admin.py | 2 +- src/registrar/tests/test_admin_request.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index bbebbdb80..e319daac0 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2632,7 +2632,7 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) message = format_html( - "The status of this domain request cannot be changed because it has been joined to a domain in Ready status:" # noqa: E501 + "The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa: E501 "{}", mark_safe(change_url), # nosec escape(str(domain)), diff --git a/src/registrar/tests/test_admin_request.py b/src/registrar/tests/test_admin_request.py index 8ec63b9d9..6c7d898c7 100644 --- a/src/registrar/tests/test_admin_request.py +++ b/src/registrar/tests/test_admin_request.py @@ -1812,7 +1812,7 @@ class TestDomainRequestAdmin(MockEppLib): "Cannot edit a domain request with a restricted creator.", ) - # @less_console_noise_decorator + @less_console_noise_decorator def test_approved_domain_request_with_ready_domain_has_warning_message(self): """Tests if the domain request has a warning message when the approved domain is in Ready state""" # Create an instance of the model @@ -1840,7 +1840,7 @@ class TestDomainRequestAdmin(MockEppLib): # Assert that the error message was called with the correct argument mock_warning.assert_called_once_with( ANY, # don't care about the request argument - f"
  • The status of this domain request cannot be changed because it has been joined to a domain in Ready status: {domain_request.approved_domain.name}
    • ", # noqa + f"The status of this domain request cannot be changed because it has been joined to a domain in Ready status: {domain_request.approved_domain.name}", # noqa ) def trigger_saving_approved_to_another_state(self, domain_is_active, another_state, rejection_reason=None): From 465e41abc57fa55c05a21b6352635ff561debe55 Mon Sep 17 00:00:00 2001 From: matthewswspence Date: Tue, 31 Dec 2024 14:30:28 -0600 Subject: [PATCH 09/10] fix spacing causing admin bug --- src/registrar/admin.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index e319daac0..7b04f3e9d 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2631,16 +2631,16 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): obj_id = domain.id change_url = reverse("admin:%s_%s_change" % (app_label, model_name), args=[obj_id]) - message = format_html( - "The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa: E501 - "{}", - mark_safe(change_url), # nosec - escape(str(domain)), - ) - messages.warning( - request, - message, - ) + message = format_html( + "The status of this domain request cannot be changed because it has been joined to a domain in Ready status: " # noqa: E501 + "{}", + mark_safe(change_url), # nosec + escape(str(domain)), + ) + messages.warning( + request, + message, + ) obj = self.get_object(request, object_id) self.display_restricted_warning(request, obj) From 6119b39a599da9fea2564ad64eeedf016d4bff56 Mon Sep 17 00:00:00 2001 From: Matthew Spence Date: Tue, 31 Dec 2024 15:26:30 -0600 Subject: [PATCH 10/10] fix comment --- src/registrar/admin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/registrar/admin.py b/src/registrar/admin.py index 8afc2d97f..808d1b557 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -2621,7 +2621,7 @@ class DomainRequestAdmin(ListHeaderAdmin, ImportExportModelAdmin): """Display restricted warning, setup the auditlog trail and pass it in extra context, display warning that status cannot be changed from 'Approved' if domain is in Ready state""" - # Fetch the Contact instance + # Fetch the domain request instance domain_request: models.DomainRequest = models.DomainRequest.objects.get(pk=object_id) if domain_request.approved_domain and domain_request.approved_domain.state == models.Domain.State.READY: domain = domain_request.approved_domain