Skip to content
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

feat: add support for GOOGLE_CLOUD_UNIVERSE_DOMAIN env var #1221

Merged
merged 2 commits into from
Jan 10, 2025
Merged

feat: add support for GOOGLE_CLOUD_UNIVERSE_DOMAIN env var #1221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
498f0f2
feat: add support for GOOGLE_CLOUD_UNIVERSE_DOMAIN env var
jackwotherspoon Jan 10, 2025
8a76d06
chore: add mypy ignore
jackwotherspoon Jan 10, 2025
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
7 changes: 6 additions & 1 deletion google/cloud/sql/connector/connector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import asyncio
from functools import partial
import logging
import os
from threading import Thread
from types import TracebackType
from typing import Any, Optional, Union
Expand Down Expand Up @@ -171,7 +172,11 @@ def __init__(
if isinstance(ip_type, str):
ip_type = IPTypes._from_str(ip_type)
self._ip_type = ip_type
self._universe_domain = universe_domain
# check for universe domain arg and then env var
if universe_domain:
self._universe_domain = universe_domain
else:
self._universe_domain = os.environ.get("GOOGLE_CLOUD_UNIVERSE_DOMAIN") # type: ignore
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to have # type: ignore here as os.environ.get has weird type hinting

was causing mypy check to complain during lint:

google/cloud/sql/connector/connector.py:179: error: Incompatible types in assignment (expression has type "Optional[str]", variable has type "str")  [assignment]

# construct service endpoint for Cloud SQL Admin API calls
if not sqladmin_api_endpoint:
self._sqladmin_api_endpoint = (
Expand Down
23 changes: 23 additions & 0 deletions tests/unit/test_connector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"""

import asyncio
import os
from typing import Union

from aiohttp import ClientResponseError
Expand Down Expand Up @@ -428,3 +429,25 @@ def test_configured_universe_domain_mismatched_credentials(
"is the default."
)
assert exc_info.value.args[0] == err_msg


def test_configured_universe_domain_env_var(
fake_credentials: Credentials,
) -> None:
"""Test that configured universe domain succeeds with universe
domain set via GOOGLE_CLOUD_UNIVERSE_DOMAIN env var.
"""
universe_domain = "test-universe.test"
# set fake credentials to be configured for the universe domain
fake_credentials._universe_domain = universe_domain
# set environment variable
os.environ["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] = universe_domain
# Note: we are not passing universe_domain arg, env var should set it
with Connector(credentials=fake_credentials) as connector:
# test universe domain was configured
assert connector._universe_domain == universe_domain
# test property and service endpoint construction
assert connector.universe_domain == universe_domain
assert connector._sqladmin_api_endpoint == f"https://sqladmin.{universe_domain}"
# unset env var
del os.environ["GOOGLE_CLOUD_UNIVERSE_DOMAIN"]
Loading