fix *rest_required_fields test actual vs expected when field is auto-populated

Author: parthea

packages/gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2

@@ -1114,10 +1114,10 @@ def test_{{ service.client_name|snake_case }}_create_channel_credentials_file(cl
 
 {% for method in service.methods.values() if 'rest' in opts.transport %}
 {% if method.extended_lro %}
-{{ test_macros.rest_required_tests(method, service, numeric_enums=opts.rest_numeric_enums, full_extended_lro=True) }}
+{{ test_macros.rest_required_tests(api, method, service, numeric_enums=opts.rest_numeric_enums, full_extended_lro=True) }}
 
 {% endif %}
-{{ test_macros.rest_required_tests(method, service, numeric_enums=opts.rest_numeric_enums) }}
+{{ test_macros.rest_required_tests(api, method, service, numeric_enums=opts.rest_numeric_enums) }}
 
 {% endfor -%} {#- method in methods for rest #}
 

packages/gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_macros.j2

@@ -1018,7 +1018,7 @@ def test_{{ method_name }}_raw_page_lro():
 {% endif %}{# method.paged_result_field #}{% endwith %}
 {% endmacro %}
 
-{% macro rest_required_tests(method, service, numeric_enums=False, full_extended_lro=False) %}
+{% macro rest_required_tests(api, method, service, numeric_enums=False, full_extended_lro=False) %}
 {% with method_name = method.client_method_name|snake_case + "_unary" if method.extended_lro and not full_extended_lro else method.client_method_name|snake_case, method_output = method.extended_lro.operation_type if method.extended_lro and not full_extended_lro else method.output %}{% if method.http_options %}
 {# TODO(kbandes): remove this if condition when lro and client streaming are supported. #}
 {% if not method.client_streaming %}
@@ -1218,6 +1218,24 @@ def test_{{ method_name }}_rest_required_fields(request_type={{ method.input.ide
                 ('$alt', 'json;enum-encoding=int')
               {% endif %}
             ]
+    {% with method_settings = api.all_method_settings.get(method.meta.address.proto) %}
+    {% if method_settings is not none %}
+    {% for auto_populated_field in method_settings.auto_populated_fields %}
+            # Ensure that the uuid4 field is set according to AIP 4235
+            # and remove it so the expected/actual comparison succeeds.
+            # Otherwise, the actual will differ from the expected since
+            # this field was automatically populated.
+            found_field = None
+            for i, (key, value) in enumerate(req.call_args.kwargs['params']):
+                if key == "{{ auto_populated_field|camel_case }}":
+                    assert re.match(r"{{ get_uuid4_re() }}", value)
+                    found_field = i
+                    break
+            if found_field is not None:
+                del req.call_args.kwargs['params'][found_field]
+    {% endfor %}
+    {% endif %}
+    {% endwith %}
             actual_params = req.call_args.kwargs['params']
             assert expected_params == actual_params
 

packages/gapic-generator/tests/integration/goldens/storagebatchoperations/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py

@@ -4132,6 +4132,18 @@ def test_create_job_rest_required_fields(request_type=storage_batch_operations.C
                     "",
                 ),
             ]
+            # Ensure that the uuid4 field is set according to AIP 4235
+            # and remove it so the expected/actual comparison succeeds.
+            # Otherwise, the actual will differ from the expected since
+            # this field was automatically populated.
+            found_field = None
+            for i, (key, value) in enumerate(req.call_args.kwargs['params']):
+                if key == "requestId":
+                    assert re.match(r"[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}", value)
+                    found_field = i
+                    break
+            if found_field is not None:
+                del req.call_args.kwargs['params'][found_field]
             actual_params = req.call_args.kwargs['params']
             assert expected_params == actual_params
 
@@ -4299,6 +4311,18 @@ def test_delete_job_rest_required_fields(request_type=storage_batch_operations.D
 
             expected_params = [
             ]
+            # Ensure that the uuid4 field is set according to AIP 4235
+            # and remove it so the expected/actual comparison succeeds.
+            # Otherwise, the actual will differ from the expected since
+            # this field was automatically populated.
+            found_field = None
+            for i, (key, value) in enumerate(req.call_args.kwargs['params']):
+                if key == "requestId":
+                    assert re.match(r"[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}", value)
+                    found_field = i
+                    break
+            if found_field is not None:
+                del req.call_args.kwargs['params'][found_field]
             actual_params = req.call_args.kwargs['params']
             assert expected_params == actual_params
 
@@ -4464,6 +4488,18 @@ def test_cancel_job_rest_required_fields(request_type=storage_batch_operations.C
 
             expected_params = [
             ]
+            # Ensure that the uuid4 field is set according to AIP 4235
+            # and remove it so the expected/actual comparison succeeds.
+            # Otherwise, the actual will differ from the expected since
+            # this field was automatically populated.
+            found_field = None
+            for i, (key, value) in enumerate(req.call_args.kwargs['params']):
+                if key == "requestId":
+                    assert re.match(r"[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}", value)
+                    found_field = i
+                    break
+            if found_field is not None:
+                del req.call_args.kwargs['params'][found_field]
             actual_params = req.call_args.kwargs['params']
             assert expected_params == actual_params