Add new resource support for apigee keystore aliases pkcs format by anuhyapolisetti · Pull Request #7519 · GoogleCloudPlatform/magic-modules

anuhyapolisetti · 2023-03-23T13:16:46Z

Add new resource support for apigee keystore aliases pkcs format

If this PR is for Terraform, I acknowledge that I have:

Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
[X ] Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
[X ] Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
[X ] Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

`google_apigee_keystore_aliases_pkcs`

shuyama1 · 2023-03-23T16:39:31Z

/gcbrun

modular-magician · 2023-03-23T16:54:36Z

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.

Terraform GA: Diff ( 5 files changed, 927 insertions(+))
Terraform Beta: Diff ( 5 files changed, 927 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

modular-magician · 2023-03-23T17:40:39Z

Tests analytics

Total tests: 2522
Passed tests 2249
Skipped tests: 264
Affected tests: 9

Action taken

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

TestAccFirebaserulesRelease_BasicRelease|TestAccDataCatalogTag_update|TestAccDataCatalogTag_dataCatalogEntryTagFalseExample|TestAccDataCatalogTag_dataCatalogEntryGroupTagExample|TestAccDataCatalogTag_dataCatalogEntryTagBasicExample|TestAccDataSourceGoogleCloudAssetResourcesSearchAll_basic|TestAccDataSourceDnsManagedZone_basic|TestAccApigeeEnvKeystoreAliasesPkcs_apigeeKeystoreAliasesPkcsExample|TestAccNetworkServicesGateway_update

Get to know how VCR tests work

modular-magician · 2023-03-23T17:41:42Z

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccDataCatalogTag_update[Debug log]
TestAccDataCatalogTag_dataCatalogEntryTagFalseExample[Debug log]
TestAccDataCatalogTag_dataCatalogEntryGroupTagExample[Debug log]
TestAccDataCatalogTag_dataCatalogEntryTagBasicExample[Debug log]
TestAccNetworkServicesGateway_update[Debug log]

Tests failed during RECORDING mode:
TestAccDataSourceGoogleCloudAssetResourcesSearchAll_basic[Error message] [Debug log]
TestAccDataSourceDnsManagedZone_basic[Error message] [Debug log]
TestAccApigeeEnvKeystoreAliasesPkcs_apigeeKeystoreAliasesPkcsExample[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

shuyama1 · 2023-03-23T18:18:48Z

/gcbrun

modular-magician · 2023-03-23T18:34:22Z

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.

Terraform GA: Diff ( 5 files changed, 927 insertions(+))
Terraform Beta: Diff ( 5 files changed, 927 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

modular-magician · 2023-03-23T19:20:09Z

Tests analytics

Total tests: 2524
Passed tests 2250
Skipped tests: 264
Affected tests: 10

Action taken

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

TestAccNetworkServicesGateway_update|TestAccDataCatalogTag_update|TestAccDataCatalogTag_dataCatalogEntryTagFalseExample|TestAccDataCatalogTag_dataCatalogEntryGroupTagExample|TestAccDataCatalogTag_dataCatalogEntryTagBasicExample|TestAccFirebaserulesRelease_BasicRelease|TestAccApigeeEnvKeystoreAliasesPkcs_apigeeKeystoreAliasesPkcsExample|TestAccDataSourceGoogleCloudAssetResourcesSearchAll_basic|TestAccDataSourceDnsManagedZone_basic|TestAccComposerEnvironment_withEncryptionConfigComposer1

Get to know how VCR tests work

modular-magician · 2023-03-23T19:44:11Z

Tests passed during RECORDING mode:
TestAccNetworkServicesGateway_update[Debug log]
TestAccDataCatalogTag_update[Debug log]
TestAccDataCatalogTag_dataCatalogEntryTagFalseExample[Debug log]
TestAccDataCatalogTag_dataCatalogEntryGroupTagExample[Debug log]
TestAccDataCatalogTag_dataCatalogEntryTagBasicExample[Debug log]
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccApigeeEnvKeystoreAliasesPkcs_apigeeKeystoreAliasesPkcsExample[Debug log]
TestAccComposerEnvironment_withEncryptionConfigComposer1[Debug log]

Tests failed during RECORDING mode:
TestAccDataSourceGoogleCloudAssetResourcesSearchAll_basic[Error message] [Debug log]
TestAccDataSourceDnsManagedZone_basic[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

…ses-pkcs

shuyama1 · 2023-03-28T17:36:08Z

/gcbrun

modular-magician · 2023-03-28T17:52:14Z

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.

Terraform GA: Diff ( 5 files changed, 927 insertions(+))
Terraform Beta: Diff ( 5 files changed, 927 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

modular-magician · 2023-03-28T18:44:53Z

Tests analytics

Total tests: 2570
Passed tests 2290
Skipped tests: 267
Affected tests: 13

Action taken

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

TestAccFirebaserulesRelease_BasicRelease|TestAccNetworkServicesGateway_update|TestAccFrameworkProviderBasePath_setBasePath|TestAccFrameworkProviderMeta_setModuleName|TestAccComputeInstanceFromRegionTemplate_basic|TestAccComposerEnvironment_withEncryptionConfigComposer2|TestAccComposerEnvironment_withEncryptionConfigComposer1|TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example|TestAccDataSourceGoogleFirebaseAppleAppConfig|TestAccDataSourceDnsManagedZone_basic|TestAccDataSourceDNSKeys_noDnsSec|TestAccDataSourceDnsRecordSet_basic|TestAccDataSourceDNSKeys_basic

Get to know how VCR tests work

modular-magician · 2023-03-28T18:57:59Z

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccNetworkServicesGateway_update[Debug log]
TestAccFrameworkProviderBasePath_setBasePath[Debug log]
TestAccFrameworkProviderMeta_setModuleName[Debug log]
TestAccComputeInstanceFromRegionTemplate_basic[Debug log]
TestAccDataSourceGoogleFirebaseAppleAppConfig[Debug log]
TestAccDataSourceDnsManagedZone_basic[Debug log]
TestAccDataSourceDNSKeys_noDnsSec[Debug log]
TestAccDataSourceDnsRecordSet_basic[Debug log]
TestAccDataSourceDNSKeys_basic[Debug log]

Tests failed during RECORDING mode:
TestAccComposerEnvironment_withEncryptionConfigComposer2[Error message] [Debug log]
TestAccComposerEnvironment_withEncryptionConfigComposer1[Error message] [Debug log]
TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

shuyama1 · 2023-03-28T20:05:53Z

/gcbrun

modular-magician · 2023-03-28T20:21:52Z

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.

Terraform GA: Diff ( 5 files changed, 927 insertions(+))
Terraform Beta: Diff ( 5 files changed, 927 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

modular-magician · 2023-03-28T21:13:26Z

Tests analytics

Total tests: 2570
Passed tests 2293
Skipped tests: 267
Affected tests: 10

Action taken

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

TestAccComputeInstanceFromRegionTemplate_basic|TestAccComposerEnvironment_withEncryptionConfigComposer1|TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example|TestAccFrameworkProviderMeta_setModuleName|TestAccFrameworkProviderBasePath_setBasePath|TestAccDataSourceDnsManagedZone_basic|TestAccDataSourceDNSKeys_noDnsSec|TestAccDataSourceDNSKeys_basic|TestAccDataSourceDnsRecordSet_basic|TestAccDataSourceGoogleFirebaseAppleAppConfig

Get to know how VCR tests work

modular-magician · 2023-03-28T21:36:42Z

Tests passed during RECORDING mode:
TestAccComputeInstanceFromRegionTemplate_basic[Debug log]
TestAccComposerEnvironment_withEncryptionConfigComposer1[Debug log]
TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example[Debug log]
TestAccFrameworkProviderMeta_setModuleName[Debug log]
TestAccFrameworkProviderBasePath_setBasePath[Debug log]
TestAccDataSourceDnsManagedZone_basic[Debug log]
TestAccDataSourceDNSKeys_noDnsSec[Debug log]
TestAccDataSourceDNSKeys_basic[Debug log]
TestAccDataSourceDnsRecordSet_basic[Debug log]
TestAccDataSourceGoogleFirebaseAppleAppConfig[Debug log]

All tests passed
View the build log or the debug log for each test

shuyama1 · 2023-03-30T19:06:11Z

/gcbrun

modular-magician · 2023-03-30T19:22:19Z

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.

Terraform GA: Diff ( 5 files changed, 927 insertions(+))
Terraform Beta: Diff ( 5 files changed, 927 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

modular-magician · 2023-03-30T20:20:03Z

Tests analytics

Total tests: 2584
Passed tests 2304
Skipped tests: 267
Affected tests: 13

Action taken

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

TestAccFirebaseWebApp_firebaseWebAppFull|TestAccFirebaseWebApp_firebaseWebAppBasicExample|TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example|TestAccComposerEnvironment_withEncryptionConfigComposer2|TestAccComposerEnvironment_UpdateComposerV2WithTriggerer|TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample|TestAccDataSourceDnsRecordSet_basic|TestAccDataSourceDnsManagedZone_basic|TestAccDataSourceDNSKeys_noDnsSec|TestAccDataSourceDNSKeys_basic|TestAccFrameworkProviderBasePath_setBasePath|TestAccFrameworkProviderMeta_setModuleName|TestAccDataSourceGoogleFirebaseAppleAppConfig

Get to know how VCR tests work

modular-magician · 2023-03-30T21:08:39Z

Tests passed during RECORDING mode:
TestAccFirebaseWebApp_firebaseWebAppFull[Debug log]
TestAccFirebaseWebApp_firebaseWebAppBasicExample[Debug log]
TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example[Debug log]
TestAccComposerEnvironment_withEncryptionConfigComposer2[Debug log]
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample[Debug log]
TestAccDataSourceDnsRecordSet_basic[Debug log]
TestAccDataSourceDnsManagedZone_basic[Debug log]
TestAccDataSourceDNSKeys_noDnsSec[Debug log]
TestAccDataSourceDNSKeys_basic[Debug log]
TestAccFrameworkProviderBasePath_setBasePath[Debug log]
TestAccFrameworkProviderMeta_setModuleName[Debug log]
TestAccDataSourceGoogleFirebaseAppleAppConfig[Debug log]

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

Please fix these to complete your PR
View the build log or the debug log for each test

shuyama1 · 2023-03-31T16:42:55Z

+				Optional:    true,
+				Computed:    true,


Suggested change

Optional: true,

Computed: true,

Computed: true,

Discussed offline: sounds like certs_info and all its subfields are output-only, please change them from optional+computed to computed. Also please change other fields if they're also output-only.
Optional+computed in Terraform: still a field that user can specify, but it will be treated as output-only field if users does not specify explicitly.

shuyama1 · 2023-03-31T16:46:00Z

+  environment 			= google_apigee_environment.apigee_environment_keystore.name
+  org_id				= google_apigee_organization.apigee_org.name
+  keystore				= google_apigee_env_keystore.apigee_environment_keystore_alias.name
+  alias                 = "tf-test%{random_suffix}"
+  file                  = "./test-fixtures/apigee/keyStore.p12"
+  filehash				= filemd5("./test-fixtures/apigee/keyStore.p12")
+  password              = sensitive("abcd")


Only nit here: some mixed using of tabs and spaces. We'd use spaces for resource configuraion.

shuyama1 · 2023-03-31T16:53:09Z

+					},
+				},
+			},
+			"password": {


Is this also output-only? If so, remove optional: true, otherwise, since we don't have a update function for this resource (I assume this resource is immutable), we need to add Forcenew. Or consider adding update functionality for this resource.

shuyama1 · 2023-03-31T17:48:28Z

 			},
 			"password": {
 				Type:        schema.TypeString,
-				Optional:    true,


computed and forcenew can be set at the same time. Consider:

if the field is output-only: only Computed:true

if the field is a input field + immutable: Optional: true + ForceNew: true

if the field is a input field + updatable: Optional: true + adding a update function for the resource

shuyama1 · 2023-03-31T18:00:15Z

/gcbrun

shuyama1 · 2023-03-31T18:56:38Z

/gcbrun

modular-magician · 2023-03-31T19:10:36Z

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.

Terraform GA: Diff ( 5 files changed, 913 insertions(+))
Terraform Beta: Diff ( 5 files changed, 913 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

modular-magician · 2023-03-31T20:01:11Z

Tests analytics

Total tests: 2584
Passed tests 2304
Skipped tests: 268
Affected tests: 12

Action taken

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

TestAccFirebaseWebApp_firebaseWebAppFull|TestAccFirebaseWebApp_firebaseWebAppBasicExample|TestAccComposerEnvironment_withEncryptionConfigComposer2|TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example|TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample|TestAccDataSourceDnsManagedZone_basic|TestAccFrameworkProviderMeta_setModuleName|TestAccDataSourceDNSKeys_noDnsSec|TestAccDataSourceDNSKeys_basic|TestAccDataSourceGoogleFirebaseAppleAppConfig|TestAccDataSourceDnsRecordSet_basic|TestAccFrameworkProviderBasePath_setBasePath

Get to know how VCR tests work

modular-magician · 2023-03-31T20:24:58Z

Tests passed during RECORDING mode:
TestAccFirebaseWebApp_firebaseWebAppFull[Debug log]
TestAccFirebaseWebApp_firebaseWebAppBasicExample[Debug log]
TestAccComposerEnvironment_withEncryptionConfigComposer2[Debug log]
TestAccApigeeEnvKeystoreAliasPkcs12_apigeeEnvKeystoreAliasPkcs12Example[Debug log]
TestAccApigeeKeystoresAliasesKeyCertFile_apigeeKeystoresAliasesKeyCertFileTestExample[Debug log]
TestAccDataSourceDnsManagedZone_basic[Debug log]
TestAccFrameworkProviderMeta_setModuleName[Debug log]
TestAccDataSourceDNSKeys_noDnsSec[Debug log]
TestAccDataSourceDNSKeys_basic[Debug log]
TestAccDataSourceGoogleFirebaseAppleAppConfig[Debug log]
TestAccDataSourceDnsRecordSet_basic[Debug log]
TestAccFrameworkProviderBasePath_setBasePath[Debug log]

All tests passed
View the build log or the debug log for each test

…gleCloudPlatform#7519) Co-authored-by: Anuhya P <anuhyap@google.com>

rileykarson · 2023-04-07T18:06:46Z

@shuyama1 watch out for the resource name in the changelog entry! This resource is called google_apigee_env_keystore_alias_pkcs12 but the changelog called it google_apigee_keystore_aliases_pkcs.

…gleCloudPlatform#7519) Co-authored-by: Anuhya P <anuhyap@google.com>

anuhyap-ship-it added 7 commits March 17, 2023 14:14

Add Apigee Keystore aliases resource for Self Signed Cert Format

5b8dec6

Second commit for selfsigned and initial commit for pkcs

26431fb

delete self signed aliases code

360674c

Update PKCS code

e54ecbc

Add filehash variable

ea502cb

update create code for pkcs

4bb5ea4

update pkcs code test file

c3c711b

anuhyapolisetti requested a review from a team as a code owner March 23, 2023 13:16

anuhyapolisetti requested review from shuyama1 and removed request for a team March 23, 2023 13:16

correct environment name

687049b

anuhyapolisetti and others added 2 commits March 24, 2023 02:27

Merge branch 'GoogleCloudPlatform:main' into add-resource/apigee-alia…

4e261bc

…ses-pkcs

update as per comments from selfsignedcert PR

31d142d

update resourcename in test case

19c4698

modular-magician requested a review from shuyama1 March 30, 2023 19:07

shuyama1 requested changes Mar 31, 2023

View reviewed changes

update certs_info field and password per comments

be1d36e

shuyama1 reviewed Mar 31, 2023

View reviewed changes

update password field

2743a2b

modular-magician requested a review from shuyama1 March 31, 2023 18:01

Update the file

fcb94fc

shuyama1 approved these changes Mar 31, 2023

View reviewed changes

shuyama1 merged commit de433d5 into GoogleCloudPlatform:main Mar 31, 2023

kimihrr pushed a commit to kimihrr/kimiah-magic-modules that referenced this pull request Apr 4, 2023

Add new resource support for apigee keystore aliases pkcs format (Goo…

302ee1f

…gleCloudPlatform#7519) Co-authored-by: Anuhya P <anuhyap@google.com>

rileykarson mentioned this pull request Apr 7, 2023

Update apigee keystore resource names to be consistent #7665

Merged

5 tasks

kimihrr pushed a commit to kimihrr/kimiah-magic-modules that referenced this pull request Apr 11, 2023

Add new resource support for apigee keystore aliases pkcs format (Goo…

f4347a3

…gleCloudPlatform#7519) Co-authored-by: Anuhya P <anuhyap@google.com>

hao-nan-li pushed a commit to hao-nan-li/magic-modules that referenced this pull request Apr 11, 2023

Add new resource support for apigee keystore aliases pkcs format (Goo…

b2eb39e

…gleCloudPlatform#7519) Co-authored-by: Anuhya P <anuhyap@google.com>

ericayyliu pushed a commit to ericayyliu/magic-modules that referenced this pull request Jul 26, 2023

Add new resource support for apigee keystore aliases pkcs format (Goo…

1455671

…gleCloudPlatform#7519) Co-authored-by: Anuhya P <anuhyap@google.com>

Uh oh!

Conversation

anuhyapolisetti commented Mar 23, 2023 • edited by shuyama1 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shuyama1 commented Mar 23, 2023

Uh oh!

modular-magician commented Mar 23, 2023

Diff report

Uh oh!

modular-magician commented Mar 23, 2023

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 23, 2023

Uh oh!

shuyama1 commented Mar 23, 2023

Uh oh!

modular-magician commented Mar 23, 2023

Diff report

Uh oh!

modular-magician commented Mar 23, 2023

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 23, 2023

Uh oh!

shuyama1 commented Mar 28, 2023

Uh oh!

modular-magician commented Mar 28, 2023

Diff report

Uh oh!

modular-magician commented Mar 28, 2023

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 28, 2023

Uh oh!

shuyama1 commented Mar 28, 2023

Uh oh!

modular-magician commented Mar 28, 2023

Diff report

Uh oh!

modular-magician commented Mar 28, 2023

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 28, 2023

Uh oh!

shuyama1 commented Mar 30, 2023

Uh oh!

modular-magician commented Mar 30, 2023

Diff report

Uh oh!

modular-magician commented Mar 30, 2023

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 30, 2023

Uh oh!

shuyama1 Mar 31, 2023

Choose a reason for hiding this comment

Uh oh!

shuyama1 Mar 31, 2023

Choose a reason for hiding this comment

Uh oh!

shuyama1 Mar 31, 2023

Choose a reason for hiding this comment

Uh oh!

shuyama1 Mar 31, 2023

Choose a reason for hiding this comment

Uh oh!

shuyama1 commented Mar 31, 2023

Uh oh!

shuyama1 commented Mar 31, 2023

Uh oh!

modular-magician commented Mar 31, 2023

Diff report

Uh oh!

modular-magician commented Mar 31, 2023

anuhyapolisetti commented Mar 23, 2023 •

edited by shuyama1

Loading