Skip to content

fix(gapic): mock os.path.exists in mTLS tests to support newer google auth #17807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chalmerlowe merged 5 commits into from
Jul 21, 2026
Merged

fix(gapic): mock os.path.exists in mTLS tests to support newer google auth #17807

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9c0671b
fix(gapic): mock os.path.exists in mTLS tests to support newer google…
chalmerlowe Jul 21, 2026
926a96f
fix(gapic): use safer mock for os.path.exists in mTLS tests
chalmerlowe Jul 21, 2026
908faf5
chore(gapic): update goldens to match generator output
chalmerlowe Jul 21, 2026
1e9a162
chore(gapic): update eventarc golden to match generator output
chalmerlowe Jul 21, 2026
6106653
chore(gapic): update credentials golden to match generator output
chalmerlowe Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions .../gapic-generator/gapic/templates/tests/unit/gapic/%name_%version/%sub/test_%service.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ def test__get_default_mtls_endpoint():

def test__read_environment_variables():
assert {{ service.client_name }}._read_environment_variables() == (False, "auto", None)

with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}):
assert {{ service.client_name }}._read_environment_variables() == (True, "auto", None)

with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}):
assert {{ service.client_name }}._read_environment_variables() == (False, "auto", None)

with mock.patch.dict(
os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}
):
Expand All @@ -200,10 +200,10 @@ def test__read_environment_variables():

with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}):
assert {{ service.client_name }}._read_environment_variables() == (False, "never", None)

with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}):
assert {{ service.client_name }}._read_environment_variables() == (False, "always", None)

with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}):
assert {{ service.client_name }}._read_environment_variables() == (False, "auto", None)

Expand Down Expand Up @@ -293,7 +293,7 @@ def test_use_client_cert_effective():
assert {{ service.client_name }}._use_client_cert_effective() is False

# Test case 12: Test when `should_use_client_cert` is available and the
# `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is unset. Also,
# `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is unset. Also,
# the GOOGLE_API_CONFIG environment variable is unset.
if hasattr(google.auth.transport.mtls, "should_use_client_cert"):
with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": ""}):
Expand All @@ -303,7 +303,7 @@ def test_use_client_cert_effective():
def test__get_client_cert_source():
mock_provided_cert_source = mock.Mock()
mock_default_cert_source = mock.Mock()

assert {{ service.client_name }}._get_client_cert_source(None, False) is None
assert {{ service.client_name }}._get_client_cert_source(mock_provided_cert_source, False) is None
assert {{ service.client_name }}._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source
Expand Down Expand Up @@ -867,7 +867,7 @@ def test_{{ service.client_name|snake_case }}_get_mtls_endpoint_and_cert_source(
)
assert api_endpoint == mock_api_endpoint
assert cert_source is None

# Test cases for mTLS enablement when GOOGLE_API_USE_CLIENT_CERTIFICATE is unset.
test_cases = [
(
Expand Down Expand Up @@ -900,7 +900,7 @@ def test_{{ service.client_name|snake_case }}_get_mtls_endpoint_and_cert_source(
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
Comment thread
chalmerlowe marked this conversation as resolved.
Outdated
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -929,10 +929,10 @@ def test_{{ service.client_name|snake_case }}_get_mtls_endpoint_and_cert_source(
},
},
mock_client_cert_source,
),
),
(
# With workloads not present in config, mTLS is disabled.
{
{
"version": 1,
"cert_configs": {},
},
Expand All @@ -947,7 +947,7 @@ def test_{{ service.client_name|snake_case }}_get_mtls_endpoint_and_cert_source(
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
Comment thread
chalmerlowe marked this conversation as resolved.
Outdated
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -994,7 +994,7 @@ def test_{{ service.client_name|snake_case }}_get_mtls_endpoint_and_cert_source(
with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}):
with pytest.raises(MutualTLSChannelError) as excinfo:
client_class.get_mtls_endpoint_and_cert_source()

assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"

@pytest.mark.parametrize("client_class", [
Expand Down Expand Up @@ -1059,7 +1059,7 @@ def test_{{ service.client_name|snake_case }}_client_api_endpoint(client_class):
with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}):
client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials())
assert client.api_endpoint == default_endpoint


@pytest.mark.parametrize("client_class,transport_class,transport_name", [
{% if 'grpc' in opts.transport %}
Expand Down
4 changes: 2 additions & 2 deletions ...generator/tests/integration/goldens/asset/tests/unit/gapic/asset_v1/test_asset_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,7 @@ def test_asset_service_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -747,7 +747,7 @@ def test_asset_service_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...s/integration/goldens/credentials/tests/unit/gapic/credentials_v1/test_iam_credentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ def test_iam_credentials_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -737,7 +737,7 @@ def test_iam_credentials_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...enerator/tests/integration/goldens/eventarc/tests/unit/gapic/eventarc_v1/test_eventarc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ def test_eventarc_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -768,7 +768,7 @@ def test_eventarc_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...r/tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_config_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ def test_config_service_v2_client_get_mtls_endpoint_and_cert_source(client_class
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -725,7 +725,7 @@ def test_config_service_v2_client_get_mtls_endpoint_and_cert_source(client_class
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions .../tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_logging_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@ def test_logging_service_v2_client_get_mtls_endpoint_and_cert_source(client_clas
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -726,7 +726,7 @@ def test_logging_service_v2_client_get_mtls_endpoint_and_cert_source(client_clas
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions .../tests/integration/goldens/logging/tests/unit/gapic/logging_v2/test_metrics_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ def test_metrics_service_v2_client_get_mtls_endpoint_and_cert_source(client_clas
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -724,7 +724,7 @@ def test_metrics_service_v2_client_get_mtls_endpoint_and_cert_source(client_clas
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...ntegration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_config_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ def test_base_config_service_v2_client_get_mtls_endpoint_and_cert_source(client_
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -725,7 +725,7 @@ def test_base_config_service_v2_client_get_mtls_endpoint_and_cert_source(client_
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...tegration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_logging_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,7 +679,7 @@ def test_logging_service_v2_client_get_mtls_endpoint_and_cert_source(client_clas
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -726,7 +726,7 @@ def test_logging_service_v2_client_get_mtls_endpoint_and_cert_source(client_clas
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...tegration/goldens/logging_internal/tests/unit/gapic/logging_v2/test_metrics_service_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ def test_base_metrics_service_v2_client_get_mtls_endpoint_and_cert_source(client
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -724,7 +724,7 @@ def test_base_metrics_service_v2_client_get_mtls_endpoint_and_cert_source(client
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...c-generator/tests/integration/goldens/redis/tests/unit/gapic/redis_v1/test_cloud_redis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ def test_cloud_redis_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -755,7 +755,7 @@ def test_cloud_redis_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
4 changes: 2 additions & 2 deletions ...r/tests/integration/goldens/redis_selective/tests/unit/gapic/redis_v1/test_cloud_redis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ def test_cloud_redis_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down Expand Up @@ -755,7 +755,7 @@ def test_cloud_redis_client_get_mtls_endpoint_and_cert_source(client_class):
config_filename = "mock_certificate_config.json"
config_file_content = json.dumps(config_data)
m = mock.mock_open(read_data=config_file_content)
with mock.patch("builtins.open", m):
with mock.patch("builtins.open", m), mock.patch("os.path.exists", return_value=True):
with mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": config_filename}
):
Expand Down
Loading
Loading