Add initial script to transition domain info fed agency

This commit is contained in:
Erin 2024-04-19 16:10:46 -07:00
parent 923ab6bdc0
commit b8425c2051
No known key found for this signature in database
GPG key ID: 1CAD275313C62460
2 changed files with 103 additions and 56 deletions

View file

@ -0,0 +1,103 @@
""""
TODO: write description
"""
import logging
import copy
from django.core.management import BaseCommand
from registrar.models import DomainInformation, DomainRequest, FederalAgency
from registrar.management.commands.utility.terminal_helper import ScriptDataHelper
logger = logging.getLogger(__name__)
class Command(BaseCommand):
help = "Transfers Domain Request and Domain Information federal agency field from string to FederalAgency object"
# Deprecated federal agency names mapped to designated replacements
rename_deprecated_federal_agency = {
"Appraisal Subcommittee": "Appraisal Subcommittee of the Federal Financial Institutions Examination Council",
"Barry Goldwater Scholarship and Excellence in Education Program": "Barry Goldwater Scholarship and Excellence in Education Foundation",
"Federal Reserve System": "Federal Reserve Board of Governors",
"Harry S Truman Scholarship Foundation": "Harry S. Truman Scholarship Foundation",
"Japan-US Friendship Commission": "Japan-U.S. Friendship Commission",
"Japan-United States Friendship Commission": "Japan-U.S. Friendship Commission",
"John F. Kennedy Center for Performing Arts": "John F. Kennedy Center for the Performing Arts",
"Occupational Safety & Health Review Commission": "Occupational Safety and Health Review Commission",
"Corporation for National & Community Service": "Corporation for National and Community Service",
"Export/Import Bank of the U.S.": "Export-Import Bank of the United States",
"Medical Payment Advisory Commission": "Medicare Payment Advisory Commission",
"U.S. Peace Corps": "Peace Corps",
"Chemical Safety Board": "U.S. Chemical Safety Board",
"Nuclear Waste Technical Review Board": "U.S. Nuclear Waste Technical Review Board",
"State, Local, and Tribal Government": "Non-Federal Agency"
}
def handle(self, **options):
"""
Converts all ready and DNS needed domains with a non-default public contact
to disclose their public contact.
"""
logger.info("Transferring federal agencies to FederalAgency object")
# DomainInforation object we populate with updated_federal_agency which are then bulk updated
domain_infos_to_update = []
domain_requests_to_update = []
# domain requests with null federal_agency that are not populated with updated_federal_agency
domain_requests_skipped = []
domain_infos_with_errors = []
domain_requests_with_errors = []
# Initializes domain request and domain info objects that need to update federal agency
# filter out domains with federal agency null or Non-Federal Agency
domain_infos = DomainInformation.objects.all()
domain_requests = DomainRequest.objects.all()
logger.info(f"Found {len(domain_infos)} DomainInfo objects with federal agency.")
for domain_info in domain_infos:
try:
federal_agency_row = self.find_federal_agency_row(domain_info)
domain_info.updated_federal_agency = federal_agency_row
domain_infos_to_update.append(domain_info)
logger.info(f"DomainInformation {domain_info} updated_federal_agency set to: {domain_info.updated_federal_agency}")
except Exception as err:
logger.info(f"DomainInformation for {domain_information} failed to update updated_federal_agency: {err}")
domain_infos_with_errors.append(domain_info)
ScriptDataHelper.bulk_update_fields(
DomainInformation, domain_infos_to_update, ["updated_federal_agency"]
)
for domain_request in domain_requests:
try:
if not domain_request.federal_agency:
domain_requests_skipped.append(domain_request)
else:
federal_agency_row = self.find_federal_agency_row(domain_request)
domain_request.updated_federal_agency = federal_agency_row
domain_requests_to_update.append(domain_request)
logger.info(f"DomainRequest {domain_request} updated_federal_agency set to: {domain_request.updated_federal_agency}")
except Exception as err:
logger.info(f"DomainRequest for {domain_request} failed to update updated_federal_agency: {err}")
domain_requests_with_errors.append(domain_request)
ScriptDataHelper.bulk_update_fields(
DomainRequest, domain_requests_to_update, ["updated_federal_agency"]
)
logger.info(f"{len(domain_infos_to_update)} DomainInformation rows updated update_federal_agency.")
logger.info(f"{len(domain_infos_with_errors)} DomainInformation rows errored when updating update_federal_agency.")
logger.info(f"{len(domain_requests_to_update)} DomainRequest rows updated update_federal_agency.")
logger.info(f"{len(domain_requests_skipped)} DomainRequest rows with null federal_agency skipped.")
logger.info(f"{len(domain_requests_with_errors)} DomainRequest rows errored when updating update_federal_agency.\n{domain_requests_with_errors}")
def find_federal_agency_row(self, domain_object):
federal_agency = domain_object.federal_agency
# Domain Information objects without a federal agency default to Non-Federal Agency
if not federal_agency:
federal_agency = "Non-Federal Agency"
if federal_agency in self.rename_deprecated_federal_agency.keys():
federal_agency = self.rename_deprecated_federal_agency[federal_agency]
return FederalAgency.objects.filter(agency=federal_agency).get()

View file

@ -1,56 +0,0 @@
""""
TODO: write description
"""
import logging
import copy
from django.core.management import BaseCommand
from registrar.models import DomainInformation, DomainRequest, FederalAgency
logger = logging.getLogger(__name__)
class Command(BaseCommand):
help = "Transfers Domain Request and Domain Information federal agency field from string to FederalAgency fk"
def __init__(self):
"""Sets global variables for code tidiness"""
super().__init__()
# domains with errors, which do not successfully update federal agency to FederalAgency fk
self.domains_with_errors: list[str] = []
# domains that successfull update federal agency to FederalAgency fk
self.domains_successfully_updated = 0
def handle(self, **options):
"""
Converts all ready and DNS needed domains with a non-default public contact
to disclose their public contact.
"""
logger.info("Transferring federal agencies to FederalAgency foreign key")
# Initializes domain request and domain info objects that need to update federal agency
# filter out domains with federal agency null or Non-Federal Agency
domain_infos = DomainInformation.objects.filter(
federal_agency__isnull=False
).exclude(
federal_agency="Non-Federal Agency"
)
logger.info(f"Found {len(domain_infos)} DomainInfo objects with federal agency.")
# Update EPP contact for domains with a security contact
for domain in domain_infos:
# try:
federal_agency = domain.federal_agency # noqa on these items as we only want to call security_contact
logger.info(f"Domain {domain} federal agency: {federal_agency}")
# except Exception as err:
# # error condition if domain not in database
# self.domains_with_errors.append(copy.deepcopy(domain.name))
# logger.error(f"error retrieving domain {domain.name} contact {domain.security_contact}: {err}")
# # Inform user how many contacts were disclosed, skipped, and errored
# logger.info(f"Updated {self.disclosed_domain_contacts_count} contacts to disclosed.")
# logger.info(
# f"Error disclosing the following {len(self.domains_with_errors)} contacts: {self.domains_with_errors}"
# )