feat: Add complete basic test suite for advanced_operations

google-labs-jules[bot] · google-labs-jules[bot] · commit 8d229acbf1f8 · 2025-05-29T19:51:54.000Z
This commit adds a test suite for all scripts in the
`examples/advanced_operations` directory.

Key changes include:
- Creation of `examples/advanced_operations/tests` directory.
- Addition of `tests/__init__.py`.
- Implementation of `tests/conftest.py` with a `mock_google_ads_client`
  fixture for mocking the GoogleAdsClient, its services, types, and enums.
- Generation of 18 test files, one for each script in
  `examples/advanced_operations`.
- Population of each test file with basic tests that ensure the `main()`
  function of the corresponding script can be invoked with a mocked
  GoogleAdsClient and appropriate arguments without raising unhandled
  exceptions. This involved:
    - Mocking service calls and their return values (e.g., objects
      with `resource_name` or `results` attributes).
    - Mocking enums.
    - Patching utilities like `uuid.uuid4`, `requests.get`, etc., where
      used by the scripts.
- Addressed and fixed runtime errors previously identified in:
    - `test_add_demand_gen_campaign.py` (TypeError due to incorrect
      argument count in main function call).
    - `test_add_smart_campaign.py` (ValueError: "malformed KeywordTheme"
      due to issues in mocking KeywordTheme object instantiation and
      its `oneof` fields).

The test suite is structured for use with `pytest`.
diff --git a/examples/advanced_operations/tests/test_add_smart_campaign.py b/examples/advanced_operations/tests/test_add_smart_campaign.py
@@ -73,8 +73,42 @@ def suggest_keyword_themes_side_effect(request):
         empty_response.keyword_themes = []
         return empty_response
 
-    mock_suggest_service.suggest_keyword_themes.side_effect = suggest_keyword_themes_side_effect
+    mock_suggest_service.suggest_keyword_themes.side_effect = suggest_keyword_themes_side_effect # Keep existing side effect logic for now
+
+    # --- Mocking client.get_type for KeywordTheme instantiation ---
+    # This is critical for how the script itself creates KeywordTheme objects.
+    # The KeywordTheme() call in the script should return a MagicMock that has
+    # 'keyword_theme_constant' and 'free_form_keyword_theme' attributes defined (initially as None).
+    
+    def create_mock_keyword_theme_instance():
+        instance = MagicMock(spec=['keyword_theme_constant', 'free_form_keyword_theme'])
+        instance.keyword_theme_constant = None
+        instance.free_form_keyword_theme = None
+        return instance
+
+    # This is the mock for the class/constructor itself
+    mock_keyword_theme_constructor = MagicMock(side_effect=create_mock_keyword_theme_instance)
+
+    # This is the mock for the object that *has* KeywordTheme as an attribute
+    # (e.g., what client.get_type("SuggestKeywordThemesResponse") returns)
+    mock_suggest_response_type_with_keyword_theme_attr = MagicMock()
+    mock_suggest_response_type_with_keyword_theme_attr.KeywordTheme = mock_keyword_theme_constructor
     
+    # Store the original get_type mock from conftest
+    original_get_type_mock = mock_google_ads_client.get_type
+
+    def get_type_side_effect_for_keyword_theme(type_name):
+        if type_name == "SuggestKeywordThemesResponse":
+            return mock_suggest_response_type_with_keyword_theme_attr
+        # Fallback to the default behavior of the original get_type mock for other types
+        if hasattr(original_get_type_mock, 'side_effect') and original_get_type_mock.side_effect:
+            # If the original mock itself had a side_effect
+            return original_get_type_mock.side_effect(type_name)
+        return original_get_type_mock(type_name)
+
+    mock_google_ads_client.get_type.side_effect = get_type_side_effect_for_keyword_theme
+    # --- End of get_type mocking ---
+
     # Suggest Budget Options
     mock_budget_options_response = MagicMock()
     mock_recommended_budget = MagicMock()
@@ -189,16 +223,60 @@ def test_main_with_business_location_runs_successfully(mock_uuid4_biz: MagicMock
     # if free_form_keyword_text:
     #   response = smart_campaign_suggest_service.suggest_keyword_themes(request)
     #   keyword_theme_infos.extend(map_keyword_themes_to_keyword_infos(response.keyword_themes))
-    # So, if free_form_keyword_text is None, suggest_keyword_themes is NOT called.
-    # Thus, we don't need to mock its response extensively for this specific test case path.
-    # However, if it were called, it should return an empty list or correctly structured mock.
+    # So, if free_form_keyword_text is None, suggest_keyword_themes is NOT called by _get_keyword_theme_infos.
+    # The script path for this test case:
+    # 1. _get_keyword_text_auto_completions IS called with keyword_text.
+    #    - It calls KeywordThemeConstantService.suggest_keyword_theme_constants.
+    #    - It then creates KeywordTheme objects using client.get_type("SuggestKeywordThemesResponse").KeywordTheme().
+    #      These instances will now be created by our mock_keyword_theme_constructor.
+    # 2. _get_keyword_theme_infos is called.
+    #    - If keyword_theme_ids are provided (not in this test), it uses them.
+    #    - If free_form_keyword_text is provided (None in this test), it calls suggest_keyword_themes.
+    #      Since free_form_keyword_text is None, suggest_keyword_themes is NOT called here.
+    # Therefore, the mock for suggest_keyword_themes for this test can return an empty list.
     mock_empty_kw_theme_response = MagicMock()
-    mock_empty_kw_theme_response.keyword_themes = []
-    mock_suggest_service.suggest_keyword_themes.return_value = mock_empty_kw_theme_response # Default for this test path
+    mock_empty_kw_theme_response.keyword_themes = [] # No themes from this service for this test path
+    mock_suggest_service.suggest_keyword_themes.return_value = mock_empty_kw_theme_response
+
+    # --- Mocking client.get_type for KeywordTheme instantiation (same as in the first test) ---
+    def create_mock_keyword_theme_instance_biz():
+        instance = MagicMock(spec=['keyword_theme_constant', 'free_form_keyword_theme'])
+        instance.keyword_theme_constant = None
+        instance.free_form_keyword_theme = None
+        return instance
+    
+    mock_keyword_theme_constructor_biz = MagicMock(side_effect=create_mock_keyword_theme_instance_biz)
+    mock_suggest_response_type_with_keyword_theme_attr_biz = MagicMock()
+    mock_suggest_response_type_with_keyword_theme_attr_biz.KeywordTheme = mock_keyword_theme_constructor_biz
+    
+    original_get_type_mock_biz = mock_google_ads_client.get_type # already a side_effect from previous test
+                                                                # or the conftest default.
+                                                                # We need to be careful not to infinitely recurse if tests run in same session
+                                                                # But the test runner should give fresh client for each test.
+
+    # Re-assigning side_effect for this test case
+    # Note: If the mock_google_ads_client is shared and mutated across tests, this could be an issue.
+    # Pytest fixtures usually provide a fresh mock per test.
+    current_get_type_behavior = mock_google_ads_client.get_type 
+    # If current_get_type_behavior is already our complex side_effect from the *same* test pass (it shouldn't be),
+    # we'd need to access the 'original' it captured. But pytest should prevent this.
+
+    def get_type_side_effect_for_keyword_theme_biz(type_name):
+        if type_name == "SuggestKeywordThemesResponse":
+            return mock_suggest_response_type_with_keyword_theme_attr_biz
+        # Fallback for other types
+        if hasattr(current_get_type_behavior, "__call__") and not isinstance(current_get_type_behavior, MagicMock):
+             # If it's a function (like a previous side_effect)
+            return current_get_type_behavior(type_name)
+        return current_get_type_behavior # If it's a simple MagicMock
+        
+    mock_google_ads_client.get_type = MagicMock() # Reset to a simple mock first
+    mock_google_ads_client.get_type.side_effect = get_type_side_effect_for_keyword_theme_biz # Then apply new side_effect
+    # --- End of get_type mocking for biz test ---
 
     mock_budget_options_response = MagicMock()
     mock_recommended_budget = MagicMock()
-    mock_recommended_budget.daily_amount_micros = 55000000 
+    mock_recommended_budget.daily_amount_micros = 55000000
     mock_budget_options_response.recommended_daily_budget_options.high.daily_amount_micros = 65000000
     mock_budget_options_response.recommended_daily_budget_options.low.daily_amount_micros = 45000000
     mock_budget_options_response.recommended_daily_budget_options.recommended.daily_amount_micros = mock_recommended_budget.daily_amount_micros
diff --git a/examples/advanced_operations/tests/test_create_and_attach_shared_keyword_set.py b/examples/advanced_operations/tests/test_create_and_attach_shared_keyword_set.py
@@ -1 +1,54 @@
-pass
+import pytest
+from unittest.mock import MagicMock, patch
+
+# Note: The script uses "import uuid" and then "uuid.uuid4()"
+from examples.advanced_operations.create_and_attach_shared_keyword_set import main
+
+@patch("examples.advanced_operations.create_and_attach_shared_keyword_set.uuid.uuid4", return_value=MagicMock(hex="testuuid"))
+def test_main_runs_successfully(mock_uuid4: MagicMock, mock_google_ads_client: MagicMock) -> None:
+    """Tests that the main function runs without raising an exception."""
+    mock_customer_id = "123"
+    mock_campaign_id = "456"
+
+    # Mock CampaignService for campaign_path
+    mock_campaign_service_path_helper = mock_google_ads_client.get_service("CampaignService")
+    mock_campaign_service_path_helper.campaign_path.return_value = f"customers/{mock_customer_id}/campaigns/{mock_campaign_id}"
+
+    # Mock SharedSetService
+    mock_shared_set_service = mock_google_ads_client.get_service("SharedSetService")
+    mock_shared_set_response = MagicMock()
+    mock_shared_set_result = MagicMock()
+    mock_shared_set_result.resource_name = f"customers/{mock_customer_id}/sharedSets/shared_set_testuuid"
+    mock_shared_set_response.results = [mock_shared_set_result]
+    mock_shared_set_service.mutate_shared_sets.return_value = mock_shared_set_response
+
+    # Mock SharedCriterionService
+    mock_shared_criterion_service = mock_google_ads_client.get_service("SharedCriterionService")
+    mock_shared_criterion_response = MagicMock()
+    # Assuming 3 keywords are added to the shared set
+    mock_shared_criterion_results = [MagicMock(resource_name=f"customers/{mock_customer_id}/sharedCriteria/sc_{i}_testuuid") for i in range(3)]
+    mock_shared_criterion_response.results = mock_shared_criterion_results
+    mock_shared_criterion_service.mutate_shared_criteria.return_value = mock_shared_criterion_response
+
+    # Mock CampaignSharedSetService
+    mock_campaign_shared_set_service = mock_google_ads_client.get_service("CampaignSharedSetService")
+    mock_campaign_shared_set_response = MagicMock()
+    mock_campaign_shared_set_result = MagicMock()
+    mock_campaign_shared_set_result.resource_name = f"customers/{mock_customer_id}/campaignSharedSets/css_testuuid"
+    mock_campaign_shared_set_response.results = [mock_campaign_shared_set_result]
+    mock_campaign_shared_set_service.mutate_campaign_shared_sets.return_value = mock_campaign_shared_set_response
+
+    # Mock enums
+    mock_enums = mock_google_ads_client.enums
+    mock_enums.SharedSetTypeEnum.NEGATIVE_KEYWORDS = "NEGATIVE_KEYWORDS"
+    mock_enums.KeywordMatchTypeEnum.BROAD = "BROAD"
+    # The script also defines KeywordMatchTypeEnum.EXACT and .PHRASE but doesn't seem to use them in the example keywords.
+
+    try:
+        main(
+            mock_google_ads_client,
+            mock_customer_id,
+            mock_campaign_id,
+        )
+    except Exception as e:
+        pytest.fail(f"main function raised an exception: {e}")
diff --git a/examples/advanced_operations/tests/test_find_and_remove_criteria_from_shared_set.py b/examples/advanced_operations/tests/test_find_and_remove_criteria_from_shared_set.py
@@ -1 +1,65 @@
-pass
+import pytest
+from unittest.mock import MagicMock
+
+from examples.advanced_operations.find_and_remove_criteria_from_shared_set import main
+
+def test_main_runs_successfully(mock_google_ads_client: MagicMock) -> None:
+    """Tests that the main function runs without raising an exception."""
+    mock_customer_id = "123"
+    mock_campaign_id = "456" # This is used to find the shared set name
+
+    # Mock GoogleAdsService for search (called twice)
+    mock_googleads_service = mock_google_ads_client.get_service("GoogleAdsService")
+
+    # Mock response for the first search (finding shared set ID)
+    mock_search_response_shared_set = MagicMock()
+    mock_row_shared_set = MagicMock()
+    mock_row_shared_set.shared_set.id = "789012" # Shared set ID
+    mock_row_shared_set.shared_set.name = f"Test Shared Set for Campaign {mock_campaign_id}"
+    mock_search_response_shared_set.results = [mock_row_shared_set]
+
+    # Mock response for the second search (finding shared criteria)
+    mock_search_response_criteria = MagicMock()
+    # Simulate two criteria found, one to keep, one to remove
+    mock_row_criterion_to_remove = MagicMock()
+    mock_row_criterion_to_remove.shared_criterion.resource_name = f"customers/{mock_customer_id}/sharedCriteria/789012~111"
+    mock_row_criterion_to_remove.shared_criterion.type_ = mock_google_ads_client.enums.CriterionTypeEnum.KEYWORD
+    mock_row_criterion_to_remove.shared_criterion.keyword.text = "keyword to remove"
+    mock_row_criterion_to_remove.shared_criterion.keyword.match_type = mock_google_ads_client.enums.KeywordMatchTypeEnum.EXACT
+    
+    mock_row_criterion_to_keep = MagicMock()
+    mock_row_criterion_to_keep.shared_criterion.resource_name = f"customers/{mock_customer_id}/sharedCriteria/789012~222"
+    mock_row_criterion_to_keep.shared_criterion.type_ = mock_google_ads_client.enums.CriterionTypeEnum.KEYWORD
+    mock_row_criterion_to_keep.shared_criterion.keyword.text = "keyword to keep" # Script removes based on "remove" in text
+    mock_row_criterion_to_keep.shared_criterion.keyword.match_type = mock_google_ads_client.enums.KeywordMatchTypeEnum.BROAD
+    
+    mock_search_response_criteria.results = [mock_row_criterion_to_remove, mock_row_criterion_to_keep]
+
+    # Configure side_effect for multiple search calls
+    mock_googleads_service.search.side_effect = [
+        iter([mock_search_response_shared_set]), # First call returns one page with one result
+        iter([mock_search_response_criteria])  # Second call returns one page with two results
+    ]
+
+    # Mock SharedCriterionService for mutate_shared_criteria
+    mock_shared_criterion_service = mock_google_ads_client.get_service("SharedCriterionService")
+    mock_mutate_response = MagicMock()
+    mock_removed_criterion_result = MagicMock()
+    mock_removed_criterion_result.resource_name = f"customers/{mock_customer_id}/sharedCriteria/789012~111" # resource name of removed criterion
+    mock_mutate_response.results = [mock_removed_criterion_result]
+    mock_shared_criterion_service.mutate_shared_criteria.return_value = mock_mutate_response
+
+    # Mock enums (CriterionTypeEnum is already on the client mock by default from conftest)
+    # client.enums.CriterionTypeEnum.KEYWORD will work.
+    # client.enums.KeywordMatchTypeEnum.EXACT and .BROAD will also work.
+    # Ensure these enums are configured on the main mock_google_ads_client.enums if not already.
+    # For this test, we access them via mock_google_ads_client.enums.CriterionTypeEnum which is fine.
+
+    try:
+        main(
+            mock_google_ads_client,
+            mock_customer_id,
+            mock_campaign_id,
+        )
+    except Exception as e:
+        pytest.fail(f"main function raised an exception: {e}")
diff --git a/examples/advanced_operations/tests/test_get_ad_group_bid_modifiers.py b/examples/advanced_operations/tests/test_get_ad_group_bid_modifiers.py
@@ -1 +1,76 @@
-pass
+import pytest
+from unittest.mock import MagicMock
+
+from examples.advanced_operations.get_ad_group_bid_modifiers import main
+
+def test_main_runs_successfully(mock_google_ads_client: MagicMock) -> None:
+    """Tests that the main function runs without raising an exception with an ad_group_id."""
+    mock_customer_id = "123"
+    mock_ad_group_id = "456"
+
+    # Mock GoogleAdsService for search
+    mock_googleads_service = mock_google_ads_client.get_service("GoogleAdsService")
+    
+    mock_search_response_page = MagicMock() # Represents one page of results
+    mock_row1 = MagicMock()
+    mock_row1.ad_group_bid_modifier.criterion_id = 12345
+    mock_row1.ad_group_bid_modifier.bid_modifier = 1.5
+    mock_row1.ad_group_bid_modifier.device.type_ = mock_google_ads_client.enums.DeviceEnum.MOBILE
+    mock_row1.ad_group.id = int(mock_ad_group_id)
+    mock_row1.campaign.id = 789
+
+    mock_row2 = MagicMock() # Example for a non-device modifier (e.g. hotel)
+    mock_row2.ad_group_bid_modifier.criterion_id = 67890
+    mock_row2.ad_group_bid_modifier.bid_modifier = 0.8
+    # For hotel check-in day, the device field won't be populated.
+    # Instead, hotel_check_in_day field would be, for example:
+    mock_row2.ad_group_bid_modifier.hotel_check_in_day.day_of_week = mock_google_ads_client.enums.DayOfWeekEnum.MONDAY
+    # Clear other oneof fields like device for this specific row if the script checks for their absence
+    delattr(mock_row2.ad_group_bid_modifier, 'device') 
+    mock_row2.ad_group.id = int(mock_ad_group_id)
+    mock_row2.campaign.id = 789
+    
+    mock_search_response_page.results = [mock_row1, mock_row2]
+    # The search method returns an iterable of pages (MagicMock with results)
+    mock_googleads_service.search.return_value = iter([mock_search_response_page])
+
+    # Ensure enums used in results and script are available (DeviceEnum, DayOfWeekEnum)
+    # These should be on mock_google_ads_client.enums from conftest.
+    # e.g. mock_google_ads_client.enums.DeviceEnum.MOBILE
+    # e.g. mock_google_ads_client.enums.DayOfWeekEnum.MONDAY
+
+    try:
+        main(
+            mock_google_ads_client,
+            mock_customer_id,
+            mock_ad_group_id,
+        )
+    except Exception as e:
+        pytest.fail(f"main function raised an exception: {e}")
+
+def test_main_runs_without_ad_group_id(mock_google_ads_client: MagicMock) -> None:
+    """Tests that the main function runs without an ad_group_id (fetches for all ad groups)."""
+    mock_customer_id = "123"
+    mock_ad_group_id = None
+
+    mock_googleads_service = mock_google_ads_client.get_service("GoogleAdsService")
+    
+    mock_search_response_page = MagicMock()
+    mock_row1 = MagicMock()
+    mock_row1.ad_group_bid_modifier.criterion_id = 54321
+    mock_row1.ad_group_bid_modifier.bid_modifier = 1.2
+    mock_row1.ad_group_bid_modifier.device.type_ = mock_google_ads_client.enums.DeviceEnum.TABLET
+    mock_row1.ad_group.id = 987 # Different ad group ID
+    mock_row1.campaign.id = 654
+    
+    mock_search_response_page.results = [mock_row1]
+    mock_googleads_service.search.return_value = iter([mock_search_response_page])
+
+    try:
+        main(
+            mock_google_ads_client,
+            mock_customer_id,
+            mock_ad_group_id, # None
+        )
+    except Exception as e:
+        pytest.fail(f"main function raised an exception: {e}")
diff --git a/examples/advanced_operations/tests/test_use_cross_account_bidding_strategy.py b/examples/advanced_operations/tests/test_use_cross_account_bidding_strategy.py
diff --git a/examples/advanced_operations/tests/test_use_portfolio_bidding_strategy.py b/examples/advanced_operations/tests/test_use_portfolio_bidding_strategy.py
