VED-26-Sync-Permissions (#601)

load supplier permissions into redis

Author: Akol125

redis_sync/src/event_read.py

@@ -1,6 +1,7 @@
 import redis
 
 
+# Reads a Redis hash using the 'read' key from the event payload.
 def read_event(redis_client: redis.Redis, event: dict, logger) -> dict:
     try:
         read_key = event["read"]

redis_sync/src/s3_event.py

@@ -1,4 +1,11 @@
 class S3EventRecord:
+    """
+    S3 Event Parsing Utilities
+    This module defines helper classes for extracting relevant information from
+    AWS S3 event records, such as the bucket name and object key.
+    - `S3EventRecord` provides access to individual record fields.
+    - `S3Event` wraps the event and extracts a list of `S3EventRecord` objects.
+    """
     def __init__(self, s3_record):
         self.s3_record = s3_record
 

redis_sync/src/s3_reader.py

@@ -1,11 +1,16 @@
-"Upload the content from a config file in S3 to ElastiCache (Redis)"
-
 from clients import s3_client
 from clients import logger
 
 
 class S3Reader:
 
+    """
+    Fetch the file from S3 using the specified bucket and key.
+    The file is expected to be a UTF-8 encoded text file (e.g., JSON or plain text).
+    We read the file content from the response body and decode it into a string.
+    This string can then be passed to json.loads() or other parsers as needed.
+    """
+
     @staticmethod
     def read(bucket_name, file_key):
         try:

redis_sync/src/transform_vaccine_map.py redis_sync/src/transform_configs.pyredis_sync/src/transform_vaccine_map.py renamed to redis_sync/src/transform_configs.py

@@ -13,3 +13,17 @@ def transform_vaccine_map(map):
         "vacc_to_diseases": vacc_to_diseases,
         "diseases_to_vacc": diseases_to_vacc
     }
+
+
+def transform_supplier_permissions(supplier):
+    """
+    Transform a supplier-permission
+    """
+    logger.info("Transforming supplier permissions data")
+    logger.info("source data: %s", supplier)
+
+    supplier_permissions = {
+        entry["supplier"]: entry["permissions"] for entry in supplier
+    }
+
+    return {"supplier_permissions": supplier_permissions}

redis_sync/src/transform_map.py

@@ -1,6 +1,6 @@
 from constants import RedisCacheKey
 from clients import logger
-from transform_vaccine_map import transform_vaccine_map
+from src.transform_configs import transform_vaccine_map, transform_supplier_permissions
 '''
 Transform config file to format required in REDIS cache.
 '''
@@ -10,7 +10,7 @@ def transform_map(data, file_type):
     # Transform the vaccine map data as needed
     logger.info("Transforming data for file type: %s", file_type)
     if file_type == RedisCacheKey.PERMISSIONS_CONFIG_FILE_KEY:
-        return data
+        return transform_supplier_permissions(data)
     if file_type == RedisCacheKey.DISEASE_MAPPING_FILE_KEY:
         return transform_vaccine_map(data)
     logger.info("No specific transformation defined for file type: %s", file_type)

redis_sync/tests/test_data/expected_perms.json

@@ -0,0 +1,16 @@
+{
+  "supplier_permissions": {
+    "DPSFULL": ["COVID19_FULL", "FLU_FULL", "MMR_FULL", "RSV_FULL"],
+    "DPSREDUCED": ["COVID19_FULL", "FLU_FULL", "MMR_FULL", "RSV_FULL"],
+    "EMIS": ["RSV_UPDATE"],
+    "PINNACLE": [""],
+    "SONAR": ["FLU_CREATE", "FLU_DELETE"],
+    "TPP": [""],
+    "AGEM-NIVS": [""],
+    "NIMS": [""],
+    "EVA": ["COVID19_CREATE", "COVID19_DELETE", "COVID19_UPDATE"],
+    "RAVS": [""],
+    "MEDICAL_DIRECTOR": [""],
+    "COVID19_VACCINE_RESOLUTION_SERVICEDESK": [""]
+  }
+}

redis_sync/tests/test_data/permissions_config.json

@@ -0,0 +1,50 @@
+[
+		{
+			"supplier": "DPSFULL",
+			"permissions": ["COVID19_FULL", "FLU_FULL", "MMR_FULL", "RSV_FULL"]
+		},
+		{
+			"supplier": "DPSREDUCED",
+			"permissions": ["COVID19_FULL", "FLU_FULL", "MMR_FULL", "RSV_FULL"]
+		},
+		{
+			"supplier": "EMIS",
+			"permissions": ["RSV_UPDATE"]
+		},
+		{
+			"supplier": "PINNACLE",
+			"permissions": [""]
+		},
+		{
+			"supplier": "SONAR",
+			"permissions": ["FLU_CREATE", "FLU_DELETE"]
+		},
+		{
+			"supplier": "TPP",
+			"permissions": [""]
+		},
+		{
+			"supplier": "AGEM-NIVS",
+			"permissions": [""]
+		},
+		{
+			"supplier": "NIMS",
+			"permissions": [""]
+		},
+		{
+			"supplier": "EVA",
+			"permissions": ["COVID19_CREATE", "COVID19_DELETE", "COVID19_UPDATE"]
+		},
+		{
+			"supplier": "RAVS",
+			"permissions": [""]
+		},
+		{
+			"supplier": "MEDICAL_DIRECTOR",
+			"permissions": [""]
+		},
+		{
+			"supplier": "COVID19_VACCINE_RESOLUTION_SERVICEDESK",
+			"permissions": [""]
+		}
+	] 

redis_sync/tests/test_transform_config.py

@@ -0,0 +1,47 @@
+
+import unittest
+import json
+from unittest.mock import patch
+from transform_configs import transform_vaccine_map, transform_supplier_permissions
+
+
+class TestTransformConfigs(unittest.TestCase):
+    def setUp(self):
+        self.logger_info_patcher = patch("transform_configs.logger.info")
+        self.mock_logger_info = self.logger_info_patcher.start()
+
+        with open("./tests/test_data/disease_mapping.json") as mapping_data:
+            self.sample_map = json.load(mapping_data)
+
+        with open("./tests/test_data/permissions_config.json") as permissions_data:
+            self.supplier_data = json.load(permissions_data)
+
+    def tearDown(self):
+        self.logger_info_patcher.stop()
+
+    def test_disease_to_vacc(self):
+        with open("./tests/test_data/expected_disease_to_vacc.json") as f:
+            expected = json.load(f)
+        result = transform_vaccine_map(self.sample_map)
+        self.assertEqual(result["diseases_to_vacc"], expected)
+
+    def test_vacc_to_diseases(self):
+        with open("./tests/test_data/expected_vacc_to_diseases.json") as f:
+            expected = json.load(f)
+        result = transform_vaccine_map(self.sample_map)
+        self.assertEqual(result["vacc_to_diseases"], expected)
+
+    def test_transform_supplier_permissions_against_expected_file(self):
+        with open("./tests/test_data/expected_perms.json") as f:
+            expected = json.load(f)
+        result = transform_supplier_permissions(self.supplier_data)
+        self.assertEqual(result, expected)
+
+    def test_empty_input(self):
+        result = transform_supplier_permissions([])
+        self.assertEqual(result, {"supplier_permissions": {}})
+
+    def test_missing_keys_raises_error(self):
+        broken_input = [{"supplier": "X"}, {"permissions": ["read:vaccine"]}]
+        with self.assertRaises(KeyError):
+            transform_supplier_permissions(broken_input)