tests: improve readability by moving mock api response and usage data to top

Author: hadiqur

tests/test_main.py

@@ -17,8 +17,23 @@
     update_s3_object,
     get_dict_value,
     get_config_file,
+
 )
 
+# Mock API response
+api_response = {
+    "download_links": [
+        "https://example.com/organisation_history_api_response.json"
+    ]
+    # There are other fields in the API response, but we don't need them for this test
+}
+
+# Mock usage data returned from GitHub API 
+fetched_usage_data = {"day_totals": [
+    {"day": "2024-01-01", "usage": 10},
+    {"day": "2024-01-02", "usage": 20},
+]}
+
 
 class TestUpdateS3Object:
     def test_update_s3_object_success(self, caplog):
@@ -124,20 +139,6 @@ def teardown_method(self):
     def test_get_and_update_historic_usage_success(self):
         s3 = MagicMock()
         gh = MagicMock()
-
-        # Mock API response
-        api_response = {
-            "download_links": [
-                "https://example.com/organisation_history_api_response.json"
-            ]
-            # There are other fields in the API response, but we don't need them for this test
-        }
-
-        # Mock usage data returned from GitHub API 
-        fetched_usage_data = {"day_totals": [
-            {"day": "2024-01-01", "usage": 10},
-            {"day": "2024-01-02", "usage": 20},
-        ]}
 
         gh.get.return_value.json.return_value = api_response
 
@@ -150,8 +151,8 @@ def test_get_and_update_historic_usage_success(self):
         # Mock requests.get returns usage data from download_links
         # We always patch dependencies imported inside the function we're testing.
         # Test environment initialisation ends here.
-        with patch("src.main.requests.get") as mock_requests_get:
-            mock_requests_get.return_value.json.return_value = fetched_usage_data
+        with patch("src.main.get") as mock_get:
+            mock_get.return_value.json.return_value = fetched_usage_data
             result, dates_added = get_and_update_historic_usage(s3, gh, False)
 
         assert result == [
@@ -169,14 +170,6 @@ def test_get_and_update_historic_usage_success(self):
     def test_get_and_update_historic_usage_no_existing_data(self, caplog):
         s3 = MagicMock()
         gh = MagicMock()
-        api_response = {
-            "download_links": [
-                "https://example.com/organisation_history_api_response.json"
-            ]
-        }
-        fetched_usage_data = {"day_totals": [
-            {"day": "2024-01-01", "usage": 10},
-        ]}
 
         gh.get.return_value.json.return_value = api_response
 
@@ -186,12 +179,12 @@ def test_get_and_update_historic_usage_no_existing_data(self, caplog):
             operation_name="GetObject",
         )
 
-        with patch("src.main.requests.get") as mock_requests_get:
-            mock_requests_get.return_value.json.return_value = fetched_usage_data
+        with patch("src.main.get") as mock_get:
+            mock_get.return_value.json.return_value = fetched_usage_data
             result, dates_added = get_and_update_historic_usage(s3, gh, False)
 
-        assert result == [{"day": "2024-01-01", "usage": 10}]
-        assert dates_added == ["2024-01-01"]
+        assert result == [{"day": "2024-01-01", "usage": 10}, {"day": "2024-01-02", "usage": 20}]
+        assert dates_added == ["2024-01-01", "2024-01-02"]
         s3.put_object.assert_called_once()
         assert any(
             "Error getting organisation_history.json" in record.getMessage()
@@ -201,41 +194,25 @@ def test_get_and_update_historic_usage_no_existing_data(self, caplog):
     def test_get_and_update_historic_usage_no_new_dates(self):
         s3 = MagicMock()
         gh = MagicMock()
-        api_response = {
-            "download_links": [
-                "https://example.com/organisation_history_api_response.json"
-            ]
-        }
-        fetched_usage_data = {"day_totals": [
-            {"day": "2024-01-01", "usage": 10},
-        ]}
 
         gh.get.return_value.json.return_value = api_response
 
         # S3 get_object returns same date as usage_data
-        existing_usage = [{"day": "2024-01-01", "usage": 10}]
+        existing_usage = [{"day": "2024-01-01", "usage": 10}, {"day": "2024-01-02", "usage": 20}]
         s3.get_object.return_value = {
             "Body": BytesIO(json.dumps(existing_usage).encode("utf-8"))
         }
-        with patch("src.main.requests.get") as mock_requests_get:
-            mock_requests_get.return_value.json.return_value = fetched_usage_data
+        with patch("src.main.get") as mock_get:
+            mock_get.return_value.json.return_value = fetched_usage_data
             result, dates_added = get_and_update_historic_usage(s3, gh, False)
 
-        assert result == [{"day": "2024-01-01", "usage": 10}]
+        assert result == [{"day": "2024-01-01", "usage": 10}, {"day": "2024-01-02", "usage": 20}]
         assert dates_added == []
         s3.put_object.assert_called_once()
 
     def test_write_data_locally_creates_file(self, tmp_path):
         s3 = MagicMock()
         gh = MagicMock()
-        api_response = {
-            "download_links": [
-                "https://example.com/organisation_history_api_response.json"
-            ]
-        }
-        fetched_usage_data = {"day_totals": [
-            {"day": "2024-01-01", "usage": 10},
-        ]}
 
         gh.get.return_value.json.return_value = api_response
 
@@ -248,11 +225,11 @@ def test_write_data_locally_creates_file(self, tmp_path):
         # Patch os.makedirs and open to use tmp_path
         with patch("src.main.os.makedirs") as mock_makedirs, \
                 patch("src.main.open", create=True) as mock_open, \
-                    patch("src.main.requests.get") as mock_requests_get:
-                        mock_requests_get.return_value.json.return_value = fetched_usage_data
+                    patch("src.main.get") as mock_get:
+                        mock_get.return_value.json.return_value = fetched_usage_data
                         result, dates_added = get_and_update_historic_usage(s3, gh, True)
-                        assert result == [{"day": "2024-01-01", "usage": 10}]
-                        assert dates_added == ["2024-01-01"]
+                        assert result == [{"day": "2024-01-01", "usage": 10}, {"day": "2024-01-02", "usage": 20}]
+                        assert dates_added == ["2024-01-01", "2024-01-02"]
                         mock_makedirs.assert_called_once_with("output", exist_ok=True)
                         mock_open.assert_called_once()
                         s3.put_object.assert_not_called()