Skip to content
This repository was archived by the owner on Nov 12, 2025. It is now read-only.

fix: Disable universe-domain validation #839

Merged
parthea merged 5 commits into from
Nov 15, 2024
Merged

fix: Disable universe-domain validation #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
781b6f0
chore: Update gapic-generator-python to v1.20.0
gcf-owl-bot[bot] Oct 23, 2024
b40c409
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Oct 23, 2024
44f6140
chore: Update gapic-generator-python to v1.20.2
gcf-owl-bot[bot] Oct 31, 2024
a4524ac
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Oct 31, 2024
0199fbc
Merge branch 'main' into owl-bot-copy
parthea Nov 15, 2024
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
40 changes: 3 additions & 37 deletions google/cloud/bigquery_storage_v1/services/big_query_read/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,36 +508,6 @@ def _get_universe_domain(
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain

@staticmethod
def _compare_universes(
client_universe: str, credentials: ga_credentials.Credentials
) -> bool:
"""Returns True iff the universe domains used by the client and credentials match.

Args:
client_universe (str): The universe domain configured via the client options.
credentials (ga_credentials.Credentials): The credentials being used in the client.

Returns:
bool: True iff client_universe matches the universe in credentials.

Raises:
ValueError: when client_universe does not match the universe in credentials.
"""

default_universe = BigQueryReadClient._DEFAULT_UNIVERSE
credentials_universe = getattr(credentials, "universe_domain", default_universe)

if client_universe != credentials_universe:
raise ValueError(
"The configured universe domain "
f"({client_universe}) does not match the universe domain "
f"found in the credentials ({credentials_universe}). "
"If you haven't configured the universe domain explicitly, "
f"`{default_universe}` is the default."
)
return True

def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.

Expand All @@ -547,13 +517,9 @@ def _validate_universe_domain(self):
Raises:
ValueError: If the configured universe domain is not valid.
"""
self._is_universe_domain_valid = (
self._is_universe_domain_valid
or BigQueryReadClient._compare_universes(
self.universe_domain, self.transport._credentials
)
)
return self._is_universe_domain_valid

# NOTE (b/349488459): universe validation is disabled until further notice.
return True

@property
def api_endpoint(self):
Expand Down
40 changes: 3 additions & 37 deletions google/cloud/bigquery_storage_v1/services/big_query_write/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -492,36 +492,6 @@ def _get_universe_domain(
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain

@staticmethod
def _compare_universes(
client_universe: str, credentials: ga_credentials.Credentials
) -> bool:
"""Returns True iff the universe domains used by the client and credentials match.

Args:
client_universe (str): The universe domain configured via the client options.
credentials (ga_credentials.Credentials): The credentials being used in the client.

Returns:
bool: True iff client_universe matches the universe in credentials.

Raises:
ValueError: when client_universe does not match the universe in credentials.
"""

default_universe = BigQueryWriteClient._DEFAULT_UNIVERSE
credentials_universe = getattr(credentials, "universe_domain", default_universe)

if client_universe != credentials_universe:
raise ValueError(
"The configured universe domain "
f"({client_universe}) does not match the universe domain "
f"found in the credentials ({credentials_universe}). "
"If you haven't configured the universe domain explicitly, "
f"`{default_universe}` is the default."
)
return True

def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.

Expand All @@ -531,13 +501,9 @@ def _validate_universe_domain(self):
Raises:
ValueError: If the configured universe domain is not valid.
"""
self._is_universe_domain_valid = (
self._is_universe_domain_valid
or BigQueryWriteClient._compare_universes(
self.universe_domain, self.transport._credentials
)
)
return self._is_universe_domain_valid

# NOTE (b/349488459): universe validation is disabled until further notice.
return True

@property
def api_endpoint(self):
Expand Down
40 changes: 3 additions & 37 deletions google/cloud/bigquery_storage_v1alpha/services/metastore_partition_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,36 +490,6 @@ def _get_universe_domain(
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain

@staticmethod
def _compare_universes(
client_universe: str, credentials: ga_credentials.Credentials
) -> bool:
"""Returns True iff the universe domains used by the client and credentials match.

Args:
client_universe (str): The universe domain configured via the client options.
credentials (ga_credentials.Credentials): The credentials being used in the client.

Returns:
bool: True iff client_universe matches the universe in credentials.

Raises:
ValueError: when client_universe does not match the universe in credentials.
"""

default_universe = MetastorePartitionServiceClient._DEFAULT_UNIVERSE
credentials_universe = getattr(credentials, "universe_domain", default_universe)

if client_universe != credentials_universe:
raise ValueError(
"The configured universe domain "
f"({client_universe}) does not match the universe domain "
f"found in the credentials ({credentials_universe}). "
"If you haven't configured the universe domain explicitly, "
f"`{default_universe}` is the default."
)
return True

def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.

Expand All @@ -529,13 +499,9 @@ def _validate_universe_domain(self):
Raises:
ValueError: If the configured universe domain is not valid.
"""
self._is_universe_domain_valid = (
self._is_universe_domain_valid
or MetastorePartitionServiceClient._compare_universes(
self.universe_domain, self.transport._credentials
)
)
return self._is_universe_domain_valid

# NOTE (b/349488459): universe validation is disabled until further notice.
return True

@property
def api_endpoint(self):
Expand Down
40 changes: 3 additions & 37 deletions google/cloud/bigquery_storage_v1beta2/services/big_query_read/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,36 +511,6 @@ def _get_universe_domain(
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain

@staticmethod
def _compare_universes(
client_universe: str, credentials: ga_credentials.Credentials
) -> bool:
"""Returns True iff the universe domains used by the client and credentials match.

Args:
client_universe (str): The universe domain configured via the client options.
credentials (ga_credentials.Credentials): The credentials being used in the client.

Returns:
bool: True iff client_universe matches the universe in credentials.

Raises:
ValueError: when client_universe does not match the universe in credentials.
"""

default_universe = BigQueryReadClient._DEFAULT_UNIVERSE
credentials_universe = getattr(credentials, "universe_domain", default_universe)

if client_universe != credentials_universe:
raise ValueError(
"The configured universe domain "
f"({client_universe}) does not match the universe domain "
f"found in the credentials ({credentials_universe}). "
"If you haven't configured the universe domain explicitly, "
f"`{default_universe}` is the default."
)
return True

def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.

Expand All @@ -550,13 +520,9 @@ def _validate_universe_domain(self):
Raises:
ValueError: If the configured universe domain is not valid.
"""
self._is_universe_domain_valid = (
self._is_universe_domain_valid
or BigQueryReadClient._compare_universes(
self.universe_domain, self.transport._credentials
)
)
return self._is_universe_domain_valid

# NOTE (b/349488459): universe validation is disabled until further notice.
return True

@property
def api_endpoint(self):
Expand Down
40 changes: 3 additions & 37 deletions google/cloud/bigquery_storage_v1beta2/services/big_query_write/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,36 +493,6 @@ def _get_universe_domain(
raise ValueError("Universe Domain cannot be an empty string.")
return universe_domain

@staticmethod
def _compare_universes(
client_universe: str, credentials: ga_credentials.Credentials
) -> bool:
"""Returns True iff the universe domains used by the client and credentials match.

Args:
client_universe (str): The universe domain configured via the client options.
credentials (ga_credentials.Credentials): The credentials being used in the client.

Returns:
bool: True iff client_universe matches the universe in credentials.

Raises:
ValueError: when client_universe does not match the universe in credentials.
"""

default_universe = BigQueryWriteClient._DEFAULT_UNIVERSE
credentials_universe = getattr(credentials, "universe_domain", default_universe)

if client_universe != credentials_universe:
raise ValueError(
"The configured universe domain "
f"({client_universe}) does not match the universe domain "
f"found in the credentials ({credentials_universe}). "
"If you haven't configured the universe domain explicitly, "
f"`{default_universe}` is the default."
)
return True

def _validate_universe_domain(self):
"""Validates client's and credentials' universe domains are consistent.

Expand All @@ -532,13 +502,9 @@ def _validate_universe_domain(self):
Raises:
ValueError: If the configured universe domain is not valid.
"""
self._is_universe_domain_valid = (
self._is_universe_domain_valid
or BigQueryWriteClient._compare_universes(
self.universe_domain, self.transport._credentials
)
)
return self._is_universe_domain_valid

# NOTE (b/349488459): universe validation is disabled until further notice.
return True

@property
def api_endpoint(self):
Expand Down
2 changes: 1 addition & 1 deletion samples/generated_samples/snippet_metadata_google.cloud.bigquery.storage.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-bigquery-storage",
"version": "2.27.0"
Copy link
Contributor

@tswast tswast Oct 28, 2024

Choose a reason for hiding this comment

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

@parthea Is it OK for these to go backward?

Copy link
Contributor

@parthea parthea Nov 15, 2024

Choose a reason for hiding this comment

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

Yes, these will be updated in the release PR

"version": "0.1.0"
},
"snippets": [
{
Expand Down
2 changes: 1 addition & 1 deletion samples/generated_samples/snippet_metadata_google.cloud.bigquery.storage.v1beta2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-bigquery-storage",
"version": "2.27.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
79 changes: 0 additions & 79 deletions tests/unit/gapic/bigquery_storage_v1/test_big_query_read.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,85 +298,6 @@ def test__get_universe_domain():
assert str(excinfo.value) == "Universe Domain cannot be an empty string."


@pytest.mark.parametrize(
"client_class,transport_class,transport_name",
[
(BigQueryReadClient, transports.BigQueryReadGrpcTransport, "grpc"),
],
)
def test__validate_universe_domain(client_class, transport_class, transport_name):
client = client_class(
transport=transport_class(credentials=ga_credentials.AnonymousCredentials())
)
assert client._validate_universe_domain() == True

# Test the case when universe is already validated.
assert client._validate_universe_domain() == True

if transport_name == "grpc":
# Test the case where credentials are provided by the
# `local_channel_credentials`. The default universes in both match.
channel = grpc.secure_channel(
"http://localhost/", grpc.local_channel_credentials()
)
client = client_class(transport=transport_class(channel=channel))
assert client._validate_universe_domain() == True

# Test the case where credentials do not exist: e.g. a transport is provided
# with no credentials. Validation should still succeed because there is no
# mismatch with non-existent credentials.
channel = grpc.secure_channel(
"http://localhost/", grpc.local_channel_credentials()
)
transport = transport_class(channel=channel)
transport._credentials = None
client = client_class(transport=transport)
assert client._validate_universe_domain() == True

# TODO: This is needed to cater for older versions of google-auth
# Make this test unconditional once the minimum supported version of
# google-auth becomes 2.23.0 or higher.
google_auth_major, google_auth_minor = [
int(part) for part in google.auth.__version__.split(".")[0:2]
]
if google_auth_major > 2 or (google_auth_major == 2 and google_auth_minor >= 23):
credentials = ga_credentials.AnonymousCredentials()
credentials._universe_domain = "foo.com"
# Test the case when there is a universe mismatch from the credentials.
client = client_class(transport=transport_class(credentials=credentials))
with pytest.raises(ValueError) as excinfo:
client._validate_universe_domain()
assert (
str(excinfo.value)
== "The configured universe domain (googleapis.com) does not match the universe domain found in the credentials (foo.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default."
)

# Test the case when there is a universe mismatch from the client.
#
# TODO: Make this test unconditional once the minimum supported version of
# google-api-core becomes 2.15.0 or higher.
api_core_major, api_core_minor = [
int(part) for part in api_core_version.__version__.split(".")[0:2]
]
if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 15):
client = client_class(
client_options={"universe_domain": "bar.com"},
transport=transport_class(
credentials=ga_credentials.AnonymousCredentials(),
),
)
with pytest.raises(ValueError) as excinfo:
client._validate_universe_domain()
assert (
str(excinfo.value)
== "The configured universe domain (bar.com) does not match the universe domain found in the credentials (googleapis.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default."
)

# Test that ValueError is raised if universe_domain is provided via client options and credentials is None
with pytest.raises(ValueError):
client._compare_universes("foo.bar", None)


@pytest.mark.parametrize(
"client_class,transport_name",
[
Expand Down
Loading