VED-79: Resolve sonar issues

Author: Akol125

azure/templates/post-deploy.yml

@@ -101,10 +101,10 @@ steps:
 
         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)"
+    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_setup.py

@@ -0,0 +1,23 @@
+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 get_mns_service(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...")
+        return MnsService(authenticator)

mns_subscription/src/subscribe_mns.py

@@ -1,39 +1,14 @@
 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)
+from mns_setup import get_mns_service
 
 
 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("Subscribing to MNS...")
-        result = mns.check_subscription()
-        logging.info(f"Subscription Result: {result}")
-        return result
-    except Exception:
-        logging.exception("Failed to complete MNS subscription process")
-        raise
+    mns = get_mns_service()
+    result = mns.check_subscription()
+    return result
 
 
 if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
     result = run_subscription()
-    print("Subscription Result:", result)
+    logging.info(f"Subscription Result: {result}")

mns_subscription/src/unsubscribe_mns.py

@@ -1,39 +1,14 @@
 import logging
-from cache import Cache
-from mns_service import MnsService
-import boto3
-from authentication import AppRestrictedAuth, Service
-from botocore.config import Config
+from mns_setup import get_mns_service
 
-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
+def run_unsubscribe():
+    mns = get_mns_service()
+    result = mns.check_delete_subscription()
+    return result
 
 
 if __name__ == "__main__":
-    result = run_subscription()
-    print("Subscription Result:", result)
+    logging.basicConfig(level=logging.INFO)
+    result = run_unsubscribe()
+    logging.debug("Subscription Result:", result)

mns_subscription/tests/test_mns_setup.py

@@ -0,0 +1,31 @@
+import unittest
+from unittest.mock import patch, MagicMock
+from mns_setup import get_mns_service
+
+class TestGetMnsService(unittest.TestCase):
+
+    @patch("mns_setup.boto3.client")
+    @patch("mns_setup.AppRestrictedAuth")
+    @patch("mns_setup.MnsService")
+    def test_get_mns_service(self, mock_mns_service, mock_app_auth, mock_boto_client):
+        # Arrange
+        mock_auth_instance = MagicMock()
+        mock_app_auth.return_value = mock_auth_instance
+
+        mock_mns_instance = MagicMock()
+        mock_mns_service.return_value = mock_mns_instance
+
+        mock_secrets_client = MagicMock()
+        mock_boto_client.return_value = mock_secrets_client
+
+        # Act
+        result = get_mns_service("int")
+
+        # Assert
+        self.assertEqual(result, mock_mns_instance)
+        mock_boto_client.assert_called_once_with("secretsmanager", config=mock_boto_client.call_args[1]['config'])
+        mock_app_auth.assert_called_once()
+        mock_mns_service.assert_called_once_with(mock_auth_instance)
+
+if __name__ == "__main__":
+    unittest.main()

mns_subscription/tests/test_subscription_mns.py

@@ -5,27 +5,16 @@
 
 class TestRunSubscription(unittest.TestCase):
 
-    @patch("subscribe_mns.MnsService")
-    @patch("subscribe_mns.AppRestrictedAuth")
-    @patch("subscribe_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
-
+    @patch("subscribe_mns.get_mns_service")  # patch where it's imported/used!
+    def test_run_subscription_success(self, mock_get_mns_service):
         mock_mns_instance = MagicMock()
-        mock_mns_instance.check_subscription.return_value = {"subscriptionId": "abc123"}
-        mock_mns_service.return_value = mock_mns_instance
+        mock_mns_instance.check_subscription.return_value = "Subscription Result: abc123"
+        mock_get_mns_service.return_value = mock_mns_instance
 
-        # Act
         result = run_subscription()
 
-        # Assert
-        self.assertEqual(result, {"subscriptionId": "abc123"})
-        mock_auth_class.assert_called_once()
+        self.assertEqual(result, "Subscription Result: abc123")
+        mock_get_mns_service.assert_called_once()
         mock_mns_instance.check_subscription.assert_called_once()
 
 

mns_subscription/tests/test_unsubscription_mns.py

@@ -1,31 +1,23 @@
 import unittest
 from unittest.mock import patch, MagicMock
-from unsubscribe_mns import run_subscription
+from unsubscribe_mns import run_unsubscribe
 
 
-class TestRunSubscription(unittest.TestCase):
+class TestRunUnsubscribe(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):
+    @patch("unsubscribe_mns.get_mns_service")
+    def test_run_unsubscribe_success(self, mock_get_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
+        mock_mns_instance.check_delete_subscription.return_value = "Subscription successfully deleted"
+        mock_get_mns_service.return_value = mock_mns_instance
 
         # Act
-        result = run_subscription()
+        result = run_unsubscribe()
 
         # Assert
-        self.assertEqual(result, {"Subscription successfully deleted"})
-        mock_auth_class.assert_called_once()
+        self.assertEqual(result, "Subscription successfully deleted")
+        mock_get_mns_service.assert_called_once()
         mock_mns_instance.check_delete_subscription.assert_called_once()
 
 

sonar-project.properties

@@ -13,4 +13,4 @@ sonar.issue.ignore.multicriteria.exclude_hl7_urls.ruleKey=python:S5332
 sonar.issue.ignore.multicriteria.exclude_hl7_urls.resourceKey=**http://terminology\.hl7\.org/CodeSystem/v3-NullFlavor**
 sonar.issue.ignore.multicriteria=e1
 sonar.issue.ignore.multicriteria.e1.ruleKey=python:S5443
-sonar.issue.ignore.multicriteria.e1.resourceKey=**/subscribe_mns.py
+sonar.issue.ignore.multicriteria.e1.resourceKey=**/mns_setup.py