feat: Automatically populate uuid4 fields

Author: parthea

.github/workflows/tests.yaml

@@ -14,7 +14,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  SHOWCASE_VERSION: 0.30.0
+  SHOWCASE_VERSION: 0.31.0
   PROTOC_VERSION: 3.20.2
 
 jobs:

gapic/ads-templates/%namespace/%name/%version/%sub/services/%service/client.py.j2

@@ -6,6 +6,7 @@ from collections import OrderedDict
 import os
 import re
 from typing import Callable, Dict, Mapping, MutableMapping, MutableSequence, Optional, {% if service.any_server_streaming %}Iterable, {% endif %}{% if service.any_client_streaming %}Iterator, {% endif %}Sequence, Tuple, Type, Union, cast
+import uuid
 {% if service.any_deprecated %}
 import warnings
 {% endif %}
@@ -473,6 +474,27 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
         )
         {% endif %}
 
+{#
+    Automatically populate uuid4 fields according to AIP-4235
+    (https://google.aip.dev/client-libraries/4235) if the
+    field satisfies either of:
+    - The field supports explicit presence and has not been set by the user
+    - The field doesn't support explicit presence, and its value is the empty
+      string (i.e. the default value)
+#}
+{% 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 %}
+    {% if method.input.fields[auto_populated_field].proto3_optional %}
+        if not request.HasField({{ auto_populated_field }}):
+    {% else %}
+        if not request.{{ auto_populated_field }}:
+    {% endif %}
+            request.{{ auto_populated_field }} = str(uuid.uuid4())
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
+
         # Send the request.
         {%+ if not method.void %}response = {% endif %}rpc(
             {% if not method.client_streaming %}

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

@@ -3,6 +3,7 @@
 {% block content %}
 
 import os
+import re
 # try/except added for compatibility with python < 3.8
 try:
     from unittest import mock
@@ -568,6 +569,16 @@ def test_{{ method_name }}(request_type, transport: str = 'grpc'):
         {% if method.client_streaming %}
         assert next(args[0]) == request
         {% else %}
+{% 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
+        re.match(r"[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}\Z", args[0].{{ auto_populated_field }})
+        # clear UUID field so that the check below succeeds
+        args[0].{{ auto_populated_field }} = ""
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
         assert args[0] == {{ method.input.ident }}()
         {% endif %}
 
@@ -629,6 +640,16 @@ def test_{{ method_name }}_empty_call():
         {% if method.client_streaming %}
         assert next(args[0]) == request
         {% else %}
+{% 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
+        re.match(r"[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}\Z", args[0].{{ auto_populated_field }})
+        # clear UUID field so that the check below succeeds
+        args[0].{{ auto_populated_field }} = ""
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
         assert args[0] == {{ method.input.ident }}()
         {% endif %}
 {% endif %}

gapic/schema/api.py

@@ -60,7 +60,6 @@
 TRANSPORT_REST = "rest"
 
 
-
 class MethodSettingsError(ValueError):
     """
     Raised when `google.api.client_pb2.MethodSettings` contains

gapic/templates/%namespace/%name_%version/%sub/services/%service/_client_macros.j2

@@ -183,6 +183,8 @@
         )
         {% endif %} {# method.explicit_routing #}
 
+{{ auto_populate_uuid4_fields(api, method) }}
+
         # Validate the universe domain.
         self._validate_universe_domain()
 
@@ -265,3 +267,26 @@
 
 {% macro define_extended_operation_subclass(extended_operation) %}
 {% endmacro %}
+
+{% macro auto_populate_uuid4_fields(api, method) %}
+{# 
+    Automatically populate uuid4 fields according to AIP-4235
+    (https://google.aip.dev/client-libraries/4235) if the
+    field satisfies either of:
+    - The field supports explicit presence and has not been set by the user
+    - The field doesn't support explicit presence, and its value is the empty
+      string (i.e. the default value)
+#}
+{% 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 %}
+    {% if method.input.fields[auto_populated_field].proto3_optional %}
+        if not request.HasField({{ auto_populated_field }}):
+    {% else %}
+        if not request.{{ auto_populated_field }}:
+    {% endif %}
+            request.{{ auto_populated_field }} = str(uuid.uuid4())
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
+{% endmacro %}

gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2

@@ -1,11 +1,13 @@
 {% extends "_base.py.j2" %}
 
 {% block content %}
+{% import "%namespace/%name_%version/%sub/services/%service/_client_macros.j2" as macros %}
 
 from collections import OrderedDict
 import functools
 import re
 from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, {% if service.any_server_streaming %}AsyncIterable, Awaitable, {% endif %}{% if service.any_client_streaming %}AsyncIterator, {% endif %}Sequence, Tuple, Type, Union
+import uuid
 {% if service.any_deprecated %}
 import warnings
 {% endif %}
@@ -386,6 +388,8 @@ class {{ service.async_client_name }}:
         )
         {% endif %}
 
+{{ macros.auto_populate_uuid4_fields(api, method) }}
+
         # Validate the universe domain.
         self._client._validate_universe_domain()
 

gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2

@@ -10,6 +10,7 @@ import functools
 import os
 import re
 from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, {% if service.any_server_streaming %}Iterable, {% endif %}{% if service.any_client_streaming %}Iterator, {% endif %}Sequence, Tuple, Type, Union, cast
+import uuid
 import warnings
 
 {% set package_path = api.naming.module_namespace|join('.') + "." + api.naming.versioned_module_name %}

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

@@ -4,6 +4,7 @@
 {% import "tests/unit/gapic/%name_%version/%sub/test_macros.j2" as test_macros %}
 
 import os
+import re
 # try/except added for compatibility with python < 3.8
 try:
     from unittest import mock
@@ -849,10 +850,10 @@ def test_{{ service.client_name|snake_case }}_create_channel_credentials_file(cl
 
 {% for method in service.methods.values() if 'grpc' in opts.transport %}{# method_name #}
 {% if method.extended_lro %}
-{{ test_macros.grpc_required_tests(method, service, full_extended_lro=True) }}
+{{ test_macros.grpc_required_tests(method, service, api, full_extended_lro=True) }}
 
 {% endif %}
-{{ test_macros.grpc_required_tests(method, service) }}
+{{ test_macros.grpc_required_tests(method, service, api) }}
 {% endfor %} {# method in methods for grpc #}
 
 {% for method in service.methods.values() if 'rest' in opts.transport %}

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

@@ -1,4 +1,4 @@
-{% macro grpc_required_tests(method, service, full_extended_lro=False) %}
+{% macro grpc_required_tests(method, service, api, full_extended_lro=False) %}
 {% with method_name = method.safe_name|snake_case + "_unary" if method.extended_lro and not full_extended_lro else method.safe_name|snake_case, method_output = method.extended_lro.operation_type if method.extended_lro and not full_extended_lro else method.output %}
 @pytest.mark.parametrize("request_type", [
   {{ method.input.ident }},
@@ -58,7 +58,19 @@ def test_{{ method_name }}(request_type, transport: str = 'grpc'):
         {% if method.client_streaming %}
         assert next(args[0]) == request
         {% else %}
-        assert args[0] == {{ method.input.ident }}()
+        request = {{ method.input.ident }}()
+{% 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
+        re.match(r"[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}\Z", args[0].{{ auto_populated_field }})
+        # clear UUID field so that the check below succeeds
+        args[0].{{ auto_populated_field }} = ""
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
+
+        assert args[0] == request
         {% endif %}
 
     # Establish that the response is the type that we expect.
@@ -119,6 +131,16 @@ def test_{{ method_name }}_empty_call():
         {% if method.client_streaming %}
         assert next(args[0]) == request
         {% else %}
+{% 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
+        re.match(r"[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}\Z", args[0].{{ auto_populated_field }})
+        # clear UUID field so that the check below succeeds
+        args[0].{{ auto_populated_field }} = ""
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
         assert args[0] == {{ method.input.ident }}()
         {% endif %}
 {% endif %}
@@ -182,6 +204,16 @@ async def test_{{ method_name }}_async(transport: str = 'grpc_asyncio', request_
         {% if method.client_streaming %}
         assert next(args[0]) == request
         {% else %}
+{% 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
+        re.match(r"[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}\Z", args[0].{{ auto_populated_field }})
+        # clear UUID field so that the check below succeeds
+        args[0].{{ auto_populated_field }} = ""
+{% endfor %}
+{% endif %}{# if method_settings is not none #}
+{% endwith %}{# method_settings #}
         assert args[0] == {{ method.input.ident }}()
         {% endif %}
 

noxfile.py

@@ -29,7 +29,7 @@
 nox.options.error_on_missing_interpreters = True
 
 
-showcase_version = os.environ.get("SHOWCASE_VERSION", "0.30.0")
+showcase_version = os.environ.get("SHOWCASE_VERSION", "0.31.0")
 ADS_TEMPLATES = path.join(path.dirname(__file__), "gapic", "ads-templates")