lint

Author: JamesW1-NHS

lambdas/ack_backend/src/constants.py

@@ -4,14 +4,17 @@
 
 AUDIT_TABLE_NAME = os.getenv("AUDIT_TABLE_NAME")
 
+
 def get_source_bucket_name() -> str:
     """Get the SOURCE_BUCKET_NAME environment from environment variables."""
     return os.getenv("SOURCE_BUCKET_NAME")
 
+
 def get_ack_bucket_name() -> str:
     """Get the ACK_BUCKET_NAME environment from environment variables."""
     return os.getenv("ACK_BUCKET_NAME")
 
+
 class FileStatus:
     """File status constants"""
 

lambdas/ack_backend/tests/test_ack_processor.py

@@ -113,8 +113,13 @@ def test_lambda_handler_main_multiple_records(self):
         response = lambda_handler(event=event, context={})
 
         self.assertEqual(response, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
-        validate_ack_file_content(self.s3_client,
-            [*array_of_success_messages, *array_of_failure_messages, *array_of_mixed_success_and_failure_messages],
+        validate_ack_file_content(
+            self.s3_client,
+            [
+                *array_of_success_messages,
+                *array_of_failure_messages,
+                *array_of_mixed_success_and_failure_messages
+            ],
             existing_file_content=ValidValues.ack_headers,
         )
 
@@ -169,7 +174,10 @@ def test_lambda_handler_main(self):
             # TODO: None of the test cases have any existing ack file content?
             with self.subTest(msg=f"Existing ack file: {test_case['description']}"):
                 existing_ack_file_content = test_case.get("existing_ack_file_content", "")
-                setup_existing_ack_file(MOCK_MESSAGE_DETAILS.temp_ack_file_key, existing_ack_file_content, self.s3_client)
+                setup_existing_ack_file(
+                    MOCK_MESSAGE_DETAILS.temp_ack_file_key,
+                    existing_ack_file_content, self.s3_client
+                )
                 response = lambda_handler(event=self.generate_event(test_case["messages"]), context={})
                 self.assertEqual(response, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
                 validate_ack_file_content(self.s3_client, test_case["messages"], existing_ack_file_content)

lambdas/ack_backend/tests/test_audit_table.py

@@ -1,8 +1,9 @@
 import unittest
-from unittest.mock import patch, MagicMock
+from unittest.mock import patch
 import audit_table
 from common.models.errors import UnhandledAuditTableError
 
+
 class TestAuditTable(unittest.TestCase):
 
     def setUp(self):

lambdas/ack_backend/tests/test_logging_decorators.py

@@ -1,9 +1,9 @@
 import unittest
-from unittest.mock import patch, MagicMock, call
+from unittest.mock import patch
 import logging_decorators
-import json
 import time
 
+
 class TestLoggingDecorators(unittest.TestCase):
     def setUp(self):
         # Patch logger and firehose_client
@@ -127,5 +127,6 @@ def dummy_lambda(event, context):
         self.mock_logger.error.assert_called()
         self.mock_firehose.put_record.assert_called()
 
+
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()

lambdas/ack_backend/tests/test_splunk_logging.py

@@ -104,10 +104,10 @@ def test_splunk_logging_successful_rows(self):
         """Tests a single object in the body of the event"""
 
         for operation in ["CREATE", "UPDATE", "DELETE"]:
-            with (
-                patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-                patch("logging_decorators.logger") as mock_logger,
-            ):
+            with (  # noqa: E999
+                patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+                patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+            ):  # noqa: E999
                 result = lambda_handler(event=generate_event([{"operation_requested": operation}]), context={})
 
             self.assertEqual(result, {"statusCode": 200, "body": json.dumps("Lambda function executed successfully!")})
@@ -132,17 +132,18 @@ def test_splunk_logging_successful_rows(self):
     def test_splunk_logging_missing_data(self):
         """Tests missing key values in the body of the event"""
 
-        with (
-            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-            patch("logging_decorators.logger") as mock_logger,
-        ):
+        with (  # noqa: E999
+            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+            patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+        ):  # noqa: E999
             with self.assertRaises(Exception):
                 lambda_handler(event={"Records": [{"body": json.dumps([{"": "456"}])}]}, context={})
 
             expected_first_logger_info_data = {**InvalidValues.Logging_with_no_values}
 
             expected_first_logger_error_data = self.expected_lambda_handler_logs(
-                success=False, number_of_rows=1, ingestion_complete=False, diagnostics="'NoneType' object has no attribute 'replace'"
+                success=False, number_of_rows=1, ingestion_complete=False,
+                diagnostics="'NoneType' object has no attribute 'replace'"
             )
 
             first_logger_info_call_args = json.loads(self.extract_all_call_args_for_logger_info(mock_logger)[0])
@@ -171,10 +172,10 @@ def test_splunk_logging_statuscode_diagnostics(
         ]
 
         for test_case in test_cases:
-            with (
-                patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-                patch("logging_decorators.logger") as mock_logger,
-            ):
+            with (  # noqa: E999
+                patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+                patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+            ):  # noqa: E999
                 result = lambda_handler(event=generate_event([{"diagnostics": test_case["diagnostics"]}]), context={})
 
             self.assertEqual(result, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
@@ -202,10 +203,10 @@ def test_splunk_logging_multiple_rows(self):
         """Tests logging for multiple objects in the body of the event"""
         messages = [{"row_id": "test1"}, {"row_id": "test2"}]
 
-        with (
-            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-            patch("logging_decorators.logger") as mock_logger,
-        ):
+        with (  # noqa: E999
+            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+            patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+        ):  # noqa: E999
             result = lambda_handler(generate_event(messages), context={})
 
         self.assertEqual(result, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
@@ -252,10 +253,10 @@ def test_splunk_logging_multiple_with_diagnostics(
             {"row_id": "test3", "operation_requested": "DELETE", "diagnostics": DiagnosticsDictionaries.NO_PERMISSIONS},
         ]
 
-        with (
-            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-            patch("logging_decorators.logger") as mock_logger,
-        ):
+        with (  # noqa: E999
+            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+            patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+        ):  # noqa: E999
             result = lambda_handler(generate_event(messages), context={})
 
         self.assertEqual(result, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
@@ -317,11 +318,12 @@ def test_splunk_update_ack_file_not_logged(self):
             message_value = "test" + str(i)
             messages.append({"row_id": message_value})
 
-        with (
-            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-            patch("logging_decorators.logger") as mock_logger,
-            patch("update_ack_file.change_audit_table_status_to_processed") as mock_change_audit_table_status_to_processed,
-        ):
+        with (  # noqa: E999
+            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+            patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+            patch("update_ack_file.change_audit_table_status_to_processed")
+                as mock_change_audit_table_status_to_processed,  # noqa: E999
+        ):  # noqa: E999
             result = lambda_handler(generate_event(messages), context={})
 
         self.assertEqual(result, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
@@ -347,7 +349,6 @@ def test_splunk_update_ack_file_not_logged(self):
         )
         mock_change_audit_table_status_to_processed.assert_not_called()
 
-
     def test_splunk_update_ack_file_logged(self):
         """Tests that update_ack_file is logged if we have sent acks for the whole file"""
         # send 99 messages
@@ -356,11 +357,12 @@ def test_splunk_update_ack_file_logged(self):
             message_value = "test" + str(i)
             messages.append({"row_id": message_value})
 
-        with (
-            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,
-            patch("logging_decorators.logger") as mock_logger,
-            patch("update_ack_file.change_audit_table_status_to_processed") as mock_change_audit_table_status_to_processed,
-        ):
+        with (  # noqa: E999
+            patch("logging_decorators.send_log_to_firehose") as mock_send_log_to_firehose,  # noqa: E999
+            patch("logging_decorators.logger") as mock_logger,  # noqa: E999
+            patch("update_ack_file.change_audit_table_status_to_processed")
+                as mock_change_audit_table_status_to_processed,  # noqa: E999
+        ):  # noqa: E999
             result = lambda_handler(generate_event(messages), context={})
 
         self.assertEqual(result, EXPECTED_ACK_LAMBDA_RESPONSE_FOR_SUCCESS)
@@ -374,7 +376,9 @@ def test_splunk_update_ack_file_logged(self):
                 "message_id": "test1",
                 "time_taken": "1.0s"
             }
-        expected_last_logger_info_data = self.expected_lambda_handler_logs(success=True, number_of_rows=99, ingestion_complete=True)
+        expected_last_logger_info_data = self.expected_lambda_handler_logs(
+            success=True, number_of_rows=99, ingestion_complete=True
+        )
 
         all_logger_info_call_args = self.extract_all_call_args_for_logger_info(mock_logger)
         thirdlast_logger_info_call_args = json.loads(all_logger_info_call_args[98])

lambdas/ack_backend/tests/test_update_ack_file.py

@@ -207,5 +207,6 @@ def test_obtain_current_ack_content_file_exists(self):
         result = obtain_current_ack_content(MOCK_MESSAGE_DETAILS.temp_ack_file_key)
         self.assertEqual(result.getvalue(), existing_content)
 
+
 if __name__ == "__main__":
     unittest.main()

lambdas/ack_backend/tests/test_update_ack_file_flow.py

@@ -19,7 +19,10 @@ def setUp(self):
         self.ack_bucket_patcher = patch('update_ack_file.get_ack_bucket_name', return_value=self.ack_bucket_name)
         self.mock_get_ack_bucket_name = self.ack_bucket_patcher.start()
 
-        self.source_bucket_patcher = patch('update_ack_file.get_source_bucket_name', return_value=self.source_bucket_name)
+        self.source_bucket_patcher = patch(
+            'update_ack_file.get_source_bucket_name',
+            return_value=self.source_bucket_name
+        )
         self.mock_get_source_bucket_name = self.source_bucket_patcher.start()
 
         self.s3_client.create_bucket(

lambdas/ack_backend/tests/utils/utils_for_ack_backend_tests.py

@@ -92,8 +92,10 @@ def generate_expected_ack_content(
     return existing_content
 
 
-def validate_ack_file_content(s3_client,
-    incoming_messages: list[dict], existing_file_content: str = ValidValues.ack_headers
+def validate_ack_file_content(
+    s3_client,
+    incoming_messages: list[dict],
+    existing_file_content: str = ValidValues.ack_headers
 ) -> None:
     """
     Obtains the ack file content and ensures that it matches the expected content (expected content is based

lambdas/ack_backend/tests/utils/values_for_ack_backend_tests.py

@@ -246,7 +246,6 @@ class ValidValues:
     }
 
 
-
 class InvalidValues:
     """Invalid values for use in tests"""
 

lambdas/shared/src/common/clients.py

@@ -16,12 +16,15 @@
 
 # for lambdas which require a global s3_client
 global_s3_client = None
+
+
 def get_s3_client():
     global global_s3_client
     if global_s3_client is None:
         global_s3_client = boto3_client("s3", region_name=REGION_NAME)
     return global_s3_client
 
+
 firehose_client = boto3_client("firehose", region_name=REGION_NAME)
 secrets_manager_client = boto3_client("secretsmanager", region_name=REGION_NAME)
 dynamodb_client = boto3_client("dynamodb", region_name=REGION_NAME)