From a18fe2a4fe3dff4550687c0853aee351b54596de Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Sat, 24 Jul 2021 10:16:29 +0000 Subject: [PATCH] fix: enable self signed jwt for grpc (#116) PiperOrigin-RevId: 386504689 Source-Link: https://github.com/googleapis/googleapis/commit/762094a99ac6e03a17516b13dfbef37927267a70 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6bfc480e1a161d5de121c2bcc3745885d33b265a --- .../services/cloud_scheduler/client.py | 4 +++ .../services/cloud_scheduler/client.py | 4 +++ .../scheduler_v1/test_cloud_scheduler.py | 31 +++++++++++-------- .../scheduler_v1beta1/test_cloud_scheduler.py | 31 +++++++++++-------- 4 files changed, 44 insertions(+), 26 deletions(-) diff --git a/google/cloud/scheduler_v1/services/cloud_scheduler/client.py b/google/cloud/scheduler_v1/services/cloud_scheduler/client.py index 90fc419c..4acfa2a5 100644 --- a/google/cloud/scheduler_v1/services/cloud_scheduler/client.py +++ b/google/cloud/scheduler_v1/services/cloud_scheduler/client.py @@ -364,6 +364,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_jobs( diff --git a/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py b/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py index 84eda1a6..5ad0ba01 100644 --- a/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py +++ b/google/cloud/scheduler_v1beta1/services/cloud_scheduler/client.py @@ -364,6 +364,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_jobs( diff --git a/tests/unit/gapic/scheduler_v1/test_cloud_scheduler.py b/tests/unit/gapic/scheduler_v1/test_cloud_scheduler.py index ca4a095d..5920820c 100644 --- a/tests/unit/gapic/scheduler_v1/test_cloud_scheduler.py +++ b/tests/unit/gapic/scheduler_v1/test_cloud_scheduler.py @@ -126,18 +126,6 @@ def test_cloud_scheduler_client_from_service_account_info(client_class): assert client.transport._host == "cloudscheduler.googleapis.com:443" -@pytest.mark.parametrize( - "client_class", [CloudSchedulerClient, CloudSchedulerAsyncClient,] -) -def test_cloud_scheduler_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", [ @@ -145,7 +133,7 @@ def test_cloud_scheduler_client_service_account_always_use_jwt(client_class): (transports.CloudSchedulerGrpcAsyncIOTransport, "grpc_asyncio"), ], ) -def test_cloud_scheduler_client_service_account_always_use_jwt_true( +def test_cloud_scheduler_client_service_account_always_use_jwt( transport_class, transport_name ): with mock.patch.object( @@ -155,6 +143,13 @@ def test_cloud_scheduler_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", [CloudSchedulerClient, CloudSchedulerAsyncClient,] @@ -235,6 +230,7 @@ def test_cloud_scheduler_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 @@ -251,6 +247,7 @@ def test_cloud_scheduler_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 @@ -267,6 +264,7 @@ def test_cloud_scheduler_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 @@ -295,6 +293,7 @@ def test_cloud_scheduler_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, ) @@ -361,6 +360,7 @@ def test_cloud_scheduler_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 @@ -394,6 +394,7 @@ def test_cloud_scheduler_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. @@ -415,6 +416,7 @@ def test_cloud_scheduler_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, ) @@ -445,6 +447,7 @@ def test_cloud_scheduler_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, ) @@ -475,6 +478,7 @@ def test_cloud_scheduler_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, ) @@ -494,6 +498,7 @@ def test_cloud_scheduler_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, ) diff --git a/tests/unit/gapic/scheduler_v1beta1/test_cloud_scheduler.py b/tests/unit/gapic/scheduler_v1beta1/test_cloud_scheduler.py index 7db0b9ca..db127721 100644 --- a/tests/unit/gapic/scheduler_v1beta1/test_cloud_scheduler.py +++ b/tests/unit/gapic/scheduler_v1beta1/test_cloud_scheduler.py @@ -128,18 +128,6 @@ def test_cloud_scheduler_client_from_service_account_info(client_class): assert client.transport._host == "cloudscheduler.googleapis.com:443" -@pytest.mark.parametrize( - "client_class", [CloudSchedulerClient, CloudSchedulerAsyncClient,] -) -def test_cloud_scheduler_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", [ @@ -147,7 +135,7 @@ def test_cloud_scheduler_client_service_account_always_use_jwt(client_class): (transports.CloudSchedulerGrpcAsyncIOTransport, "grpc_asyncio"), ], ) -def test_cloud_scheduler_client_service_account_always_use_jwt_true( +def test_cloud_scheduler_client_service_account_always_use_jwt( transport_class, transport_name ): with mock.patch.object( @@ -157,6 +145,13 @@ def test_cloud_scheduler_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", [CloudSchedulerClient, CloudSchedulerAsyncClient,] @@ -237,6 +232,7 @@ def test_cloud_scheduler_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 @@ -253,6 +249,7 @@ def test_cloud_scheduler_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 @@ -269,6 +266,7 @@ def test_cloud_scheduler_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 @@ -297,6 +295,7 @@ def test_cloud_scheduler_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, ) @@ -363,6 +362,7 @@ def test_cloud_scheduler_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 @@ -396,6 +396,7 @@ def test_cloud_scheduler_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. @@ -417,6 +418,7 @@ def test_cloud_scheduler_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, ) @@ -447,6 +449,7 @@ def test_cloud_scheduler_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, ) @@ -477,6 +480,7 @@ def test_cloud_scheduler_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, ) @@ -496,6 +500,7 @@ def test_cloud_scheduler_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, )