|
| 1 | +import unittest |
| 2 | +from unittest.mock import patch, MagicMock, ANY |
| 3 | +import sys |
| 4 | +from io import StringIO |
| 5 | +import datetime |
| 6 | + |
| 7 | +# Correctly import the main function from the script to be tested |
| 8 | +from examples.basic_operations.add_campaigns import main as add_campaigns_main |
| 9 | +from google.ads.googleads.v19.common.types.bidding import ManualCpc |
| 10 | + |
| 11 | +class TestAddCampaigns(unittest.TestCase): |
| 12 | + @patch("examples.basic_operations.add_campaigns.datetime.date") |
| 13 | + @patch("examples.basic_operations.add_campaigns.GoogleAdsClient.load_from_storage") |
| 14 | + def test_add_campaigns_mocked_service(self, mock_load_from_storage, mock_date): |
| 15 | + # --- Setup Mocks --- |
| 16 | + mock_client = MagicMock() |
| 17 | + mock_load_from_storage.return_value = mock_client |
| 18 | + |
| 19 | + # Configure get_type to return distinct mocks for different type_name arguments |
| 20 | + # to prevent interference between budget and campaign object creation. |
| 21 | + def get_type_side_effect(type_name, version=None): # Added version to match potential signature |
| 22 | + mock_type_instance = MagicMock(name=f"MockTypeInstance_{type_name}") |
| 23 | + # Ensure .create is also a unique mock for each type instance |
| 24 | + mock_type_instance.create = MagicMock(name=f"MockCreateFor_{type_name}") |
| 25 | + return mock_type_instance |
| 26 | + mock_client.get_type.side_effect = get_type_side_effect |
| 27 | + |
| 28 | + # Mock datetime to control start and end dates |
| 29 | + fixed_today = datetime.date(2024, 1, 1) # Real datetime.date for calculations |
| 30 | + expected_start_date_str = (fixed_today + datetime.timedelta(days=1)).strftime("%Y%m%d") |
| 31 | + expected_end_date_str = (fixed_today + datetime.timedelta(days=1) + datetime.timedelta(weeks=4)).strftime("%Y%m%d") |
| 32 | + |
| 33 | + # Configure the mock_date object (which is mocking ...add_campaigns.datetime.date) |
| 34 | + mock_date.today.return_value = fixed_today |
| 35 | + |
| 36 | + def mock_strftime_side_effect(date_obj, format_str): |
| 37 | + # This function will be called by the script's datetime.date.strftime(date_obj, format_str) |
| 38 | + # We expect format_str to be "%Y%m%d" |
| 39 | + if date_obj == (fixed_today + datetime.timedelta(days=1)): # This is start_time in script |
| 40 | + return expected_start_date_str |
| 41 | + elif date_obj == (fixed_today + datetime.timedelta(days=1) + datetime.timedelta(weeks=4)): # This is end_time in script |
| 42 | + return expected_end_date_str |
| 43 | + # Fallback for safety, though not expected to be hit in this test |
| 44 | + return "UNEXPECTED_STRFTIME_CALL" |
| 45 | + mock_date.strftime.side_effect = mock_strftime_side_effect |
| 46 | + |
| 47 | + |
| 48 | + # Mock CampaignBudgetService |
| 49 | + mock_budget_service = mock_client.get_service("CampaignBudgetService", version="v19") |
| 50 | + mock_budget_mutate_response = MagicMock() |
| 51 | + mock_budget_result = MagicMock() |
| 52 | + mock_budget_resource_name = "customers/1234567890/campaignBudgets/BUDGET_ID_123" |
| 53 | + mock_budget_result.resource_name = mock_budget_resource_name |
| 54 | + mock_budget_mutate_response.results = [mock_budget_result] |
| 55 | + mock_budget_service.mutate_campaign_budgets.return_value = mock_budget_mutate_response |
| 56 | + |
| 57 | + # Mock CampaignService |
| 58 | + mock_campaign_service = mock_client.get_service("CampaignService", version="v19") |
| 59 | + mock_campaign_mutate_response = MagicMock() |
| 60 | + mock_campaign_result = MagicMock() |
| 61 | + mock_campaign_result.resource_name = "customers/1234567890/campaigns/CAMPAIGN_ID_456" |
| 62 | + mock_campaign_mutate_response.results = [mock_campaign_result] |
| 63 | + mock_campaign_service.mutate_campaigns.return_value = mock_campaign_mutate_response |
| 64 | + |
| 65 | + customer_id = "1234567890" |
| 66 | + |
| 67 | + # --- Capture stdout --- |
| 68 | + old_stdout = sys.stdout |
| 69 | + sys.stdout = captured_output = StringIO() |
| 70 | + |
| 71 | + # --- Call the main function --- |
| 72 | + add_campaigns_main(mock_client, customer_id) |
| 73 | + |
| 74 | + # --- Restore stdout --- |
| 75 | + sys.stdout = old_stdout |
| 76 | + output = captured_output.getvalue().strip() |
| 77 | + |
| 78 | + # --- Assertions for CampaignBudgetService --- |
| 79 | + mock_budget_service.mutate_campaign_budgets.assert_called_once_with( |
| 80 | + customer_id=customer_id, |
| 81 | + operations=[ANY] |
| 82 | + ) |
| 83 | + _, budget_call_kwargs = mock_budget_service.mutate_campaign_budgets.call_args |
| 84 | + budget_operations = budget_call_kwargs["operations"] |
| 85 | + self.assertEqual(len(budget_operations), 1) |
| 86 | + budget_operation = budget_operations[0] |
| 87 | + |
| 88 | + self.assertTrue(budget_operation.create.name.startswith("Interplanetary Budget ")) |
| 89 | + self.assertEqual(budget_operation.create.delivery_method, mock_client.enums.BudgetDeliveryMethodEnum.STANDARD) |
| 90 | + self.assertEqual(budget_operation.create.amount_micros, 500000) |
| 91 | + |
| 92 | + # --- Assertions for CampaignService --- |
| 93 | + mock_campaign_service.mutate_campaigns.assert_called_once_with( |
| 94 | + customer_id=customer_id, |
| 95 | + operations=[ANY] |
| 96 | + ) |
| 97 | + _, campaign_call_kwargs = mock_campaign_service.mutate_campaigns.call_args |
| 98 | + campaign_operations = campaign_call_kwargs["operations"] |
| 99 | + self.assertEqual(len(campaign_operations), 1) |
| 100 | + campaign_operation = campaign_operations[0].create # Access the .create attribute |
| 101 | + |
| 102 | + self.assertTrue(campaign_operation.name.startswith("Interplanetary Cruise ")) |
| 103 | + self.assertEqual(campaign_operation.advertising_channel_type, mock_client.enums.AdvertisingChannelTypeEnum.SEARCH) |
| 104 | + self.assertEqual(campaign_operation.status, mock_client.enums.CampaignStatusEnum.PAUSED) |
| 105 | + self.assertIsInstance(campaign_operation.manual_cpc, ManualCpc) |
| 106 | + self.assertEqual(campaign_operation.campaign_budget, mock_budget_resource_name) |
| 107 | + |
| 108 | + self.assertEqual(campaign_operation.network_settings.target_google_search, True) |
| 109 | + self.assertEqual(campaign_operation.network_settings.target_search_network, True) |
| 110 | + self.assertEqual(campaign_operation.network_settings.target_partner_search_network, False) |
| 111 | + self.assertEqual(campaign_operation.network_settings.target_content_network, True) |
| 112 | + |
| 113 | + self.assertEqual(campaign_operation.start_date, expected_start_date_str) |
| 114 | + self.assertEqual(campaign_operation.end_date, expected_end_date_str) |
| 115 | + |
| 116 | + |
| 117 | + # --- Assert script output --- |
| 118 | + expected_output = f"Created campaign {mock_campaign_result.resource_name}." |
| 119 | + self.assertEqual(output, expected_output) |
| 120 | + |
| 121 | +if __name__ == "__main__": |
| 122 | + unittest.main() |
0 commit comments