VED-187 Remove test data at the end of each e2e test (#385)

- Clean up after each e2e test
- Improved exponential back-off
- E2e tests refactoring

Author: robertnovac1

azure/templates/post-deploy.yml

@@ -206,7 +206,7 @@ steps:
 
     displayName: Run full batch test suite
     workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/e2e_batch"
-
+    condition: eq(1, 2) # Disable task but make this step visible in the pipeline
 
   - task: PublishTestResults@2
     displayName: 'Publish test results'

e2e/test_authorization.py

@@ -1,5 +1,4 @@
 import uuid
-import unittest
 from typing import Set
 
 from lib.apigee import ApigeeApp
@@ -16,10 +15,8 @@
 from utils.immunisation_api import ImmunisationApi
 from utils.resource import generate_imms_resource
 from utils.mappings import VaccineTypes
-from utils.constants import env_internal_dev
 
 
-@unittest.skipIf(env_internal_dev, "TestApplicationRestrictedAuthorization for internal-dev environment")
 class TestApplicationRestrictedAuthorization(ImmunizationBaseTest):
 
     my_app: ApigeeApp
@@ -40,12 +37,16 @@ def make_app(self, permissions: Set[Permission], vaxx_type_perms: Set = None):
 
         self.my_imms_api = ImmunisationApi(base_url, app_res_auth)
 
+    # Runs after each individual test method in a test class.
+    # It’s used to clean up resources that were initialized specifically for a single test.
     def tearDown(self):
         self.apigee_service.delete_application(self.my_app.name)
+        self.my_imms_api.cleanup_test_records()
+        self.default_imms_api.cleanup_test_records()
 
     def test_get_imms_authorised(self):
         """it should get Immunization if app has immunization:read permission"""
-        imms_id = self.create_immunization_resource(self.default_imms_api)
+        imms_id = self.default_imms_api.create_immunization_resource()
         self.make_app({Permission.READ})
         # When
         response = self.my_imms_api.get_immunization_by_id(imms_id)
@@ -57,7 +58,7 @@ def test_get_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.READ})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.get_immunization_by_id("id-doesn't-matter")
+        response = self.my_imms_api.get_immunization_by_id("id-doesn't-matter", expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
@@ -75,7 +76,7 @@ def test_create_imms_unauthorised_vaxx(self):
         self.make_app({Permission.CREATE}, {"flu:create"})
         # When
         imms = generate_imms_resource()
-        response = self.my_imms_api.create_immunization(imms)
+        response = self.my_imms_api.create_immunization(imms, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
@@ -85,14 +86,14 @@ def test_create_imms_unauthorised(self):
         self.make_app(perms)
         # When
         imms = generate_imms_resource()
-        result = self.my_imms_api.create_immunization(imms)
+        result = self.my_imms_api.create_immunization(imms, expected_status_code=403)
         # Then
         self.assertEqual(result.status_code, 403, result.text)
 
     def test_update_imms_authorised(self):
         """it should update Immunization if app has immunization:update and immunization:create permission"""
         imms = generate_imms_resource()
-        imms_id = self.create_immunization_resource(self.default_imms_api, imms)
+        imms_id = self.default_imms_api.create_immunization_resource(imms)
         imms["id"] = imms_id
 
         self.make_app({Permission.CREATE, Permission.UPDATE})
@@ -106,26 +107,26 @@ def test_update_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.UPDATE})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.update_immunization("doesn't-matter", {})
+        response = self.my_imms_api.update_immunization("doesn't-matter", {}, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_update_imms_unauthorised_2(self):
         """it should not update Immunization if app doesn't immunization:create permission"""
         imms = generate_imms_resource()
-        imms_id = self.create_immunization_resource(self.default_imms_api, imms)
+        imms_id = self.default_imms_api.create_immunization_resource(imms)
         imms["id"] = imms_id
 
         perms = app_full_access(exclude={Permission.CREATE})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.update_immunization(imms_id, imms)
+        response = self.my_imms_api.update_immunization(imms_id, imms, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_delete_imms_authorised(self):
         """it should delete Immunization if app has immunization:delete permission"""
-        imms_id = self.create_immunization_resource(self.default_imms_api)
+        imms_id = self.default_imms_api.create_immunization_resource()
         self.make_app({Permission.DELETE})
         # When
         response = self.my_imms_api.delete_immunization(imms_id)
@@ -137,14 +138,14 @@ def test_delete_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.DELETE})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.delete_immunization("doesn't-matter")
+        response = self.my_imms_api.delete_immunization("doesn't-matter", expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_search_imms_authorised(self):
         """it should search Immunization if app has immunization:search permission"""
         mmr = generate_imms_resource(valid_nhs_number1, VaccineTypes.mmr)
-        _ = self.create_immunization_resource(self.default_imms_api, mmr)
+        _ = self.default_imms_api.create_immunization_resource(mmr)
 
         self.make_app({Permission.SEARCH})
         # When
@@ -157,23 +158,22 @@ def test_search_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.SEARCH})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.search_immunizations(valid_nhs_number1, VaccineTypes.mmr)
+        response = self.my_imms_api.search_immunizations(valid_nhs_number1, VaccineTypes.mmr, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_search_imms_unauthorised_vax(self):
         """it should not search Immunization if app does not have proper vax permissions"""
         mmr = generate_imms_resource(valid_nhs_number1, VaccineTypes.mmr)
-        _ = self.create_immunization_resource(self.default_imms_api, mmr)
+        _ = self.default_imms_api.create_immunization_resource(mmr)
 
         self.make_app({Permission.SEARCH}, {"flu:read"})
         # When
-        response = self.my_imms_api.search_immunizations(valid_nhs_number1, VaccineTypes.mmr)
+        response = self.my_imms_api.search_immunizations(valid_nhs_number1, VaccineTypes.mmr, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
 
-@unittest.skipIf(env_internal_dev, "TestCis2Authorization for internal-dev environment")
 class TestCis2Authorization(ImmunizationBaseTest):
     my_app: ApigeeApp
     my_imms_api: ImmunisationApi
@@ -193,12 +193,16 @@ def make_app(self, permissions: Set[Permission], vaxx_type_perms: Set = None):
 
         self.my_imms_api = ImmunisationApi(base_url, app_res_auth)
 
+    # Runs after each individual test method in a test class.
+    # It’s used to clean up resources that were initialized specifically for a single test.
     def tearDown(self):
         self.apigee_service.delete_application(self.my_app.name)
+        self.my_imms_api.cleanup_test_records()
+        self.default_imms_api.cleanup_test_records()
 
     def test_get_imms_authorised(self):
         """it should get Immunization if app has immunization:read permission"""
-        imms_id = self.create_immunization_resource(self.default_imms_api)
+        imms_id = self.default_imms_api.create_immunization_resource()
         self.make_app({Permission.READ})
         # When
         response = self.my_imms_api.get_immunization_by_id(imms_id)
@@ -210,16 +214,16 @@ def test_get_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.READ})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.get_immunization_by_id("id-doesn't-matter")
+        response = self.my_imms_api.get_immunization_by_id("id-doesn't-matter", expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_get_imms__unauthorised_vaxx(self):
         """it should not get Immunization if app does not have the correct vaccine permission"""
-        imms_id = self.create_immunization_resource(self.default_imms_api)
+        imms_id = self.default_imms_api.create_immunization_resource()
         self.make_app({Permission.READ}, {"flu:create"})
         # When
-        response = self.my_imms_api.get_immunization_by_id(imms_id)
+        response = self.my_imms_api.get_immunization_by_id(imms_id, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
@@ -238,7 +242,7 @@ def test_create_imms_unauthorised(self):
         self.make_app(perms)
         # When
         imms = generate_imms_resource()
-        result = self.my_imms_api.create_immunization(imms)
+        result = self.my_imms_api.create_immunization(imms, expected_status_code=403)
         # Then
         self.assertEqual(result.status_code, 403, result.text)
 
@@ -247,14 +251,14 @@ def test_create_imms_unauthorised_vaxx(self):
         self.make_app({Permission.CREATE}, {"flu:create"})
         # When
         imms = generate_imms_resource()
-        response = self.my_imms_api.create_immunization(imms)
+        response = self.my_imms_api.create_immunization(imms, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_update_imms_authorised(self):
         """it should update Immunization if app has the immunization:update and immunization:create permission"""
         imms = generate_imms_resource()
-        imms_id = self.create_immunization_resource(self.default_imms_api, imms)
+        imms_id = self.default_imms_api.create_immunization_resource(imms)
         imms["id"] = imms_id
 
         self.make_app({Permission.CREATE, Permission.UPDATE})
@@ -268,25 +272,25 @@ def test_update_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.UPDATE})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.update_immunization("doesn't-matter", {})
+        response = self.my_imms_api.update_immunization("doesn't-matter", {}, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_update_imms_unauthorised_vaxx(self):
         """it should not update Immunization if app does not have the correct vaccine permission"""
         imms = generate_imms_resource()
-        imms_id = self.create_immunization_resource(self.default_imms_api, imms)
+        imms_id = self.default_imms_api.create_immunization_resource(imms)
         imms["id"] = imms_id
 
         self.make_app({Permission.CREATE, Permission.UPDATE}, {"flu:create"})
         # When
-        response = self.my_imms_api.update_immunization(imms_id, imms)
+        response = self.my_imms_api.update_immunization(imms_id, imms, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_delete_imms_authorised(self):
         """it should delete Immunization if app has immunization:delete permission"""
-        imms_id = self.create_immunization_resource(self.default_imms_api)
+        imms_id = self.default_imms_api.create_immunization_resource()
         self.make_app({Permission.DELETE})
         # When
         response = self.my_imms_api.delete_immunization(imms_id)
@@ -298,23 +302,23 @@ def test_delete_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.DELETE})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.delete_immunization("doesn't-matter")
+        response = self.my_imms_api.delete_immunization("doesn't-matter", expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_delete_imms__unauthorised_vaxx(self):
         """it should not delete Immunization if app does not have the correct vaccine permission"""
-        imms_id = self.create_immunization_resource(self.default_imms_api)
+        imms_id = self.default_imms_api.create_immunization_resource()
         self.make_app({Permission.READ}, {"flu:create"})
         # When
-        response = self.my_imms_api.delete_immunization(imms_id)
+        response = self.my_imms_api.delete_immunization(imms_id, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)
 
     def test_search_imms_authorised(self):
         """it should search Immunization if app has immunization:search permission"""
         mmr = generate_imms_resource(valid_nhs_number1, VaccineTypes.mmr)
-        _ = self.create_immunization_resource(self.default_imms_api, mmr)
+        _ = self.default_imms_api.create_immunization_resource(mmr)
 
         self.make_app({Permission.SEARCH})
         # When
@@ -327,6 +331,6 @@ def test_search_imms_unauthorised(self):
         perms = app_full_access(exclude={Permission.SEARCH})
         self.make_app(perms)
         # When
-        response = self.my_imms_api.search_immunizations(valid_nhs_number1, VaccineTypes.mmr)
+        response = self.my_imms_api.search_immunizations(valid_nhs_number1, VaccineTypes.mmr, expected_status_code=403)
         # Then
         self.assertEqual(response.status_code, 403, response.text)

e2e/test_create_immunization.py

@@ -1,10 +1,7 @@
-import unittest
 from utils.base_test import ImmunizationBaseTest
 from utils.resource import generate_imms_resource, get_full_row_from_identifier
-from utils.constants import env_internal_dev
 
 
-@unittest.skipIf(env_internal_dev, "TestCreateImmunization for internal-dev environment")
 class TestCreateImmunization(ImmunizationBaseTest):
 
     def test_create_imms(self):
@@ -33,37 +30,38 @@ def test_non_unique_identifier(self):
         """
         # Set up
         imms = generate_imms_resource()
-        imms_id = self.create_immunization_resource(self.default_imms_api, imms)
+        imms_id = self.default_imms_api.create_immunization_resource(imms)
         self.assertEqual(self.default_imms_api.get_immunization_by_id(imms_id).status_code, 200)
 
         # Check that duplicate CREATE request is rejected
-        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms), 422)
+        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms, expected_status_code=422), 422)
 
         # Check that duplice CREATE request is rejected after the event is updated
         imms["id"] = imms_id  # Imms fhir resource should include the id for update
         self.default_imms_api.update_immunization(imms_id, imms)
         self.assertEqual(self.default_imms_api.get_immunization_by_id(imms_id).status_code, 200)
         del imms["id"]  # Imms fhir resource should not include an id for create
-        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms), 422)
+        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms, expected_status_code=422), 422)
 
         # Check that duplice CREATE request is rejected after the event is updated then deleted
         self.default_imms_api.delete_immunization(imms_id)
-        self.assertEqual(self.default_imms_api.get_immunization_by_id(imms_id).status_code, 404)
-        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms), 422)
+        self.assertEqual(self.default_imms_api.get_immunization_by_id(
+            imms_id, expected_status_code=404).status_code, 404)
+        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms, expected_status_code=422), 422)
 
         # Check that duplice CREATE request is rejected after the event is updated then deleted then reinstated
         imms["id"] = imms_id  # Imms fhir resource should include the id for update
         self.default_imms_api.update_immunization(imms_id, imms)
         self.assertEqual(self.default_imms_api.get_immunization_by_id(imms_id).status_code, 200)
         del imms["id"]  # Imms fhir resource should not include an id for create
-        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms), 422)
+        self.assert_operation_outcome(self.default_imms_api.create_immunization(imms, expected_status_code=422), 422)
 
     def test_bad_nhs_number(self):
         """it should reject the request if nhs-number does not exist"""
         bad_nhs_number = "7463384756"
         imms = generate_imms_resource(nhs_number=bad_nhs_number)
 
-        response = self.default_imms_api.create_immunization(imms)
+        response = self.default_imms_api.create_immunization(imms, expected_status_code=400)
 
         self.assert_operation_outcome(response, 400, bad_nhs_number)
 
@@ -75,7 +73,7 @@ def test_validation(self):
         invalid_datetime = "2020-12-32"
         imms["occurrenceDateTime"] = invalid_datetime
         # When
-        response = self.default_imms_api.create_immunization(imms)
+        response = self.default_imms_api.create_immunization(imms, expected_status_code=400)
 
         # Then
         self.assert_operation_outcome(response, 400, "occurrenceDateTime")
@@ -134,7 +132,7 @@ def test_create_imms_with_missing_mandatory_field(self):
         del imms["primarySource"]
 
         # When
-        response = self.default_imms_api.create_immunization(imms)
+        response = self.default_imms_api.create_immunization(imms, expected_status_code=400)
 
         # Then
         self.assert_operation_outcome(response, 400, "primarySource is a mandatory field")

e2e/test_delete_immunization.py

@@ -1,11 +1,8 @@
-import unittest
 from utils.base_test import ImmunizationBaseTest
 from utils.immunisation_api import parse_location
 from utils.resource import generate_imms_resource
-from utils.constants import env_internal_dev
 
 
-@unittest.skipIf(env_internal_dev, "TestDeleteImmunization for internal-dev environment")
 class TestDeleteImmunization(ImmunizationBaseTest):
 
     def test_delete_imms(self):
@@ -36,6 +33,6 @@ def test_delete_imms(self):
 
     def test_delete_immunization_already_deleted(self):
         """it should return 404 when deleting a deleted resource"""
-        imms = self.create_a_deleted_immunization_resource(self.default_imms_api)
-        response = self.default_imms_api.delete_immunization(imms["id"])
+        imms = self.default_imms_api.create_a_deleted_immunization_resource()
+        response = self.default_imms_api.delete_immunization(imms["id"], expected_status_code=404)
         self.assert_operation_outcome(response, 404)