add showcase tests; clean up code

Author: parthea

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

@@ -23,6 +23,11 @@ from google.auth.transport.grpc import SslCredentials             # type: ignore
 from google.auth.exceptions import MutualTLSChannelError          # type: ignore
 from google.oauth2 import service_account                         # type: ignore
 
+try:
+    from google.api_core import version_header
+except ImportError:
+    version_header = None
+
 {% set package_path = api.naming.module_namespace|join('.') + "." + api.naming.versioned_module_name %}
 from {{package_path}} import gapic_version as package_version
 
@@ -479,11 +484,21 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
         )
         {% endif %}
 
-        {% if service.version %}
-        metadata = tuple(metadata) + (
-            gapic_v1.version_header.to_grpc_metadata("{{ service.version }}"),
-        )
-        {% endif %}
+{#
+    Add API Version to metadata as per https://github.com/aip-dev/google.aip.dev/pull/1331.
+    When using this macro, ensure the calling template
+    generates the following lines:
+        try:
+            from google.api_core import version_header
+        except ImportError:
+            version_header = None
+#}
+    {% if service.version %}
+        if version_header:
+            metadata = tuple(metadata) + (
+                version_header.to_api_version_header("{{ service.version }}"),
+            )
+    {% endif %}{# service.version #}
 {#
     Automatically populate UUID4 fields according to
     https://google.aip.dev/client-libraries/4235 when the

gapic/ads-templates/setup.py.j2

@@ -29,8 +29,7 @@ else:
     release_status = "Development Status :: 5 - Production/Stable"
 
 dependencies = [
-    "google-api-core[grpc] @ git+https://github.com/googleapis/python-api-core.git@add-api-version-header",
-    #"google-api-core[grpc] >= 2.10.0, < 3.0.0dev",
+    "google-api-core[grpc] >= 2.10.0, < 3.0.0dev",
     "google-auth >= 2.14.1, <3.0.0dev",
     "googleapis-common-protos >= 1.53.0",
     "grpcio >= 1.10.0",

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

@@ -39,6 +39,7 @@ from google.oauth2 import service_account
 from {{ (api.naming.module_namespace + (api.naming.versioned_module_name,) + service.meta.address.subpackage)|join(".") }}.services.{{ service.name|snake_case }} import {{ service.client_name }}
 from {{ (api.naming.module_namespace + (api.naming.versioned_module_name,) + service.meta.address.subpackage)|join(".") }}.services.{{ service.name|snake_case }} import transports
 
+from google.api_core import api_core_version
 from google.api_core import client_options
 from google.api_core import exceptions as core_exceptions
 from google.api_core import grpc_helpers
@@ -69,6 +70,11 @@ from google.iam.v1 import options_pb2  # type: ignore
 from google.iam.v1 import policy_pb2  # type: ignore
 {% endif %}
 {% endfilter %}
+try:
+    from google.api_core import version_header
+except ImportError:
+    version_header = None
+
 
 {% with uuid4_re = "[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}" %}
 
@@ -147,6 +153,7 @@ def test_{{ service.client_name|snake_case }}_service_account_always_use_jwt(tra
         use_jwt.assert_not_called()
 
 
+
 @pytest.mark.parametrize("client_class,transport_name", [
     {% if 'grpc' in opts.transport %}
     ({{ service.client_name }}, "grpc"),
@@ -636,6 +643,35 @@ def test_{{ method_name }}(request_type, transport: str = 'grpc'):
     {% endwith %}{# auto_populated_field_sample_value #}
 
 
+{% if service.version %}
+@pytest.mark.parametrize("transport_name", [
+    {% if 'grpc' in opts.transport %}
+    ("grpc"),
+    {% endif %}
+    {% if 'rest' in opts.transport %}
+    ("rest"),
+    {% endif %}
+])
+def test_{{ method_name }}_api_version_header(transport_name):
+    # TODO: Make this test unconditional once the minimum supported version of
+    # google-api-core becomes 2.19.0 or higher.
+    api_core_major, api_core_minor = [int(part) for part in api_core_version.__version__.split(".")[0:2]]
+    if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 19):
+        client = {{ service.client_name }}(credentials=ga_credentials.AnonymousCredentials(), transport=transport_name)
+        # Mock the actual call within the gRPC stub, and fake the request.
+        with mock.patch.object(
+                type(client.transport.{{ method.transport_safe_name|snake_case }}),
+                '__call__'
+            ) as call:
+                client.{{ method_name }}()
+
+        # Establish that the api version header was sent.
+        _, _, kw = call.mock_calls[0]
+        assert kw['metadata'][0] == (version_header.API_VERSION_METADATA_KEY, "{{ service.version }}")
+    else:
+        pytest.skip("google-api-core>=2.19.0 is required for `google.api_core.version_header`")
+{% endif %}{# service.version #}
+
 {% if not method.client_streaming %}
 def test_{{ method_name }}_empty_call():
     # This test is a coverage failsafe to make sure that totally empty calls,
@@ -904,9 +940,9 @@ def test_{{ method_name }}_pager(transport_name: str = "grpc"):
             RuntimeError,
         )
 
-        metadata = ()
+        expected_metadata = ()
         {% if method.field_headers %}
-        metadata = tuple(metadata) + (
+        expected_metadata = tuple(expected_metadata) + (
             gapic_v1.routing_header.to_grpc_metadata((
                 {% for field_header in method.field_headers %}
                 {% if not method.client_streaming %}
@@ -918,7 +954,13 @@ def test_{{ method_name }}_pager(transport_name: str = "grpc"):
         {% endif %}
         pager = client.{{ method_name }}(request={})
 
-        assert pager._metadata == metadata
+        {% if service.version %}
+        if version_header:
+            expected_metadata = tuple(expected_metadata) + (
+                version_header.to_api_version_header("{{ service.version }}"),
+            )
+        {% endif %}
+        assert pager._metadata == expected_metadata
 
         results = list(pager)
         assert len(results) == 6

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

@@ -183,12 +183,7 @@
         )
         {% endif %} {# method.explicit_routing #}
 
-        {% if service.version %}
-        metadata = tuple(metadata) + (
-            gapic_v1.version_header.to_grpc_metadata("{{ service.version }}"),
-        )
-        {% endif %}
-
+{{ add_api_version_header_to_metadata(service) }}
 {{ auto_populate_uuid4_fields(api, method) }}
 
         # Validate the universe domain.
@@ -297,3 +292,21 @@
 {% endif %}{# if method_settings is not none #}
 {% endwith %}{# method_settings #}
 {% endmacro %}
+
+{% macro add_api_version_header_to_metadata(service) %}
+{#
+    Add API Version to metadata as per https://github.com/aip-dev/google.aip.dev/pull/1331.
+    When using this macro, ensure the calling template
+    generates the following lines:
+        try:
+            from google.api_core import version_header
+        except ImportError:
+            version_header = None
+#}
+    {% if service.version %}
+        if version_header:
+            metadata = tuple(metadata) + (
+                version_header.to_api_version_header("{{ service.version }}"),
+            )
+    {% endif %}{# service.version #}
+{% endmacro %}

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

@@ -24,6 +24,11 @@ from google.api_core import retry_async as retries
 from google.auth import credentials as ga_credentials   # type: ignore
 from google.oauth2 import service_account              # type: ignore
 
+try:
+    from google.api_core import version_header
+except ImportError:
+    version_header = None
+
 try:
     OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None]
 except AttributeError:  # pragma: NO COVER
@@ -391,12 +396,7 @@ class {{ service.async_client_name }}:
         )
         {% endif %}
 
-        {% if service.version %}
-        metadata = tuple(metadata) + (
-            gapic_v1.version_header.to_grpc_metadata("{{ service.version }}")
-        )
-        {% endif %}
-
+{{ macros.add_api_version_header_to_metadata(service) }}
 {{ macros.auto_populate_uuid4_fields(api, method) }}
 
         # Validate the universe domain.

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

@@ -31,6 +31,11 @@ from google.auth.transport.grpc import SslCredentials             # type: ignore
 from google.auth.exceptions import MutualTLSChannelError          # type: ignore
 from google.oauth2 import service_account                         # type: ignore
 
+try:
+    from google.api_core import version_header
+except ImportError:
+    version_header = None
+
 try:
     OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
 except AttributeError:  # pragma: NO COVER

gapic/templates/setup.py.j2

@@ -30,8 +30,7 @@ else:
     release_status = "Development Status :: 5 - Production/Stable"
 
 dependencies = [
-    "google-api-core[grpc] @ git+https://github.com/googleapis/python-api-core.git@add-api-version-header",
-    #"google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
+    "google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
     # Exclude incompatible versions of `google-auth`
     # See https://github.com/googleapis/google-cloud-python/issues/12364
     "google-auth >= 2.14.1, <3.0.0dev,!=2.24.0,!=2.25.0",

gapic/templates/testing/_default_constraints.j2

@@ -3,6 +3,7 @@
 # List all library dependencies and extras in this file.
 proto-plus
 protobuf
+google-api-core
 {% for package_tuple, package_info in pypi_packages.items() %}
 {# Quick check to make sure the package is different from this setup.py #}
 {% if api.naming.warehouse_package_name != package_info.package_name %}

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

@@ -77,6 +77,10 @@ from google.iam.v1 import options_pb2  # type: ignore
 from google.iam.v1 import policy_pb2  # type: ignore
 {% endif %}
 {% endfilter %}
+try:
+    from google.api_core import version_header
+except ImportError:
+    version_header = None
 
 
 def client_cert_source_callback():
@@ -178,6 +182,49 @@ def test__get_api_endpoint():
         {{ service.client_name }}._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto")
     assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com."
 
+{% if service.version %}
+{% for method in service.methods.values() %}{% with method_name = method.name|snake_case %}
+{% for mode in ["", "async"] %}
+{% if mode == "async" %}
+async def test_{{ method_name }}_api_version_header_async(transport_name="grpc"):
+    client = {{ service.async_client_name }}(credentials=ga_credentials.AnonymousCredentials(), transport=transport_name)
+{% else %}
+@pytest.mark.parametrize("transport_name", [
+    {% if 'grpc' in opts.transport %}
+    ("grpc"),
+    {% endif %}
+    {% if 'rest' in opts.transport %}
+    ("rest"),
+    {% endif %}
+])
+def test_{{ method_name }}_api_version_header(transport_name):
+    client = {{ service.client_name }}(credentials=ga_credentials.AnonymousCredentials(), transport=transport_name)
+{% endif %}
+    # TODO: Make this test unconditional once the minimum supported version of
+    # google-api-core becomes 2.19.0 or higher.
+    api_core_major, api_core_minor = [int(part) for part in api_core_version.__version__.split(".")[0:2]]
+    if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 19):
+        # Mock the actual call within the gRPC stub, and fake the request.
+        with mock.patch.object(
+                type(client.transport.{{ method.transport_safe_name|snake_case }}),
+                '__call__'
+            ) as call:
+            {% if mode == "async" %}
+                await client.{{ method_name }}()
+            {% else %}
+                client.{{ method_name }}()
+            {% endif %}
+
+        # Establish that the api version header was sent.
+        _, _, kw = call.mock_calls[0]
+        assert kw['metadata'][0] == (gapic_v1.version_header.API_VERSION_METADATA_KEY, "{{ service.version }}")
+    else:
+        pytest.skip("google-api-core>=2.19.0 is required for `google.api_core.version_header`")
+{% endfor %}{# mode #}
+{% endwith %}
+{% endfor %}
+{% endif %}{# service.version #}
+
 def test__get_universe_domain():
     client_universe_domain = "foo.com"
     universe_domain_env = "bar.com"

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

@@ -121,32 +121,6 @@ def test_{{ method_name }}(request_type, transport: str = 'grpc'):
     {% endif %}
     {% endwith %}{# auto_populated_field_sample_value #}
 
-{% if service.version %}
-{% for mode in ["", "async"] %}
-{% if mode == "async" %}
-async def test_{{ method_name }}_api_version_header_async():
-    client = {{ service.async_client_name }}(credentials=ga_credentials.AnonymousCredentials())
-{% else %}
-def test_{{ method_name }}_api_version_header():
-    client = {{ service.client_name }}(credentials=ga_credentials.AnonymousCredentials())
-{% endif %}
-    # Mock the actual call within the gRPC stub, and fake the request.
-    with mock.patch.object(
-            type(client.transport.{{ method.transport_safe_name|snake_case }}),
-            '__call__'
-        ) as call:
-        {% if mode == "async" %}
-            await client.{{ method_name }}()
-        {% else %}
-            client.{{ method_name }}()
-        {% endif %}
-
-    # Establish that the api version header was sent.
-    _, _, kw = call.mock_calls[0]
-    assert kw['metadata'][0] == (gapic_v1.version_header.API_VERSION_METADATA_KEY, "{{ service.version }}")
-{% endfor %}{# mode #}
-{% endif %}{# service.version #}
-
 {% if not method.client_streaming %}
 def test_{{ method_name }}_empty_call():
     # This test is a coverage failsafe to make sure that totally empty calls,
@@ -776,9 +750,9 @@ def test_{{ method_name }}_pager(transport_name: str = "grpc"):
             RuntimeError,
         )
 
-        metadata = ()
+        expected_metadata = ()
         {% if not method.explicit_routing and method.field_headers %}
-        metadata = tuple(metadata) + (
+        expected_metadata = tuple(expected_metadata) + (
             gapic_v1.routing_header.to_grpc_metadata((
                 {% for field_header in method.field_headers %}
                 {% if not method.client_streaming %}
@@ -788,9 +762,15 @@ def test_{{ method_name }}_pager(transport_name: str = "grpc"):
             )),
         )
         {% endif %}
+        {% if service.version %}
+        if version_header:
+            expected_metadata = tuple(expected_metadata) + (
+                version_header.to_api_version_header("{{ service.version }}"),
+            )
+        {% endif %}
         pager = client.{{ method_name }}(request={})
 
-        assert pager._metadata == metadata
+        assert pager._metadata == expected_metadata
 
         results = list(pager)
         assert len(results) == 6

noxfile.py

@@ -189,7 +189,7 @@ def showcase_library(
     session.log("-" * 70)
 
     # Install gapic-generator-python
-    session.install("-e", ".")
+    session.install("-e", ".", "--no-cache-dir")
 
     # Install grpcio-tools for protoc
     session.install("grpcio-tools")
@@ -266,12 +266,12 @@ def showcase_library(
             f"{tmp_dir}/testing/constraints-{session.python}.txt"
             )
             # Install the library with a constraints file.
-            session.install("-e", tmp_dir, "-r", constraints_path)
+            session.install("-e", tmp_dir, "-r", constraints_path, "--no-cache-dir")
         else:
             # The ads templates do not have constraints files.
             # See https://github.com/googleapis/gapic-generator-python/issues/1788
             # Install the library without a constraints file.
-            session.install("-e", tmp_dir)
+            session.install("-e", tmp_dir, "--no-cache-dir")
         yield tmp_dir
 
 

setup.py

@@ -28,8 +28,7 @@
     # Ensure that the lower bounds of these dependencies match what we have in the
     # templated setup.py.j2: https://github.com/googleapis/gapic-generator-python/blob/main/gapic/templates/setup.py.j2
     "click >= 6.7",
-    "google-api-core @ git+https://github.com/googleapis/python-api-core.git@add-api-version-header",
-    #"google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
+    "google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
     "googleapis-common-protos >= 1.55.0",
     "grpcio >= 1.24.3",
     # 2.11.0 is required which adds the `default` argument to `jinja-filters.map()`