zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-05-31 17:53:56 +02:00
Code Issues Projects Releases Packages Wiki Activity

Linted

Browse source
This commit is contained in:
CocoByte 2023-10-30 23:59:50 -06:00
parent a33efbe772
commit 7e04179c20
No known key found for this signature in database
GPG key ID: BBFAA2526384C97F
3 changed files with 45 additions and 112 deletions
Download patch file Download diff file Expand all files Collapse all files

117
src/registrar/management/commands/master_domain_migrations.py
View file

@ -8,11 +8,6 @@
import logging import logging
import argparse import argparse
import sys import sys
import os
from django.test import Client
from django_fsm import TransitionNotAllowed # type: ignore
from django.core.management import BaseCommand from django.core.management import BaseCommand
from django.core.management import call_command from django.core.management import call_command
@ -22,7 +17,6 @@ from registrar.models import (
DomainInformation, DomainInformation,
DomainInvitation, DomainInvitation,
TransitionDomain, TransitionDomain,
User,
) )
from registrar.management.commands.utility.terminal_helper import ( from registrar.management.commands.utility.terminal_helper import (
@ -100,19 +94,26 @@ class Command(BaseCommand):
parser.add_argument( parser.add_argument(
"--migrationDirectory", "--migrationDirectory",
default="migrationData", default="migrationData",
help="The location of the files used for load_transition_domain migration script", help=(
"The location of the files used for"
"load_transition_domain migration script"
),
) )
parser.add_argument( parser.add_argument(
"--migrationFilenames", "--migrationFilenames",
default="escrow_domain_contacts.daily.gov.GOV.txt,escrow_contacts.daily.gov.GOV.txt,escrow_domain_statuses.daily.gov.GOV.txt", default="""escrow_domain_contacts.daily.gov.GOV.txt,
escrow_contacts.daily.gov.GOV.txt,
escrow_domain_statuses.daily.gov.GOV.txt""",
help="""The files used for load_transition_domain migration script. help="""The files used for load_transition_domain migration script.
Must appear IN ORDER and separated by commas: Must appear IN ORDER and separated by commas:
domain_contacts_filename.txt,contacts_filename.txt,domain_statuses_filename.txt domain_contacts_filename.txt,contacts_filename.txt,domain_statuses_filename.txt
where... where...
- domain_contacts_filename is the Data file with domain contact information - domain_contacts_filename is the Data file with domain contact
information
- contacts_filename is the Data file with contact information - contacts_filename is the Data file with contact information
- domain_statuses_filename is the Data file with domain status information""", - domain_statuses_filename is the Data file with domain status
information""",
) )
parser.add_argument( parser.add_argument(
@ -196,13 +197,15 @@ class Command(BaseCommand):
if len(matching_domain_informations) == 0: if len(matching_domain_informations) == 0:
TerminalHelper.print_conditional( TerminalHelper.print_conditional(
debug_on, debug_on,
f"""{TerminalColors.YELLOW}Missing Domain Information{TerminalColors.ENDC}""", f"""{TerminalColors.YELLOW}Missing Domain Information
{TerminalColors.ENDC}""",
) )
missing_domain_informations.append(transition_domain_name) missing_domain_informations.append(transition_domain_name)
if len(matching_domain_invitations) == 0: if len(matching_domain_invitations) == 0:
TerminalHelper.print_conditional( TerminalHelper.print_conditional(
debug_on, debug_on,
f"""{TerminalColors.YELLOW}Missing Domain Invitation{TerminalColors.ENDC}""", f"""{TerminalColors.YELLOW}Missing Domain Invitation
{TerminalColors.ENDC}""",
) )
missing_domain_invites.append(transition_domain_name) missing_domain_invites.append(transition_domain_name)
@ -228,19 +231,23 @@ class Command(BaseCommand):
{total_missing_domains} Missing Domains: {total_missing_domains} Missing Domains:
(These are transition domains that are missing from the Domain Table) (These are transition domains that are missing from the Domain Table)
{TerminalColors.YELLOW}{missing_domains_as_string}{TerminalColors.OKGREEN} {TerminalColors.YELLOW}{missing_domains_as_string}
{TerminalColors.OKGREEN}
{total_duplicate_domains} Duplicate Domains: {total_duplicate_domains} Duplicate Domains:
(These are transition domains which have duplicate entries in the Domain Table) (These are transition domains which have duplicate
{TerminalColors.YELLOW}{duplicate_domains_as_string}{TerminalColors.OKGREEN} entries in the Domain Table)
{TerminalColors.YELLOW}{duplicate_domains_as_string}
{TerminalColors.OKGREEN}
{total_missing_domain_informations} Domain Information Entries missing: {total_missing_domain_informations} Domain Information Entries missing:
(These are transition domains which have no entries in the Domain Information Table) (These are transition domains which have no entries
{TerminalColors.YELLOW}{missing_domain_informations_as_string}{TerminalColors.OKGREEN} in the Domain Information Table)
{TerminalColors.YELLOW}{missing_domain_informations_as_string}
{TerminalColors.OKGREEN}
{total_missing_domain_invitations} Domain Invitations missing: {total_missing_domain_invitations} Domain Invitations missing:
(These are transition domains which have no entires in the Domain Invitation Table) (These are transition domains which have no entires in
{TerminalColors.YELLOW}{missing_domain_invites_as_string}{TerminalColors.OKGREEN} the Domain Invitation Table)
{TerminalColors.YELLOW}{missing_domain_invites_as_string}
{TerminalColors.OKGREEN}
{TerminalColors.ENDC} {TerminalColors.ENDC}
""" """
) )
@ -377,13 +384,10 @@ class Command(BaseCommand):
logger.info( logger.info(
f""" f"""
{TerminalColors.YELLOW} {TerminalColors.YELLOW}
PLEASE Re-Run the script with the correct file location and filenames: PLEASE Re-Run the script with the correct
file location and filenames:
EXAMPLE:
docker compose run -T app ./manage.py test_domain_migration --runMigrations --migrationDirectory /app/tmp --migrationFilenames escrow_domain_contacts.daily.gov.GOV.txt escrow_contacts.daily.gov.GOV.txt escrow_domain_statuses.daily.gov.GOV.txt
""" """
) # noqa )
return return
# Proceed executing the migration scripts # Proceed executing the migration scripts
@ -400,33 +404,6 @@ class Command(BaseCommand):
) )
self.run_transfer_script(debug_on, prompts_enabled) self.run_transfer_script(debug_on, prompts_enabled)
def simulate_user_logins(self, debug_on):
"""Simulates logins for users (this will add
Domain Information objects to our tables)"""
# logger.info(f""
# f"{TerminalColors.OKCYAN}"
# f"================== SIMULATING LOGINS =================="
# f"{TerminalColors.ENDC}")
# for invite in DomainInvitation.objects.all(): #TODO: move to unit test
# #DEBUG:
# TerminalHelper.print_conditional(debug_on,
# f"{TerminalColors.OKCYAN}"
# f"Processing invite: {invite}"
# f"{TerminalColors.ENDC}")
# # get a user with this email address
# user, user_created = User.objects.get_or_create(email=invite.email, username=invite.email)
# #DEBUG:
# TerminalHelper.print_conditional(user_created,
# f"""{TerminalColors.OKCYAN}No user found (creating temporary user object){TerminalColors.ENDC}""")
# TerminalHelper.print_conditional(debug_on,
# f"""{TerminalColors.OKCYAN}Executing first-time login for user: {user}{TerminalColors.ENDC}""")
# user.first_login()
# if user_created:
# logger.info(f"""{TerminalColors.YELLOW}(Deleting temporary user object){TerminalColors.ENDC}""")
# user.delete()
def handle( def handle(
self, self,
**options, **options,
@ -453,9 +430,6 @@ class Command(BaseCommand):
debug_on = options.get("debug") debug_on = options.get("debug")
prompts_enabled = options.get("prompt") prompts_enabled = options.get("prompt")
run_migrations_enabled = options.get("runMigrations") run_migrations_enabled = options.get("runMigrations")
simulate_user_login_enabled = (
False # TODO: delete? Moving to unit test... options.get("triggerLogins")
)
TerminalHelper.print_conditional( TerminalHelper.print_conditional(
debug_on, debug_on,
@ -538,30 +512,7 @@ class Command(BaseCommand):
) )
prompt_continuation_of_analysis = True prompt_continuation_of_analysis = True
# STEP 2 -- SIMULATE LOGINS # STEP 2 -- SEND INVITES
# Simulate user login for each user in domain
# invitation if specified by user OR if running
# migration scripts.
# (NOTE: Although users can choose to run login
# simulations separately (for testing purposes),
# if we are running all migration scripts, we should
# automatically execute this as the final step
# to ensure Domain Information objects get added
# to the database.)
if run_migrations_enabled and simulate_user_login_enabled:
if prompts_enabled:
simulate_user_login_enabled = TerminalHelper.query_yes_no(
f"""{TerminalColors.FAIL}
Proceed with simulating user logins?
{TerminalColors.ENDC}"""
)
if not simulate_user_login_enabled:
return
self.simulate_user_logins(debug_on)
prompt_continuation_of_analysis = True
# STEP 3 -- SEND INVITES
proceed_with_sending_invites = run_migrations_enabled proceed_with_sending_invites = run_migrations_enabled
if prompts_enabled and run_migrations_enabled: if prompts_enabled and run_migrations_enabled:
proceed_with_sending_invites = TerminalHelper.query_yes_no( proceed_with_sending_invites = TerminalHelper.query_yes_no(
@ -574,7 +525,7 @@ class Command(BaseCommand):
self.run_send_invites_script(debug_on, prompts_enabled) self.run_send_invites_script(debug_on, prompts_enabled)
prompt_continuation_of_analysis = True prompt_continuation_of_analysis = True
# STEP 4 -- ANALYZE TABLES & GENERATE REPORT # STEP 3 -- ANALYZE TABLES & GENERATE REPORT
# Analyze tables for corrupt data... # Analyze tables for corrupt data...
if prompt_continuation_of_analysis and prompts_enabled: if prompt_continuation_of_analysis and prompts_enabled:
# ^ (only prompt if we ran steps 1 and/or 2) # ^ (only prompt if we ran steps 1 and/or 2)

1
src/registrar/management/commands/utility/terminal_helper.py
View file

@ -1,5 +1,4 @@
import logging import logging
import os
import sys import sys
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)

31
src/registrar/tests/test_transition_domain_migrations.py
View file

@ -1,4 +1,3 @@
from unittest.mock import patch
from django.test import TestCase from django.test import TestCase
from registrar.models import ( from registrar.models import (
@ -10,9 +9,6 @@ from registrar.models import (
UserDomainRole, UserDomainRole,
) )
from registrar.management.commands.master_domain_migrations import (
Command as master_migration_command,
)
from django.core.management import call_command from django.core.management import call_command
@ -52,7 +48,7 @@ class TestLogins(TestCase):
call_command("transfer_transition_domains_to_domains") call_command("transfer_transition_domains_to_domains")
def run_master_script(self): def run_master_script(self):
command = call_command( call_command(
"master_domain_migrations", "master_domain_migrations",
runMigrations=True, runMigrations=True,
migrationDirectory=f"{self.test_data_file_location}", migrationDirectory=f"{self.test_data_file_location}",
@ -154,23 +150,8 @@ class TestLogins(TestCase):
self.run_master_script() self.run_master_script()
# # TODO: instead of patching....there has got to be a way of making sure subsequent commands use the django database # STEP 2: (analyze the tables just like the
# # Patch subroutines for migrations # migration script does, but add assert statements)
# def side_effect():
# self.run_load_domains()
# self.run_transfer_domains()
# patcher = patch("registrar.management.commands.master_domain_migrations.Command.run_migration_scripts")
# mocked_get = patcher.start()
# mocked_get.side_effect = side_effect
# # Patch subroutines for sending invitations
# def side_effect():
# # TODO: what should happen here?
# return
# patcher = patch("registrar.management.commands.master_domain_migrations.Command.run_send_invites_script")
# mocked_get = patcher.start()
# mocked_get.side_effect = side_effect
# STEP 2: (analyze the tables just like the migration script does, but add assert statements)
expected_total_transition_domains = 8 expected_total_transition_domains = 8
expected_total_domains = 4 expected_total_domains = 4
expected_total_domain_informations = 0 expected_total_domain_informations = 0
@ -178,7 +159,8 @@ class TestLogins(TestCase):
expected_missing_domains = 0 expected_missing_domains = 0
expected_duplicate_domains = 0 expected_duplicate_domains = 0
# we expect 8 missing domain invites since the migration does not auto-login new users # we expect 8 missing domain invites since the
# migration does not auto-login new users
expected_missing_domain_informations = 8 expected_missing_domain_informations = 8
# we expect 1 missing invite from anomaly.gov (an injected error) # we expect 1 missing invite from anomaly.gov (an injected error)
expected_missing_domain_invitations = 1 expected_missing_domain_invitations = 1
@ -196,7 +178,8 @@ class TestLogins(TestCase):
def test_load_transition_domain(self): def test_load_transition_domain(self):
self.run_load_domains() self.run_load_domains()
# STEP 2: (analyze the tables just like the migration script does, but add assert statements) # STEP 2: (analyze the tables just like the migration
# script does, but add assert statements)
expected_total_transition_domains = 8 expected_total_transition_domains = 8
expected_total_domains = 0 expected_total_domains = 0
expected_total_domain_informations = 0 expected_total_domain_informations = 0