From 42dec38b224dc15b0cbace67f88c2ee8e127af5d Mon Sep 17 00:00:00 2001 From: zandercymatics <141044360+zandercymatics@users.noreply.github.com> Date: Thu, 22 Aug 2024 12:12:38 -0600 Subject: [PATCH] skeleton pt 2 --- src/registrar/admin.py | 6 +++--- .../{0119_allowedemails.py => 0119_allowedemail.py} | 2 +- src/registrar/migrations/0120_create_groups_v16.py | 2 +- src/registrar/models/__init__.py | 6 +++--- .../models/{allowed_emails.py => allowed_email.py} | 4 ++-- src/registrar/templates/admin/model_descriptions.html | 2 ++ .../includes/descriptions/allowed_email_description.html | 6 ++++++ 7 files changed, 18 insertions(+), 10 deletions(-) rename src/registrar/migrations/{0119_allowedemails.py => 0119_allowedemail.py} (95%) rename src/registrar/models/{allowed_emails.py => allowed_email.py} (74%) create mode 100644 src/registrar/templates/django/admin/includes/descriptions/allowed_email_description.html diff --git a/src/registrar/admin.py b/src/registrar/admin.py index 730e0fb20..9e5fb71aa 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -3169,9 +3169,9 @@ class SuborganizationAdmin(ListHeaderAdmin, ImportExportModelAdmin): extra_context = {"domain_requests": domain_requests, "domains": domains} return super().change_view(request, object_id, form_url, extra_context) -class AllowedEmailsAdmin(ListHeaderAdmin): +class AllowedEmailAdmin(ListHeaderAdmin): class Meta: - model = models.AllowedEmails + model = models.AllowedEmail list_display = ["email"] search_fields = ["email"] @@ -3205,7 +3205,7 @@ admin.site.register(models.Portfolio, PortfolioAdmin) admin.site.register(models.DomainGroup, DomainGroupAdmin) admin.site.register(models.Suborganization, SuborganizationAdmin) admin.site.register(models.SeniorOfficial, SeniorOfficialAdmin) -admin.site.register(models.AllowedEmails, AllowedEmailsAdmin) +admin.site.register(models.AllowedEmail, AllowedEmailAdmin) # Register our custom waffle implementations admin.site.register(models.WaffleFlag, WaffleFlagAdmin) diff --git a/src/registrar/migrations/0119_allowedemails.py b/src/registrar/migrations/0119_allowedemail.py similarity index 95% rename from src/registrar/migrations/0119_allowedemails.py rename to src/registrar/migrations/0119_allowedemail.py index ddfda75ca..9d63d6973 100644 --- a/src/registrar/migrations/0119_allowedemails.py +++ b/src/registrar/migrations/0119_allowedemail.py @@ -11,7 +11,7 @@ class Migration(migrations.Migration): operations = [ migrations.CreateModel( - name="AllowedEmails", + name="AllowedEmail", fields=[ ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")), ("created_at", models.DateTimeField(auto_now_add=True)), diff --git a/src/registrar/migrations/0120_create_groups_v16.py b/src/registrar/migrations/0120_create_groups_v16.py index 51330bc99..f08e20805 100644 --- a/src/registrar/migrations/0120_create_groups_v16.py +++ b/src/registrar/migrations/0120_create_groups_v16.py @@ -25,7 +25,7 @@ def create_groups(apps, schema_editor) -> Any: class Migration(migrations.Migration): dependencies = [ - ("registrar", "0119_allowedemails"), + ("registrar", "0119_allowedemail"), ] operations = [ diff --git a/src/registrar/models/__init__.py b/src/registrar/models/__init__.py index 93723de7d..f525e690e 100644 --- a/src/registrar/models/__init__.py +++ b/src/registrar/models/__init__.py @@ -21,7 +21,7 @@ from .portfolio import Portfolio from .domain_group import DomainGroup from .suborganization import Suborganization from .senior_official import SeniorOfficial -from .allowed_emails import AllowedEmails +from .allowed_email import AllowedEmail __all__ = [ @@ -47,7 +47,7 @@ __all__ = [ "DomainGroup", "Suborganization", "SeniorOfficial", - "AllowedEmails", + "AllowedEmail", ] auditlog.register(Contact) @@ -72,4 +72,4 @@ auditlog.register(Portfolio) auditlog.register(DomainGroup) auditlog.register(Suborganization) auditlog.register(SeniorOfficial) -auditlog.register(AllowedEmails) +auditlog.register(AllowedEmail) diff --git a/src/registrar/models/allowed_emails.py b/src/registrar/models/allowed_email.py similarity index 74% rename from src/registrar/models/allowed_emails.py rename to src/registrar/models/allowed_email.py index e89c5904b..90105debe 100644 --- a/src/registrar/models/allowed_emails.py +++ b/src/registrar/models/allowed_email.py @@ -3,9 +3,9 @@ from django.db import models from .utility.time_stamped_model import TimeStampedModel -class AllowedEmails(TimeStampedModel): +class AllowedEmail(TimeStampedModel): """ - AllowedEmails is a whitelist for email addresses that we can send to + AllowedEmail is a whitelist for email addresses that we can send to in non-production environments. """ diff --git a/src/registrar/templates/admin/model_descriptions.html b/src/registrar/templates/admin/model_descriptions.html index 4b61e21bd..9f13245fe 100644 --- a/src/registrar/templates/admin/model_descriptions.html +++ b/src/registrar/templates/admin/model_descriptions.html @@ -32,6 +32,8 @@ {% include "django/admin/includes/descriptions/website_description.html" %} {% elif opts.model_name == 'portfolioinvitation' %} {% include "django/admin/includes/descriptions/portfolio_invitation_description.html" %} + {% elif opts.model_name == 'allowedemail' %} + {% include "django/admin/includes/descriptions/allowed_email_description.html" %} {% else %}

This table does not have a description yet.

{% endif %} diff --git a/src/registrar/templates/django/admin/includes/descriptions/allowed_email_description.html b/src/registrar/templates/django/admin/includes/descriptions/allowed_email_description.html new file mode 100644 index 000000000..4bac06437 --- /dev/null +++ b/src/registrar/templates/django/admin/includes/descriptions/allowed_email_description.html @@ -0,0 +1,6 @@ +

This table is an email whitelist for non-production environments.

+

+ If an email is sent out and the email does not exist within this table (or is not a subset of it), + then no email will be sent. +

+

If this table is populated in a production environment, no change will occur as it will simply be ignored.

\ No newline at end of file