From 4554de4a6d97541ad0a0886457558ba33ec64088 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Tue, 5 Mar 2024 18:14:43 -0500 Subject: [PATCH 01/21] Update documentation on CSS BEM naming --- docs/developer/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index dc4c9ddd2..7172669fe 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -240,7 +240,7 @@ type docker-compose run owasp ``` -# Images, stylesheets, and JavaScript +## Images, stylesheets, and JavaScript We use the U.S. Web Design System (USWDS) for styling our applications. @@ -252,7 +252,7 @@ Assets are stored in `registrar/assets` during development and served from `regi We utilize the [uswds-compile tool](https://designsystem.digital.gov/documentation/getting-started/developers/phase-two-compile/) from USWDS to compile and package USWDS assets. -## Making and viewing style changes +### Making and viewing style changes When you run `docker-compose up` the `node` service in the container will begin to watch for changes in the `registrar/assets` folder, and will recompile once any changes are made. @@ -263,7 +263,11 @@ Within the `registrar/assets` folder, the `_theme` folder contains three files i You can also compile the **Sass** at any time using `npx gulp compile`. Similarly, you can copy over **other static assets** (images and javascript files), using `npx gulp copyAssets`. -## Upgrading USWDS and other JavaScript packages +### CSS convention + +We use [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming conventions for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. + +### Upgrading USWDS and other JavaScript packages Version numbers can be manually controlled in `package.json`. Edit that, if desired. From 78eee0a9b5049aab3dad203144e2e4d462a68682 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Tue, 5 Mar 2024 18:16:19 -0500 Subject: [PATCH 02/21] Update documentation on CSS BEM naming --- docs/developer/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index 7172669fe..438bef792 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -263,9 +263,9 @@ Within the `registrar/assets` folder, the `_theme` folder contains three files i You can also compile the **Sass** at any time using `npx gulp compile`. Similarly, you can copy over **other static assets** (images and javascript files), using `npx gulp copyAssets`. -### CSS convention +### CSS classes naming -We use [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming conventions for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. +We use [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming convention for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. ### Upgrading USWDS and other JavaScript packages From 2ee3df91b9774d6f8152abed2151962ba5722129 Mon Sep 17 00:00:00 2001 From: CocoByte Date: Wed, 6 Mar 2024 15:13:11 -0700 Subject: [PATCH 03/21] added blanks to public_contact fields (to remove required-field error in frontend form) --- src/registrar/models/public_contact.py | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/src/registrar/models/public_contact.py b/src/registrar/models/public_contact.py index 989dfb0cd..262455c1e 100644 --- a/src/registrar/models/public_contact.py +++ b/src/registrar/models/public_contact.py @@ -8,8 +8,6 @@ from registrar.utility.enums import DefaultEmail from .utility.time_stamped_model import TimeStampedModel -from phonenumber_field.modelfields import PhoneNumberField # type: ignore - def get_id(): """Generate a 16 character registry ID with a low probability of collision.""" @@ -62,17 +60,17 @@ class PublicContact(TimeStampedModel): ) name = models.CharField(null=False, help_text="Contact's full name") - org = models.CharField(null=True, help_text="Contact's organization (null ok)") + org = models.CharField(null=True, blank=True, help_text="Contact's organization (null ok)") street1 = models.CharField(null=False, help_text="Contact's street") - street2 = models.CharField(null=True, help_text="Contact's street (null ok)") - street3 = models.CharField(null=True, help_text="Contact's street (null ok)") + street2 = models.CharField(null=True, blank=True, help_text="Contact's street (null ok)") + street3 = models.CharField(null=True, blank=True, help_text="Contact's street (null ok)") city = models.CharField(null=False, help_text="Contact's city") sp = models.CharField(null=False, help_text="Contact's state or province") pc = models.CharField(null=False, help_text="Contact's postal code") cc = models.CharField(null=False, help_text="Contact's country code") - email = models.EmailField(null=False, help_text="Contact's email address") - voice = PhoneNumberField(null=False, help_text="Contact's phone number. Must be in ITU.E164.2005 format") - fax = PhoneNumberField( + email = models.CharField(null=False, help_text="Contact's email address") + voice = models.CharField(null=False, help_text="Contact's phone number. Must be in ITU.E164.2005 format") + fax = models.CharField( null=True, help_text="Contact's fax number (null ok). Must be in ITU.E164.2005 format.", ) From c73e7179bc374032e0db3809f37b6f6a968f92fd Mon Sep 17 00:00:00 2001 From: CocoByte Date: Wed, 6 Mar 2024 15:13:42 -0700 Subject: [PATCH 04/21] added blank to fax field --- src/registrar/models/public_contact.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/registrar/models/public_contact.py b/src/registrar/models/public_contact.py index 262455c1e..56cda07de 100644 --- a/src/registrar/models/public_contact.py +++ b/src/registrar/models/public_contact.py @@ -72,6 +72,7 @@ class PublicContact(TimeStampedModel): voice = models.CharField(null=False, help_text="Contact's phone number. Must be in ITU.E164.2005 format") fax = models.CharField( null=True, + blank=True, help_text="Contact's fax number (null ok). Must be in ITU.E164.2005 format.", ) pw = models.CharField(null=False, help_text="Contact's authorization code. 16 characters minimum.") From a166281cd296ec1cc08d6ede6508456003b4d976 Mon Sep 17 00:00:00 2001 From: CocoByte Date: Wed, 6 Mar 2024 15:19:04 -0700 Subject: [PATCH 05/21] Remove merge error --- src/registrar/models/public_contact.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/registrar/models/public_contact.py b/src/registrar/models/public_contact.py index b479706b8..52d38d565 100644 --- a/src/registrar/models/public_contact.py +++ b/src/registrar/models/public_contact.py @@ -68,7 +68,6 @@ class PublicContact(TimeStampedModel): sp = models.CharField(null=False, help_text="Contact's state or province") pc = models.CharField(null=False, help_text="Contact's postal code") cc = models.CharField(null=False, help_text="Contact's country code") - email = models.CharField(null=False, help_text="Contact's email address") email = models.EmailField(null=False, help_text="Contact's email address") voice = models.CharField(null=False, help_text="Contact's phone number. Must be in ITU.E164.2005 format") fax = models.CharField( From db4919cc09e717e895998e318e406a0ebf7b58e3 Mon Sep 17 00:00:00 2001 From: CocoByte Date: Thu, 14 Mar 2024 12:48:16 -0600 Subject: [PATCH 06/21] linted --- src/registrar/models/public_contact.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/registrar/models/public_contact.py b/src/registrar/models/public_contact.py index 52d38d565..f9dea3f02 100644 --- a/src/registrar/models/public_contact.py +++ b/src/registrar/models/public_contact.py @@ -72,7 +72,7 @@ class PublicContact(TimeStampedModel): voice = models.CharField(null=False, help_text="Contact's phone number. Must be in ITU.E164.2005 format") fax = models.CharField( null=True, - blank=True, + blank=True, help_text="Contact's fax number (null ok). Must be in ITU.E164.2005 format.", ) pw = models.CharField(null=False, help_text="Contact's authorization code. 16 characters minimum.") From 63c0aec4b849cf55bd9f1b13294307bbff4a4710 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Fri, 15 Mar 2024 14:29:41 -0400 Subject: [PATCH 07/21] enhance state mismatch error message --- src/djangooidc/oidc.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/djangooidc/oidc.py b/src/djangooidc/oidc.py index bff766bb4..fa3aac08e 100644 --- a/src/djangooidc/oidc.py +++ b/src/djangooidc/oidc.py @@ -182,7 +182,11 @@ class Client(oic.Client): if authn_response["state"] != session.get("state", None): # this most likely means the user's Django session vanished - logger.error("Received state not the same as expected for %s" % state) + logger.error( + f"Received state not the same as expected for {state}" + f"authn_response['state'] = {authn_response['state']}" + f"session.get('state', None) = {session.get('state', None)}" + ) if session.get("state", None) is None: raise o_e.NoStateDefined() raise o_e.AuthenticationFailed(locator=state) From 6816ed1b91364273b363fda45c5282b1c8180e11 Mon Sep 17 00:00:00 2001 From: zandercymatics <141044360+zandercymatics@users.noreply.github.com> Date: Fri, 15 Mar 2024 12:53:46 -0600 Subject: [PATCH 08/21] Create 0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py --- ...ct_fax_alter_publiccontact_org_and_more.py | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py diff --git a/src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py b/src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py new file mode 100644 index 000000000..66c904391 --- /dev/null +++ b/src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py @@ -0,0 +1,35 @@ +# Generated by Django 4.2.10 on 2024-03-15 18:47 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ("registrar", "0076_alter_domainrequest_current_websites_and_more"), + ] + + operations = [ + migrations.AlterField( + model_name="publiccontact", + name="fax", + field=models.CharField( + blank=True, help_text="Contact's fax number (null ok). Must be in ITU.E164.2005 format.", null=True + ), + ), + migrations.AlterField( + model_name="publiccontact", + name="org", + field=models.CharField(blank=True, help_text="Contact's organization (null ok)", null=True), + ), + migrations.AlterField( + model_name="publiccontact", + name="street2", + field=models.CharField(blank=True, help_text="Contact's street (null ok)", null=True), + ), + migrations.AlterField( + model_name="publiccontact", + name="street3", + field=models.CharField(blank=True, help_text="Contact's street (null ok)", null=True), + ), + ] From ea43a34dee9350b6e7349354fa7dc7a89996126c Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Fri, 15 Mar 2024 15:34:53 -0400 Subject: [PATCH 09/21] Attempt a redirect (once) if there's a state mismatch --- src/djangooidc/exceptions.py | 4 ++-- src/djangooidc/oidc.py | 20 +++++++++++++------- src/djangooidc/tests/test_views.py | 8 ++++---- src/djangooidc/views.py | 22 +++++++++++++++------- 4 files changed, 34 insertions(+), 20 deletions(-) diff --git a/src/djangooidc/exceptions.py b/src/djangooidc/exceptions.py index 226337f54..f7de9c816 100644 --- a/src/djangooidc/exceptions.py +++ b/src/djangooidc/exceptions.py @@ -33,8 +33,8 @@ class AuthenticationFailed(OIDCException): friendly_message = "This login attempt didn't work." -class NoStateDefined(OIDCException): - friendly_message = "The session state is None." +class StateMismatch(OIDCException): + friendly_message = "State mismatch. This login attempt didn't work." class InternalError(OIDCException): diff --git a/src/djangooidc/oidc.py b/src/djangooidc/oidc.py index fa3aac08e..5e6cc5d7f 100644 --- a/src/djangooidc/oidc.py +++ b/src/djangooidc/oidc.py @@ -182,14 +182,20 @@ class Client(oic.Client): if authn_response["state"] != session.get("state", None): # this most likely means the user's Django session vanished - logger.error( - f"Received state not the same as expected for {state}" - f"authn_response['state'] = {authn_response['state']}" - f"session.get('state', None) = {session.get('state', None)}" - ) if session.get("state", None) is None: - raise o_e.NoStateDefined() - raise o_e.AuthenticationFailed(locator=state) + logger.error( + f"The OP state {state} does not match the session state." + f"The session state is None." + f"authn_response['state'] = {authn_response['state']}" + f"session.get('state', None) = {session.get('state', None)}" + ) + else: + logger.error( + f"The OP state {state} does not match the session state." + f"authn_response['state'] = {authn_response['state']}" + f"session.get('state', None) = {session.get('state', None)}" + ) + raise o_e.StateMismatch() if self.behaviour.get("response_type") == "code": # need an access token to get user info (and to log the user out later) diff --git a/src/djangooidc/tests/test_views.py b/src/djangooidc/tests/test_views.py index 0f734b80d..fe02c3ea8 100644 --- a/src/djangooidc/tests/test_views.py +++ b/src/djangooidc/tests/test_views.py @@ -4,7 +4,7 @@ from django.http import HttpResponse from django.test import Client, TestCase, RequestFactory from django.urls import reverse -from djangooidc.exceptions import NoStateDefined, InternalError +from djangooidc.exceptions import StateMismatch, InternalError from ..views import login_callback from .common import less_console_noise @@ -129,14 +129,14 @@ class ViewsTest(TestCase): self.assertContains(response, "Hi") def test_login_callback_with_no_session_state(self, mock_client): - """If the local session is None (ie the server restarted while user was logged out), + """If the local session does not match the OP session, we do not throw an exception. Rather, we attempt to login again.""" with less_console_noise(): # MOCK # mock the acr_value to some string - # mock the callback function to raise the NoStateDefined Exception + # mock the callback function to raise the StateMismatch Exception mock_client.get_default_acr_value.side_effect = self.create_acr - mock_client.callback.side_effect = NoStateDefined() + mock_client.callback.side_effect = StateMismatch() # TEST # test the login callback response = self.client.get(reverse("openid_login_callback")) diff --git a/src/djangooidc/views.py b/src/djangooidc/views.py index 2d3c842d2..0a2a07d05 100644 --- a/src/djangooidc/views.py +++ b/src/djangooidc/views.py @@ -108,16 +108,24 @@ def login_callback(request): if user: login(request, user) logger.info("Successfully logged in user %s" % user) - # Double login bug (1507)? + # Clear the flag if the exception is not caught + request.session.pop("redirect_attempted", None) return redirect(request.session.get("next", "/")) else: raise o_e.BannedUser() - except o_e.NoStateDefined as nsd_err: - # In the event that a user is in the middle of a login when the app is restarted, - # their session state will no longer be available, so redirect the user to the - # beginning of login process without raising an error to the user. - logger.warning(f"No State Defined: {nsd_err}") - return redirect(request.session.get("next", "/")) + except o_e.StateMismatch as nsd_err: + # Check if the redirect has already been attempted + if not request.session.get("redirect_attempted", False): + # Set the flag to indicate that the redirect has been attempted + request.session["redirect_attempted"] = True + + # In the event of a sstate mismatch between OP and session, redirect the user to the + # beginning of login process without raising an error to the user. Attempt once. + logger.warning(f"No State Defined: {nsd_err}") + return redirect(request.session.get("next", "/")) + else: + # Clear the redirect_attempted flag? + return error_page(request, nsd_err) except Exception as err: return error_page(request, err) From bdffaca09954940e6b250b75bf93f52b419cfd28 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Fri, 15 Mar 2024 16:01:42 -0400 Subject: [PATCH 10/21] formatting --- src/djangooidc/oidc.py | 10 +++++----- src/djangooidc/views.py | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/djangooidc/oidc.py b/src/djangooidc/oidc.py index 5e6cc5d7f..95ed322f5 100644 --- a/src/djangooidc/oidc.py +++ b/src/djangooidc/oidc.py @@ -184,15 +184,15 @@ class Client(oic.Client): # this most likely means the user's Django session vanished if session.get("state", None) is None: logger.error( - f"The OP state {state} does not match the session state." - f"The session state is None." - f"authn_response['state'] = {authn_response['state']}" + f"The OP state {state} does not match the session state. " + f"The session state is None. " + f"authn_response['state'] = {authn_response['state']} " f"session.get('state', None) = {session.get('state', None)}" ) else: logger.error( - f"The OP state {state} does not match the session state." - f"authn_response['state'] = {authn_response['state']}" + f"The OP state {state} does not match the session state. " + f"authn_response['state'] = {authn_response['state']} " f"session.get('state', None) = {session.get('state', None)}" ) raise o_e.StateMismatch() diff --git a/src/djangooidc/views.py b/src/djangooidc/views.py index 0a2a07d05..3e21e6628 100644 --- a/src/djangooidc/views.py +++ b/src/djangooidc/views.py @@ -124,7 +124,7 @@ def login_callback(request): logger.warning(f"No State Defined: {nsd_err}") return redirect(request.session.get("next", "/")) else: - # Clear the redirect_attempted flag? + # Clear the redirect_attempted flag? return error_page(request, nsd_err) except Exception as err: return error_page(request, err) From eecdd9506f265565181526818cb90b3094c2ba54 Mon Sep 17 00:00:00 2001 From: Rachid Mrad <107004823+rachidatecs@users.noreply.github.com> Date: Mon, 18 Mar 2024 11:54:18 -0400 Subject: [PATCH 11/21] Update src/djangooidc/views.py Co-authored-by: Alysia Broddrick <109625347+abroddrick@users.noreply.github.com> --- src/djangooidc/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/djangooidc/views.py b/src/djangooidc/views.py index 3e21e6628..ffcd30634 100644 --- a/src/djangooidc/views.py +++ b/src/djangooidc/views.py @@ -119,7 +119,7 @@ def login_callback(request): # Set the flag to indicate that the redirect has been attempted request.session["redirect_attempted"] = True - # In the event of a sstate mismatch between OP and session, redirect the user to the + # In the event of a state mismatch between OP and session, redirect the user to the # beginning of login process without raising an error to the user. Attempt once. logger.warning(f"No State Defined: {nsd_err}") return redirect(request.session.get("next", "/")) From 6f8af3f5c371c85d6f86d8fd918e17f42ea48b1e Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Tue, 19 Mar 2024 12:03:13 -0400 Subject: [PATCH 12/21] attempt redirect_attempted pop from session in else clause --- src/djangooidc/views.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/djangooidc/views.py b/src/djangooidc/views.py index 3e21e6628..024761fba 100644 --- a/src/djangooidc/views.py +++ b/src/djangooidc/views.py @@ -124,7 +124,8 @@ def login_callback(request): logger.warning(f"No State Defined: {nsd_err}") return redirect(request.session.get("next", "/")) else: - # Clear the redirect_attempted flag? + # Clear the flag if the exception is not caught + request.session.pop("redirect_attempted", None) return error_page(request, nsd_err) except Exception as err: return error_page(request, err) From d04b54a9f97f343dfb1422dfd0210a70cb66576b Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Tue, 19 Mar 2024 12:04:46 -0400 Subject: [PATCH 13/21] fix typo --- src/djangooidc/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/djangooidc/views.py b/src/djangooidc/views.py index 024761fba..522e3415f 100644 --- a/src/djangooidc/views.py +++ b/src/djangooidc/views.py @@ -119,7 +119,7 @@ def login_callback(request): # Set the flag to indicate that the redirect has been attempted request.session["redirect_attempted"] = True - # In the event of a sstate mismatch between OP and session, redirect the user to the + # In the event of a state mismatch between OP and session, redirect the user to the # beginning of login process without raising an error to the user. Attempt once. logger.warning(f"No State Defined: {nsd_err}") return redirect(request.session.get("next", "/")) From e4c1b06f63424d16af0a04970d66015344e80132 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Tue, 19 Mar 2024 16:48:36 -0400 Subject: [PATCH 14/21] unit tests --- src/djangooidc/tests/test_views.py | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/src/djangooidc/tests/test_views.py b/src/djangooidc/tests/test_views.py index fe02c3ea8..f1b333316 100644 --- a/src/djangooidc/tests/test_views.py +++ b/src/djangooidc/tests/test_views.py @@ -133,17 +133,29 @@ class ViewsTest(TestCase): we do not throw an exception. Rather, we attempt to login again.""" with less_console_noise(): # MOCK - # mock the acr_value to some string - # mock the callback function to raise the StateMismatch Exception mock_client.get_default_acr_value.side_effect = self.create_acr mock_client.callback.side_effect = StateMismatch() # TEST - # test the login callback response = self.client.get(reverse("openid_login_callback")) - # ASSERTIONS - # assert that the user is redirected to the start of the login process + # ASSERT self.assertEqual(response.status_code, 302) self.assertEqual(response.url, "/") + # Check that the redirect_attempted flag is set in the session + self.assertTrue(self.client.session.get("redirect_attempted", False)) + + def test_login_callback_with_no_session_state_attempt_again_only_once(self, mock_client): + """We only attempt to relogin once. After that, it's the error page for you.""" + with less_console_noise(): + # MOCK + mock_client.get_default_acr_value.side_effect = self.create_acr + mock_client.callback.side_effect = StateMismatch() + session = self.client.session + session['redirect_attempted'] = True + session.save() + # TEST + response = self.client.get(reverse("openid_login_callback")) + # ASSERT + self.assertEqual(response.status_code, 500) def test_login_callback_reads_next(self, mock_client): """If the next value is set in the session, test that login_callback returns From 3ea0d90853c76edc1e1320673cec0bb8e16bcd02 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Tue, 19 Mar 2024 16:51:38 -0400 Subject: [PATCH 15/21] lint --- src/djangooidc/tests/test_views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/djangooidc/tests/test_views.py b/src/djangooidc/tests/test_views.py index f1b333316..4bcb4648a 100644 --- a/src/djangooidc/tests/test_views.py +++ b/src/djangooidc/tests/test_views.py @@ -150,7 +150,7 @@ class ViewsTest(TestCase): mock_client.get_default_acr_value.side_effect = self.create_acr mock_client.callback.side_effect = StateMismatch() session = self.client.session - session['redirect_attempted'] = True + session["redirect_attempted"] = True session.save() # TEST response = self.client.get(reverse("openid_login_callback")) From d2c6a2df8b866bc703249bfcf886aacb92e970cb Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Wed, 20 Mar 2024 12:29:12 -0400 Subject: [PATCH 16/21] change StateMismatch to inherit AuthenticationFailed --- src/djangooidc/exceptions.py | 2 +- src/djangooidc/tests/test_views.py | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/djangooidc/exceptions.py b/src/djangooidc/exceptions.py index f7de9c816..000c47649 100644 --- a/src/djangooidc/exceptions.py +++ b/src/djangooidc/exceptions.py @@ -33,7 +33,7 @@ class AuthenticationFailed(OIDCException): friendly_message = "This login attempt didn't work." -class StateMismatch(OIDCException): +class StateMismatch(AuthenticationFailed): friendly_message = "State mismatch. This login attempt didn't work." diff --git a/src/djangooidc/tests/test_views.py b/src/djangooidc/tests/test_views.py index 4bcb4648a..f10afcbaf 100644 --- a/src/djangooidc/tests/test_views.py +++ b/src/djangooidc/tests/test_views.py @@ -132,10 +132,11 @@ class ViewsTest(TestCase): """If the local session does not match the OP session, we do not throw an exception. Rather, we attempt to login again.""" with less_console_noise(): - # MOCK + # MOCK get_default_acr_value and the callback to raise StateMismatch + # error when called mock_client.get_default_acr_value.side_effect = self.create_acr mock_client.callback.side_effect = StateMismatch() - # TEST + # TEST receiving a response from login.gov response = self.client.get(reverse("openid_login_callback")) # ASSERT self.assertEqual(response.status_code, 302) @@ -146,16 +147,17 @@ class ViewsTest(TestCase): def test_login_callback_with_no_session_state_attempt_again_only_once(self, mock_client): """We only attempt to relogin once. After that, it's the error page for you.""" with less_console_noise(): - # MOCK + # MOCK get_default_acr_value, redirect_attempted to True and the callback + # to raise StateMismatch error when called mock_client.get_default_acr_value.side_effect = self.create_acr mock_client.callback.side_effect = StateMismatch() session = self.client.session session["redirect_attempted"] = True session.save() - # TEST + # TEST receiving a response from login.gov response = self.client.get(reverse("openid_login_callback")) # ASSERT - self.assertEqual(response.status_code, 500) + self.assertEqual(response.status_code, 401) def test_login_callback_reads_next(self, mock_client): """If the next value is set in the session, test that login_callback returns From cb9808594f055461117d8272ec16dd3fe3423fbf Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Wed, 20 Mar 2024 17:33:55 -0400 Subject: [PATCH 17/21] change organization_type to generic_org_type --- src/registrar/admin.py | 22 +++--- src/registrar/fixtures_domain_requests.py | 4 +- src/registrar/forms/domain.py | 12 ++-- src/registrar/forms/domain_request_wizard.py | 2 +- .../transfer_transition_domains_to_domains.py | 6 +- .../utility/extra_transition_domain_helper.py | 20 +++--- ...ininformation_generic_org_type_and_more.py | 28 ++++++++ src/registrar/models/domain_information.py | 2 +- src/registrar/models/domain_request.py | 18 ++--- src/registrar/models/transition_domain.py | 4 +- .../domain_authorizing_official.html | 6 +- .../templates/domain_org_name_address.html | 6 +- .../templates/domain_request_org_type.html | 2 +- .../templates/domain_request_review.html | 4 +- .../templates/domain_request_status.html | 2 +- .../includes/domain_request_summary.txt | 2 +- .../templates/includes/ao_example.html | 14 ++-- .../templates/includes/domain_example.html | 14 ++-- src/registrar/templatetags/custom_filters.py | 4 +- src/registrar/tests/common.py | 26 +++---- src/registrar/tests/test_admin.py | 8 +-- src/registrar/tests/test_models.py | 4 +- src/registrar/tests/test_reports.py | 4 +- .../test_transition_domain_migrations.py | 10 +-- src/registrar/tests/test_views_application.py | 60 ++++++++-------- src/registrar/tests/test_views_domain.py | 16 ++--- src/registrar/utility/csv_export.py | 68 +++++++++---------- src/registrar/views/domain.py | 4 +- src/registrar/views/domain_request.py | 8 +-- 29 files changed, 204 insertions(+), 176 deletions(-) create mode 100644 src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py diff --git a/src/registrar/admin.py b/src/registrar/admin.py index ead2dab05..5b88a9ce2 100644 --- a/src/registrar/admin.py +++ b/src/registrar/admin.py @@ -830,7 +830,7 @@ class DomainInformationAdmin(ListHeaderAdmin): # Columns list_display = [ "domain", - "organization_type", + "generic_org_type", "created_at", "submitter", ] @@ -841,7 +841,7 @@ class DomainInformationAdmin(ListHeaderAdmin): ] # Filters - list_filter = ["organization_type"] + list_filter = ["generic_org_type"] # Search search_fields = [ @@ -858,7 +858,7 @@ class DomainInformationAdmin(ListHeaderAdmin): "Type of organization", { "fields": [ - "organization_type", + "generic_org_type", "is_election_board", "federal_type", "federal_agency", @@ -1000,7 +1000,7 @@ class DomainRequestAdmin(ListHeaderAdmin): list_display = [ "requested_domain", "status", - "organization_type", + "generic_org_type", "federal_type", "federal_agency", "organization_name", @@ -1027,7 +1027,7 @@ class DomainRequestAdmin(ListHeaderAdmin): # Filters list_filter = ( "status", - "organization_type", + "generic_org_type", "federal_type", ElectionOfficeFilter, "rejection_reason", @@ -1065,7 +1065,7 @@ class DomainRequestAdmin(ListHeaderAdmin): "Type of organization", { "fields": [ - "organization_type", + "generic_org_type", "is_election_board", "federal_type", "federal_agency", @@ -1394,7 +1394,7 @@ class DomainAdmin(ListHeaderAdmin): # Columns list_display = [ "name", - "organization_type", + "generic_org_type", "federal_type", "federal_agency", "organization_name", @@ -1419,10 +1419,10 @@ class DomainAdmin(ListHeaderAdmin): # in autocomplete_fields for domain ordering = ["name"] - def organization_type(self, obj): - return obj.domain_info.get_organization_type_display() + def generic_org_type(self, obj): + return obj.domain_info.get_generic_org_type_display() - organization_type.admin_order_field = "domain_info__organization_type" # type: ignore + generic_org_type.admin_order_field = "domain_info__generic_org_type" # type: ignore def federal_agency(self, obj): return obj.domain_info.federal_agency if obj.domain_info else None @@ -1459,7 +1459,7 @@ class DomainAdmin(ListHeaderAdmin): state_territory.admin_order_field = "domain_info__state_territory" # type: ignore # Filters - list_filter = ["domain_info__organization_type", "domain_info__federal_type", ElectionOfficeFilter, "state"] + list_filter = ["domain_info__generic_org_type", "domain_info__federal_type", ElectionOfficeFilter, "state"] search_fields = ["name"] search_help_text = "Search by domain name." diff --git a/src/registrar/fixtures_domain_requests.py b/src/registrar/fixtures_domain_requests.py index a37e29d6b..02efae5a9 100644 --- a/src/registrar/fixtures_domain_requests.py +++ b/src/registrar/fixtures_domain_requests.py @@ -30,7 +30,7 @@ class DomainRequestFixture: # { # "status": "started", # "organization_name": "Example - Just started", - # "organization_type": "federal", + # "generic_org_type": "federal", # "federal_agency": None, # "federal_type": None, # "address_line1": None, @@ -98,7 +98,7 @@ class DomainRequestFixture: def _set_non_foreign_key_fields(cls, da: DomainRequest, app: dict): """Helper method used by `load`.""" da.status = app["status"] if "status" in app else "started" - da.organization_type = app["organization_type"] if "organization_type" in app else "federal" + da.generic_org_type = app["generic_org_type"] if "generic_org_type" in app else "federal" da.federal_agency = ( app["federal_agency"] if "federal_agency" in app diff --git a/src/registrar/forms/domain.py b/src/registrar/forms/domain.py index 22d76c768..0bfd9b667 100644 --- a/src/registrar/forms/domain.py +++ b/src/registrar/forms/domain.py @@ -262,8 +262,8 @@ class AuthorizingOfficialContactForm(ContactForm): return super().save() # Determine if the domain is federal or tribal - is_federal = self.domainInfo.organization_type == DomainRequest.OrganizationChoices.FEDERAL - is_tribal = self.domainInfo.organization_type == DomainRequest.OrganizationChoices.TRIBAL + is_federal = self.domainInfo.generic_org_type == DomainRequest.OrganizationChoices.FEDERAL + is_tribal = self.domainInfo.generic_org_type == DomainRequest.OrganizationChoices.TRIBAL # Get the Contact object from the db for the Authorizing Official db_ao = Contact.objects.get(id=self.instance.id) @@ -363,8 +363,8 @@ class DomainOrgNameAddressForm(forms.ModelForm): self.fields["state_territory"].widget.attrs.pop("maxlength", None) self.fields["zipcode"].widget.attrs.pop("maxlength", None) - self.is_federal = self.instance.organization_type == DomainRequest.OrganizationChoices.FEDERAL - self.is_tribal = self.instance.organization_type == DomainRequest.OrganizationChoices.TRIBAL + self.is_federal = self.instance.generic_org_type == DomainRequest.OrganizationChoices.FEDERAL + self.is_tribal = self.instance.generic_org_type == DomainRequest.OrganizationChoices.TRIBAL field_to_disable = None if self.is_federal: @@ -384,9 +384,9 @@ class DomainOrgNameAddressForm(forms.ModelForm): # If they get past this point, we forbid it this way. # This could be malicious, so lets reserve information for the backend only. if self.is_federal and not self._field_unchanged("federal_agency"): - raise ValueError("federal_agency cannot be modified when the organization_type is federal") + raise ValueError("federal_agency cannot be modified when the generic_org_type is federal") elif self.is_tribal and not self._field_unchanged("organization_name"): - raise ValueError("organization_name cannot be modified when the organization_type is tribal") + raise ValueError("organization_name cannot be modified when the generic_org_type is tribal") else: super().save() diff --git a/src/registrar/forms/domain_request_wizard.py b/src/registrar/forms/domain_request_wizard.py index ef47143ea..1efc028f6 100644 --- a/src/registrar/forms/domain_request_wizard.py +++ b/src/registrar/forms/domain_request_wizard.py @@ -169,7 +169,7 @@ class RegistrarFormSet(forms.BaseFormSet): class OrganizationTypeForm(RegistrarForm): - organization_type = forms.ChoiceField( + generic_org_type = forms.ChoiceField( # use the long names in the domain request form choices=DomainRequest.OrganizationChoicesVerbose.choices, widget=forms.RadioSelect, diff --git a/src/registrar/management/commands/transfer_transition_domains_to_domains.py b/src/registrar/management/commands/transfer_transition_domains_to_domains.py index 7f09d8de7..4ea74e335 100644 --- a/src/registrar/management/commands/transfer_transition_domains_to_domains.py +++ b/src/registrar/management/commands/transfer_transition_domains_to_domains.py @@ -332,7 +332,7 @@ class Command(BaseCommand): updated = False fields_to_update = [ - "organization_type", + "generic_org_type", "federal_type", "federal_agency", "organization_name", @@ -400,7 +400,7 @@ class Command(BaseCommand): if debug_on: logger.info(f"Contact created: {contact}") - org_type_current = transition_domain.organization_type + org_type_current = transition_domain.generic_org_type match org_type_current: case "Federal": org_type = ("federal", "Federal") @@ -431,7 +431,7 @@ class Command(BaseCommand): } if valid_org_type: - new_domain_info_data["organization_type"] = org_type[0] + new_domain_info_data["generic_org_type"] = org_type[0] elif debug_on: logger.debug(f"No org type found on {domain.name}") diff --git a/src/registrar/management/commands/utility/extra_transition_domain_helper.py b/src/registrar/management/commands/utility/extra_transition_domain_helper.py index 5c3573fb1..eb41c4be8 100644 --- a/src/registrar/management/commands/utility/extra_transition_domain_helper.py +++ b/src/registrar/management/commands/utility/extra_transition_domain_helper.py @@ -200,7 +200,7 @@ class LoadExtraTransitionDomain: updated_fields = [ "organization_name", - "organization_type", + "generic_org_type", "federal_type", "federal_agency", "first_name", @@ -412,7 +412,7 @@ class LoadExtraTransitionDomain: return transition_domain def parse_domain_type_data(self, domain_name, transition_domain: TransitionDomain) -> TransitionDomain: - """Grabs organization_type and federal_type from the parsed files + """Grabs generic_org_type and federal_type from the parsed files and associates it with a transition_domain object, then returns that object.""" if not isinstance(transition_domain, TransitionDomain): raise ValueError("Not a valid object, must be TransitionDomain") @@ -439,7 +439,7 @@ class LoadExtraTransitionDomain: raise ValueError("Found invalid data on DOMAIN_ADHOC") # Then, just grab the organization type. - new_organization_type = domain_type[0].strip() + new_generic_org_type = domain_type[0].strip() # Check if this domain_type is active or not. # If not, we don't want to add this. @@ -455,8 +455,8 @@ class LoadExtraTransitionDomain: # Are we updating data that already exists, # or are we adding new data in its place? - organization_type_exists = ( - transition_domain.organization_type is not None and transition_domain.organization_type.strip() != "" + generic_org_type_exists = ( + transition_domain.generic_org_type is not None and transition_domain.generic_org_type.strip() != "" ) federal_type_exists = ( transition_domain.federal_type is not None and transition_domain.federal_type.strip() != "" @@ -467,20 +467,20 @@ class LoadExtraTransitionDomain: is_federal = domain_type_length == 2 if is_federal: new_federal_type = domain_type[1].strip() - transition_domain.organization_type = new_organization_type + transition_domain.generic_org_type = new_generic_org_type transition_domain.federal_type = new_federal_type else: - transition_domain.organization_type = new_organization_type + transition_domain.generic_org_type = new_generic_org_type transition_domain.federal_type = None # Logs if we either added to this property, # or modified it. self._add_or_change_message( EnumFilenames.DOMAIN_ADHOC, - "organization_type", - transition_domain.organization_type, + "generic_org_type", + transition_domain.generic_org_type, domain_name, - organization_type_exists, + generic_org_type_exists, ) self._add_or_change_message( diff --git a/src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py b/src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py new file mode 100644 index 000000000..79d9a71b4 --- /dev/null +++ b/src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py @@ -0,0 +1,28 @@ +# Generated by Django 4.2.10 on 2024-03-20 21:14 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("registrar", "0076_alter_domainrequest_current_websites_and_more"), + ] + + operations = [ + migrations.RenameField( + model_name="domaininformation", + old_name="organization_type", + new_name="generic_org_type", + ), + migrations.RenameField( + model_name="domainrequest", + old_name="organization_type", + new_name="generic_org_type", + ), + migrations.RenameField( + model_name="transitiondomain", + old_name="organization_type", + new_name="generic_org_type", + ), + ] diff --git a/src/registrar/models/domain_information.py b/src/registrar/models/domain_information.py index f8f4db9c6..b5755a3c9 100644 --- a/src/registrar/models/domain_information.py +++ b/src/registrar/models/domain_information.py @@ -49,7 +49,7 @@ class DomainInformation(TimeStampedModel): ) # ##### data fields from the initial form ##### - organization_type = models.CharField( + generic_org_type = models.CharField( max_length=255, choices=OrganizationChoices.choices, null=True, diff --git a/src/registrar/models/domain_request.py b/src/registrar/models/domain_request.py index e7378a880..7527529a1 100644 --- a/src/registrar/models/domain_request.py +++ b/src/registrar/models/domain_request.py @@ -397,7 +397,7 @@ class DomainRequest(TimeStampedModel): ) # ##### data fields from the initial form ##### - organization_type = models.CharField( + generic_org_type = models.CharField( max_length=255, # use the short names in Django admin choices=OrganizationChoices.choices, @@ -886,12 +886,12 @@ class DomainRequest(TimeStampedModel): def show_organization_federal(self) -> bool: """Show this step if the answer to the first question was "federal".""" - user_choice = self.organization_type + user_choice = self.generic_org_type return user_choice == DomainRequest.OrganizationChoices.FEDERAL def show_tribal_government(self) -> bool: """Show this step if the answer to the first question was "tribal".""" - user_choice = self.organization_type + user_choice = self.generic_org_type return user_choice == DomainRequest.OrganizationChoices.TRIBAL def show_organization_election(self) -> bool: @@ -900,7 +900,7 @@ class DomainRequest(TimeStampedModel): This shows for answers that aren't "Federal" or "Interstate". This also doesnt show if user selected "School District" as well (#524) """ - user_choice = self.organization_type + user_choice = self.generic_org_type excluded = [ DomainRequest.OrganizationChoices.FEDERAL, DomainRequest.OrganizationChoices.INTERSTATE, @@ -910,7 +910,7 @@ class DomainRequest(TimeStampedModel): def show_about_your_organization(self) -> bool: """Show this step if this is a special district or interstate.""" - user_choice = self.organization_type + user_choice = self.generic_org_type return user_choice in [ DomainRequest.OrganizationChoices.SPECIAL_DISTRICT, DomainRequest.OrganizationChoices.INTERSTATE, @@ -927,12 +927,12 @@ class DomainRequest(TimeStampedModel): def is_federal(self) -> Union[bool, None]: """Is this domain request for a federal agency? - organization_type can be both null and blank, + generic_org_type can be both null and blank, """ - if not self.organization_type: - # organization_type is either blank or None, can't answer + if not self.generic_org_type: + # generic_org_type is either blank or None, can't answer return None - if self.organization_type == DomainRequest.OrganizationChoices.FEDERAL: + if self.generic_org_type == DomainRequest.OrganizationChoices.FEDERAL: return True return False diff --git a/src/registrar/models/transition_domain.py b/src/registrar/models/transition_domain.py index 0c9c2ae66..eafbeda00 100644 --- a/src/registrar/models/transition_domain.py +++ b/src/registrar/models/transition_domain.py @@ -49,7 +49,7 @@ class TransitionDomain(TimeStampedModel): verbose_name="Processed", help_text="Indicates whether this TransitionDomain was already processed", ) - organization_type = models.CharField( + generic_org_type = models.CharField( max_length=255, null=True, blank=True, @@ -147,7 +147,7 @@ class TransitionDomain(TimeStampedModel): f"username: {self.username}, \n" f"status: {self.status}, \n" f"email sent: {self.email_sent}, \n" - f"organization type: {self.organization_type}, \n" + f"organization type: {self.generic_org_type}, \n" f"organization_name: {self.organization_name}, \n" f"federal_type: {self.federal_type}, \n" f"federal_agency: {self.federal_agency}, \n" diff --git a/src/registrar/templates/domain_authorizing_official.html b/src/registrar/templates/domain_authorizing_official.html index 2e2faa0d3..aa9808c2e 100644 --- a/src/registrar/templates/domain_authorizing_official.html +++ b/src/registrar/templates/domain_authorizing_official.html @@ -12,7 +12,7 @@

Your authorizing official is a person within your organization who can authorize domain requests. This person must be in a role of significant, executive responsibility within the organization. Read more about who can serve as an authorizing official.

- {% if organization_type == "federal" or organization_type == "tribal" %} + {% if generic_org_type == "federal" or generic_org_type == "tribal" %}

The authorizing official for your organization can’t be updated here. To suggest an update, email help@get.gov. @@ -25,7 +25,7 @@

{% csrf_token %} - {% if organization_type == "federal" or organization_type == "tribal" %} + {% if generic_org_type == "federal" or generic_org_type == "tribal" %} {# If all fields are disabled, add SR content #}
{{ form.first_name.value }}
{{ form.last_name.value }}
@@ -41,7 +41,7 @@ {% input_with_errors form.email %} - {% if organization_type != "federal" and organization_type != "tribal" %} + {% if generic_org_type != "federal" and generic_org_type != "tribal" %} {% endif %}
diff --git a/src/registrar/templates/domain_org_name_address.html b/src/registrar/templates/domain_org_name_address.html index 180fdd2a6..1e6176aa0 100644 --- a/src/registrar/templates/domain_org_name_address.html +++ b/src/registrar/templates/domain_org_name_address.html @@ -11,12 +11,12 @@

The name of your organization will be publicly listed as the domain registrant.

- {% if domain.domain_info.organization_type == "federal" %} + {% if domain.domain_info.generic_org_type == "federal" %}

The federal agency for your organization can’t be updated here. To suggest an update, email help@get.gov.

- {% elif domain.domain_info.organization_type == "tribal" %} + {% elif domain.domain_info.generic_org_type == "tribal" %}

Your organization name can’t be updated here. To suggest an update, email help@get.gov. @@ -28,7 +28,7 @@

{% csrf_token %} - {% if domain.domain_info.organization_type == 'federal' %} + {% if domain.domain_info.generic_org_type == 'federal' %} {% input_with_errors form.federal_agency %} {% endif %} diff --git a/src/registrar/templates/domain_request_org_type.html b/src/registrar/templates/domain_request_org_type.html index eab61e0bc..0e01a5260 100644 --- a/src/registrar/templates/domain_request_org_type.html +++ b/src/registrar/templates/domain_request_org_type.html @@ -14,6 +14,6 @@ {% block form_fields %} {% with add_class="usa-radio__input--tile" add_legend_class="usa-sr-only" %} - {% input_with_errors forms.0.organization_type %} + {% input_with_errors forms.0.generic_org_type %} {% endwith %} {% endblock %} diff --git a/src/registrar/templates/domain_request_review.html b/src/registrar/templates/domain_request_review.html index 71aec8d0a..227fc0cea 100644 --- a/src/registrar/templates/domain_request_review.html +++ b/src/registrar/templates/domain_request_review.html @@ -24,8 +24,8 @@ {% if step == Step.ORGANIZATION_TYPE %} {% namespaced_url 'domain-request' step as domain_request_url %} - {% if domain_request.organization_type is not None %} - {% with title=form_titles|get_item:step value=domain_request.get_organization_type_display|default:"Incomplete" %} + {% if domain_request.generic_org_type is not None %} + {% with title=form_titles|get_item:step value=domain_request.get_generic_org_type_display|default:"Incomplete" %} {% include "includes/summary_item.html" with title=title value=value heading_level=heading_level editable=True edit_link=domain_request_url %} {% endwith %} {% else %} diff --git a/src/registrar/templates/domain_request_status.html b/src/registrar/templates/domain_request_status.html index 55260db97..e6ca4cdb3 100644 --- a/src/registrar/templates/domain_request_status.html +++ b/src/registrar/templates/domain_request_status.html @@ -52,7 +52,7 @@

Summary of your domain request

{% with heading_level='h3' %} - {% with org_type=DomainRequest.get_organization_type_display %} + {% with org_type=DomainRequest.get_generic_org_type_display %} {% include "includes/summary_item.html" with title='Type of organization' value=org_type heading_level=heading_level %} {% endwith %} diff --git a/src/registrar/templates/emails/includes/domain_request_summary.txt b/src/registrar/templates/emails/includes/domain_request_summary.txt index 6c7b36523..10ec9ac2c 100644 --- a/src/registrar/templates/emails/includes/domain_request_summary.txt +++ b/src/registrar/templates/emails/includes/domain_request_summary.txt @@ -1,7 +1,7 @@ SUMMARY OF YOUR DOMAIN REQUEST Type of organization: -{{ domain_request.get_organization_type_display }} +{{ domain_request.get_generic_org_type_display }} {% if domain_request.show_organization_federal %} Federal government branch: {{ domain_request.get_federal_type_display }} diff --git a/src/registrar/templates/includes/ao_example.html b/src/registrar/templates/includes/ao_example.html index 85df174aa..cddf0def7 100644 --- a/src/registrar/templates/includes/ao_example.html +++ b/src/registrar/templates/includes/ao_example.html @@ -24,28 +24,28 @@ {% endif %} -{% elif organization_type == 'city' %} +{% elif generic_org_type == 'city' %}

Cities

Domain requests from cities must be authorized by someone in a role of significant, executive responsibility within the city (mayor, council president, city manager, township/village supervisor, select board chairperson, chief, senior technology officer, or equivalent).

-{% elif organization_type == 'county' %} +{% elif generic_org_type == 'county' %}

Counties

Domain requests from counties must be authorized by the commission chair or someone in a role of significant, executive responsibility within the county (county judge, county mayor, parish/borough president, senior technology officer, or equivalent). Other county-level offices (county clerk, sheriff, county auditor, comptroller) may qualify, as well, in some instances.

-{% elif organization_type == 'interstate' %} +{% elif generic_org_type == 'interstate' %}

Interstate organizations

Domain requests from interstate organizations must be authorized by someone in a role of significant, executive responsibility within the organization (president, director, chair, senior technology officer, or equivalent) or one of the state’s governors or CIOs.

-{% elif organization_type == 'school_district' %} +{% elif generic_org_type == 'school_district' %}

School districts

Domain requests from school district governments must be authorized by someone in a role of significant, executive responsibility within the district (board chair, superintendent, senior technology officer, or equivalent).

-{% elif organization_type == 'special_district' %} +{% elif generic_org_type == 'special_district' %}

Special districts

Domain requests from special districts must be authorized by someone in a role of significant, executive responsibility within the district (CEO, chair, executive director, senior technology officer, or equivalent).

-{% elif organization_type == 'state_or_territory' %} +{% elif generic_org_type == 'state_or_territory' %}

U.S. states and territories

States and territories: executive branch

@@ -54,7 +54,7 @@

States and territories: judicial and legislative branches

Domain requests from state legislatures and courts must be authorized by an agency’s CIO or someone in a role of significant, executive responsibility within the agency.

-{% elif organization_type == 'tribal' %} +{% elif generic_org_type == 'tribal' %}

Tribal governments

Domain requests from federally-recognized tribal governments must be authorized by the tribal leader the Bureau of Indian Affairs recognizes.

Domain requests from state-recognized tribal governments must be authorized by the tribal leader the individual state recognizes.

diff --git a/src/registrar/templates/includes/domain_example.html b/src/registrar/templates/includes/domain_example.html index 74ab18b3b..05df00e7b 100644 --- a/src/registrar/templates/includes/domain_example.html +++ b/src/registrar/templates/includes/domain_example.html @@ -26,7 +26,7 @@ {% endif %} -{% elif organization_type == 'interstate' %} +{% elif generic_org_type == 'interstate' %}
  • EMScompact.gov
    • @@ -34,7 +34,7 @@
  • trpa.gov
-{% elif organization_type == 'state_or_territory' %} +{% elif generic_org_type == 'state_or_territory' %}

State .gov domains must include the two-letter state abbreviation or clearly spell out the state name.

Examples:

    @@ -44,7 +44,7 @@
  • Guam.gov
-{% elif organization_type == 'tribal' %} +{% elif generic_org_type == 'tribal' %}

Tribal domains may include the suffix -nsn, for native sovereign nation.

Examples:

    @@ -53,7 +53,7 @@
  • TulalipTribalCourt-nsn.gov
-{% elif organization_type == 'county' %} +{% elif generic_org_type == 'county' %}

Most county .gov domains must include the two-letter state abbreviation or the full state name. County names that aren’t shared by any other city, county, parish, town, borough, village or equivalent in the U.S. (at the time a domain is granted) don’t have to refer to their state in their domain name. Counties can include “county” in their domain to distinguish it from other places with similar names.

We use the Census Bureau’s National Places Gazetteer Files to determine if county names are unique.

@@ -65,7 +65,7 @@
  • MiamiDade.gov
    • -{% elif organization_type == 'city' %} +{% elif generic_org_type == 'city' %}

    Most city domains must include the two-letter state abbreviation or clearly spell out the state name. Using phrases like “City of” or “Town of” is optional.

    Cities that meet one of the criteria below don’t have to refer to their state in their domain name.

      @@ -81,7 +81,7 @@

    -{% elif organization_type == 'special_district' %} +{% elif generic_org_type == 'special_district' %}

    Domain names must represent your organization or institutional name, not solely the services you provide. It also needs to include your two-letter state abbreviation or clearly spell out the state name.

    Examples:

      @@ -90,7 +90,7 @@
    • UtahTrust.gov
    -{% elif organization_type == 'school_district' %} +{% elif generic_org_type == 'school_district' %}

    Domain names must represent your organization or institutional name.

    Examples:

      diff --git a/src/registrar/templatetags/custom_filters.py b/src/registrar/templatetags/custom_filters.py index ff7a6258c..dc42a5c1d 100644 --- a/src/registrar/templatetags/custom_filters.py +++ b/src/registrar/templatetags/custom_filters.py @@ -54,9 +54,9 @@ def contains_checkbox(html_list): @register.filter -def get_organization_long_name(organization_type): +def get_organization_long_name(generic_org_type): organization_choices_dict = dict(DomainRequest.OrganizationChoicesVerbose.choices) - long_form_type = organization_choices_dict[organization_type] + long_form_type = organization_choices_dict[generic_org_type] if long_form_type is None: logger.error("Organization type error, triggered by a template's custom filter") return "Error" diff --git a/src/registrar/tests/common.py b/src/registrar/tests/common.py index 04eb4c82d..5349a3b83 100644 --- a/src/registrar/tests/common.py +++ b/src/registrar/tests/common.py @@ -348,7 +348,7 @@ class AuditedAdminMockData: purpose (str - optional): Sets a domains purpose Returns: Dictionary: { - organization_type: str, + generic_org_type: str, federal_type: str, purpose: str, organization_name: str = "{} organization".format(item_name), @@ -366,7 +366,7 @@ class AuditedAdminMockData: """ # noqa creator = self.dummy_user(item_name, "creator") common_args = dict( - organization_type=org_type, + generic_org_type=org_type, federal_type=federal_type, purpose=purpose, organization_name="{} organization".format(item_name), @@ -552,67 +552,67 @@ class MockDb(TestCase): self.domain_information_1, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_1, - organization_type="federal", + generic_org_type="federal", federal_agency="World War I Centennial Commission", federal_type="executive", is_election_board=True, ) self.domain_information_2, _ = DomainInformation.objects.get_or_create( - creator=self.user, domain=self.domain_2, organization_type="interstate", is_election_board=True + creator=self.user, domain=self.domain_2, generic_org_type="interstate", is_election_board=True ) self.domain_information_3, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_3, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=True, ) self.domain_information_4, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_4, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=True, ) self.domain_information_5, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_5, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=False, ) self.domain_information_6, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_6, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=False, ) self.domain_information_7, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_7, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=False, ) self.domain_information_8, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_8, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=False, ) self.domain_information_9, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_9, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=False, ) self.domain_information_10, _ = DomainInformation.objects.get_or_create( creator=self.user, domain=self.domain_10, - organization_type="federal", + generic_org_type="federal", federal_agency="Armed Forces Retirement Home", is_election_board=False, ) @@ -767,7 +767,7 @@ def completed_domain_request( is_staff=True, ) domain_request_kwargs = dict( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", is_policy_acknowledged=True, diff --git a/src/registrar/tests/test_admin.py b/src/registrar/tests/test_admin.py index 9666633e9..28a500ae2 100644 --- a/src/registrar/tests/test_admin.py +++ b/src/registrar/tests/test_admin.py @@ -286,7 +286,7 @@ class TestDomainAdmin(MockEppLib, WebTest): # for our actual domain_request self.assertContains(response, "Federal", count=8) # This may be a bit more robust - self.assertContains(response, 'Federal', count=1) + self.assertContains(response, 'Federal', count=1) # Now let's make sure the long description does not exist self.assertNotContains(response, "Federal: an agency of the U.S. government") @@ -692,7 +692,7 @@ class TestDomainRequestAdmin(MockEppLib): # for our actual domain request self.assertContains(response, "Federal", count=6) # This may be a bit more robust - self.assertContains(response, 'Federal', count=1) + self.assertContains(response, 'Federal', count=1) # Now let's make sure the long description does not exist self.assertNotContains(response, "Federal: an agency of the U.S. government") @@ -1295,7 +1295,7 @@ class TestDomainRequestAdmin(MockEppLib): "rejection_reason", "creator", "investigator", - "organization_type", + "generic_org_type", "federally_recognized_tribe", "state_recognized_tribe", "tribe_name", @@ -1503,7 +1503,7 @@ class TestDomainRequestAdmin(MockEppLib): readonly_fields = self.admin.get_list_filter(request) expected_fields = ( "status", - "organization_type", + "generic_org_type", "federal_type", DomainRequestAdmin.ElectionOfficeFilter, "rejection_reason", diff --git a/src/registrar/tests/test_models.py b/src/registrar/tests/test_models.py index 4d5315b80..c7fe5f94c 100644 --- a/src/registrar/tests/test_models.py +++ b/src/registrar/tests/test_models.py @@ -101,7 +101,7 @@ class TestDomainRequest(TestCase): domain_request = DomainRequest.objects.create( creator=user, investigator=user, - organization_type=DomainRequest.OrganizationChoices.FEDERAL, + generic_org_type=DomainRequest.OrganizationChoices.FEDERAL, federal_type=DomainRequest.BranchChoices.EXECUTIVE, is_election_board=False, organization_name="Test", @@ -129,7 +129,7 @@ class TestDomainRequest(TestCase): domain, _ = Domain.objects.get_or_create(name="igorville.gov") information = DomainInformation.objects.create( creator=user, - organization_type=DomainInformation.OrganizationChoices.FEDERAL, + generic_org_type=DomainInformation.OrganizationChoices.FEDERAL, federal_type=DomainInformation.BranchChoices.EXECUTIVE, is_election_board=False, organization_name="Test", diff --git a/src/registrar/tests/test_reports.py b/src/registrar/tests/test_reports.py index b91f3bd18..029fe873a 100644 --- a/src/registrar/tests/test_reports.py +++ b/src/registrar/tests/test_reports.py @@ -341,9 +341,9 @@ class ExportDataTest(MockDb, MockEppLib): "State", "Security contact email", ] - sort_fields = ["domain__name", "federal_agency", "organization_type"] + sort_fields = ["domain__name", "federal_agency", "generic_org_type"] filter_condition = { - "organization_type__icontains": "federal", + "generic_org_type__icontains": "federal", "domain__state__in": [ Domain.State.READY, Domain.State.DNS_NEEDED, diff --git a/src/registrar/tests/test_transition_domain_migrations.py b/src/registrar/tests/test_transition_domain_migrations.py index 9008a4f94..9311b59f7 100644 --- a/src/registrar/tests/test_transition_domain_migrations.py +++ b/src/registrar/tests/test_transition_domain_migrations.py @@ -334,7 +334,7 @@ class TestOrganizationMigration(TestCase): domain_name="fakewebsite2.gov", status="on hold", email_sent=True, - organization_type="Federal", + generic_org_type="Federal", organization_name="Fanoodle", federal_type="Executive", federal_agency="Department of Commerce", @@ -399,7 +399,7 @@ class TestOrganizationMigration(TestCase): ).get() expected_domain_information = DomainInformation( creator=expected_creator, - organization_type="federal", + generic_org_type="federal", federal_agency="Department of Commerce", federal_type="executive", organization_name="Fanoodle", @@ -454,7 +454,7 @@ class TestOrganizationMigration(TestCase): ).get() expected_domain_information = DomainInformation( creator=expected_creator, - organization_type="federal", + generic_org_type="federal", federal_agency="Department of Commerce", federal_type="executive", organization_name="Fanoodle", @@ -794,7 +794,7 @@ class TestMigrations(TestCase): # parsing right if we get a lot of data. anomaly = anomaly_domain_infos.get() self.assertEqual(anomaly.organization_name, "Flashdog") - self.assertEqual(anomaly.organization_type, None) + self.assertEqual(anomaly.generic_org_type, None) self.assertEqual(anomaly.federal_agency, None) self.assertEqual(anomaly.federal_type, None) @@ -809,7 +809,7 @@ class TestMigrations(TestCase): fakewebsite = fakewebsite_domain_infos.get() self.assertEqual(fakewebsite.organization_name, "Fanoodle") - self.assertEqual(fakewebsite.organization_type, "federal") + self.assertEqual(fakewebsite.generic_org_type, "federal") self.assertEqual(fakewebsite.federal_agency, "Department of Commerce") self.assertEqual(fakewebsite.federal_type, "executive") diff --git a/src/registrar/tests/test_views_application.py b/src/registrar/tests/test_views_application.py index 1414d4525..a4cb210bc 100644 --- a/src/registrar/tests/test_views_application.py +++ b/src/registrar/tests/test_views_application.py @@ -57,7 +57,7 @@ class DomainRequestTests(TestWithUser, WebTest): self.assertEqual(detail_page.status_code, 302) # You can access the 'Location' header to get the redirect URL redirect_url = detail_page.url - self.assertEqual(redirect_url, "/request/organization_type/") + self.assertEqual(redirect_url, "/request/generic_org_type/") def test_domain_request_form_empty_submit(self): """Tests empty submit on the first page after the acknowledgement page""" @@ -141,13 +141,13 @@ class DomainRequestTests(TestWithUser, WebTest): # ---- TYPE PAGE ---- type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = "federal" + type_form["generic_org_type-generic_org_type"] = "federal" # test next button and validate data self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) type_result = type_form.submit() # should see results in db domain_request = DomainRequest.objects.get() # there's only one - self.assertEqual(domain_request.organization_type, "federal") + self.assertEqual(domain_request.generic_org_type, "federal") # the post request should return a redirect to the next form in # the domain request page self.assertEqual(type_result.status_code, 302) @@ -522,7 +522,7 @@ class DomainRequestTests(TestWithUser, WebTest): self.assertNotContains(type_page, self.TITLES["organization_federal"]) self.assertNotContains(type_page, self.TITLES["organization_election"]) type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = "federal" + type_form["generic_org_type-generic_org_type"] = "federal" # set the session ID before .submit() self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) @@ -577,7 +577,7 @@ class DomainRequestTests(TestWithUser, WebTest): self.assertNotContains(type_page, self.TITLES["organization_federal"]) self.assertNotContains(type_page, self.TITLES["organization_election"]) type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = "county" + type_form["generic_org_type-generic_org_type"] = "county" # set the session ID before .submit() self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) @@ -626,7 +626,7 @@ class DomainRequestTests(TestWithUser, WebTest): session_id = self.app.cookies[settings.SESSION_COOKIE_NAME] type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = "federal" + type_form["generic_org_type-generic_org_type"] = "federal" self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) type_result = type_form.submit() @@ -636,7 +636,7 @@ class DomainRequestTests(TestWithUser, WebTest): # Now on federal type page, click back to the organization type self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) - new_page = federal_page.click(str(self.TITLES["organization_type"]), index=0) + new_page = federal_page.click(str(self.TITLES["generic_org_type"]), index=0) # Should be a link to the organization_federal page self.assertGreater( @@ -663,7 +663,7 @@ class DomainRequestTests(TestWithUser, WebTest): session_id = self.app.cookies[settings.SESSION_COOKIE_NAME] type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = DomainRequest.OrganizationChoices.INTERSTATE + type_form["generic_org_type-generic_org_type"] = DomainRequest.OrganizationChoices.INTERSTATE self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) type_result = type_form.submit() @@ -708,7 +708,7 @@ class DomainRequestTests(TestWithUser, WebTest): session_id = self.app.cookies[settings.SESSION_COOKIE_NAME] type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = DomainRequest.OrganizationChoices.SPECIAL_DISTRICT + type_form["generic_org_type-generic_org_type"] = DomainRequest.OrganizationChoices.SPECIAL_DISTRICT self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) type_result = type_page.forms[0].submit() # follow first redirect @@ -884,7 +884,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(555) 555 5557", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1018,7 +1018,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5557", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1092,7 +1092,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5557", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1169,7 +1169,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5557", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1245,7 +1245,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5557", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1320,7 +1320,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5556", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1392,7 +1392,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5555", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1458,7 +1458,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5555", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1529,7 +1529,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5555", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1594,7 +1594,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(201) 555 5555", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1667,7 +1667,7 @@ class DomainRequestTests(TestWithUser, WebTest): session_id = self.app.cookies[settings.SESSION_COOKIE_NAME] type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = DomainRequest.OrganizationChoices.INTERSTATE + type_form["generic_org_type-generic_org_type"] = DomainRequest.OrganizationChoices.INTERSTATE self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) type_result = type_form.submit() # follow first redirect @@ -1695,7 +1695,7 @@ class DomainRequestTests(TestWithUser, WebTest): session_id = self.app.cookies[settings.SESSION_COOKIE_NAME] type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = DomainRequest.OrganizationChoices.TRIBAL + type_form["generic_org_type-generic_org_type"] = DomainRequest.OrganizationChoices.TRIBAL self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) type_result = type_form.submit() # the tribal government page comes immediately afterwards @@ -1726,7 +1726,7 @@ class DomainRequestTests(TestWithUser, WebTest): # ---- TYPE PAGE ---- type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = "federal" + type_form["generic_org_type-generic_org_type"] = "federal" # test next button self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) @@ -1766,9 +1766,9 @@ class DomainRequestTests(TestWithUser, WebTest): # Go back to organization type page and change type self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) - ao_page.click(str(self.TITLES["organization_type"]), index=0) + ao_page.click(str(self.TITLES["generic_org_type"]), index=0) self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) - type_form["organization_type-organization_type"] = "city" + type_form["generic_org_type-generic_org_type"] = "city" type_result = type_form.submit() self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) election_page = type_result.follow() @@ -1797,7 +1797,7 @@ class DomainRequestTests(TestWithUser, WebTest): # ---- TYPE PAGE ---- type_form = type_page.forms[0] - type_form["organization_type-organization_type"] = "federal" + type_form["generic_org_type-generic_org_type"] = "federal" # test next button self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) @@ -1866,9 +1866,9 @@ class DomainRequestTests(TestWithUser, WebTest): # Go back to organization type page and change type self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) - dotgov_page.click(str(self.TITLES["organization_type"]), index=0) + dotgov_page.click(str(self.TITLES["generic_org_type"]), index=0) self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) - type_form["organization_type-organization_type"] = "city" + type_form["generic_org_type-generic_org_type"] = "city" type_result = type_form.submit() self.app.set_cookie(settings.SESSION_COOKIE_NAME, session_id) election_page = type_result.follow() @@ -1936,7 +1936,7 @@ class DomainRequestTests(TestWithUser, WebTest): phone="(555) 555 5557", ) domain_request, _ = DomainRequest.objects.get_or_create( - organization_type="federal", + generic_org_type="federal", federal_type="executive", purpose="Purpose of the site", anything_else="No", @@ -1965,10 +1965,10 @@ class DomainRequestTests(TestWithUser, WebTest): # -- the best that can/should be done here is to ensure the correct values # are being passed to the templating engine - url = reverse("domain-request:organization_type") + url = reverse("domain-request:generic_org_type") response = self.client.get(url, follow=True) self.assertContains(response, "") - # choices = response.context['wizard']['form']['organization_type'].subwidgets + # choices = response.context['wizard']['form']['generic_org_type'].subwidgets # radio = [ x for x in choices if x.data["value"] == "federal" ][0] # checked = radio.data["selected"] # self.assertTrue(checked) diff --git a/src/registrar/tests/test_views_domain.py b/src/registrar/tests/test_views_domain.py index 78f4de83d..b4019d098 100644 --- a/src/registrar/tests/test_views_domain.py +++ b/src/registrar/tests/test_views_domain.py @@ -1051,7 +1051,7 @@ class TestDomainAuthorizingOfficial(TestDomainOverview): """Tests that no edit can occur when the underlying domain is federal""" # Set the org type to federal - self.domain_information.organization_type = DomainInformation.OrganizationChoices.FEDERAL + self.domain_information.generic_org_type = DomainInformation.OrganizationChoices.FEDERAL self.domain_information.save() # Add an AO. We can do this at the model level, just not the form level. @@ -1107,7 +1107,7 @@ class TestDomainAuthorizingOfficial(TestDomainOverview): """Tests that no edit can occur when the underlying domain is tribal""" # Set the org type to federal - self.domain_information.organization_type = DomainInformation.OrganizationChoices.TRIBAL + self.domain_information.generic_org_type = DomainInformation.OrganizationChoices.TRIBAL self.domain_information.save() # Add an AO. We can do this at the model level, just not the form level. @@ -1233,7 +1233,7 @@ class TestDomainOrganization(TestDomainOverview): # Set the current domain to a tribal organization with a preset value. # Save first, so we can test if saving is unaffected (it should be). tribal_org_type = DomainInformation.OrganizationChoices.TRIBAL - self.domain_information.organization_type = tribal_org_type + self.domain_information.generic_org_type = tribal_org_type self.domain_information.save() try: # Add an org name @@ -1242,7 +1242,7 @@ class TestDomainOrganization(TestDomainOverview): except ValueError as err: self.fail(f"A ValueError was caught during the test: {err}") - self.assertEqual(self.domain_information.organization_type, tribal_org_type) + self.assertEqual(self.domain_information.generic_org_type, tribal_org_type) org_name_page = self.app.get(reverse("domain-org-name-address", kwargs={"pk": self.domain.id})) @@ -1290,7 +1290,7 @@ class TestDomainOrganization(TestDomainOverview): # Set the current domain to a tribal organization with a preset value. # Save first, so we can test if saving is unaffected (it should be). fed_org_type = DomainInformation.OrganizationChoices.FEDERAL - self.domain_information.organization_type = fed_org_type + self.domain_information.generic_org_type = fed_org_type self.domain_information.save() try: self.domain_information.federal_agency = "AMTRAK" @@ -1298,7 +1298,7 @@ class TestDomainOrganization(TestDomainOverview): except ValueError as err: self.fail(f"A ValueError was caught during the test: {err}") - self.assertEqual(self.domain_information.organization_type, fed_org_type) + self.assertEqual(self.domain_information.generic_org_type, fed_org_type) org_name_page = self.app.get(reverse("domain-org-name-address", kwargs={"pk": self.domain.id})) @@ -1346,7 +1346,7 @@ class TestDomainOrganization(TestDomainOverview): # Set the current domain to a tribal organization with a preset value. # Save first, so we can test if saving is unaffected (it should be). federal_org_type = DomainInformation.OrganizationChoices.FEDERAL - self.domain_information.organization_type = federal_org_type + self.domain_information.generic_org_type = federal_org_type self.domain_information.save() old_federal_agency_value = ("AMTRAK", "AMTRAK") @@ -1357,7 +1357,7 @@ class TestDomainOrganization(TestDomainOverview): except ValueError as err: self.fail(f"A ValueError was caught during the test: {err}") - self.assertEqual(self.domain_information.organization_type, federal_org_type) + self.assertEqual(self.domain_information.generic_org_type, federal_org_type) new_value = ("Department of State", "Department of State") self.client.post( diff --git a/src/registrar/utility/csv_export.py b/src/registrar/utility/csv_export.py index 916e0b0c8..7b93f4efa 100644 --- a/src/registrar/utility/csv_export.py +++ b/src/registrar/utility/csv_export.py @@ -81,9 +81,9 @@ def parse_domain_row(columns, domain_info: DomainInformation, security_emails_di security_email = "(blank)" if domain_info.federal_type: - domain_type = f"{domain_info.get_organization_type_display()} - {domain_info.get_federal_type_display()}" + domain_type = f"{domain_info.get_generic_org_type_display()} - {domain_info.get_federal_type_display()}" else: - domain_type = domain_info.get_organization_type_display() + domain_type = domain_info.get_generic_org_type_display() # create a dictionary of fields which can be included in output FIELDS = { @@ -217,9 +217,9 @@ def parse_request_row(columns, request: DomainRequest): requested_domain_name = request.requested_domain.name if request.federal_type: - request_type = f"{request.get_organization_type_display()} - {request.get_federal_type_display()}" + request_type = f"{request.get_generic_org_type_display()} - {request.get_federal_type_display()}" else: - request_type = request.get_organization_type_display() + request_type = request.get_generic_org_type_display() # create a dictionary of fields which can be included in output FIELDS = { @@ -295,7 +295,7 @@ def export_data_type_to_csv(csv_file): # Coalesce is used to replace federal_type of None with ZZZZZ sort_fields = [ - "organization_type", + "generic_org_type", Coalesce("federal_type", Value("ZZZZZ")), "federal_agency", "domain__name", @@ -328,7 +328,7 @@ def export_data_full_to_csv(csv_file): ] # Coalesce is used to replace federal_type of None with ZZZZZ sort_fields = [ - "organization_type", + "generic_org_type", Coalesce("federal_type", Value("ZZZZZ")), "federal_agency", "domain__name", @@ -361,13 +361,13 @@ def export_data_federal_to_csv(csv_file): ] # Coalesce is used to replace federal_type of None with ZZZZZ sort_fields = [ - "organization_type", + "generic_org_type", Coalesce("federal_type", Value("ZZZZZ")), "federal_agency", "domain__name", ] filter_condition = { - "organization_type__icontains": "federal", + "generic_org_type__icontains": "federal", "domain__state__in": [ Domain.State.READY, Domain.State.DNS_NEEDED, @@ -468,23 +468,23 @@ def get_sliced_domains(filter_condition, distinct=False): # Round trip 2: Get counts for other slices if distinct: - organization_types_query = ( - DomainInformation.objects.filter(**filter_condition).values_list("organization_type", flat=True).distinct() + generic_org_types_query = ( + DomainInformation.objects.filter(**filter_condition).values_list("generic_org_type", flat=True).distinct() ) else: - organization_types_query = DomainInformation.objects.filter(**filter_condition).values_list( - "organization_type", flat=True + generic_org_types_query = DomainInformation.objects.filter(**filter_condition).values_list( + "generic_org_type", flat=True ) - organization_type_counts = Counter(organization_types_query) + generic_org_type_counts = Counter(generic_org_types_query) - federal = organization_type_counts.get(DomainRequest.OrganizationChoices.FEDERAL, 0) - interstate = organization_type_counts.get(DomainRequest.OrganizationChoices.INTERSTATE, 0) - state_or_territory = organization_type_counts.get(DomainRequest.OrganizationChoices.STATE_OR_TERRITORY, 0) - tribal = organization_type_counts.get(DomainRequest.OrganizationChoices.TRIBAL, 0) - county = organization_type_counts.get(DomainRequest.OrganizationChoices.COUNTY, 0) - city = organization_type_counts.get(DomainRequest.OrganizationChoices.CITY, 0) - special_district = organization_type_counts.get(DomainRequest.OrganizationChoices.SPECIAL_DISTRICT, 0) - school_district = organization_type_counts.get(DomainRequest.OrganizationChoices.SCHOOL_DISTRICT, 0) + federal = generic_org_type_counts.get(DomainRequest.OrganizationChoices.FEDERAL, 0) + interstate = generic_org_type_counts.get(DomainRequest.OrganizationChoices.INTERSTATE, 0) + state_or_territory = generic_org_type_counts.get(DomainRequest.OrganizationChoices.STATE_OR_TERRITORY, 0) + tribal = generic_org_type_counts.get(DomainRequest.OrganizationChoices.TRIBAL, 0) + county = generic_org_type_counts.get(DomainRequest.OrganizationChoices.COUNTY, 0) + city = generic_org_type_counts.get(DomainRequest.OrganizationChoices.CITY, 0) + special_district = generic_org_type_counts.get(DomainRequest.OrganizationChoices.SPECIAL_DISTRICT, 0) + school_district = generic_org_type_counts.get(DomainRequest.OrganizationChoices.SCHOOL_DISTRICT, 0) # Round trip 3 election_board = DomainInformation.objects.filter(is_election_board=True, **filter_condition).distinct().count() @@ -511,23 +511,23 @@ def get_sliced_requests(filter_condition, distinct=False): # Round trip 2: Get counts for other slices if distinct: - organization_types_query = ( - DomainRequest.objects.filter(**filter_condition).values_list("organization_type", flat=True).distinct() + generic_org_types_query = ( + DomainRequest.objects.filter(**filter_condition).values_list("generic_org_type", flat=True).distinct() ) else: - organization_types_query = DomainRequest.objects.filter(**filter_condition).values_list( - "organization_type", flat=True + generic_org_types_query = DomainRequest.objects.filter(**filter_condition).values_list( + "generic_org_type", flat=True ) - organization_type_counts = Counter(organization_types_query) + generic_org_type_counts = Counter(generic_org_types_query) - federal = organization_type_counts.get(DomainRequest.OrganizationChoices.FEDERAL, 0) - interstate = organization_type_counts.get(DomainRequest.OrganizationChoices.INTERSTATE, 0) - state_or_territory = organization_type_counts.get(DomainRequest.OrganizationChoices.STATE_OR_TERRITORY, 0) - tribal = organization_type_counts.get(DomainRequest.OrganizationChoices.TRIBAL, 0) - county = organization_type_counts.get(DomainRequest.OrganizationChoices.COUNTY, 0) - city = organization_type_counts.get(DomainRequest.OrganizationChoices.CITY, 0) - special_district = organization_type_counts.get(DomainRequest.OrganizationChoices.SPECIAL_DISTRICT, 0) - school_district = organization_type_counts.get(DomainRequest.OrganizationChoices.SCHOOL_DISTRICT, 0) + federal = generic_org_type_counts.get(DomainRequest.OrganizationChoices.FEDERAL, 0) + interstate = generic_org_type_counts.get(DomainRequest.OrganizationChoices.INTERSTATE, 0) + state_or_territory = generic_org_type_counts.get(DomainRequest.OrganizationChoices.STATE_OR_TERRITORY, 0) + tribal = generic_org_type_counts.get(DomainRequest.OrganizationChoices.TRIBAL, 0) + county = generic_org_type_counts.get(DomainRequest.OrganizationChoices.COUNTY, 0) + city = generic_org_type_counts.get(DomainRequest.OrganizationChoices.CITY, 0) + special_district = generic_org_type_counts.get(DomainRequest.OrganizationChoices.SPECIAL_DISTRICT, 0) + school_district = generic_org_type_counts.get(DomainRequest.OrganizationChoices.SCHOOL_DISTRICT, 0) # Round trip 3 election_board = DomainRequest.objects.filter(is_election_board=True, **filter_condition).distinct().count() diff --git a/src/registrar/views/domain.py b/src/registrar/views/domain.py index b2ae76852..b61691b50 100644 --- a/src/registrar/views/domain.py +++ b/src/registrar/views/domain.py @@ -236,7 +236,7 @@ class DomainAuthorizingOfficialView(DomainFormBaseView): domain_info = self.get_domain_info_from_domain() invalid_fields = [DomainRequest.OrganizationChoices.FEDERAL, DomainRequest.OrganizationChoices.TRIBAL] - is_federal_or_tribal = domain_info and (domain_info.organization_type in invalid_fields) + is_federal_or_tribal = domain_info and (domain_info.generic_org_type in invalid_fields) form_kwargs["disable_fields"] = is_federal_or_tribal return form_kwargs @@ -244,7 +244,7 @@ class DomainAuthorizingOfficialView(DomainFormBaseView): def get_context_data(self, **kwargs): """Adds custom context.""" context = super().get_context_data(**kwargs) - context["organization_type"] = self.object.domain_info.organization_type + context["generic_org_type"] = self.object.domain_info.generic_org_type return context def get_success_url(self): diff --git a/src/registrar/views/domain_request.py b/src/registrar/views/domain_request.py index da5d717f4..244b47602 100644 --- a/src/registrar/views/domain_request.py +++ b/src/registrar/views/domain_request.py @@ -33,7 +33,7 @@ class Step(StrEnum): appear in the order they are defined. (Order matters.) """ - ORGANIZATION_TYPE = "organization_type" + ORGANIZATION_TYPE = "generic_org_type" TRIBAL_GOVERNMENT = "tribal_government" ORGANIZATION_FEDERAL = "organization_federal" ORGANIZATION_ELECTION = "organization_election" @@ -340,7 +340,7 @@ class DomainRequestWizard(DomainRequestWizardPermissionView, TemplateView): Queries the DB for a domain request and returns a list of unlocked steps.""" history_dict = { - "organization_type": self.domain_request.organization_type is not None, + "generic_org_type": self.domain_request.generic_org_type is not None, "tribal_government": self.domain_request.tribe_name is not None, "organization_federal": self.domain_request.federal_type is not None, "organization_election": self.domain_request.is_election_board is not None, @@ -506,7 +506,7 @@ class AuthorizingOfficial(DomainRequestWizard): def get_context_data(self): context = super().get_context_data() - context["organization_type"] = self.domain_request.organization_type + context["generic_org_type"] = self.domain_request.generic_org_type context["federal_type"] = self.domain_request.federal_type return context @@ -522,7 +522,7 @@ class DotgovDomain(DomainRequestWizard): def get_context_data(self): context = super().get_context_data() - context["organization_type"] = self.domain_request.organization_type + context["generic_org_type"] = self.domain_request.generic_org_type context["federal_type"] = self.domain_request.federal_type return context From c99b9adc15f0afceeaa96ba723733a7cb0326968 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Wed, 20 Mar 2024 17:43:54 -0400 Subject: [PATCH 18/21] merge main --- ...ct_fax_alter_publiccontact_org_and_more.py | 35 +++++++++++++++++++ ...ninformation_generic_org_type_and_more.py} | 2 +- src/registrar/models/public_contact.py | 7 ++-- 3 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py rename src/registrar/migrations/{0077_rename_organization_type_domaininformation_generic_org_type_and_more.py => 0078_rename_organization_type_domaininformation_generic_org_type_and_more.py} (88%) diff --git a/src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py b/src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py new file mode 100644 index 000000000..66c904391 --- /dev/null +++ b/src/registrar/migrations/0077_alter_publiccontact_fax_alter_publiccontact_org_and_more.py @@ -0,0 +1,35 @@ +# Generated by Django 4.2.10 on 2024-03-15 18:47 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ("registrar", "0076_alter_domainrequest_current_websites_and_more"), + ] + + operations = [ + migrations.AlterField( + model_name="publiccontact", + name="fax", + field=models.CharField( + blank=True, help_text="Contact's fax number (null ok). Must be in ITU.E164.2005 format.", null=True + ), + ), + migrations.AlterField( + model_name="publiccontact", + name="org", + field=models.CharField(blank=True, help_text="Contact's organization (null ok)", null=True), + ), + migrations.AlterField( + model_name="publiccontact", + name="street2", + field=models.CharField(blank=True, help_text="Contact's street (null ok)", null=True), + ), + migrations.AlterField( + model_name="publiccontact", + name="street3", + field=models.CharField(blank=True, help_text="Contact's street (null ok)", null=True), + ), + ] diff --git a/src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py b/src/registrar/migrations/0078_rename_organization_type_domaininformation_generic_org_type_and_more.py similarity index 88% rename from src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py rename to src/registrar/migrations/0078_rename_organization_type_domaininformation_generic_org_type_and_more.py index 79d9a71b4..fb9d65cce 100644 --- a/src/registrar/migrations/0077_rename_organization_type_domaininformation_generic_org_type_and_more.py +++ b/src/registrar/migrations/0078_rename_organization_type_domaininformation_generic_org_type_and_more.py @@ -6,7 +6,7 @@ from django.db import migrations class Migration(migrations.Migration): dependencies = [ - ("registrar", "0076_alter_domainrequest_current_websites_and_more"), + ("registrar", "0077_alter_publiccontact_fax_alter_publiccontact_org_and_more"), ] operations = [ diff --git a/src/registrar/models/public_contact.py b/src/registrar/models/public_contact.py index cdd0d6a42..f9dea3f02 100644 --- a/src/registrar/models/public_contact.py +++ b/src/registrar/models/public_contact.py @@ -60,10 +60,10 @@ class PublicContact(TimeStampedModel): ) name = models.CharField(null=False, help_text="Contact's full name") - org = models.CharField(null=True, help_text="Contact's organization (null ok)") + org = models.CharField(null=True, blank=True, help_text="Contact's organization (null ok)") street1 = models.CharField(null=False, help_text="Contact's street") - street2 = models.CharField(null=True, help_text="Contact's street (null ok)") - street3 = models.CharField(null=True, help_text="Contact's street (null ok)") + street2 = models.CharField(null=True, blank=True, help_text="Contact's street (null ok)") + street3 = models.CharField(null=True, blank=True, help_text="Contact's street (null ok)") city = models.CharField(null=False, help_text="Contact's city") sp = models.CharField(null=False, help_text="Contact's state or province") pc = models.CharField(null=False, help_text="Contact's postal code") @@ -72,6 +72,7 @@ class PublicContact(TimeStampedModel): voice = models.CharField(null=False, help_text="Contact's phone number. Must be in ITU.E164.2005 format") fax = models.CharField( null=True, + blank=True, help_text="Contact's fax number (null ok). Must be in ITU.E164.2005 format.", ) pw = models.CharField(null=False, help_text="Contact's authorization code. 16 characters minimum.") From cc90e8068be5f52401f44a86f6b0c49b58ca63d2 Mon Sep 17 00:00:00 2001 From: Rachid Mrad <107004823+rachidatecs@users.noreply.github.com> Date: Fri, 22 Mar 2024 18:07:22 -0400 Subject: [PATCH 19/21] Update docs/developer/README.md Co-authored-by: Alysia Broddrick <109625347+abroddrick@users.noreply.github.com> --- docs/developer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index 438bef792..612b56fdf 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -265,7 +265,7 @@ You can also compile the **Sass** at any time using `npx gulp compile`. Similarl ### CSS classes naming -We use [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming convention for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. +We use the [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming convention for our custom classes. This is in line with how [USWDS approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. ### Upgrading USWDS and other JavaScript packages From f73ff0b9719e0a0f35169f50b65990a67b857027 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Fri, 22 Mar 2024 18:08:52 -0400 Subject: [PATCH 20/21] edits --- docs/developer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index 438bef792..5317679dc 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -263,7 +263,7 @@ Within the `registrar/assets` folder, the `_theme` folder contains three files i You can also compile the **Sass** at any time using `npx gulp compile`. Similarly, you can copy over **other static assets** (images and javascript files), using `npx gulp copyAssets`. -### CSS classes naming +### CSS class naming conventions We use [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming convention for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. From a053d512929b6fdeb2f5b25874276eb20f9d00c1 Mon Sep 17 00:00:00 2001 From: Rachid Mrad Date: Fri, 22 Mar 2024 18:10:03 -0400 Subject: [PATCH 21/21] copyedits --- docs/developer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/README.md b/docs/developer/README.md index 5317679dc..699b1a886 100644 --- a/docs/developer/README.md +++ b/docs/developer/README.md @@ -265,7 +265,7 @@ You can also compile the **Sass** at any time using `npx gulp compile`. Similarl ### CSS class naming conventions -We use [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming convention for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. +We use the [CSS Block Element Modifier (BEM)](https://getbem.com/naming/) naming convention for our custom classes. This is in line with how USWDS [approaches](https://designsystem.digital.gov/whats-new/updates/2019/04/08/introducing-uswds-2-0/) their CSS class architecture and helps keep our code cohesive and readable. ### Upgrading USWDS and other JavaScript packages