unit tests

Author: JamesW1-NHS

lambdas/filenameprocessor/tests/test_lambda_handler.py

@@ -243,7 +243,7 @@ def test_lambda_handler_non_root_file(self):
     def test_lambda_handler_extended_attributes_success(self):
         """
         Tests that for an extended attributes file (prefix starts with 'Vaccination_Extended_Attributes'):
-        * The file is added to the audit table with a status of 'Processing'
+        * The file is added to the audit table with a status of 'Processed'
         * The queue_name stored is the extended attribute identifier
         * The file is moved to the destination bucket under archive/
         * No SQS message is sent
@@ -278,16 +278,27 @@ def test_lambda_handler_extended_attributes_success(self):
                     ),
                 ),
             ),
+            patch(
+                "file_name_processor.delete_file",
+                side_effect=lambda src_bucket, key: (
+                    s3_client.delete_object(
+                        Bucket=BucketNames.SOURCE,
+                        Key=key,
+                    ),
+                ),
+            ),
         ):
             lambda_handler(self.make_event([self.make_record(test_cases[0].file_key)]), None)
 
-        # Assert audit table entry captured with Processing and queue_name set to the identifier
+        # Assert audit table entry captured with Processed and queue_name set to the identifier
         table_items = self.get_audit_table_items()
         self.assertEqual(len(table_items), 1)
         item = table_items[0]
+        print(json.dumps(item))
         self.assertEqual(item[AuditTableKeys.MESSAGE_ID]["S"], test_cases[0].message_id)
         self.assertEqual(item[AuditTableKeys.FILENAME]["S"], test_cases[0].file_key)
         self.assertEqual(item[AuditTableKeys.QUEUE_NAME]["S"], test_cases[0].ods_code + "_COVID")
+        self.assertEqual(item[AuditTableKeys.STATUS]["S"], "Processed")
         self.assertEqual(item[AuditTableKeys.TIMESTAMP]["S"], test_cases[0].created_at_formatted_string)
         self.assertEqual(item[AuditTableKeys.EXPIRES_AT]["N"], str(test_cases[0].expires_at))
         # File should be moved to destination under archive/
@@ -300,6 +311,70 @@ def test_lambda_handler_extended_attributes_success(self):
         self.assert_no_sqs_message()
         self.assert_no_ack_file(test_cases[0])
 
+    def test_lambda_handler_extended_attributes_failure(self):
+        """
+        Tests that for an extended attributes file (prefix starts with 'Vaccination_Extended_Attributes'):
+        Where the file has not been copied to the destination bucket
+        * The file is added to the audit table with a status of 'Failed'
+        * The queue_name stored is the extended attribute identifier
+        * The file is moved to the archive/ folder in the source bucket
+        * No SQS message is sent
+        * No ack file is created
+        """
+
+        # Build an extended attributes file.
+        # FileDetails supports this when vaccine_type starts with 'Vaccination_Extended_Attributes'.
+        test_cases = [MockFileDetails.extended_attributes_file]
+
+        # Put file in source bucket
+        s3_client.put_object(
+            Bucket=BucketNames.SOURCE,
+            Key=test_cases[0].file_key,
+            Body=MOCK_EXTENDED_ATTRIBUTES_FILE_CONTENT,
+        )
+
+        # Patch uuid4 (message id), the identifier extraction, and don't move the file
+        with (
+            patch("file_name_processor.uuid4", return_value=test_cases[0].message_id),
+            patch(
+                "file_name_processor.validate_extended_attributes_file_key",
+                return_value=test_cases[0].ods_code + "_COVID",
+            ),
+            patch(
+                "file_name_processor.copy_file_outside_bucket",
+                side_effect=lambda src_bucket, key, dst_bucket, dst_key: (  # effectively do nothing
+                    None,
+                ),
+            ),
+        ):
+            lambda_handler(self.make_event([self.make_record(test_cases[0].file_key)]), None)
+
+        # Assert audit table entry captured with Failed and queue_name set to the identifier.
+        # Assert that the ClientError message is a 404 Not Found.
+        table_items = self.get_audit_table_items()
+        self.assertEqual(len(table_items), 1)
+        item = table_items[0]
+        print(json.dumps(item))
+        self.assertEqual(item[AuditTableKeys.MESSAGE_ID]["S"], test_cases[0].message_id)
+        self.assertEqual(item[AuditTableKeys.FILENAME]["S"], test_cases[0].file_key)
+        self.assertEqual(item[AuditTableKeys.QUEUE_NAME]["S"], test_cases[0].ods_code + "_COVID")
+        self.assertEqual(item[AuditTableKeys.TIMESTAMP]["S"], test_cases[0].created_at_formatted_string)
+        self.assertEqual(item[AuditTableKeys.STATUS]["S"], "Failed")
+        self.assertEqual(
+            item[AuditTableKeys.ERROR_DETAILS]["S"],
+            "An error occurred (404) when calling the HeadObject operation: Not Found",
+        )
+        self.assertEqual(item[AuditTableKeys.EXPIRES_AT]["N"], str(test_cases[0].expires_at))
+        # File should be moved to source under archive/
+        dest_key = f"archive/{test_cases[0].file_key}"
+        print(f" destination file is at {s3_client.list_objects(Bucket=BucketNames.SOURCE)}")
+        retrieved = s3_client.get_object(Bucket=BucketNames.SOURCE, Key=dest_key)
+        self.assertIsNotNone(retrieved)
+
+        # No SQS and no ack file
+        self.assert_no_sqs_message()
+        self.assert_no_ack_file(test_cases[0])
+
     @patch("elasticache.get_redis_client")
     def test_lambda_invalid_file_key_no_other_files_in_queue(self, mock_get_redis_client):
         """

lambdas/shared/tests/test_common/test_s3_utils.py

@@ -4,6 +4,7 @@
 from unittest.mock import patch
 
 import boto3
+from botocore.exceptions import ClientError
 from moto import mock_aws
 
 from common import aws_s3_utils
@@ -113,3 +114,45 @@ def test_move_file_outside_bucket_copies_then_deletes(self):
         # Assert source object was deleted
         with self.assertRaises(self.s3.exceptions.NoSuchKey):
             self.s3.get_object(Bucket=self.source_bucket, Key=source_key)
+
+    def test_is_file_in_bucket(self):
+        """File should be present in destination bucket"""
+        file_key = "src/move_file_test.csv"
+
+        # Put an object in the source bucket
+        body_content = b"dummy file content"
+        self.s3.put_object(Bucket=self.source_bucket, Key=file_key, Body=body_content)
+
+        # Should raise no exception
+        aws_s3_utils.is_file_in_bucket(
+            bucket_name=self.source_bucket,
+            file_key=file_key,
+        )
+
+    def test_is_file_not_in_bucket(self):
+        """File should not be present in source bucket"""
+        file_key = "src/move_file_test.csv"
+
+        # Don't put the object in the source bucket
+
+        # Should raise an exception
+        with self.assertRaises(ClientError):
+            aws_s3_utils.is_file_in_bucket(
+                bucket_name=self.source_bucket,
+                file_key=file_key,
+            )
+
+    def test_is_file_in_wrong_bucket(self):
+        """File should not be present in destination bucket"""
+        file_key = "src/move_file_test.csv"
+
+        # Put an object in the source bucket
+        body_content = b"dummy file content"
+        self.s3.put_object(Bucket=self.source_bucket, Key=file_key, Body=body_content)
+
+        # Should raise an exception
+        with self.assertRaises(ClientError):
+            aws_s3_utils.is_file_in_bucket(
+                bucket_name=self.destination_bucket,
+                file_key=file_key,
+            )