VED-79: sandbox pipeline

Author: Akol125

azure/azure-pr-pipeline.yml

@@ -48,3 +48,4 @@ extends:
           - template: ./templates/post-deploy.yml
             parameters:
               aws_account_type: 'dev'
+              subscribe_to_mns: 'true'

azure/templates/post-deploy.yml

@@ -77,25 +77,34 @@ steps:
     displayName: Apply Terraform
     workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)"
     retryCountOnTaskFailure: 2
+parameters:
+  - name: aws_account_type
+    type: string
+    default: 'dev'
+  - name: subscribe_mns
+    type: boolean
+    default: true  # Set to true by default, false where you want to skip
 
+steps:
+  - ${{ if eq(parameters.subscribe_mns, true) }}:
   - bash: |
-      export AWS_PROFILE=apim-dev
-      echo "Subscribing SQS to MNS for 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 "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
-    displayName: "Run MNS Subscription"
-    workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/mns_subscription"
-    env:
-      SQS_ARN: "$(ID_SYNC_QUEUE_ARN)"
+        export AWS_PROFILE=apim-dev
+        echo "Subscribing SQS to MNS for 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 "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
+      displayName: "Run MNS Subscription"
+      workingDirectory: "$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/mns_subscription"
+      env:
+        SQS_ARN: "$(ID_SYNC_QUEUE_ARN)"
 
   - bash: |
       set -ex

mns_subscription/src/mns_service.py

@@ -118,3 +118,37 @@ def check_subscription(self) -> dict:
         except Exception as e:
             logging.error(f"Error ensuring subscription: {e}")
             raise
+
+    def delete_subscription(self, subscription_id: str) -> bool:
+        """Delete the subscription by ID."""
+        url = f"{MNS_URL}/{subscription_id}"
+        response = requests.delete(url, headers=self.request_headers)
+        if response.status_code in (200, 204):
+            logging.info(f"Deleted subscription {subscription_id}")
+            return True
+        elif response.status_code == 401:
+            raise TokenValidationError(response=response.json(), message="Token validation failed for the request")
+        elif response.status_code == 404:
+            raise ResourceFoundError(response=response.json(), message=f"Subscription {subscription_id} not found")
+        elif response.status_code == 403:
+            raise UnauthorizedError(response=response.json(), message="No permission to delete subscription")
+        elif response.status_code == 500:
+            raise ServerError(response=response.json(), message="Internal Server Error")
+        else:
+            raise UnhandledResponseError(response=response.json(), message=f"Unhandled error: {response.status_code}")
+
+    def check_delete_subcription(self):
+        try:
+            resource = self.get_subscription()  # Get the full resource dict
+            if not resource:
+                return "No matching subscription found to delete."
+
+            subscription_id = resource.get("id")
+            if not subscription_id:
+                return "Subscription resource missing 'id' field."
+
+            self.delete_subscription(subscription_id)
+            return "Subscription successfully deleted"
+        except Exception as e:
+            # Optionally log the exception here
+            return f"Error deleting subscription: {str(e)}"

mns_subscription/src/unsubscribe_mns.py

@@ -0,0 +1,39 @@
+import logging
+from cache import Cache
+from mns_service import MnsService
+import boto3
+from authentication import AppRestrictedAuth, Service
+from botocore.config import Config
+
+logging.basicConfig(level=logging.INFO)
+
+
+def run_subscription():
+    try:
+        mns_env: str = "int"
+
+        boto_config = Config(region_name="eu-west-2")
+        cache = Cache(directory="/tmp")
+        logging.info("Creating authenticator...")
+        authenticator = AppRestrictedAuth(
+            service=Service.MNS,
+            secret_manager_client=boto3.client("secretsmanager", config=boto_config),
+            environment=mns_env,
+            cache=cache,
+        )
+
+        logging.info("Creating MNS service...")
+        mns = MnsService(authenticator)
+
+        logging.info("Deleting MNS Subscription...")
+        result = mns.check_delete_subscription()
+        logging.info(f"Subscription Result: {result}")
+        return result
+    except Exception:
+        logging.exception("Failed to complete MNS subscription process")
+        raise
+
+
+if __name__ == "__main__":
+    result = run_subscription()
+    print("Subscription Result:", result)

mns_subscription/tests/test_mns_service.py

@@ -143,6 +143,45 @@ def test_check_subscription_creates_if_not_found(self, mock_get, mock_post):
         mock_get.assert_called_once()
         mock_post.assert_called_once()
 
+    @patch.object(MnsService, "delete_subscription")
+    @patch.object(MnsService, "get_subscription")
+    def test_check_delete_subscription_success(self, mock_get_subscription, mock_delete_subscription):
+        # Mock get_subscription returns a resource with id
+        mock_get_subscription.return_value = {"id": "sub-123"}
+        # Mock delete_subscription returns True
+        mock_delete_subscription.return_value = True
+
+        service = MnsService(self.authenticator)
+        result = service.check_delete_subcription()
+        self.assertEqual(result, "Subscription successfully deleted")
+        mock_get_subscription.assert_called_once()
+        mock_delete_subscription.assert_called_once_with("sub-123")
+
+    @patch.object(MnsService, "get_subscription")
+    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()
+        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": "nope"}
+        service = MnsService(self.authenticator)
+        result = service.check_delete_subcription()
+        self.assertEqual(result, "Subscription resource missing 'id' field.")
+
+    @patch.object(MnsService, "delete_subscription")
+    @patch.object(MnsService, "get_subscription")
+    def test_check_delete_subscription_raises(self, mock_get_subscription, mock_delete_subscription):
+        mock_get_subscription.return_value = {"id": "sub-123"}
+        mock_delete_subscription.side_effect = Exception("Error!")
+        service = MnsService(self.authenticator)
+        result = service.check_delete_subcription()
+        self.assertTrue(result.startswith("Error deleting subscription: Error!"))
+
 
 if __name__ == "__main__":
     unittest.main()

…_subscription/tests/test_subscription.py …scription/tests/test_subscription_mns.pymns_subscription/tests/test_subscription.py renamed to mns_subscription/tests/test_subscription_mns.py mns_subscription/tests/test_subscription.py renamed to mns_subscription/tests/test_subscription_mns.py

@@ -0,0 +1,33 @@
+import unittest
+from unittest.mock import patch, MagicMock
+from unsubscribe_mns import run_subscription
+
+
+class TestRunSubscription(unittest.TestCase):
+
+    @patch("unsubscribe_mns.MnsService")
+    @patch("unsubscribe_mns.AppRestrictedAuth")
+    @patch("unsubscribe_mns.boto3.client")
+    def test_run_subscription_success(self, mock_boto_client, mock_auth_class, mock_mns_service):
+        # Arrange
+        mock_secrets_client = MagicMock()
+        mock_boto_client.return_value = mock_secrets_client
+
+        mock_auth_instance = MagicMock()
+        mock_auth_class.return_value = mock_auth_instance
+
+        mock_mns_instance = MagicMock()
+        mock_mns_instance.check_delete_subscription.return_value = {"Subscription successfully deleted"}
+        mock_mns_service.return_value = mock_mns_instance
+
+        # Act
+        result = run_subscription()
+
+        # Assert
+        self.assertEqual(result, {"Subscription successfully deleted"})
+        mock_auth_class.assert_called_once()
+        mock_mns_instance.check_delete_subscription.assert_called_once()
+
+
+if __name__ == "__main__":
+    unittest.main()