|
| 1 | +# Copyright 2025 Google LLC |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +import sys |
| 16 | +import os |
| 17 | +import unittest |
| 18 | +from unittest.mock import MagicMock, call |
| 19 | +from io import StringIO |
| 20 | + |
| 21 | +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../../"))) |
| 22 | + |
| 23 | +from google.ads.googleads.errors import GoogleAdsException |
| 24 | +from google.ads.googleads.client import GoogleAdsClient |
| 25 | +from api_examples.get_conversion_upload_summary import main |
| 26 | + |
| 27 | + |
| 28 | +class TestGetConversionUploadSummary(unittest.TestCase): |
| 29 | + def setUp(self): |
| 30 | + self.mock_client = MagicMock(spec=GoogleAdsClient) |
| 31 | + self.mock_ga_service = MagicMock() |
| 32 | + self.mock_client.get_service.return_value = self.mock_ga_service |
| 33 | + self.customer_id = "1234567890" |
| 34 | + |
| 35 | + self.captured_output = StringIO() |
| 36 | + sys.stdout = self.captured_output |
| 37 | + |
| 38 | + def tearDown(self): |
| 39 | + sys.stdout = sys.__stdout__ |
| 40 | + |
| 41 | + def test_main_success(self): |
| 42 | + # Mock responses for search_stream |
| 43 | + mock_batch_1 = MagicMock() |
| 44 | + mock_row_1 = MagicMock() |
| 45 | + mock_summary_1 = MagicMock() |
| 46 | + mock_summary_1.resource_name = "customers/123/offlineConversionUploadClientSummaries/1" |
| 47 | + mock_summary_1.status.name = "SUCCESS" |
| 48 | + mock_summary_1.total_event_count = 10 |
| 49 | + mock_summary_1.successful_event_count = 10 |
| 50 | + mock_summary_1.success_rate = 1.0 |
| 51 | + mock_summary_1.last_upload_date_time = "2024-01-01 12:00:00" |
| 52 | + mock_summary_1.alerts = [] |
| 53 | + mock_summary_1.daily_summaries = [] |
| 54 | + mock_summary_1.job_summaries = [] |
| 55 | + mock_row_1.offline_conversion_upload_client_summary = mock_summary_1 |
| 56 | + mock_batch_1.results = [mock_row_1] |
| 57 | + |
| 58 | + mock_batch_2 = MagicMock() |
| 59 | + mock_row_2 = MagicMock() |
| 60 | + mock_summary_2 = MagicMock() |
| 61 | + mock_summary_2.resource_name = "customers/123/offlineConversionUploadConversionActionSummaries/1" |
| 62 | + mock_summary_2.conversion_action_name = "My Conversion Action" |
| 63 | + mock_summary_2.status.name = "SUCCESS" |
| 64 | + mock_summary_2.total_event_count = 5 |
| 65 | + mock_summary_2.successful_event_count = 5 |
| 66 | + mock_summary_2.alerts = [] |
| 67 | + mock_summary_2.daily_summaries = [] |
| 68 | + mock_summary_2.job_summaries = [] |
| 69 | + mock_row_2.offline_conversion_upload_conversion_action_summary = mock_summary_2 |
| 70 | + mock_batch_2.results = [mock_row_2] |
| 71 | + |
| 72 | + # The first call returns client summary, second call returns conversion action summary |
| 73 | + self.mock_ga_service.search_stream.side_effect = [[mock_batch_1], [mock_batch_2]] |
| 74 | + |
| 75 | + main(self.mock_client, self.customer_id) |
| 76 | + |
| 77 | + # Check output |
| 78 | + output = self.captured_output.getvalue() |
| 79 | + self.assertIn("Offline Conversion Upload Client Summary:", output) |
| 80 | + self.assertIn("Resource Name: customers/123/offlineConversionUploadClientSummaries/1", output) |
| 81 | + self.assertIn("Offline Conversion Upload Conversion Action Summary:", output) |
| 82 | + self.assertIn("Conversion Action Name: My Conversion Action", output) |
| 83 | + |
| 84 | + self.assertEqual(self.mock_ga_service.search_stream.call_count, 2) |
| 85 | + |
| 86 | + def test_main_google_ads_exception(self): |
| 87 | + mock_error = MagicMock() |
| 88 | + mock_error.code.return_value.name = "INTERNAL_ERROR" |
| 89 | + mock_failure = MagicMock() |
| 90 | + mock_failure.errors = [MagicMock(message="Internal error")] |
| 91 | + |
| 92 | + self.mock_ga_service.search_stream.side_effect = GoogleAdsException( |
| 93 | + error=mock_error, |
| 94 | + call=MagicMock(), |
| 95 | + failure=mock_failure, |
| 96 | + request_id="test_request_id" |
| 97 | + ) |
| 98 | + |
| 99 | + with self.assertRaises(SystemExit) as cm: |
| 100 | + main(self.mock_client, self.customer_id) |
| 101 | + |
| 102 | + self.assertEqual(cm.exception.code, 1) |
| 103 | + output = self.captured_output.getvalue() |
| 104 | + self.assertIn('Request with ID "test_request_id" failed with status "INTERNAL_ERROR"', output) |
| 105 | + |
| 106 | +if __name__ == "__main__": |
| 107 | + unittest.main() |
0 commit comments