test(generator): sandbox verification of spec-driven telemetry compliance tests

.github/workflows/gapic-generator-tests.yml

@@ -73,7 +73,7 @@ jobs:
         with:
           python-version: "${{ matrix.python }}"
           allow-prereleases: true
-          # Caches compiled wheels locally to prevent building heavy libraries 
+          # Caches compiled wheels locally to prevent building heavy libraries
           # such as grpcio, which we build from scratch on every run for Python 3.15+.
           # Follow https://github.com/grpc/grpc/issues/41010 for updates.
           cache: 'pip'
@@ -94,6 +94,40 @@ jobs:
           cd packages/gapic-generator
           nox -s showcase_unit${{ matrix.variant }}-${MATRIX_PYTHON}
 
+  showcase-system:
+    needs: python_config
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
+        with:
+          python-version: "3.10"
+          cache: 'pip'
+          cache-dependency-path: '**/requirements*.txt'
+      - name: Install System Deps & Protoc
+        run: |
+          sudo apt-get update && sudo apt-get install -y curl pandoc unzip
+          sudo mkdir -p /usr/src/protoc/ && sudo chown -R ${USER} /usr/src/
+          curl --location https://github.com/google/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-x86_64.zip --output /usr/src/protoc/protoc.zip
+          cd /usr/src/protoc/ && unzip protoc.zip
+          sudo ln -s /usr/src/protoc/bin/protoc /usr/local/bin/protoc
+      - name: Install & Run Showcase Daemon
+        run: |
+          sudo mkdir -p /usr/src/showcase && sudo chown -R ${USER} /usr/src/
+          curl --location https://github.com/googleapis/gapic-showcase/releases/download/v${SHOWCASE_VERSION}/gapic-showcase-${SHOWCASE_VERSION}-linux-amd64.tar.gz --output /usr/src/showcase/showcase.tar.gz
+          cd /usr/src/showcase/ && tar -xf showcase.tar.gz
+          ./gapic-showcase run &
+          sleep 2
+          curl -s http://localhost:7469/ > /dev/null || true
+      - name: Run Showcase System Tests
+        run: |
+          pip install nox
+          cd packages/gapic-generator
+          nox -s showcase-3.10 -- -v -s tests/system
+
   showcase-mypy:
     needs: python_config
     runs-on: ubuntu-latest
@@ -159,7 +193,7 @@ jobs:
         with:
           python-version: ${{ needs.python_config.outputs.prerelease_python }}
           allow-prereleases: true
-          # Caches compiled wheels locally to prevent building heavy libraries 
+          # Caches compiled wheels locally to prevent building heavy libraries
           # such as grpcio, which we build from scratch on every run for Python 3.15+.
           # Follow https://github.com/grpc/grpc/issues/41010 for updates.
           cache: 'pip'
@@ -189,7 +223,7 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
           allow-prereleases: true
-          # Caches compiled wheels locally to prevent building heavy libraries 
+          # Caches compiled wheels locally to prevent building heavy libraries
           # such as grpcio, which we build from scratch on every run for Python 3.15+.
           # Follow https://github.com/grpc/grpc/issues/41010 for updates.
           cache: 'pip'
@@ -234,16 +268,16 @@ jobs:
 
       - name: Run Bazel Integration Tests
         run: |
-          # We need to move into the package directory if the 
+          # We need to move into the package directory if the
           # WORKSPACE file is located there.
           cd packages/gapic-generator
           bazelisk test //tests/integration/... --test_output=errors
 
   # Final job to simplify branch protection rules.
-  # This job will be reported as 'Success' if all its dependencies either 
+  # This job will be reported as 'Success' if all its dependencies either
   # pass or are skipped due to path filtering.
   status:
-    needs: [check_changes, python_config, showcase-unit, showcase-mypy, goldens, goldens-prerelease, fragment-snippet, integration]
+    needs: [check_changes, python_config, showcase-unit, showcase-system, showcase-mypy, goldens, goldens-prerelease, fragment-snippet, integration]
     if: always()
     runs-on: ubuntu-latest
     steps:
@@ -261,4 +295,3 @@ jobs:
             exit 1
           fi
           echo "All checks passed or were successfully skipped."
-

.gitignore

@@ -55,6 +55,7 @@ venv/
 # Test logs
 coverage.xml
 *sponge_log.xml
+raw_spans_output*.json
 
 # System test environment variables.
 **/system_tests/local_test_setup
@@ -72,3 +73,6 @@ bazel-bin
 bazel-gapic-generator
 bazel-out
 bazel-testlogs
+
+# Telemetry raw spans dump
+raw_spans_output-*.json

.pre-commit-config.yaml

@@ -14,6 +14,7 @@
 #
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+exclude: '^packages/gapic-generator/tests/integration/goldens/'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0

packages/gapic-generator/gapic/schema/mixins.py

@@ -19,50 +19,60 @@
         "DeleteOperation",
         request_type="operations_pb2.DeleteOperationRequest",
         response_type="None",
+        rpc_name="google.longrunning.Operations/DeleteOperation",
     ),
     "WaitOperation": wrappers.MixinMethod(
         "WaitOperation",
         request_type="operations_pb2.WaitOperationRequest",
         response_type="operations_pb2.Operation",
+        rpc_name="google.longrunning.Operations/WaitOperation",
     ),
     "ListOperations": wrappers.MixinMethod(
         "ListOperations",
         request_type="operations_pb2.ListOperationsRequest",
         response_type="operations_pb2.ListOperationsResponse",
+        rpc_name="google.longrunning.Operations/ListOperations",
     ),
     "CancelOperation": wrappers.MixinMethod(
         "CancelOperation",
         request_type="operations_pb2.CancelOperationRequest",
         response_type="None",
+        rpc_name="google.longrunning.Operations/CancelOperation",
     ),
     "GetOperation": wrappers.MixinMethod(
         "GetOperation",
         request_type="operations_pb2.GetOperationRequest",
         response_type="operations_pb2.Operation",
+        rpc_name="google.longrunning.Operations/GetOperation",
     ),
     "TestIamPermissions": wrappers.MixinMethod(
         "TestIamPermissions",
         request_type="iam_policy_pb2.TestIamPermissionsRequest",
         response_type="iam_policy_pb2.TestIamPermissionsResponse",
+        rpc_name="google.iam.v1.IAMPolicy/TestIamPermissions",
     ),
     "GetIamPolicy": wrappers.MixinMethod(
         "GetIamPolicy",
         request_type="iam_policy_pb2.GetIamPolicyRequest",
         response_type="policy_pb2.Policy",
+        rpc_name="google.iam.v1.IAMPolicy/GetIamPolicy",
     ),
     "SetIamPolicy": wrappers.MixinMethod(
         "SetIamPolicy",
         request_type="iam_policy_pb2.SetIamPolicyRequest",
         response_type="policy_pb2.Policy",
+        rpc_name="google.iam.v1.IAMPolicy/SetIamPolicy",
     ),
     "ListLocations": wrappers.MixinMethod(
         "ListLocations",
         request_type="locations_pb2.ListLocationsRequest",
         response_type="locations_pb2.ListLocationsResponse",
+        rpc_name="google.cloud.location.Locations/ListLocations",
     ),
     "GetLocation": wrappers.MixinMethod(
         "GetLocation",
         request_type="locations_pb2.GetLocationRequest",
         response_type="locations_pb2.Location",
+        rpc_name="google.cloud.location.Locations/GetLocation",
     ),
 }

packages/gapic-generator/gapic/schema/wrappers.py

@@ -1463,6 +1463,8 @@ class MixinMethod:
     name: str
     request_type: str
     response_type: str
+    rpc_name: str = ""
+
 
 
 @dataclasses.dataclass(frozen=True)

packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/_compat.py.j2

@@ -5,14 +5,15 @@
 """A compatibility module for older versions of google-api-core."""
 {% set has_auto_populated_fields = api.all_method_settings.values()|map(attribute="auto_populated_fields", default=[])|select|list %}
 {# TODO(https://github.com/googleapis/google-cloud-python/issues/17813):
-Clean up this file/functions when the minimum supported version of 
+Clean up this file/functions when the minimum supported version of
 google-api-core has the functions in `_compat.py.j2`. #}
-{# TODO(https://github.com/googleapis/google-cloud-python/issues/17884): 
-Add conditional logic to check if static code exists in google-api-core and use it from there, 
+{# TODO(https://github.com/googleapis/google-cloud-python/issues/17884):
+Add conditional logic to check if static code exists in google-api-core and use it from there,
 falling back to the local implementation if not present. #}
-{# TODO(https://github.com/googleapis/google-cloud-python/issues/17883): 
+{# TODO(https://github.com/googleapis/google-cloud-python/issues/17883):
 Backfill compatibility functions being removed from the client layer. #}
 
+import contextlib
 import os
 import json
 {% if has_auto_populated_fields %}
@@ -23,9 +24,6 @@ import google.protobuf.message
 from typing import Any, Dict, List, Optional, Tuple
 {% if has_auto_populated_fields %}
 from typing import TYPE_CHECKING, Union
-
-if TYPE_CHECKING:  # pragma: NO COVER
-    import proto  # type: ignore[import-untyped]
 {% endif %}
 
 from google.api_core import path_template
@@ -34,9 +32,37 @@ from google.auth.exceptions import MutualTLSChannelError
 from google.protobuf import json_format
 from urllib.parse import urlparse, urlunparse
 
+{% if has_auto_populated_fields %}
+if TYPE_CHECKING:  # pragma: NO COVER
+    import proto  # type: ignore[import-untyped]
+{% endif %}
+
+# The _observability module was introduced in google-api-core 2.36.0+.
+# On older versions of google-api-core or when type-checking against them,
+# mypy may flag attr-defined or assignment errors when fallback to None occurs.
+try:
+    from google.api_core import _observability  # type: ignore[attr-defined]
+except ImportError:  # pragma: NO COVER
+    _observability = None  # type: ignore[assignment]
+
+if _observability is not None and hasattr(_observability, "trace_http_request"):
+    trace_http_request = _observability.trace_http_request
+else:  # pragma: NO COVER
+    # Fallback for older versions of google-api-core without HTTP tracing.
+    @contextlib.contextmanager
+    def trace_http_request(*args: Any, **kwargs: Any):
+        yield None
+
+if _observability is not None and hasattr(_observability, "record_http_response"):
+    record_http_response = _observability.record_http_response
+else:  # pragma: NO COVER
+    # Fallback for older versions of google-api-core without HTTP tracing.
+    def record_http_response(span: Any, response: Any) -> None:
+        pass
+
 try:
     # note: `#type: ignore` is added because the return type for `should_use_client_cert`
-    # is different than that of the fallback implementation below. This will be removed once 
+    # is different than that of the fallback implementation below. This will be removed once
     # we bump the minimum supported version of google-auth.
     from google.auth.transport.mtls import should_use_client_cert  # type: ignore
 except ImportError:  # pragma: NO COVER