feat(storage): add bucket IP filtering samples and tests by nidhiii-27 · Pull Request #14594 · GoogleCloudPlatform/python-docs-samples

nidhiii-27 · 2026-09-09T07:35:58Z

Add Python code samples and tests demonstrating Cloud Storage Bucket IP filtering.

Fixes: b/544985518

[Generated-by: AI]

Add Python code samples and tests demonstrating Cloud Storage Bucket IP filtering. Fixes: b/544985518 [Generated-by: AI]

gemini-code-assist

Code Review

This pull request introduces Python code snippets and tests demonstrating Google Cloud Storage bucket IP filtering features, including creating, enabling, disabling, retrieving, listing, and deleting IP filtering rules. The review feedback highlights several potential bugs and improvement opportunities: handling potential IndexError exceptions when executing the scripts from the command line without arguments, defensively checking for None values to avoid TypeError exceptions on list operations, and refactoring direct self-assignments to prevent linter warnings or accidental code removal that would break the SDK's change registration.

Address review feedback regarding self-assignment, defensive None checks, and CLI arg handling. [Generated-by: AI]

snippet-bot · 2026-09-09T08:53:46Z

Here is the summary of changes.

You are about to add 6 region tags.

storage/samples/snippets/storage_create_bucket_ip_filtering.py:19, tag storage_create_bucket_ip_filtering
storage/samples/snippets/storage_delete_ip_filtering_rules.py:19, tag storage_delete_ip_filtering_rules
storage/samples/snippets/storage_disable_ip_filtering.py:19, tag storage_disable_ip_filtering
storage/samples/snippets/storage_enable_ip_filtering.py:19, tag storage_enable_ip_filtering
storage/samples/snippets/storage_get_ip_filtering.py:19, tag storage_get_ip_filtering
storage/samples/snippets/storage_list_buckets_ip_filtering.py:17, tag storage_list_buckets_ip_filtering

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

chandra-siri · 2026-09-22T11:29:42Z

why all the kokoro tests are failing ?

nidhiii-27 · 2026-09-23T06:07:19Z

why all the kokoro tests are failing ?

The kokoro configs have been disabled hence these tests do not run at all.

shradhakatyal

Blocking dependency issue (storage/samples/snippets/requirements.txt):
storage/samples/snippets/requirements.txt currently pins google-cloud-storage==3.1.0, which predates google.cloud.storage.ip_filter (added in 3.3.0). Please bump google-cloud-storage to >=3.3.0 (e.g., 3.14.1) so nox tests do not fail with ModuleNotFoundError.

[Generated-by: AI]

shradhakatyal

Thank you for addressing the previous inline feedback. Please resolve the remaining dependency version issue in requirements.txt and the inline comments below.

Blocking dependency issue (storage/samples/snippets/requirements.txt):
storage/samples/snippets/requirements.txt currently pins google-cloud-storage==3.1.0. The google.cloud.storage.ip_filter module was added in version 3.3.0. Without updating this dependency, nox test sessions will fail with ModuleNotFoundError.

shradhakatyal · 2026-10-07T08:25:05Z

+from google.cloud import storage
+import pytest
+
+import storage_create_bucket_ip_filtering


storage/samples/snippets/requirements.txt currently pins google-cloud-storage==3.1.0. The google.cloud.storage.ip_filter module was introduced in version 3.3.0. Please update storage/samples/snippets/requirements.txt to 3.14.1 so nox tests do not fail with ModuleNotFoundError:

-google-cloud-storage==3.1.0 +google-cloud-storage==3.14.1

shradhakatyal · 2026-10-07T08:25:05Z

+    assert (
+        public_range
+        not in modified.ip_filter.public_network_source.allowed_ip_cidr_ranges
+    )


When the last CIDR range is removed, the GCS API returns an empty publicNetworkSource object. In google-cloud-storage, IPFilter._from_api_resource() evaluates if public_network_source_data: on {} as False. This sets modified.ip_filter.public_network_source to None, which will raise an AttributeError here. Please check for None before accessing allowed_ip_cidr_ranges.

Suggested change

assert (

public_range

not in modified.ip_filter.public_network_source.allowed_ip_cidr_ranges

)

assert (

modified.ip_filter.public_network_source is None

or public_range

not in modified.ip_filter.public_network_source.allowed_ip_cidr_ranges

)

shradhakatyal · 2026-10-07T08:25:05Z

+    buckets = list(storage_client.list_buckets(projection="full"))
+
+    for bucket in buckets:
+        status = bucket.ip_filter.mode if bucket.ip_filter else "Not Configured"
+        print(f"Bucket: {bucket.name}, IP Filter Mode: {status}")


The default noAcl projection in list_buckets() already returns the summarized ipFilter configuration, including mode. Using projection="full" unnecessarily fetches ACL metadata for every bucket and requires extra IAM permissions. Also, please guard against bucket.ip_filter.mode being None.

Suggested change

buckets = list(storage_client.list_buckets(projection="full"))

for bucket in buckets:

status = bucket.ip_filter.mode if bucket.ip_filter else "Not Configured"

print(f"Bucket: {bucket.name}, IP Filter Mode: {status}")

buckets = list(storage_client.list_buckets())

for bucket in buckets:

status = (

bucket.ip_filter.mode

if bucket.ip_filter and bucket.ip_filter.mode

else "Not Configured"

)

print(f"Bucket: {bucket.name}, IP Filter Mode: {status}")

shradhakatyal · 2026-10-07T08:25:05Z

+    if ip_filter.public_network_source is None:
+        ip_filter.public_network_source = PublicNetworkSource(allowed_ip_cidr_ranges=[])
+    elif ip_filter.public_network_source.allowed_ip_cidr_ranges is None:
+        ip_filter.public_network_source.allowed_ip_cidr_ranges = []
+
+    if (
+        public_range
+        and public_range not in ip_filter.public_network_source.allowed_ip_cidr_ranges
+    ):
+        ip_filter.public_network_source.allowed_ip_cidr_ranges.append(public_range)


Nit: Currently, ip_filter.public_network_source is initialized to an empty PublicNetworkSource even when public_range is empty. This sends "publicNetworkSource": {"allowedIpCidrRanges": []} in the PATCH payload when only VPC rules are configured. Please move the initialization inside if public_range: to match the vpc_network handling below.

Suggested change

if ip_filter.public_network_source is None:

ip_filter.public_network_source = PublicNetworkSource(allowed_ip_cidr_ranges=[])

elif ip_filter.public_network_source.allowed_ip_cidr_ranges is None:

ip_filter.public_network_source.allowed_ip_cidr_ranges = []

if (

public_range

and public_range not in ip_filter.public_network_source.allowed_ip_cidr_ranges

):

ip_filter.public_network_source.allowed_ip_cidr_ranges.append(public_range)

if public_range:

if ip_filter.public_network_source is None:

ip_filter.public_network_source = PublicNetworkSource(

allowed_ip_cidr_ranges=[]

)

elif ip_filter.public_network_source.allowed_ip_cidr_ranges is None:

ip_filter.public_network_source.allowed_ip_cidr_ranges = []

if (

public_range

not in ip_filter.public_network_source.allowed_ip_cidr_ranges

):

ip_filter.public_network_source.allowed_ip_cidr_ranges.append(

public_range

)

feat(storage): add bucket IP filtering samples and tests

9813072

Add Python code samples and tests demonstrating Cloud Storage Bucket IP filtering. Fixes: b/544985518 [Generated-by: AI]

nidhiii-27 added the ai-generated label Sep 9, 2026

product-auto-label Bot added api: storage Issues related to the Cloud Storage API. samples Issues that are directly related to samples. labels Sep 9, 2026

gemini-code-assist Bot reviewed Sep 9, 2026

View reviewed changes

fix(storage): resolve review comments for bucket IP filtering

b015d30

Address review feedback regarding self-assignment, defensive None checks, and CLI arg handling. [Generated-by: AI]

nidhiii-27 marked this pull request as ready for review September 9, 2026 08:53

nidhiii-27 requested review from a team as code owners September 9, 2026 08:53

blunderbuss-gcf Bot assigned vsharonlynn Sep 9, 2026

nidhiii-27 requested a review from chandra-siri September 21, 2026 08:37

shradhakatyal reviewed Sep 28, 2026

View reviewed changes

fix(storage): address reviewer comments on bucket IP filter samples

044145c

[Generated-by: AI]

nidhiii-27 requested a review from shradhakatyal September 28, 2026 10:57

shradhakatyal reviewed Oct 7, 2026

View reviewed changes

Conversation

nidhiii-27 commented Sep 9, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

snippet-bot Bot commented Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chandra-siri commented Sep 22, 2026

Uh oh!

nidhiii-27 commented Sep 23, 2026

Uh oh!

shradhakatyal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shradhakatyal left a comment

Choose a reason for hiding this comment

Uh oh!

shradhakatyal Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

shradhakatyal Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

shradhakatyal Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

shradhakatyal Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

snippet-bot Bot commented Sep 9, 2026 •

edited

Loading