Added new Apigee resource /v1/organizations/<apigee_org>/environments/<apigee_env>/addonsConfig #12616

sharmajai09 · 2024-12-19T17:28:14Z

`google_apigee_environment_addons_config`

github-actions · 2024-12-19T17:28:53Z

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

@melinath, 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.

melinath · 2024-12-19T17:37:34Z

Taking this over as the original reviewer of #12417

modular-magician · 2024-12-19T20:56:34Z

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 ( 5 files changed, 539 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 539 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 79 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_apigee_environment_addons_config (1 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_apigee_environment_addons_config" "primary" {
  api_security_enabled = # value needed
}

modular-magician · 2024-12-19T21:01:21Z

Tests analytics

Total tests: 52
Passed tests: 17
Skipped tests: 35
Affected tests: 0

Click here to see the affected service packages

apigee

#### Non-exercised tests

🔴 Tests were added that are skipped in VCR:

TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample
🟢 All tests passed!

View the build log

melinath · 2024-12-19T21:54:32Z

Manual test run: https://hashicorp.teamcity.com/buildConfiguration/TerraformProviders_GoogleCloud_GOOGLE_BETA_MMUPSTREAMTESTS_GOOGLEBETA_PACKAGE_APIGEE/288117

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

melinath · 2024-12-19T22:15:04Z

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

+      org_id: 'ORG_ID'
+      billing_account: 'BILLING_ACCT'
+    exclude_docs: true
+    skip_vcr: true


Just want to double-check that this needs to skip VCR tests? More information on the reasons for doing this (or not): https://googlecloudplatform.github.io/magic-modules/test/test/#skip-tests-in-vcr-replaying-mode

AddonsConfig tests don't seem to need this.

i had to add skip_vcr check back due to previously known error

Error waiting for Deleting Organization: error while retrieving operation: googleapi: Error 403: Permission 'apigee.operations.get' denied on resource 'organizations/tf-test-bawr39q93i/operations/55f073f3-0694-4c76-a387-a39b74c30e49' (or it may not exist)

I'd be inclined to remove this for now, since that error doesn't seem like it's inherently a VCR-blocking issue, and it should get resolved at the same time as hashicorp/terraform-provider-google#20668 (hopefully soon!), and I don't want us to forget to remove it later. I'm happy to approve with the failing test in this case since it should be possible to verify it's a problem with the Organization resource, not this one.

melinath · 2024-12-19T22:22:34Z

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

+    'Enable ApiSecurity Add-On': 'https://cloud.google.com/apigee/docs/api-platform/reference/manage-security-add-on'
+  api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.addonsConfig/setAddonEnablement'
+docs:
+base_url: '{{env_id}}/addonsConfig'


The addonsConfig part doesn't need to be in the base_url, since this isn't a "real" resource. Technically the base_url should probably be organizations/{{org_id}}/environments but I think given the overrides in place this might actually not get used at all.

Suggested change

base_url: '{{env_id}}/addonsConfig'

base_url: '{{env_id}}'

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

mmv1/templates/terraform/custom_import/apigee_env_addons.go.tmpl

melinath · 2024-12-19T22:32:30Z

mmv1/templates/terraform/custom_import/apigee_env_addons.go.tmpl

+nameParts := strings.Split(d.Get("env_id").(string), "/")
+if len(nameParts) == 5 {
+	id := fmt.Sprintf("organizations/%s/environments/%s", nameParts[1], nameParts[3])
+	d.SetId(id)
+}


Should be something like this:

Suggested change

nameParts := strings.Split(d.Get("env_id").(string), "/")

if len(nameParts) == 5 {

id := fmt.Sprintf("organizations/%s/environments/%s", nameParts[1], nameParts[3])

d.SetId(id)

}

id := d.Get("env_id").(string)

nameParts := strings.Split(id, "/")

if len(nameParts) != 4 { // you could be stricter about this check if you want.

return nil, fmt.Errorf("env is expected to have shape organizations/{{"{{"}}org_id{{"}}"}}/environments/{{"{{"}}env{{"}}"}}, got %s instead", id)

}

d.SetId(id)

Any errors parsing the import id need to be returned - otherwise you might end up with an import that looks like it succeeds but fails to actually set an id (which means the resource won't actually be imported).

modular-magician · 2024-12-20T09: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 ( 5 files changed, 582 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 582 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 69 insertions(+))

modular-magician · 2024-12-20T10:02:44Z

Tests analytics

Total tests: 52
Passed tests: 17
Skipped tests: 34
Affected tests: 1

Click here to see the affected service packages

apigee

Action taken

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

TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample

Get to know how VCR tests work

modular-magician · 2024-12-20T10:13:25Z

🔴 Tests failed during RECORDING mode:
TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

…get' denied on resource

modular-magician · 2024-12-20T15:59:39Z

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 ( 5 files changed, 582 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 582 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 69 insertions(+))

modular-magician · 2024-12-20T16:04:17Z

Tests analytics

Total tests: 52
Passed tests: 17
Skipped tests: 35
Affected tests: 0

Click here to see the affected service packages

apigee

#### Non-exercised tests

🔴 Tests were added that are skipped in VCR:

TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample
🟢 All tests passed!

View the build log

melinath · 2024-12-20T21:47:54Z

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

+      org_id: 'ORG_ID'
+      billing_account: 'BILLING_ACCT'
+    exclude_docs: true
+    skip_vcr: true


I'd be inclined to remove this for now, since that error doesn't seem like it's inherently a VCR-blocking issue, and it should get resolved at the same time as hashicorp/terraform-provider-google#20668 (hopefully soon!), and I don't want us to forget to remove it later. I'm happy to approve with the failing test in this case since it should be possible to verify it's a problem with the Organization resource, not this one.

melinath · 2024-12-20T21:51:46Z

mmv1/templates/terraform/examples/apigee_env_addons_enable_analytics.tf.tmpl

@@ -0,0 +1,70 @@
+resource "google_project" "project" {


Usually the purpose of having a docs-only example is to remove extra configuration the users don't necessarily need to know about; for example, apigee_addons_basic only has the google_apigee_addons_config resource.

If the extra information here is useful for users, you could create docs based on the other example instead of having a second one just for docs.

done I have kept Org and environment creation steps as this resource is available only when Org is PAYG and environment is COMPREHENSIVE.

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

mmv1/templates/terraform/custom_import/apigee_env_addons.go.tmpl

melinath · 2024-12-20T23:40:34Z

@modular-magician reassign-reviewer

melinath · 2024-12-20T23:41:01Z

reassigning since I'll be OOO next week.

github-actions · 2024-12-26T09:41:09Z

@SirGitsalot This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions · 2024-12-30T09:41:11Z

@GoogleCloudPlatform/terraform-team @SirGitsalot This PR has been waiting for review for 1 week. Please take a look! Use the label disable-review-reminders to disable these notifications.

github-actions · 2025-01-06T09:41:42Z

@GoogleCloudPlatform/terraform-team @SirGitsalot This PR has been waiting for review for 2 weeks. Please take a look! Use the label disable-review-reminders to disable these notifications.

melinath · 2025-01-06T23:35:16Z

Sorry for the delay on this one; we had a miscommunication regarding the vacation plans! I can take it back over now that I'm back.

melinath

a couple small changes

melinath · 2025-01-08T00:05:05Z

mmv1/templates/terraform/custom_import/apigee_env_addons.go.tmpl

+config := meta.(*transport_tpg.Config)
+
+// current import_formats cannot import fields with forward slashes in their value
+if err := tpgresource.ParseImportId([]string{"(?P<env_id>.+)/addonsConfig"}, d, config); err != nil {


The regex here matches what users pass in when using terraform import & definitely shouldn't contain addonsConfig

Suggested change

if err := tpgresource.ParseImportId([]string{"(?P<env_id>.+)/addonsConfig"}, d, config); err != nil {

if err := tpgresource.ParseImportId([]string{"(?P<env_id>.+)"}, d, config); err != nil {

done
somehow when I was running tests locally import worked only when I added /addonsConfig

I had you make some other changes (like adding the id_format) so that removing this here would work. I think your local testing may have been before those changes?

melinath · 2025-01-08T00:08:08Z

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

+id_format:
+  - '{{env_id}}'


Sorry, I think I had suggested formatting this as a list but it should actually be just a string. This is causing the yaml parsing error.

Suggested change

id_format:

- '{{env_id}}'

id_format: '{{env_id}}'

modular-magician · 2025-01-08T06:01:18Z

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 ( 5 files changed, 530 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 530 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 69 insertions(+))

modular-magician · 2025-01-08T06:06:08Z

Tests analytics

Total tests: 52
Passed tests: 17
Skipped tests: 34
Affected tests: 1

Click here to see the affected service packages

apigee

Action taken

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

TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample

Get to know how VCR tests work

modular-magician · 2025-01-08T06:17:27Z

🔴 Tests failed during RECORDING mode:
TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

melinath

one small change but otherwise LGTM. the test failure is expected and is not due to a problem with this resource AFAICT. The update logic is similar enough to the create logic (even using the same API method) that I feel comfortable with not having an update test.

mmv1/products/apigee/EnvironmentAddonsConfig.yaml

modular-magician · 2025-01-08T17:19:38Z

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 ( 5 files changed, 528 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 528 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 69 insertions(+))

modular-magician · 2025-01-08T17:25:07Z

Tests analytics

Total tests: 52
Passed tests: 17
Skipped tests: 34
Affected tests: 1

Click here to see the affected service packages

apigee

Action taken

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

TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample

Get to know how VCR tests work

modular-magician · 2025-01-08T17:28:45Z

🔴 Tests failed during RECORDING mode:
TestAccApigeeEnvironmentAddonsConfig_apigeeEnvAddonsAnalyticsTestExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

sharmajai09 added 6 commits December 6, 2024 23:57

Added new resource for Environment addon

83e825b

bug fixes

2990972

fix tests

4852161

bug fixes

3a51da1

Merge branch 'GoogleCloudPlatform:main' into main

eeec741

Deleted api security tests

1af8c49

sharmajai09 changed the title ~~Updated~~ Added new resource Dec 19, 2024

github-actions bot requested a review from BBBmau December 19, 2024 17:28

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

sharmajai09 changed the title ~~Added new resource~~ Added new Apigee resource /v1/organizations/<apigee_org>/environments/<apigee_env>/addonsConfig Dec 19, 2024

melinath requested review from melinath and removed request for BBBmau December 19, 2024 17:37

modular-magician removed the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Dec 19, 2024

sharmajai09 added 2 commits December 19, 2024 20:38

fix yaml format error

e04d9e5

Removed api security tests

9cd2f45

modular-magician added the service/apigee label Dec 19, 2024

melinath requested changes Dec 19, 2024

View reviewed changes

address pull request comments

2c5817b

github-actions bot requested a review from melinath December 20, 2024 09:47

skip vcr due to known issue Error 403: Permission 'apigee.operations.…

3937627

…get' denied on resource

melinath requested changes Dec 20, 2024

View reviewed changes

github-actions bot requested a review from SirGitsalot December 20, 2024 23:41

addressing review comments

e420f28

github-actions bot requested a review from melinath December 23, 2024 18:00

melinath removed the request for review from SirGitsalot January 6, 2025 23:35

melinath requested changes Jan 8, 2025

View reviewed changes

addressing review comments

1ffb0c3

github-actions bot requested a review from melinath January 8, 2025 05:50

melinath requested changes Jan 8, 2025

View reviewed changes

mmv1/products/apigee/EnvironmentAddonsConfig.yaml Outdated Show resolved Hide resolved

Update mmv1/products/apigee/EnvironmentAddonsConfig.yaml

78edf2d

github-actions bot requested a review from melinath January 8, 2025 17:07

melinath approved these changes Jan 8, 2025

View reviewed changes

melinath merged commit 716d7b6 into GoogleCloudPlatform:main Jan 8, 2025
14 of 15 checks passed

	if err := tpgresource.ParseImportId([]string{"(?P<env_id>.+)/addonsConfig"}, d, config); err != nil {
	if err := tpgresource.ParseImportId([]string{"(?P<env_id>.+)"}, d, config); err != nil {

Added new Apigee resource /v1/organizations/<apigee_org>/environments/<apigee_env>/addonsConfig #12616

Added new Apigee resource /v1/organizations/<apigee_org>/environments/<apigee_env>/addonsConfig #12616

Conversation

sharmajai09 commented Dec 19, 2024 • edited Loading

github-actions bot commented Dec 19, 2024 • edited by melinath Loading

melinath commented Dec 19, 2024

modular-magician commented Dec 19, 2024

Diff report

Missing test report

modular-magician commented Dec 19, 2024

Tests analytics

melinath commented Dec 19, 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

modular-magician commented Dec 20, 2024

Diff report

modular-magician commented Dec 20, 2024

Tests analytics

Action taken

modular-magician commented Dec 20, 2024

modular-magician commented Dec 20, 2024

Diff report

modular-magician commented Dec 20, 2024

Tests analytics

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melinath commented Dec 20, 2024

melinath commented Dec 20, 2024

github-actions bot commented Dec 26, 2024

github-actions bot commented Dec 30, 2024

github-actions bot commented Jan 6, 2025

melinath commented Jan 6, 2025

melinath left a 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

modular-magician commented Jan 8, 2025

Diff report

modular-magician commented Jan 8, 2025

Tests analytics

Action taken

modular-magician commented Jan 8, 2025

melinath left a comment

Choose a reason for hiding this comment

modular-magician commented Jan 8, 2025

Diff report

modular-magician commented Jan 8, 2025

Tests analytics

Action taken

modular-magician commented Jan 8, 2025

sharmajai09 commented Dec 19, 2024 •

edited

Loading

github-actions bot commented Dec 19, 2024 •

edited by melinath

Loading