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

fixed formatting and test with terminal prompting

Browse source
This commit is contained in:
David Kennedy 2024-06-03 17:23:34 -04:00
parent 4ff60817da
commit 9ecb9f3556
No known key found for this signature in database
GPG key ID: 6528A5386E66B96B
2 changed files with 52 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/registrar/management/commands/clean_tables.py
View file

@ -18,10 +18,10 @@ class Command(BaseCommand):
if settings.IS_PRODUCTION: if settings.IS_PRODUCTION:
logger.error("clean_tables cannot be run in production") logger.error("clean_tables cannot be run in production")
return return
TerminalHelper.prompt_for_execution( TerminalHelper.prompt_for_execution(
system_exit_on_terminate=True, system_exit_on_terminate=True,
info_to_inspect=f""" info_to_inspect="""
This script will delete all rows from the following tables: This script will delete all rows from the following tables:
* Contact * Contact
* Domain * Domain

84
src/registrar/tests/test_management_scripts.py
View file

@ -788,8 +788,12 @@ class TestCleanTables(TestCase):
def test_command_logs_error_in_production(self): def test_command_logs_error_in_production(self):
"""Test that the handle method does not process in production""" """Test that the handle method does not process in production"""
with less_console_noise(): with less_console_noise():
call_command("clean_tables") with patch(
self.logger_mock.error.assert_called_with("clean_tables cannot be run in production") "registrar.management.commands.utility.terminal_helper.TerminalHelper.query_yes_no_exit", # noqa
return_value=True,
):
call_command("clean_tables")
self.logger_mock.error.assert_called_with("clean_tables cannot be run in production")
@override_settings(IS_PRODUCTION=False) @override_settings(IS_PRODUCTION=False)
def test_command_cleans_tables(self): def test_command_cleans_tables(self):
@ -799,45 +803,53 @@ class TestCleanTables(TestCase):
model_mock = MagicMock() model_mock = MagicMock()
get_model_mock.return_value = model_mock get_model_mock.return_value = model_mock
call_command("clean_tables") with patch(
"registrar.management.commands.utility.terminal_helper.TerminalHelper.query_yes_no_exit", # noqa
return_value=True,
):
call_command("clean_tables")
table_names = [ table_names = [
"DomainInformation", "DomainInformation",
"DomainRequest", "DomainRequest",
"PublicContact", "PublicContact",
"Domain", "Domain",
"User", "User",
"Contact", "Contact",
"Website", "Website",
"DraftDomain", "DraftDomain",
"HostIp", "HostIp",
"Host", "Host",
] ]
# Check that each model's delete method was called # Check that each model's delete method was called
for table_name in table_names: for table_name in table_names:
get_model_mock.assert_any_call("registrar", table_name) get_model_mock.assert_any_call("registrar", table_name)
model_mock.objects.all().delete.assert_called() model_mock.objects.all().delete.assert_called()
self.logger_mock.info.assert_any_call("Successfully cleaned table DomainInformation") self.logger_mock.info.assert_any_call("Successfully cleaned table DomainInformation")
@override_settings(IS_PRODUCTION=False) @override_settings(IS_PRODUCTION=False)
def test_command_handles_nonexistent_model(self): def test_command_handles_nonexistent_model(self):
"""Test that exceptions for non existent models are handled properly within the handle method""" """Test that exceptions for non existent models are handled properly within the handle method"""
with less_console_noise(): with less_console_noise():
with patch("django.apps.apps.get_model", side_effect=LookupError): with patch("django.apps.apps.get_model", side_effect=LookupError):
call_command("clean_tables") with patch(
# Assert that the error message was logged for any of the table names "registrar.management.commands.utility.terminal_helper.TerminalHelper.query_yes_no_exit", # noqa
self.logger_mock.error.assert_any_call("Model for table DomainInformation not found.") return_value=True,
self.logger_mock.error.assert_any_call("Model for table DomainRequest not found.") ):
self.logger_mock.error.assert_any_call("Model for table PublicContact not found.") call_command("clean_tables")
self.logger_mock.error.assert_any_call("Model for table Domain not found.") # Assert that the error message was logged for any of the table names
self.logger_mock.error.assert_any_call("Model for table User not found.") self.logger_mock.error.assert_any_call("Model for table DomainInformation not found.")
self.logger_mock.error.assert_any_call("Model for table Contact not found.") self.logger_mock.error.assert_any_call("Model for table DomainRequest not found.")
self.logger_mock.error.assert_any_call("Model for table Website not found.") self.logger_mock.error.assert_any_call("Model for table PublicContact not found.")
self.logger_mock.error.assert_any_call("Model for table DraftDomain not found.") self.logger_mock.error.assert_any_call("Model for table Domain not found.")
self.logger_mock.error.assert_any_call("Model for table HostIp not found.") self.logger_mock.error.assert_any_call("Model for table User not found.")
self.logger_mock.error.assert_any_call("Model for table Host not found.") self.logger_mock.error.assert_any_call("Model for table Contact not found.")
self.logger_mock.error.assert_any_call("Model for table Website not found.")
self.logger_mock.error.assert_any_call("Model for table DraftDomain not found.")
self.logger_mock.error.assert_any_call("Model for table HostIp not found.")
self.logger_mock.error.assert_any_call("Model for table Host not found.")
@override_settings(IS_PRODUCTION=False) @override_settings(IS_PRODUCTION=False)
def test_command_logs_other_exceptions(self): def test_command_logs_other_exceptions(self):
@ -848,9 +860,13 @@ class TestCleanTables(TestCase):
get_model_mock.return_value = model_mock get_model_mock.return_value = model_mock
model_mock.objects.all().delete.side_effect = Exception("Some error") model_mock.objects.all().delete.side_effect = Exception("Some error")
call_command("clean_tables") with patch(
"registrar.management.commands.utility.terminal_helper.TerminalHelper.query_yes_no_exit", # noqa
return_value=True,
):
call_command("clean_tables")
self.logger_mock.error.assert_any_call("Error cleaning table DomainInformation: Some error") self.logger_mock.error.assert_any_call("Error cleaning table DomainInformation: Some error")
class TestExportTables(MockEppLib): class TestExportTables(MockEppLib):