Skip to content

Commit

Permalink
fix: enable self signed jwt for grpc (#217)
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 7ad4780 commit 46d9c8c
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 37 deletions.
4 changes: 4 additions & 0 deletions packages/google-cloud-speech/google/cloud/speech_v1/services/speech/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,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 recognize(
Expand Down
4 changes: 4 additions & 0 deletions packages/google-cloud-speech/google/cloud/speech_v1p1beta1/services/adaptation/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,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 create_phrase_set(
Expand Down
4 changes: 4 additions & 0 deletions packages/google-cloud-speech/google/cloud/speech_v1p1beta1/services/speech/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,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 recognize(
Expand Down
31 changes: 18 additions & 13 deletions packages/google-cloud-speech/tests/unit/gapic/speech_v1/test_speech.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,33 +112,28 @@ def test_speech_client_from_service_account_info(client_class):
assert client.transport._host == "speech.googleapis.com:443"


@pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient,])
def test_speech_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.SpeechGrpcTransport, "grpc"),
(transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"),
],
)
def test_speech_client_service_account_always_use_jwt_true(
transport_class, transport_name
):
def test_speech_client_service_account_always_use_jwt(transport_class, transport_name):
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=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", [SpeechClient, SpeechAsyncClient,])
def test_speech_client_from_service_account_file(client_class):
Expand Down Expand Up @@ -207,6 +202,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -223,6 +219,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -239,6 +236,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -267,6 +265,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -329,6 +328,7 @@ def test_speech_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 @@ -362,6 +362,7 @@ def test_speech_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 @@ -383,6 +384,7 @@ def test_speech_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 All @@ -409,6 +411,7 @@ def test_speech_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 All @@ -435,6 +438,7 @@ def test_speech_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 @@ -452,6 +456,7 @@ def test_speech_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-speech/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,24 +115,14 @@ def test_adaptation_client_from_service_account_info(client_class):
assert client.transport._host == "speech.googleapis.com:443"


@pytest.mark.parametrize("client_class", [AdaptationClient, AdaptationAsyncClient,])
def test_adaptation_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.AdaptationGrpcTransport, "grpc"),
(transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"),
],
)
def test_adaptation_client_service_account_always_use_jwt_true(
def test_adaptation_client_service_account_always_use_jwt(
transport_class, transport_name
):
with mock.patch.object(
Expand All @@ -142,6 +132,13 @@ def test_adaptation_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", [AdaptationClient, AdaptationAsyncClient,])
def test_adaptation_client_from_service_account_file(client_class):
Expand Down Expand Up @@ -218,6 +215,7 @@ def test_adaptation_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 @@ -234,6 +232,7 @@ def test_adaptation_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 @@ -250,6 +249,7 @@ def test_adaptation_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 @@ -278,6 +278,7 @@ def test_adaptation_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 @@ -342,6 +343,7 @@ def test_adaptation_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 @@ -375,6 +377,7 @@ def test_adaptation_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 @@ -396,6 +399,7 @@ def test_adaptation_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 @@ -426,6 +430,7 @@ def test_adaptation_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 @@ -456,6 +461,7 @@ def test_adaptation_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 @@ -473,6 +479,7 @@ def test_adaptation_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
31 changes: 18 additions & 13 deletions packages/google-cloud-speech/tests/unit/gapic/speech_v1p1beta1/test_speech.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,33 +116,28 @@ def test_speech_client_from_service_account_info(client_class):
assert client.transport._host == "speech.googleapis.com:443"


@pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient,])
def test_speech_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.SpeechGrpcTransport, "grpc"),
(transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"),
],
)
def test_speech_client_service_account_always_use_jwt_true(
transport_class, transport_name
):
def test_speech_client_service_account_always_use_jwt(transport_class, transport_name):
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=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", [SpeechClient, SpeechAsyncClient,])
def test_speech_client_from_service_account_file(client_class):
Expand Down Expand Up @@ -211,6 +206,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -227,6 +223,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -243,6 +240,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -271,6 +269,7 @@ def test_speech_client_client_options(client_class, transport_class, transport_n
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 @@ -333,6 +332,7 @@ def test_speech_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 @@ -366,6 +366,7 @@ def test_speech_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 @@ -387,6 +388,7 @@ def test_speech_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 All @@ -413,6 +415,7 @@ def test_speech_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 All @@ -439,6 +442,7 @@ def test_speech_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 @@ -456,6 +460,7 @@ def test_speech_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 46d9c8c

Please sign in to comment.