Add support for regional secret resource `google_secret_manager_regional_secret` #11678

abheda-crest · 2024-09-11T07:15:33Z

Add support for new regional secret resource google_secret_manager_regional_secret. I have also defined the iam_policy field in the RegionalSecret.yaml file to include the IAM resources and IAM datasources as well.

More info about regional secrets: https://cloud.google.com/secret-manager/docs/regional-secrets-overview

Notes:

In RegionalSecret.yaml file, the versionAliases field is commented and the respective test cases covered in the resource_secret_manager_regional_secret_test.go.erb file are also commented because this field depends on creating regional_secret_version_resource. We intend to uncomment once this PR is merged and dependent tests can pass.
As of now, the API reference of the regional secrets are being documented on GCP docs side. Hence, the link mentioned in the ResourceSecret.yaml file will be updated later.

Release Note Template for Downstream PRs (will be copied)

`google_secret_manager_regional_secret`

google-cla · 2024-09-11T07:15:37Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

github-actions · 2024-09-11T11:05:06Z

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@hao-nan-li, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

gptSanyam · 2024-09-11T11:14:06Z

mmv1/templates/terraform/pre_update/secret_manager_regional_secret.go.erb

+	# limitations under the License.
+-%>
+// As the API expects only one of ttl or expireTime
+if d.HasChange("ttl") && !d.HasChange("expire_time") {


Shouldn't there be an opposite condition here:
To remove ttl if expiry_time is introduced in the update.

As the API expects only one of the ttl or expireTime field, I've added this condition for switching between ttl and expireTime field. I've confirmed this behaviour and I've also added respective test case for the same. This test case can be found here: https://github.com/GoogleCloudPlatform/magic-modules/pull/11678/files#diff-11e793af43830f42f81e70d049956097a6df58b14f018cb62e7f1727f2bcd211R407

We should add a test case to prove it.

Yeah I've already added the test case that handles the switching between these fields.

gptSanyam · 2024-09-11T11:17:40Z

mmv1/templates/terraform/pre_update/secret_manager_regional_secret.go.erb

+	# See the License for the specific language governing permissions and
+	# limitations under the License.
+-%>
+// As the API expects only one of ttl or expireTime


Corresponding Secrets files seems to be doing a bit more than this:
https://github.com/gptSanyam/magic-modules/blob/main/mmv1/templates/terraform/pre_update/secret_manager_secret.go.erb

Let's make a list of things it is doing and then reason about what needs to be removed for regional secrets.

Sure.
The corresponding file does two tasks:

To enable the updation of replication field explicitly and updating the updateMask and ultimately the url to incorporate the changes in updateMask.

To handle the behaviour of ttl and expireTime as mentioned in the comment (Add support for regional secret resource google_secret_manager_regional_secret #11678 (comment))

In regional secrets, there is no field for replication that requires explicit handling for updation. Hence, I need to only handle the ttl and expireTime scenario

Got it. Thanks.

gptSanyam · 2024-09-11T11:20:05Z

mmv1/third_party/terraform/.teamcity/components/inputs/services_beta.kt

@@ -616,6 +616,11 @@ var ServicesListBeta = mapOf(
        "displayName" to "Secretmanager",
        "path" to "./google-beta/services/secretmanager"
    ),
+    "secretmanagerregional" to mapOf(
+        "name" to "secretmanagerregional",
+        "displayName" to "Secretmanagerregional",


Why is this needed?
We are setting displayName = Secrets Manager in products.yaml, is this an override.
I think this is the name used in the terrafrom registry to list the products, we want both regional and non-regional resources to be listed under the same listing.
https://github.com/GoogleCloudPlatform/magic-modules/pull/11678/files#diff-c1cff9a2fbc2183ca2638f5cc05943ff90a42751de6dad07cece718f78bf9fe3R16

Verified, existing resources like IAM are also adding this.

gptSanyam · 2024-09-11T11:20:54Z

mmv1/third_party/terraform/.teamcity/components/inputs/services_ga.kt

@@ -611,6 +611,11 @@ var ServicesListGa = mapOf(
        "displayName" to "Secretmanager",
        "path" to "./google/services/secretmanager"
    ),
+    "secretmanagerregional" to mapOf(
+        "name" to "secretmanagerregional",
+        "displayName" to "Secretmanagerregional",


Same as beta.

The Action for teamcity was failing regarding this. Before I've added this snippet, the workflow was failing: https://github.com/GoogleCloudPlatform/magic-modules/actions/runs/10806885008/job/29976554704. I am not sure if we need to add this snippet.

Verified, existing resources like IAM are also adding this.

gptSanyam

LGTM

modular-magician · 2024-09-11T15:58:05Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 19 files changed, 4573 insertions(+), 3 deletions(-))
google-beta provider: Diff ( 17 files changed, 4563 insertions(+), 3 deletions(-))
terraform-google-conversion: Diff ( 4 files changed, 603 insertions(+))
Open in Cloud Shell: Diff ( 24 files changed, 715 insertions(+))

modular-magician · 2024-09-11T17:06:41Z

Tests analytics

Total tests: 4018
Passed tests: 3582
Skipped tests: 411
Affected tests: 25

Click here to see the affected service packages

All service packages are affected

#### Non-exercised tests

Tests were added that are skipped in VCR:

TestAccSecretManagerRegionalRegionalSecretIamBindingGenerated_withAndWithoutCondition
TestAccSecretManagerRegionalRegionalSecretIamMemberGenerated_withAndWithoutCondition

Action taken

Found 25 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

TestAccComputeInstance_confidentialHyperDiskBootDisk

TestAccSecretManagerRegionalRegionalSecretIamBindingGenerated

TestAccSecretManagerRegionalRegionalSecretIamBindingGenerated_withCondition

TestAccSecretManagerRegionalRegionalSecretIamMemberGenerated

TestAccSecretManagerRegionalRegionalSecretIamMemberGenerated_withCondition

TestAccSecretManagerRegionalRegionalSecretIamPolicyGenerated

TestAccSecretManagerRegionalRegionalSecretIamPolicyGenerated_withCondition

TestAccSecretManagerRegionalRegionalSecretIam_iamBindingUpdate

TestAccSecretManagerRegionalRegionalSecretIam_iamPolicyUpdate

TestAccSecretManagerRegionalRegionalSecret_annotationsUpdate

TestAccSecretManagerRegionalRegionalSecret_cmekUpdate

TestAccSecretManagerRegionalRegionalSecret_expireTimeUpdate

TestAccSecretManagerRegionalRegionalSecret_import

TestAccSecretManagerRegionalRegionalSecret_labelsUpdate

TestAccSecretManagerRegionalRegionalSecret_regionalSecretConfigBasicExample

TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithCmekExample

TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithExpireTimeExample

TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithRotationExample

TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithTtlExample

TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithVersionDestroyTtlExample

TestAccSecretManagerRegionalRegionalSecret_rotationInfoUpdate

TestAccSecretManagerRegionalRegionalSecret_topicsUpdate

TestAccSecretManagerRegionalRegionalSecret_ttlUpdate

TestAccSecretManagerRegionalRegionalSecret_updateBetweenTtlAndExpireTime

TestAccSecretManagerRegionalRegionalSecret_versionDestroyTtlUpdate

Get to know how VCR tests work

modular-magician · 2024-09-11T17:37:21Z

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccComputeInstance_confidentialHyperDiskBootDisk[Debug log]
TestAccSecretManagerRegionalRegionalSecretIamBindingGenerated[Debug log]
TestAccSecretManagerRegionalRegionalSecretIamBindingGenerated_withCondition[Debug log]
TestAccSecretManagerRegionalRegionalSecretIamMemberGenerated[Debug log]
TestAccSecretManagerRegionalRegionalSecretIamMemberGenerated_withCondition[Debug log]
TestAccSecretManagerRegionalRegionalSecretIamPolicyGenerated[Debug log]
TestAccSecretManagerRegionalRegionalSecretIamPolicyGenerated_withCondition[Debug log]
TestAccSecretManagerRegionalRegionalSecretIam_iamBindingUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecretIam_iamPolicyUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_annotationsUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_cmekUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_expireTimeUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_import[Debug log]
TestAccSecretManagerRegionalRegionalSecret_labelsUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_regionalSecretConfigBasicExample[Debug log]
TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithCmekExample[Debug log]
TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithExpireTimeExample[Debug log]
TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithRotationExample[Debug log]
TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithTtlExample[Debug log]
TestAccSecretManagerRegionalRegionalSecret_regionalSecretWithVersionDestroyTtlExample[Debug log]
TestAccSecretManagerRegionalRegionalSecret_rotationInfoUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_topicsUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_ttlUpdate[Debug log]
TestAccSecretManagerRegionalRegionalSecret_updateBetweenTtlAndExpireTime[Debug log]
TestAccSecretManagerRegionalRegionalSecret_versionDestroyTtlUpdate[Debug log]
$\textcolor{red}{\textsf{Tests failed when rerunning REPLAYING mode:}}$
TestAccComputeInstance_confidentialHyperDiskBootDisk[Error message] [Debug log]

Tests failed due to non-determinism or randomness when the VCR replayed the response after the HTTP request was made.

Please fix these to complete your PR. If you believe these test failures to be incorrect or unrelated to your change, or if you have any questions, please raise the concern with your reviewer.

$\textcolor{green}{\textsf{All tests passed!}}$

View the build log or the debug log for each test

abheda-crest · 2024-09-12T05:03:27Z

I think that TestAccComputeInstance_confidentialHyperDiskBootDisk has been fixed very recently as a part of this PR: #11615

hao-nan-li · 2024-09-12T15:59:36Z

I think that TestAccComputeInstance_confidentialHyperDiskBootDisk has been fixed very recently as a part of this PR: #11615

I don't think that test is affected by your change.

hao-nan-li

Thanks for adding the new resource in

…nal_secret` (GoogleCloudPlatform#11678)

modular-magician added the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Sep 11, 2024

abheda-crest force-pushed the secret-manager-regional-secret-resource-support branch from aceb2d5 to f3ed8a0 Compare September 11, 2024 07:50

abheda-crest added 3 commits September 11, 2024 13:36

Add support for regional secret resource

8a9e4ef

adjusted indentation in RegionalSecret resource file

45b3c28

Added services to teamcity

cebddcc

abheda-crest force-pushed the secret-manager-regional-secret-resource-support branch from 3d69eba to cebddcc Compare September 11, 2024 08:07

abheda-crest marked this pull request as ready for review September 11, 2024 11:04

github-actions bot requested a review from hao-nan-li September 11, 2024 11:05

gptSanyam reviewed Sep 11, 2024

View reviewed changes

abheda-crest requested a review from gptSanyam September 11, 2024 11:42

gptSanyam approved these changes Sep 11, 2024

View reviewed changes

modular-magician added service/secretmanager and removed awaiting-approval Pull requests that need reviewer's approval to run presubmit tests labels Sep 11, 2024

hao-nan-li approved these changes Sep 12, 2024

View reviewed changes

hao-nan-li merged commit 3084e72 into GoogleCloudPlatform:main Sep 12, 2024
16 of 17 checks passed

gptSanyam mentioned this pull request Sep 12, 2024

Adding support for regional secrets. #11671

Closed

iyabchen pushed a commit to iyabchen/magic-modules that referenced this pull request Sep 14, 2024

Add support for regional secret resource `google_secret_manager_regio…

57f994f

…nal_secret` (GoogleCloudPlatform#11678)

abheda-crest mentioned this pull request Sep 14, 2024

Add support for regional secret datasource google_secret_manager_regional_secret #11718

Merged

abd-goog pushed a commit to abd-goog/magic-modules that referenced this pull request Sep 23, 2024

Add support for regional secret resource `google_secret_manager_regio…

a645f53

…nal_secret` (GoogleCloudPlatform#11678)

niharika-98 pushed a commit to niharika-98/magic-modules that referenced this pull request Oct 7, 2024

Add support for regional secret resource `google_secret_manager_regio…

e03c908

…nal_secret` (GoogleCloudPlatform#11678)

Philip-Jonany pushed a commit to Philip-Jonany/magic-modules that referenced this pull request Nov 4, 2024

Add support for regional secret resource `google_secret_manager_regio…

1a2ad69

…nal_secret` (GoogleCloudPlatform#11678)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for regional secret resource `google_secret_manager_regional_secret` #11678

Add support for regional secret resource `google_secret_manager_regional_secret` #11678

abheda-crest commented Sep 11, 2024 •

edited

Loading

google-cla bot commented Sep 11, 2024

github-actions bot commented Sep 11, 2024

gptSanyam Sep 11, 2024

abheda-crest Sep 11, 2024

gptSanyam Sep 11, 2024

abheda-crest Sep 11, 2024

gptSanyam Sep 11, 2024

gptSanyam Sep 11, 2024

abheda-crest Sep 11, 2024

gptSanyam Sep 11, 2024

gptSanyam Sep 11, 2024

gptSanyam Sep 11, 2024

gptSanyam Sep 11, 2024

abheda-crest Sep 11, 2024 •

edited

Loading

gptSanyam Sep 11, 2024

gptSanyam left a comment

modular-magician commented Sep 11, 2024

modular-magician commented Sep 11, 2024

modular-magician commented Sep 11, 2024

abheda-crest commented Sep 12, 2024

hao-nan-li commented Sep 12, 2024

hao-nan-li left a comment

Add support for regional secret resource google_secret_manager_regional_secret #11678

Add support for regional secret resource google_secret_manager_regional_secret #11678

Conversation

abheda-crest commented Sep 11, 2024 • edited Loading

google-cla bot commented Sep 11, 2024

github-actions bot commented Sep 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abheda-crest Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gptSanyam left a comment

Choose a reason for hiding this comment

modular-magician commented Sep 11, 2024

Diff report

modular-magician commented Sep 11, 2024

Tests analytics

Action taken

modular-magician commented Sep 11, 2024

abheda-crest commented Sep 12, 2024

hao-nan-li commented Sep 12, 2024

hao-nan-li left a comment

Choose a reason for hiding this comment

Add support for regional secret resource `google_secret_manager_regional_secret` #11678

Add support for regional secret resource `google_secret_manager_regional_secret` #11678

abheda-crest commented Sep 11, 2024 •

edited

Loading

abheda-crest Sep 11, 2024 •

edited

Loading