Ved 507-unsubscribe-pipeline (#715)

Unsubscribing to a notification and fixing teardown pipeline

Author: Akol125

.github/dependabot.yml

@@ -60,6 +60,7 @@ updates:
       - "/redis_sync"
       - "/lambdas/id_sync"
       - "/lambdas/shared"
+      - "/mns_subscription"
     schedule:
       interval: "daily"
     open-pull-requests-limit: 1

azure/azure-pr-teardown-pipeline.yml

@@ -45,10 +45,37 @@ jobs:
 
       - bash: |
           export AWS_PROFILE=apim-dev
-          account_id="$(aws sts get-caller-identity --query Account --output text)"
 
           cd terraform
-          terraform workspace select $(WORKSPACE)
-          make init && make destroy aws_account_no=${account_id} environment=$(WORKSPACE)
+          make init environment="dev" sub_environment="$WORKSPACE" bucket_name="immunisation-internal-dev-terraform-state-files"
+          make workspace sub_environment="$WORKSPACE"
+
+          # Extract values from Terraform state before destroying
+          ID_SYNC_QUEUE_ARN=$(make -s output name=id_sync_queue_arn)
+          echo "##vso[task.setvariable variable=ID_SYNC_QUEUE_ARN]$ID_SYNC_QUEUE_ARN"
+        displayName: "Init Terraform and extract MNS values"
+
+      - bash: |
+          export AWS_PROFILE=apim-dev
+          cd mns_subscription
+
+          echo "unsubscribing SQS Queue from MNS notifications."
+          pyenv install -s 3.11.11
+          pyenv local 3.11.11
+          echo "Setting up poetry environment..."
+          poetry env use 3.11
+          poetry install --no-root
+
+          echo "unsubscribing SQS to MNS for notifications.."
+          make unsubscribe
+        displayName: "Unsubscribe MNS"
+        env:
+          SQS_ARN: "$(ID_SYNC_QUEUE_ARN)"
+
+      - bash: |
+          export AWS_PROFILE=apim-dev
+
+          cd terraform
+          make destroy environment="dev" sub_environment="$WORKSPACE" bucket_name="immunisation-internal-dev-terraform-state-files"
         displayName: Destroy terraform PR workspace and linked resources
-        retryCountOnTaskFailure: 2
+        retryCountOnTaskFailure: 2

azure/templates/post-deploy.yml

@@ -60,7 +60,6 @@ steps:
         echo pr_no: $pr_no
 
         cd terraform
-
         make init
         make apply environment=${{ parameters.aws_account_type }} sub_environment=$workspace
 
@@ -91,11 +90,8 @@ steps:
         poetry env use 3.11
         poetry install --no-root
 
-        echo "Setting PYTHONPATH..."
-        export PYTHONPATH=$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/mns_subscription
-
         echo "Subscribing SQS to MNS for notifications..."
-        poetry run python src/subscribe_mns.py
+        make subscribe
       displayName: "Run MNS Subscription"
       workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/mns_subscription"
       env:

mns_subscription/Makefile

@@ -1,3 +1,9 @@
+subscribe:
+	@PYTHONPATH=src poetry run python src/subscribe_mns.py
+
+unsubscribe:
+	@PYTHONPATH=src poetry run python src/unsubscribe_mns.py
+
 test:
 	@PYTHONPATH=src:tests python -m unittest
 

mns_subscription/src/mns_service.py

@@ -52,7 +52,7 @@ def subscribe_notification(self) -> dict | None:
         if response.status_code in (200, 201):
             return response.json()
         else:
-            MnsService.handle_response(response)
+            MnsService.raise_error_response(response)
 
     def get_subscription(self) -> dict | None:
         response = requests.get(MNS_URL, headers=self.request_headers, timeout=10)
@@ -70,7 +70,7 @@ def get_subscription(self) -> dict | None:
                     return resource
             return None
         else:
-            MnsService.handle_response(response)
+            MnsService.raise_error_response(response)
 
     def check_subscription(self) -> dict:
         """
@@ -90,17 +90,17 @@ def check_subscription(self) -> dict:
             logging.error(f"Error ensuring subscription: {e}")
             raise
 
-    def delete_subscription(self, subscription_id: str) -> bool:
+    def delete_subscription(self, subscription_id: str) -> str:
         """Delete the subscription by ID."""
         url = f"{MNS_URL}/{subscription_id}"
         response = requests.delete(url, headers=self.request_headers, timeout=10)
-        if response.status_code in (200, 204):
+        if response.status_code == 204:
             logging.info(f"Deleted subscription {subscription_id}")
-            return True
+            return "Subscription Successfully Deleted..."
         else:
-            MnsService.handle_response(response)
+            MnsService.raise_error_response(response)
 
-    def check_delete_subcription(self):
+    def check_delete_subscription(self):
         try:
             resource = self.get_subscription()
             if not resource:
@@ -116,7 +116,7 @@ def check_delete_subcription(self):
             return f"Error deleting subscription: {str(e)}"
 
     @staticmethod
-    def handle_response(response):
+    def raise_error_response(response):
         error_mapping = {
             401: (TokenValidationError, "Token validation failed for the request"),
             400: (BadRequestError, "Bad request: Resource type or parameters incorrect"),

mns_subscription/src/mns_setup.py

@@ -19,5 +19,5 @@ def get_mns_service(mns_env: str = "int"):
         cache=cache,
     )
 
-    logging.info("Creating MNS service...")
+    logging.info("Authentication Initiated...")
     return MnsService(authenticator)

mns_subscription/models/errors.py mns_subscription/src/models/errors.pymns_subscription/models/errors.py renamed to mns_subscription/src/models/errors.py

@@ -11,4 +11,4 @@ def run_unsubscribe():
 if __name__ == "__main__":
     logging.basicConfig(level=logging.INFO)
     result = run_unsubscribe()
-    logging.debug(f"Subscription Result: {result}")
+    logging.info(f"Subscription Status: {result}")

mns_subscription/src/unsubscribe_mns.py

@@ -148,19 +148,18 @@ def test_check_subscription_creates_if_not_found(self, mock_get, mock_post):
 
     @patch("mns_service.requests.delete")
     def test_delete_subscription_success(self, mock_delete):
-        for code in (200, 204):
-            mock_response = MagicMock()
-            mock_response.status_code = code
-            mock_delete.return_value = mock_response
-
-            service = MnsService(self.authenticator)
-            result = service.delete_subscription("sub-id-123")
-            self.assertTrue(result)
-            mock_delete.assert_called_with(
-                f"{MNS_URL}/sub-id-123",
-                headers=service.request_headers,
-                timeout=10
-            )
+        mock_response = MagicMock()
+        mock_response.status_code = 204
+        mock_delete.return_value = mock_response
+
+        service = MnsService(self.authenticator)
+        result = service.delete_subscription("sub-id-123")
+        self.assertTrue(result)
+        mock_delete.assert_called_with(
+            f"{MNS_URL}/sub-id-123",
+            headers=service.request_headers,
+            timeout=10
+        )
 
     @patch("mns_service.requests.delete")
     def test_delete_subscription_401(self, mock_delete):
@@ -226,7 +225,7 @@ def test_check_delete_subscription_success(self, mock_get_subscription, mock_del
         mock_delete_subscription.return_value = True
 
         service = MnsService(self.authenticator)
-        result = service.check_delete_subcription()
+        result = service.check_delete_subscription()
         self.assertEqual(result, "Subscription successfully deleted")
         mock_get_subscription.assert_called_once()
         mock_delete_subscription.assert_called_once_with("sub-123")
@@ -236,15 +235,15 @@ def test_check_delete_subscription_no_resource(self, mock_get_subscription):
         # No subscription found
         mock_get_subscription.return_value = None
         service = MnsService(self.authenticator)
-        result = service.check_delete_subcription()
+        result = service.check_delete_subscription()
         self.assertEqual(result, "No matching subscription found to delete.")
 
     @patch.object(MnsService, "get_subscription")
     def test_check_delete_subscription_missing_id(self, mock_get_subscription):
         # Resource with no id field
         mock_get_subscription.return_value = {"not_id": "not-id"}
         service = MnsService(self.authenticator)
-        result = service.check_delete_subcription()
+        result = service.check_delete_subscription()
         self.assertEqual(result, "Subscription resource missing 'id' field.")
 
     @patch.object(MnsService, "delete_subscription")
@@ -253,7 +252,7 @@ def test_check_delete_subscription_raises(self, mock_get_subscription, mock_dele
         mock_get_subscription.return_value = {"id": "sub-123"}
         mock_delete_subscription.side_effect = Exception("Error!")
         service = MnsService(self.authenticator)
-        result = service.check_delete_subcription()
+        result = service.check_delete_subscription()
         self.assertTrue(result.startswith("Error deleting subscription: Error!"))
 
     def mock_response(self, status_code, json_data=None):
@@ -265,23 +264,23 @@ def mock_response(self, status_code, json_data=None):
     def test_404_resource_found_error(self):
         resp = self.mock_response(404, {"resource": "Not found"})
         with self.assertRaises(ResourceNotFoundError) as context:
-            MnsService.handle_response(resp)
+            MnsService.raise_error_response(resp)
         self.assertIn("Subscription or Resource not found", str(context.exception))
         self.assertEqual(context.exception.message, "Subscription or Resource not found")
         self.assertEqual(context.exception.response, {"resource": "Not found"})
 
     def test_400_bad_request_error(self):
         resp = self.mock_response(400, {"resource": "Invalid"})
         with self.assertRaises(BadRequestError) as context:
-            MnsService.handle_response(resp)
+            MnsService.raise_error_response(resp)
         self.assertIn("Bad request: Resource type or parameters incorrect", str(context.exception))
         self.assertEqual(context.exception.message, "Bad request: Resource type or parameters incorrect")
         self.assertEqual(context.exception.response, {"resource": "Invalid"})
 
     def test_unhandled_status_code(self):
         resp = self.mock_response(418, {"resource": 1234})
         with self.assertRaises(UnhandledResponseError) as context:
-            MnsService.handle_response(resp)
+            MnsService.raise_error_response(resp)
         self.assertIn("Unhandled error: 418", str(context.exception))
         self.assertEqual(context.exception.response, {"resource": 1234})
 

mns_subscription/tests/test_mns_service.py

@@ -6,13 +6,14 @@ sub_environment_dir := $(if $(findstring pr-,$(sub_environment)),pr,$(sub_enviro
 
 tf_cmd = AWS_PROFILE=$(AWS_PROFILE) terraform
 
-bucket_name = $(if $(filter dev,$(environment)),immunisation-$(sub_environment),immunisation-$(environment))-terraform-state-files
+
+bucket_name ?= $(if $(filter dev,$(environment)),immunisation-$(sub_environment),immunisation-$(environment))-terraform-state-files
 
 tf_state = -backend-config="bucket=$(bucket_name)"
 
 tf_vars = \
   -var="sub_environment=$(sub_environment)" \
-  -var-file="./environments/$(environment)/$(sub_environment_dir)/variables.tfvars"
+  -var-file=./environments/$(environment)/$(sub_environment_dir)/variables.tfvars
 
 lock-provider:
 	# Run this only when you install a new terraform provider. This will generate sha code in lock file for all platform