VED-888 / VED-892: Add support for new vacc types & fix existing config. (#964)

* VED-888 / VED-892: Add support for new vacc types. Rename COVID vacc type.

* VED-888: Update other references to COVID-19 for consistency.

* VED-892: Add new vacc types to OAS.

Author: mfjarvis

backend/src/authorisation/authoriser.py

@@ -18,7 +18,7 @@ def _expand_permissions(
         permissions: list[str],
     ) -> dict[str, list[ApiOperationCode]]:
         """Parses and expands permissions data into a dictionary mapping vaccination types to a list of permitted
-        API operations. The raw string from Redis will be in the form VAC.PERMS e.g. COVID19.CRUDS
+        API operations. The raw string from Redis will be in the form VAC.PERMS e.g. COVID.CRUDS
         """
         expanded_permissions = {}
 

backend/tests/authorisation/test_authoriser.py

@@ -22,63 +22,59 @@ def tearDown(self):
 
     def test_authorise_returns_true_if_supplier_has_permissions(self):
         """Authoriser().authorise should return true if the supplier has the required permissions"""
-        self.mock_cache_client.hget.return_value = '["COVID19.RS"]'
+        self.mock_cache_client.hget.return_value = '["COVID.RS"]'
 
-        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.READ, {"COVID19"})
+        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.READ, {"COVID"})
 
         self.assertTrue(result)
         self.mock_cache_client.hget.assert_called_once_with("supplier_permissions", self.MOCK_SUPPLIER_NAME)
         self.mock_logger.info.assert_called_once_with(
-            "operation: r, supplier_permissions: {'covid19': ['r', 's']}, vaccine_types: {'COVID19'}"
+            "operation: r, supplier_permissions: {'covid': ['r', 's']}, vaccine_types: {'COVID'}"
         )
 
     def test_authorise_returns_false_if_supplier_does_not_have_any_permissions(self):
         """Authoriser().authorise should return false if the supplier does not have any permissions in the cache"""
         self.mock_cache_client.hget.return_value = ""
 
-        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.CREATE, {"COVID19"})
+        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.CREATE, {"COVID"})
 
         self.assertFalse(result)
         self.mock_cache_client.hget.assert_called_once_with("supplier_permissions", self.MOCK_SUPPLIER_NAME)
-        self.mock_logger.info.assert_called_once_with(
-            "operation: c, supplier_permissions: {}, vaccine_types: {'COVID19'}"
-        )
+        self.mock_logger.info.assert_called_once_with("operation: c, supplier_permissions: {}, vaccine_types: {'COVID'}")
 
     def test_authorise_returns_false_if_supplier_does_not_have_permission_for_operation(
         self,
     ):
         """Authoriser().authorise should return false if the supplier does not have permission for the operation"""
-        self.mock_cache_client.hget.return_value = '["COVID19.RS"]'
+        self.mock_cache_client.hget.return_value = '["COVID.RS"]'
 
-        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.CREATE, {"COVID19"})
+        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.CREATE, {"COVID"})
 
         self.assertFalse(result)
         self.mock_cache_client.hget.assert_called_once_with("supplier_permissions", self.MOCK_SUPPLIER_NAME)
         self.mock_logger.info.assert_called_once_with(
-            "operation: c, supplier_permissions: {'covid19': ['r', 's']}, vaccine_types: {'COVID19'}"
+            "operation: c, supplier_permissions: {'covid': ['r', 's']}, vaccine_types: {'COVID'}"
         )
 
     def test_authorise_returns_false_if_no_permission_for_vaccination_type(self):
         """Authoriser().authorise should return false if the supplier does not have permission for the vaccination
         type"""
-        self.mock_cache_client.hget.return_value = '["COVID19.RS"]'
+        self.mock_cache_client.hget.return_value = '["COVID.RS"]'
 
         result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.READ, {"FLU"})
 
         self.assertFalse(result)
         self.mock_cache_client.hget.assert_called_once_with("supplier_permissions", self.MOCK_SUPPLIER_NAME)
         self.mock_logger.info.assert_called_once_with(
-            "operation: r, supplier_permissions: {'covid19': ['r', 's']}, vaccine_types: {'FLU'}"
+            "operation: r, supplier_permissions: {'covid': ['r', 's']}, vaccine_types: {'FLU'}"
         )
 
     def test_authorise_returns_false_multiple_vaccs_scenario(self):
         """Authoriser().authorise should return false if the supplier is missing a permission for any of the vaccs in
         the list provided"""
-        self.mock_cache_client.hget.return_value = '["COVID19.RS", "FLU.CRUDS"]'
+        self.mock_cache_client.hget.return_value = '["COVID.RS", "FLU.CRUDS"]'
 
-        result = self.test_authoriser.authorise(
-            self.MOCK_SUPPLIER_NAME, ApiOperationCode.READ, {"FLU", "COVID19", "RSV"}
-        )
+        result = self.test_authoriser.authorise(self.MOCK_SUPPLIER_NAME, ApiOperationCode.READ, {"FLU", "COVID", "RSV"})
 
         self.assertFalse(result)
         self.mock_cache_client.hget.assert_called_once_with("supplier_permissions", self.MOCK_SUPPLIER_NAME)
@@ -87,8 +83,8 @@ def test_filter_permitted_vacc_types_returns_all_if_supplier_has_perms_for_all(
         self,
     ):
         """The same set of vaccination types will be returned if the supplier has the required permissions"""
-        self.mock_cache_client.hget.return_value = '["COVID19.RS", "FLU.CRUDS", "RSV.CRUDS"]'
-        requested_vacc_types = {"FLU", "COVID19", "RSV"}
+        self.mock_cache_client.hget.return_value = '["COVID.RS", "FLU.CRUDS", "RSV.CRUDS"]'
+        requested_vacc_types = {"FLU", "COVID", "RSV"}
 
         result = self.test_authoriser.filter_permitted_vacc_types(
             self.MOCK_SUPPLIER_NAME, ApiOperationCode.SEARCH, requested_vacc_types
@@ -103,11 +99,11 @@ def test_filter_permitted_vacc_types_removes_any_vacc_types_that_the_supplier_ca
     ):
         """Filter permitted vacc types method will filter out any vaccination types that the user cannot interact
         with"""
-        self.mock_cache_client.hget.return_value = '["COVID19.RS", "FLU.CRUDS", "RSV.R"]'
+        self.mock_cache_client.hget.return_value = '["COVID.RS", "FLU.CRUDS", "RSV.R"]'
 
         result = self.test_authoriser.filter_permitted_vacc_types(
-            self.MOCK_SUPPLIER_NAME, ApiOperationCode.SEARCH, {"FLU", "COVID19", "RSV"}
+            self.MOCK_SUPPLIER_NAME, ApiOperationCode.SEARCH, {"FLU", "COVID", "RSV"}
         )
 
-        self.assertSetEqual(result, {"FLU", "COVID19"})
+        self.assertSetEqual(result, {"FLU", "COVID"})
         self.mock_cache_client.hget.assert_called_once_with("supplier_permissions", self.MOCK_SUPPLIER_NAME)

backend/tests/batch/test_batch_filename_to_events_mapper.py

@@ -25,18 +25,18 @@
 
 MOCK_SUPPLIER_TWO_COVID_EVENT_ONE = {
     "row_id": "row-1",
-    "file_key": "supplier_two_covid19_file_key",
+    "file_key": "supplier_two_covid_file_key",
     "created_at_formatted_string": "2025-01-24T14:00:00Z",
     "supplier": "supplier_two",
-    "vax_type": "COVID-19",
+    "vax_type": "COVID",
     "local_id": "local-1",
     "operation_requested": "CREATE",
 }
 
 
 class TestBatchFilenameToEventsMapper(unittest.TestCase):
     expected_key_supplier_one = "supplier_one_rsv_file_key_2025-01-24T12:00:00Z"
-    expected_key_supplier_two = "supplier_two_covid19_file_key_2025-01-24T14:00:00Z"
+    expected_key_supplier_two = "supplier_two_covid_file_key_2025-01-24T14:00:00Z"
 
     def setUp(self) -> None:
         self.batch_filename_to_events_mapper = BatchFilenameToEventsMapper()

backend/tests/controller/test_fhir_batch_controller.py

@@ -11,7 +11,7 @@
 )
 from repository.fhir_batch_repository import ImmunizationBatchRepository
 from service.fhir_batch_service import ImmunizationBatchService
-from testing_utils.immunization_utils import create_covid_19_immunization
+from testing_utils.immunization_utils import create_covid_immunization
 
 
 class TestCreateImmunizationBatchController(unittest.TestCase):
@@ -25,7 +25,7 @@ def test_send_request_to_dynamo_create_success(self):
         """it should create Immunization and return imms id location"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         message_body = {
             "supplier": "test_supplier",
             "fhir_json": imms.json(),
@@ -50,7 +50,7 @@ def test_send_request_to_dynamo_create_badrequest(self):
         """it should return error since it got failed in initial validation"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         create_result = CustomValidationError(
             message="Validation errors: contained[?(@.resourceType=='Patient')].identifier[0].value does not exists"
         )
@@ -79,7 +79,7 @@ def test_send_request_to_dynamo_create_duplicate(self):
         """it should not create the Immunization since its a duplicate record"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         create_result = IdentifierDuplicationError(identifier="test#123")
         message_body = {
             "supplier": "test_supplier",
@@ -105,7 +105,7 @@ def test_send_request_to_dynamo_create_unhandled_error(self):
         """it should not create the Immunization since the error occoured in db"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = UnhandledResponseError(response="Non-200 response from dynamodb", message="connection timeout")
         message_body = {
             "supplier": "test_supplier",
@@ -141,7 +141,7 @@ def test_send_request_to_dynamo_update_success(self):
         """it should update Immunization and return imms id"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         message_body = {
             "supplier": "test_supplier",
             "fhir_json": imms.json(),
@@ -166,7 +166,7 @@ def test_send_request_to_dynamo_update_badrequest(self):
         """it should return error since it got failed in initial validation"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = CustomValidationError(
             message="Validation errors: contained[?(@.resourceType=='Patient')].identifier[0].value does not exists"
         )
@@ -194,7 +194,7 @@ def test_send_request_to_dynamo_update_resource_not_found(self):
         """it should not update the Immunization since no resource found for the record"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = ResourceNotFoundError("Immunization", "test#123")
         message_body = {
             "supplier": "test_supplier",
@@ -220,7 +220,7 @@ def test_send_request_to_dynamo_update_unhandled_error(self):
         """it should not update the Immunization since the error occoured in db"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = UnhandledResponseError(response="Non-200 response from dynamodb", message="connection timeout")
         message_body = {
             "supplier": "test_supplier",
@@ -256,7 +256,7 @@ def test_send_request_to_dynamo_delete_success(self):
         """it should delete Immunization and return imms id"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         message_body = {
             "supplier": "test_supplier",
             "fhir_json": imms.json(),
@@ -281,7 +281,7 @@ def test_send_request_to_dynamo_delete_badrequest(self):
         """it should return error since it got failed in initial validation"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = CustomValidationError(
             message="Validation errors: contained[?(@.resourceType=='Patient')].identifier[0].value does not exists"
         )
@@ -309,7 +309,7 @@ def test_send_request_to_dynamo_delete_resource_not_found(self):
         """it should not delete the Immunization since no resource found for the record"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = ResourceNotFoundError("Immunization", "test#123")
         message_body = {
             "supplier": "test_supplier",
@@ -335,7 +335,7 @@ def test_send_request_to_dynamo_delete_unhandled_error(self):
         """it should not delete the Immunization since the error occoured in db"""
 
         imms_id = str(uuid.uuid4())
-        imms = create_covid_19_immunization(imms_id)
+        imms = create_covid_immunization(imms_id)
         update_result = UnhandledResponseError(response="Non-200 response from dynamodb", message="connection timeout")
         message_body = {
             "supplier": "test_supplier",