add tests for init, create_session, transform_response, check_response_for_rate_limit, paginate_endpoint, and get_subscriber_hash

Author: KeshSridhar

src/tests/test_mailchimp.py

@@ -0,0 +1,180 @@
+import os
+import json
+import unittest
+from unittest.mock import MagicMock, patch
+from src.stac_utils.mailchimp import MailChimpClient, logger
+
+class TestMailChimpClient(unittest.TestCase):
+    def setUp(self) -> None:
+        self.test_client = MailChimpClient(api_key="fake-us9")
+        self.test_logger = logger
+
+    def test_init_env_keys(self):
+        """Test that client initializes with environmental keys"""
+        test_api_key = "hgd1204-us20"
+        with patch.dict(os.environ, values={"MAILCHIMP_API_KEY": test_api_key}):
+            test_client = MailChimpClient()
+            self.assertEqual(test_api_key, test_client.api_key)
+            # test the extracted data center and base_url
+            self.assertEqual("us20", test_client.data_center)
+            self.assertEqual(
+                "https://us20.api.mailchimp.com/3.0", test_client.base_url
+            )
+
+    def test_create_session(self):
+        """Test that API token and content type is set in headers for a Mailchimp session"""
+        session = self.test_client.create_session()
+
+        # check that the auth tuple is correctly set
+        self.assertEqual(session.auth, ("anystring", self.test_client.api_key))
+
+        # check that the "Content-Type" header exists and has a value of "application/json"
+        self.assertIn("Content-Type", session.headers)
+        self.assertEqual(session.headers["Content-Type"], "application/json")
+
+    def test_transform_response_valid_json(self):
+        """Test that response is transformed and includes status code"""
+        mock_data = {"foo_bar": "spam", "email_address": "[email protected]"}
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        # http response body contains bytes
+        mock_response.content = json.dumps(mock_data).encode()
+        mock_response.json.return_value = mock_data
+        result = self.test_client.transform_response(mock_response)
+        # make sure output matches expected dict
+        self.assertEqual(result, {"foo_bar": "spam", "email_address": "[email protected]", "status_code": 200})
+
+    def test_transform_response_empty_content(self):
+        """Test that empty content or a 204 response returns only the status code"""
+        mock_response = MagicMock()
+        mock_response.status_code = 204
+        # no data returned in 204 response
+        mock_response.content = b""
+        result = self.test_client.transform_response(mock_response)
+        self.assertEqual(result, {"status_code": 204})
+
+    def test_transform_response_invalid_json(self):
+        """Test that response for invalid JSON returns an empty dict with the status code"""
+        mock_response = MagicMock()
+        mock_response.status_code = 500
+        mock_response.content = b"not a valid json"
+        # bad json
+        mock_response.json.side_effect = json.decoder.JSONDecodeError("error", "not a valid json", 0)
+        result = self.test_client.transform_response(mock_response)
+        self.assertEqual(result, {"status_code": 500})
+
+    @patch.object(logger, "warning")
+    def test_check_response_for_rate_limit(self, mock_warning):
+        """Test that check_response_for_rate_limit always returns 1 and actually logs warning on 429"""
+        mock_response_valid = MagicMock()
+        mock_response_valid.status_code = 200
+
+        mock_response_limit = MagicMock()
+        mock_response_limit.status_code = 429
+
+        # should always return 1
+        result_valid = self.test_client.check_response_for_rate_limit(mock_response_valid)
+        result_limit = self.test_client.check_response_for_rate_limit(mock_response_limit)
+
+        self.assertEqual(result_valid, 1)
+        self.assertEqual(result_limit, 1)
+
+        # verify that the logger warning called once (occurs when 429)
+        mock_warning.assert_called_once_with("Mailchimp rate limit hit (HTTP 429: Too Many Requests)")
+
+    @patch.object(MailChimpClient, "transform_response")
+    @patch.object(logger, "debug")
+    @patch("requests.Session.get")
+    def test_paginate_endpoint_valid(self, mock_get, mock_debug, mock_transform):
+        """Test that paginate_endpoint correctly aggregates results across multiple pages"""
+        # set pages
+        mock_transform.side_effect = [
+            {"members": [{"id": "1"}, {"id": "2"}], "total_items": 4},
+            {"members": [{"id": "3"}, {"id": "4"}], "total_items": 4},
+        ]
+
+        # set http calls
+        fake_response_1 = MagicMock()
+        fake_response_2 = MagicMock()
+        mock_get.side_effect = [fake_response_1, fake_response_2]
+
+        results = self.test_client.paginate_endpoint(
+            base_endpoint="lists/898/members",
+            data_key="members",
+            count=2,
+            max_pages=2,
+        )
+        # all data in list
+        self.assertEqual(results, [{"id": "1"}, {"id": "2"}, {"id": "3"}, {"id": "4"}])
+        # two calls
+        self.assertEqual(mock_get.call_count, 2)
+        # debug not called
+        mock_debug.assert_not_called()
+
+    @patch.object(MailChimpClient, "transform_response")
+    @patch.object(logger, "debug")
+    @patch("requests.Session.get")
+    def test_paginate_endpoint_debug_logs_when_empty(self, mock_get, mock_debug, mock_transform):
+        """Test that paginate_endpoint logs debug message and stops when no items are found"""
+        # mock first page has data, second page empty (triggers debug...)
+        mock_transform.side_effect = [
+            {"members": [{"id": "1"}, {"id": "2"}], "total_items": 4},
+            {"members": []},
+        ]
+
+        # set HTTP calls
+        fake_response_1 = MagicMock()
+        fake_response_2 = MagicMock()
+        mock_get.side_effect = [fake_response_1, fake_response_2]
+
+
+        self.test_client.paginate_endpoint(
+            base_endpoint="lists/898/members",
+            data_key="members",
+            count=2,
+        )
+
+        # should log debug once when second page is empty
+        mock_debug.assert_called_once_with("No items found at offset 2 for key 'members'")
+        # two calls
+        self.assertEqual(mock_get.call_count, 2)
+
+    @patch.object(MailChimpClient, "transform_response")
+    @patch.object(logger, "debug")
+    @patch("requests.Session.get")
+    def test_paginate_endpoint_stops_when_total_items_reached(self, mock_get, mock_debug, mock_transform):
+        """Test that paginate_endpoint stops paginating when offset >= total_items"""
+        mock_transform.side_effect = [
+            {"members": [{"id": "1"}, {"id": "2"}], "total_items": 3},
+            {"members": [{"id": "3"}], "total_items": 3},
+        ]
+
+        # set HTTP calls
+        fake_response_1 = MagicMock()
+        fake_response_2 = MagicMock()
+        mock_get.side_effect = [fake_response_1, fake_response_2]
+
+        results = self.test_client.paginate_endpoint(
+            base_endpoint="lists/010/members",
+            data_key="members",
+            count=2,
+        )
+
+        # 3 total members
+        self.assertEqual(results, [{"id": "1"}, {"id": "2"}, {"id": "3"}])
+        # two calls
+        self.assertEqual(mock_get.call_count, 2)
+        # debug not called
+        mock_debug.assert_not_called()
+
+    def test_get_subscriber_hash(self):
+        """Test that get_subscriber_hash returns correct md5 hash and normalizes to lowercase"""
+        email = "[email protected]"
+        expected_subscriber_hash = "67441e845c03ceda61635c3263393515"
+
+        result = MailChimpClient.get_subscriber_hash(email)
+        self.assertEqual(result, expected_subscriber_hash)
+
+        # lowercase version
+        self.assertEqual(result, MailChimpClient.get_subscriber_hash("[email protected]"))
+