chore(secretmanager): Add samples for deleting secret annotations and updating annotation and label args #13511

durgesh-ninave-crest · 2025-07-18T10:21:12Z

Description

Created samples for Global and Regional Secret Manager API

Samples

Delete Secret Annotation
Delete Regional Secret Annotations

Also, fixed the TypeError in some samples by changing the initialization of labels and annotations from a set to a dictionary.

Checklist

I have followed Sample Guidelines from AUTHORING_GUIDE.MD
README is updated to include all relevant information
Tests pass: nox -s py-3.9 (see Test Environment Setup)
Lint pass: nox -s lint (see Test Environment Setup)
These samples need a new API enabled in testing projects to pass (let us know which ones)
These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
Please merge this PR for me once it is approved

gemini-code-assist

Summary of Changes

Hello @durgesh-ninave-crest, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the sample coverage for Google Cloud Secret Manager by introducing new Python examples that demonstrate advanced management of secret metadata, specifically focusing on labels and annotations. It also addresses a critical bug by correcting the data structure used for labels and annotations in several existing samples, improving their reliability and correctness.

Highlights

New Secret Manager Samples: I've added new Python samples for Google Cloud Secret Manager, specifically demonstrating how to edit secret labels and delete secret annotations. These samples cover both global and regional Secret Manager API interactions.
Bug Fix: TypeError in Samples: I've addressed a TypeError in several existing Secret Manager samples. The issue stemmed from labels and annotations being incorrectly initialized as sets ({key, value}) instead of dictionaries ({key: value}). This has been corrected across all affected samples.
Expanded Test Coverage: Corresponding unit tests have been added or updated in snippets_test.py and regional_samples/snippets_test.py to validate the functionality of the newly introduced samples for deleting annotations and editing labels.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

The pull request introduces new samples for managing secret labels and annotations in both global and regional Secret Manager APIs, and fixes a bug in existing samples related to TypeError on label and annotation initialization.

secretmanager/snippets/regional_samples/snippets_test.py

gemini-code-assist · 2025-07-18T10:23:37Z

secretmanager/snippets/snippets_test.py

+) -> None:
+    project_id, secret_id, _ = secret
+    delete_secret_annotation(project_id, secret_id, annotation_key)
+    with pytest.raises(exceptions.NotFound):
+        print(f"{client}")
+        name = f"projects/{project_id}/secrets/{secret_id}/versions/latest"
+        retry_client_access_secret_version(client, request={"name": name})


This test has a critical logical flaw. Deleting an annotation does not affect the secret or its versions, so checking for exceptions.NotFound when accessing a version is incorrect. The test currently passes only because the secret fixture doesn't create a version, so access_secret_version with the 'latest' alias fails.

The test should be updated to verify that the annotation is removed from the secret.

# Verify the annotation was deleted. secret_name = client.secret_path(project_id, secret_id) updated_secret = client.get_secret(request={"name": secret_name}) assert annotation_key not in updated_secret.annotations

@durgesh-ninave-crest can you please update, this was not addressed and we have marked this as resolved. Please add an assert statement to verify that the annotations were removed!

I've already added an assertion.

secretmanager/snippets/delete_secret_annotation.py

secretmanager/snippets/edit_secret_labels.py

secretmanager/snippets/regional_samples/delete_regional_secret_annotation.py

YashSaraf11 · 2025-07-21T03:45:02Z

This is not a feature, please use chore for future work!

Also please update the title of the pull request, since we are adding more than delete secrets annotation code samples here

snippet-bot · 2025-07-21T04:15:04Z

Here is the summary of changes.

You are about to add 2 region tags.

secretmanager/snippets/delete_secret_annotation.py:16, tag secretmanager_delete_secret_annotation
secretmanager/snippets/regional_samples/delete_regional_secret_annotation.py:16, tag secretmanager_delete_regional_secret_annotation

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

YashSaraf11

LGTM!

vipul7499 · 2025-07-22T04:49:27Z

secretmanager/snippets/regional_samples/snippets_test.py

@@ -469,6 +470,24 @@ def test_create_regional_secret_with_label(
    assert secret_id in secret.name


+def test_delete_regional_secret_annotation(


Can we add some asserts in the tests

I followed the pattern of the other delete test cases, which is why it was missing. I've added the necessary assertion to the tests.

The assert statement doesn't verify the functionality of the sample, we should assert to verify the operation performed.
Here you could have verified that after deleting the secret annotation, it should be null. Please update similarly at all other places.

I've updated the assertion to reflect the intended functionality of the sample.

The tests are missing assertion

YashSaraf11 · 2025-07-22T04:49:44Z

secretmanager/snippets/snippets_test.py

+) -> None:
+    project_id, secret_id, _ = secret
+    delete_secret_annotation(project_id, secret_id, annotation_key)
+    with pytest.raises(exceptions.NotFound):
+        print(f"{client}")
+        name = f"projects/{project_id}/secrets/{secret_id}/versions/latest"
+        retry_client_access_secret_version(client, request={"name": name})


@durgesh-ninave-crest can you please update, this was not addressed and we have marked this as resolved. Please add an assert statement to verify that the annotations were removed!

YashSaraf11 · 2025-07-25T04:37:33Z

secretmanager/snippets/regional_samples/snippets_test.py

@@ -469,6 +470,24 @@ def test_create_regional_secret_with_label(
    assert secret_id in secret.name


+def test_delete_regional_secret_annotation(


The assert statement doesn't verify the functionality of the sample, we should assert to verify the operation performed.
Here you could have verified that after deleting the secret annotation, it should be null. Please update similarly at all other places.

durgesh-ninave-crest added 2 commits July 18, 2025 15:40

feat(secretmanager): Added samples for labels and annotations

0943419

fix(secretmanager): Update arguments labels and annotations

7510de8

product-auto-label bot added api: secretmanager Issues related to the Secret Manager API. samples Issues that are directly related to samples. labels Jul 18, 2025

gemini-code-assist bot reviewed Jul 18, 2025

View reviewed changes

durgesh-ninave-crest added 2 commits July 18, 2025 16:15

fix(secretmanager): address gemini review comments

61486ed

fix(secretmanager): update samples and testcases

a129270

durgesh-ninave-crest changed the title ~~feat(secretmanager): Add samples for labels and annotations in Secret Manager~~ feat(secretmanager): Added samples for delete secret annotation in Secret Manager Jul 18, 2025

durgesh-ninave-crest changed the title ~~feat(secretmanager): Added samples for delete secret annotation in Secret Manager~~ chore(secretmanager): Add samples for deleting secret annotations and updating annotation and label args Jul 21, 2025

YashSaraf11 marked this pull request as ready for review July 21, 2025 04:15

YashSaraf11 requested review from a team as code owners July 21, 2025 04:15

YashSaraf11 previously approved these changes Jul 22, 2025

View reviewed changes

YashSaraf11 self-assigned this Jul 22, 2025

YashSaraf11 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 22, 2025

kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 22, 2025

pragya644 approved these changes Jul 22, 2025

View reviewed changes

vipul7499 reviewed Jul 22, 2025

View reviewed changes

YashSaraf11 self-requested a review July 22, 2025 04:50

durgesh-ninave-crest added 2 commits July 22, 2025 11:10

Merge branch 'main' into secretmanager-label-and-annotation-samples

ab08321

chore(secretmanager): added assertions in test cases

3251152

YashSaraf11 requested changes Jul 25, 2025

View reviewed changes

durgesh-ninave-crest added 2 commits July 25, 2025 14:00

Merge branch 'main' into secretmanager-label-and-annotation-samples

0aac15f

chore(secretmanager): update test assertions

0703bef

durgesh-ninave-crest force-pushed the secretmanager-label-and-annotation-samples branch from e75e533 to 0703bef Compare July 25, 2025 08:32

		@@ -469,6 +470,24 @@ def test_create_regional_secret_with_label(
		assert secret_id in secret.name


		def test_delete_regional_secret_annotation(

chore(secretmanager): Add samples for deleting secret annotations and updating annotation and label args #13511

Are you sure you want to change the base?

chore(secretmanager): Add samples for deleting secret annotations and updating annotation and label args #13511

Conversation

durgesh-ninave-crest commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

gemini-code-assist bot Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

YashSaraf11 commented Jul 21, 2025

Uh oh!

snippet-bot bot commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

YashSaraf11 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

durgesh-ninave-crest commented Jul 18, 2025 •

edited

Loading

snippet-bot bot commented Jul 21, 2025 •

edited

Loading