Deprecate createSampleWorkflows and provisionGmek fields. Add createSampleIntegrations

[rohitjangid]

Deprecate createSampleWorkflows and provisionGmek fields and add createSampleIntegrations in google_integrations_client to keep it consistent with terminology.

Release Note Template for Downstream PRs (will be copied)

integrations: Deprecated `create_sample_workflows` and `provision_gmek` fields and added `create_sample_integrations` in `google_integrations_client` to keep it consistent with terminology.

[github-actions]

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

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

[modular-magician]

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 ( 3 files changed, 17 insertions(+), 18 deletions(-))
google-beta provider: Diff ( 3 files changed, 17 insertions(+), 18 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 4 insertions(+), 4 deletions(-))
Open in Cloud Shell: Diff ( 1 file changed, 1 insertion(+), 4 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field create_sample_workflows within resource google_integrations_client was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

[rohitjangid]

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 ( 3 files changed, 17 insertions(+), 18 deletions(-)) google-beta provider: Diff ( 3 files changed, 17 insertions(+), 18 deletions(-)) terraform-google-conversion: Diff ( 1 file changed, 4 insertions(+), 4 deletions(-)) Open in Cloud Shell: Diff ( 1 file changed, 1 insertion(+), 4 deletions(-))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field create_sample_workflows within resource google_integrations_client was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer. If you intend to make this change you will need to wait for a major release window. An override-breaking-change label can be added to allow merging.

@SarahFrench The change is expected. We do not have any usage for this resource and hence this change should be fine.

[modular-magician]

Tests analytics

Total tests: 2
Passed tests: 1
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

• integrations

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log

[modular-magician]

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 ( 3 files changed, 22 insertions(+), 23 deletions(-))
google-beta provider: Diff ( 3 files changed, 22 insertions(+), 23 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 4 insertions(+), 4 deletions(-))
Open in Cloud Shell: Diff ( 4 files changed, 136 insertions(+))

Breaking Change(s) Detected

The following breaking change(s) were detected within your pull request.

• Field create_sample_workflows within resource google_integrations_client was either removed or renamed - reference

If you believe this detection to be incorrect please raise the concern with your reviewer.
If you intend to make this change you will need to wait for a major release window.
An override-breaking-change label can be added to allow merging.

[modular-magician]

Tests analytics

Total tests: 2
Passed tests: 1
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

• integrations

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log

[SarahFrench]

Hi there, thanks for your PR!

@SarahFrench The change is expected. We do not have any usage for this resource and hence this change should be fine.

Renaming a field is typically a breaking change, that's navigated via a deprecation process, because we don't know how many users may have a Terraform configuration that contains that field. I can see that this resource was only added last month but how can you be sure that this doesn't break a user's existing configuration?

[rohitjangid]

Hi there, thanks for your PR!

@SarahFrench The change is expected. We do not have any usage for this resource and hence this change should be fine.

Renaming a field is typically a breaking change, that's navigated via a deprecation process, because we don't know how many users may have a Terraform configuration that contains that field. I can see that this resource was only added last month but how can you be sure that this doesn't break a user's existing configuration?

Added deprecation message

[modular-magician]

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 ( 3 files changed, 38 insertions(+), 16 deletions(-))
google-beta provider: Diff ( 3 files changed, 38 insertions(+), 16 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 4 files changed, 136 insertions(+))

Missing test report

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

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

resource "google_integrations_client" "primary" {
  create_sample_workflows = # value needed
}

[modular-magician]

Tests analytics

Total tests: 2
Passed tests: 1
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

• integrations

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log

[modular-magician]

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 ( 3 files changed, 38 insertions(+), 16 deletions(-))
google-beta provider: Diff ( 3 files changed, 38 insertions(+), 16 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 4 files changed, 136 insertions(+))

Missing test report

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

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

resource "google_integrations_client" "primary" {
  create_sample_workflows = # value needed
}

[modular-magician]

Tests analytics

Total tests: 2
Passed tests: 1
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

• integrations

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log

[SarahFrench]

Hi, thanks for adding the deprecation message! There's a 6.0.0 major release planned soon so the deprecated field can be removed then. Could you please open an issue about removing the field? That'll ensure the work is included in our planning.

Also, something I investigated was whether this PR should use the api_name property, which we use to let a resource's fields have different names to API fields. I found that it's not currently usable because the deprecated field is present, so the existing solution with pre_create should be kept. However when the deprecated field is removed in future I think we should replace the use of the pre_create with adding api_name: createSampleWorkflows to the section describing createSampleIntegrations.

---

I'm currently not able to use this API in my GCP project, so could you please confirm via manual test or acceptance test that a resource can be provisioned using either the old or the new field? Thanks!

[rohitjangid]

Hi, thanks for adding the deprecation message! There's a 6.0.0 major release planned soon so the deprecated field can be removed then. Could you please open an issue about removing the field? That'll ensure the work is included in our planning.

Also, something I investigated was whether this PR should use the api_name property, which we use to let a resource's fields have different names to API fields. I found that it's not currently usable because the deprecated field is present, so the existing solution with pre_create should be kept. However when the deprecated field is removed in future I think we should replace the use of the pre_create with adding api_name: createSampleWorkflows to the section describing createSampleIntegrations.

I'm currently not able to use this API in my GCP project, so could you please confirm via manual test or acceptance test that a resource can be provisioned using either the old or the new field? Thanks!

@SarahFrench Filed hashicorp/terraform-provider-google#17928 as request.

I have also manually tested that resource could be provisioned with either fields.

[modular-magician]

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 ( 3 files changed, 44 insertions(+), 20 deletions(-))
google-beta provider: Diff ( 3 files changed, 44 insertions(+), 20 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 4 files changed, 136 insertions(+))

Missing test report

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

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

resource "google_integrations_client" "primary" {
  create_sample_workflows = # value needed
}

[modular-magician]

Tests analytics

Total tests: 12
Passed tests: 11
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

• integrations

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log

[modular-magician]

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 ( 3 files changed, 79 insertions(+), 20 deletions(-))
google-beta provider: Diff ( 3 files changed, 79 insertions(+), 20 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 8 files changed, 242 insertions(+))

[modular-magician]

Tests analytics

Total tests: 13
Passed tests: 11
Skipped tests: 1
Affected tests: 1

Click here to see the affected service packages

• integrations

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

TestAccIntegrationsClient_integrationsClientSampleWorkflowsExample

Get to know how VCR tests work

[modular-magician]

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccIntegrationsClient_integrationsClientSampleWorkflowsExample[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$

---

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log or the debug log for each test

[modular-magician]

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 ( 3 files changed, 81 insertions(+), 22 deletions(-))
google-beta provider: Diff ( 3 files changed, 81 insertions(+), 22 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 9 files changed, 243 insertions(+), 1 deletion(-))

[modular-magician]

Tests analytics

Total tests: 13
Passed tests: 11
Skipped tests: 1
Affected tests: 1

Click here to see the affected service packages

• integrations

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

TestAccIntegrationsClient_integrationsClientBasicExample

Get to know how VCR tests work

[modular-magician]

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccIntegrationsClient_integrationsClientBasicExample[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$

---

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log or the debug log for each test

[modular-magician]

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 ( 3 files changed, 89 insertions(+), 27 deletions(-))
google-beta provider: Diff ( 3 files changed, 89 insertions(+), 27 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 9 files changed, 242 insertions(+), 1 deletion(-))

[modular-magician]

Tests analytics

Total tests: 13
Passed tests: 11
Skipped tests: 1
Affected tests: 1

Click here to see the affected service packages

• integrations

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

TestAccIntegrationsClient_integrationsClientDeprecatedFieldsExample

Get to know how VCR tests work

[modular-magician]

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccIntegrationsClient_integrationsClientDeprecatedFieldsExample[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$

---

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log or the debug log for each test

[modular-magician]

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, 89 insertions(+), 37 deletions(-))
google-beta provider: Diff ( 5 files changed, 89 insertions(+), 37 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))
Open in Cloud Shell: Diff ( 18 files changed, 242 insertions(+), 10 deletions(-))

[modular-magician]

Tests analytics

Total tests: 13
Passed tests: 3
Skipped tests: 1
Affected tests: 9

Click here to see the affected service packages

• integrations

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

TestAccIntegrationsAuthConfig_integrationsAuthConfigAdvanceExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigAuthTokenExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigClientCertificateOnlyExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigJwtExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigOauth2AuthorizationCodeExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigOauth2ClientCredentialsExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigOidcTokenExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigServiceAccountExample|TestAccIntegrationsAuthConfig_integrationsAuthConfigUsernameAndPasswordExample

Get to know how VCR tests work

[modular-magician]

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccIntegrationsAuthConfig_integrationsAuthConfigAdvanceExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigAuthTokenExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigClientCertificateOnlyExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigJwtExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigOauth2AuthorizationCodeExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigOauth2ClientCredentialsExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigOidcTokenExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigServiceAccountExample[Debug log]
TestAccIntegrationsAuthConfig_integrationsAuthConfigUsernameAndPasswordExample[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$

---

$\textcolor{green}{\textsf{All tests passed!}}$
View the build log or the debug log for each test

[rohitjangid]

Hi @SarahFrench
All issues are now resolved. PTAL.

[SarahFrench]

Approved, but here's a summary of the PR in case anyone looks back at it:

• create_sample_integrations added as a renamed version of create_sample_workflows
  • The API isn't updated yet; the pre_create code will allow the new, renamed version of the field to be matched to the relevant API field name.
  • Use of pre_create is necessary instead of api_name because of name collision between the deprecated and new versions of the field. When the deprecated field is removed use of api_name would be preferred, if its still necessary.
• Tests confirm either field can be used currently
• provision_gmek is deprecated and not related to the create_sample_* fields above