tests: add showcase tests for reading grpc/rest response metadata #2300

parthea · 2024-12-17T16:53:27Z

This PR adds showcase integration tests for reading response metadata using the following matrix: [(gRPC, REST), (sync , async)]
This PR depends on #2370.

vchudnov-g · 2024-12-17T19:03:16Z

tests/system/conftest.py

+        self.request_metadata = []
+        self.response_metadata = []
+
+    async def _add_metadata(self, client_call_details):


Suggested change

async def _add_metadata(self, client_call_details):

async def _add_request_metadata(self, client_call_details):

fixed in e302dc7

vchudnov-g · 2024-12-17T19:12:13Z

tests/system/conftest.py

+        response_it = continuation(client_call_details, request)
+        return response_it
+
+    async def intercept_stream_unary(


We should use more descriptive names to differentiate this method from the previous one. I realize previously existing classes established this pattern, but we should clarify.

This is not something that we can change as it's an abstract method in gRPC that we're overriding

https://grpc.github.io/grpc/python/grpc.html#grpc.StreamUnaryClientInterceptor.intercept_stream_unary

Ack. Too bad.

vchudnov-g · 2024-12-17T19:14:44Z

tests/system/conftest.py

+        return response_it
+
+
+class MetadataClienRestInterceptor(EchoRestInterceptor):


I would clarify in the name that this is for the echo service

Suggested change

class MetadataClienRestInterceptor(EchoRestInterceptor):

class EchoMetadataClienRestInterceptor(EchoRestInterceptor):

Fixed in 1ae8aaa

vchudnov-g · 2024-12-17T19:16:10Z

tests/system/conftest.py

+
+
+@pytest.fixture
+def intercepted_echo_grpc_async():


Put the two grpc fixtures next to each other?

Fixed in 7147a58

vchudnov-g · 2024-12-17T19:17:48Z

tests/system/conftest.py

+
+
+@pytest.fixture
+def intercepted_echo_rest():


We're waiting for REST async or can we test that now?

Fixed in 05f6c65

vchudnov-g · 2024-12-17T19:20:15Z

tests/system/test_grpc_interceptor_streams.py



-def test_unary_stream(intercepted_echo):
+def test_unary_stream(intercepted_echo_grpc):


Do we want to test async grpc here?

Fixed in 05f6c65

vchudnov-g · 2024-12-17T19:38:56Z

tests/system/test_response_metadata.py

+
+
+@pytest.mark.parametrize(
+    "transport,response_metadata",


How do the interceptors used int his file know about the response metadata they should be injecting? Or is this real response metadata from Showcase? I'm not finding it by doing a search n the Showcase repo.

The interceptors aren't injecting anything here. There is a feature of the echo rpc which adds response headers(metadata) with the X-Showcase-Request prefix automatically for REST , using information from the request. This was added in googleapis/gapic-showcase#1509. For gRPC, I believe this feature was added in googleapis/gapic-showcase#970

vchudnov-g

One q.

vchudnov-g · 2025-03-28T16:51:15Z

tests/system/conftest.py

+        response_it = continuation(client_call_details, request)
+        return response_it
+
+    async def intercept_stream_unary(


Ack. Too bad.

vchudnov-g · 2025-03-28T17:08:18Z

tests/system/conftest.py

+@pytest.fixture
+def intercepted_echo_grpc_async():
+    # The interceptor adds 'showcase-trailer' client metadata. Showcase server
+    # echos any metadata with key 'showcase-trailer', so the same metadata


nit: sp. Above as well

Suggested change

# echos any metadata with key 'showcase-trailer', so the same metadata

# echoes any metadata with key 'showcase-trailer', so the same metadata

Fixed in 6495273

feat: Add REST Interceptors to support reading metadata

fbaff28

product-auto-label bot added the size: m Pull request size is medium. label Dec 17, 2024

tests: add showcase tests for reading grpc/rest call metadata

a48fc54

parthea force-pushed the add-showcase-test-rest-interceptors-metadata branch from 4d0f596 to a48fc54 Compare December 17, 2024 17:07

parthea marked this pull request as ready for review December 17, 2024 17:07

parthea requested a review from a team as a code owner December 17, 2024 17:07

blunderbuss-gcf bot assigned vchudnov-g Dec 17, 2024

vchudnov-g reviewed Dec 17, 2024

View reviewed changes

Base automatically changed from add-rest-response-metadata to main December 18, 2024 18:57

parthea assigned parthea and unassigned vchudnov-g Dec 18, 2024

parthea marked this pull request as draft January 29, 2025 11:51

parthea added 6 commits March 22, 2025 07:05

Merge branch 'main' into add-showcase-test-rest-interceptors-metadata

ef98679

Merge branch 'main' into add-showcase-test-rest-interceptors-metadata

3559bcb

_add_metadata->_add_request_metadata

e302dc7

MetadataClienRestInterceptor->EchoMetadataClientRestInterceptor

1ae8aaa

refactor

7147a58

add async rest tests

05f6c65

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Mar 22, 2025

parthea added 3 commits March 22, 2025 13:40

lint

6c94ecc

build: remove showcase integration tests ads

1e92f71

also remove usage in github action

cfd1717

parthea added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 23, 2025

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 23, 2025

update copyright year

b3287ac

parthea marked this pull request as ready for review March 24, 2025 14:24

Merge branch 'main' into add-showcase-test-rest-interceptors-metadata

fd0bb03

parthea assigned vchudnov-g and unassigned parthea Mar 25, 2025

parthea assigned ohmayr Mar 25, 2025

vchudnov-g approved these changes Mar 28, 2025

View reviewed changes

fix typo

6495273

parthea enabled auto-merge (squash) March 28, 2025 20:26

parthea merged commit 7542410 into main Mar 28, 2025
121 checks passed

parthea deleted the add-showcase-test-rest-interceptors-metadata branch March 28, 2025 20:30

	async def _add_metadata(self, client_call_details):
	async def _add_request_metadata(self, client_call_details):

		return response_it


		class MetadataClienRestInterceptor(EchoRestInterceptor):

	class MetadataClienRestInterceptor(EchoRestInterceptor):
	class EchoMetadataClienRestInterceptor(EchoRestInterceptor):



		def test_unary_stream(intercepted_echo):
		def test_unary_stream(intercepted_echo_grpc):

	# echos any metadata with key 'showcase-trailer', so the same metadata
	# echoes any metadata with key 'showcase-trailer', so the same metadata



		@pytest.mark.parametrize(
		"transport,response_metadata",

tests: add showcase tests for reading grpc/rest response metadata #2300

tests: add showcase tests for reading grpc/rest response metadata #2300

Uh oh!

Conversation

parthea commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

parthea Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vchudnov-g left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

parthea commented Dec 17, 2024 •

edited

Loading

parthea Mar 24, 2025 •

edited

Loading