Skip to content

Commit

Permalink
fix: enable self signed jwt for grpc (#113)
Browse files Browse the repository at this point in the history 
PiperOrigin-RevId: 386504689

Source-Link: googleapis/googleapis@762094a

Source-Link: googleapis/googleapis-gen@6bfc480
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] authored Jul 24, 2021
1 parent f51342a commit 7ac3d28
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 22 deletions.
4 changes: 4 additions & 0 deletions packages/google-cloud-trace/google/cloud/trace_v1/services/trace_service/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,10 @@ def __init__(
client_cert_source_for_mtls=client_cert_source_func,
quota_project_id=client_options.quota_project_id,
client_info=client_info,
always_use_jwt_access=(
Transport == type(self).get_transport_class("grpc")
or Transport == type(self).get_transport_class("grpc_asyncio")
),
)

def list_traces(
Expand Down
4 changes: 4 additions & 0 deletions packages/google-cloud-trace/google/cloud/trace_v2/services/trace_service/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,10 @@ def __init__(
client_cert_source_for_mtls=client_cert_source_func,
quota_project_id=client_options.quota_project_id,
client_info=client_info,
always_use_jwt_access=(
Transport == type(self).get_transport_class("grpc")
or Transport == type(self).get_transport_class("grpc_asyncio")
),
)

def batch_write_spans(
Expand Down
29 changes: 18 additions & 11 deletions packages/google-cloud-trace/tests/unit/gapic/trace_v1/test_trace_service.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,24 +114,14 @@ def test_trace_service_client_from_service_account_info(client_class):
assert client.transport._host == "cloudtrace.googleapis.com:443"


@pytest.mark.parametrize("client_class", [TraceServiceClient, TraceServiceAsyncClient,])
def test_trace_service_client_service_account_always_use_jwt(client_class):
with mock.patch.object(
service_account.Credentials, "with_always_use_jwt_access", create=True
) as use_jwt:
creds = service_account.Credentials(None, None, None)
client = client_class(credentials=creds)
use_jwt.assert_not_called()


@pytest.mark.parametrize(
"transport_class,transport_name",
[
(transports.TraceServiceGrpcTransport, "grpc"),
(transports.TraceServiceGrpcAsyncIOTransport, "grpc_asyncio"),
],
)
def test_trace_service_client_service_account_always_use_jwt_true(
def test_trace_service_client_service_account_always_use_jwt(
transport_class, transport_name
):
with mock.patch.object(
Expand All @@ -141,6 +131,13 @@ def test_trace_service_client_service_account_always_use_jwt_true(
transport = transport_class(credentials=creds, always_use_jwt_access=True)
use_jwt.assert_called_once_with(True)

with mock.patch.object(
service_account.Credentials, "with_always_use_jwt_access", create=True
) as use_jwt:
creds = service_account.Credentials(None, None, None)
transport = transport_class(credentials=creds, always_use_jwt_access=False)
use_jwt.assert_not_called()


@pytest.mark.parametrize("client_class", [TraceServiceClient, TraceServiceAsyncClient,])
def test_trace_service_client_from_service_account_file(client_class):
Expand Down Expand Up @@ -217,6 +214,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is
Expand All @@ -233,6 +231,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is
Expand All @@ -249,6 +248,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has
Expand Down Expand Up @@ -277,6 +277,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id="octopus",
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down Expand Up @@ -341,6 +342,7 @@ def test_trace_service_client_mtls_env_auto(
client_cert_source_for_mtls=expected_client_cert_source,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case ADC client cert is provided. Whether client cert is used depends on
Expand Down Expand Up @@ -374,6 +376,7 @@ def test_trace_service_client_mtls_env_auto(
client_cert_source_for_mtls=expected_client_cert_source,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case client_cert_source and ADC client cert are not provided.
Expand All @@ -395,6 +398,7 @@ def test_trace_service_client_mtls_env_auto(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down Expand Up @@ -425,6 +429,7 @@ def test_trace_service_client_client_options_scopes(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down Expand Up @@ -455,6 +460,7 @@ def test_trace_service_client_client_options_credentials_file(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand All @@ -472,6 +478,7 @@ def test_trace_service_client_client_options_from_dict():
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down
29 changes: 18 additions & 11 deletions packages/google-cloud-trace/tests/unit/gapic/trace_v2/test_trace_service.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,24 +117,14 @@ def test_trace_service_client_from_service_account_info(client_class):
assert client.transport._host == "cloudtrace.googleapis.com:443"


@pytest.mark.parametrize("client_class", [TraceServiceClient, TraceServiceAsyncClient,])
def test_trace_service_client_service_account_always_use_jwt(client_class):
with mock.patch.object(
service_account.Credentials, "with_always_use_jwt_access", create=True
) as use_jwt:
creds = service_account.Credentials(None, None, None)
client = client_class(credentials=creds)
use_jwt.assert_not_called()


@pytest.mark.parametrize(
"transport_class,transport_name",
[
(transports.TraceServiceGrpcTransport, "grpc"),
(transports.TraceServiceGrpcAsyncIOTransport, "grpc_asyncio"),
],
)
def test_trace_service_client_service_account_always_use_jwt_true(
def test_trace_service_client_service_account_always_use_jwt(
transport_class, transport_name
):
with mock.patch.object(
Expand All @@ -144,6 +134,13 @@ def test_trace_service_client_service_account_always_use_jwt_true(
transport = transport_class(credentials=creds, always_use_jwt_access=True)
use_jwt.assert_called_once_with(True)

with mock.patch.object(
service_account.Credentials, "with_always_use_jwt_access", create=True
) as use_jwt:
creds = service_account.Credentials(None, None, None)
transport = transport_class(credentials=creds, always_use_jwt_access=False)
use_jwt.assert_not_called()


@pytest.mark.parametrize("client_class", [TraceServiceClient, TraceServiceAsyncClient,])
def test_trace_service_client_from_service_account_file(client_class):
Expand Down Expand Up @@ -220,6 +217,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is
Expand All @@ -236,6 +234,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is
Expand All @@ -252,6 +251,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has
Expand Down Expand Up @@ -280,6 +280,7 @@ def test_trace_service_client_client_options(
client_cert_source_for_mtls=None,
quota_project_id="octopus",
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down Expand Up @@ -344,6 +345,7 @@ def test_trace_service_client_mtls_env_auto(
client_cert_source_for_mtls=expected_client_cert_source,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case ADC client cert is provided. Whether client cert is used depends on
Expand Down Expand Up @@ -377,6 +379,7 @@ def test_trace_service_client_mtls_env_auto(
client_cert_source_for_mtls=expected_client_cert_source,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)

# Check the case client_cert_source and ADC client cert are not provided.
Expand All @@ -398,6 +401,7 @@ def test_trace_service_client_mtls_env_auto(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down Expand Up @@ -428,6 +432,7 @@ def test_trace_service_client_client_options_scopes(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down Expand Up @@ -458,6 +463,7 @@ def test_trace_service_client_client_options_credentials_file(
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand All @@ -475,6 +481,7 @@ def test_trace_service_client_client_options_from_dict():
client_cert_source_for_mtls=None,
quota_project_id=None,
client_info=transports.base.DEFAULT_CLIENT_INFO,
always_use_jwt_access=True,
)


Expand Down

0 comments on commit 7ac3d28

Please sign in to comment.