Refactor muxing 1 : Re-use same config to configure the SDK and PF providers, fix VCR testing #11903

SarahFrench · 2024-10-03T09:06:29Z

Fixes hashicorp/terraform-provider-google#19197
Fixes hashicorp/terraform-provider-google#18774
Fixes hashicorp/terraform-provider-google#20280

Summary

This PR:

Changes how the plugin-framework implementation of the provider is configured
- Before: Parallel implementation of configuration logic that parses user inputs and populates a fwtransport.FrameworkProviderConfig struct
- After: The configure function obtains an already populated transport_tpg.Config struct from the SDK provider, with no duplication of logic to process user inputs.
Changes code defining the VCR system to accommodate the change above
- Now the PF provider uses the same Config struct as the SDK provider, both providers can use the same cached configs.
- This fixes VCR test(s) fail during replay: Framework converted resources hashicorp/terraform-provider-google#14158 , because a single test will use a single cached client again.
Makes necessary changes to the data sources currently implemented with the plugin-framework
- These now expect to receive a transport_tpg.Config struct
- Any provider-level values are now in the old type system, and require thought about where we convert between those type systems.

Things to pay attention to during review/testing

What acceptance tests need to be updated now that the PF provider is configured in a SDK-like way?
Are only changes just to the test required, or do the failures indicate user-facing changes in behaviour?
Tests
- 🔴 Acceptance tests for the provider's configuration behaviour are mostly VCR skipped. Testing this PR will require use of TeamCity!
- Manual testing encouraged
- We should look at known bugs linked to the muxing and confirm they're gone before merge
  - data.google_dns_managed_zone always fails with "Post "https://oauth2.googleapis.com/token": context canceled" hashicorp/terraform-provider-google#16832 (comment)
- After merge, we should closely monitor nightly tests and not rely on the Release Shepherd picking up any failures linked to this PR. Newer tests will provide more signal.

provider: refactored how the provider configuration is handled internally

modular-magician · 2024-10-03T09:18:33Z

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 ( 15 files changed, 157 insertions(+), 179 deletions(-))
google-beta provider: Diff ( 21 files changed, 201 insertions(+), 222 deletions(-))

SarahFrench · 2024-10-03T09:25:47Z

Initial acc tests for the SDK and PF provider code. These tests aren't final, as we're waiting for some more acc tests to be added to the code base and then pulled into this PR.

GA Provider:

SDK - all tests
Framework - all tests

Beta Provider:

SDK - all tests
Framework - all tests
Firebase - affected tests only

Test failures:

In the Framework builds lots of tests currently fail with Attribute 'X' found when not expected
- Explanation: this is because in the new PF type system if a string field's value is null the field isn't present at all, whereas in the SDK system the field would have a value of "".
- User impact? : Values that were once null will become "" when passed to PF-implemented resources.
- Code changes : This is an example of where we can just update the test
Changes cause "" values of request_reason to no longer be used in the PF code, instead any present ENVs will be used instead
Test flakiness is impacting:
- (SDK - test is misnamed) TestAccFwProvider_impersonate_service_account_delegates
- (SDK) TestAccProviderBasePath_setInvalidBasePath
- (SDK) TestAccProviderUserProjectOverride

modular-magician · 2024-10-03T10:35:08Z

Tests analytics

Total tests: 4138
Passed tests: 3716
Skipped tests: 411
Affected tests: 11

Click here to see the affected service packages

All service packages are affected

Action taken

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

TestAccDataSourceGoogleFirebaseAndroidAppConfig

TestAccDataSourceGoogleFirebaseAppleAppConfig

TestAccDataSourceGoogleQuotaInfos_basic

TestAccDataformRepositoryReleaseConfig_dataformRepositoryReleaseConfigExample

TestAccDataformRepositoryWorkflowConfig_dataformRepositoryWorkflowConfigExample

TestAccDataformRepository_dataformRepositoryWithCloudsourceRepoAndSshExample

TestAccDataformRepository_updated

TestAccDataprocCluster_withAutoscalingPolicy

TestAccFirebaseWebApp_firebaseWebAppFull

TestAccFrameworkProviderBasePath_setBasePath

TestAccFrameworkProviderMeta_setModuleName

Get to know how VCR tests work

modular-magician · 2024-10-03T11:15:31Z

🟢 Tests passed during RECORDING mode:
TestAccDataSourceGoogleFirebaseAndroidAppConfig[Debug log]
TestAccDataSourceGoogleFirebaseAppleAppConfig[Debug log]
TestAccFirebaseWebApp_firebaseWebAppFull[Debug log]
TestAccFrameworkProviderBasePath_setBasePath[Debug log]
TestAccFrameworkProviderMeta_setModuleName[Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🔴 Tests failed during RECORDING mode:
TestAccDataSourceGoogleQuotaInfos_basic[Error message] [Debug log]
TestAccDataformRepositoryReleaseConfig_dataformRepositoryReleaseConfigExample[Error message] [Debug log]
TestAccDataformRepositoryWorkflowConfig_dataformRepositoryWorkflowConfigExample[Error message] [Debug log]
TestAccDataformRepository_dataformRepositoryWithCloudsourceRepoAndSshExample[Error message] [Debug log]
TestAccDataformRepository_updated[Error message] [Debug log]
TestAccDataprocCluster_withAutoscalingPolicy[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

SarahFrench · 2024-10-03T16:23:27Z

Latest commits address some of the test failures described in this comment.

modular-magician · 2024-10-03T18:13:31Z

🟢 Tests passed during RECORDING mode:
TestAccFrameworkProviderBasePath_setBasePath[Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🔴 Tests failed during RECORDING mode:
TestAccDataSourceGoogleQuotaInfos_basic[Error message] [Debug log]
TestAccDataformRepositoryReleaseConfig_dataformRepositoryReleaseConfigExample[Error message] [Debug log]
TestAccDataformRepositoryWorkflowConfig_dataformRepositoryWorkflowConfigExample[Error message] [Debug log]
TestAccDataformRepository_dataformRepositoryWithCloudsourceRepoAndSshExample[Error message] [Debug log]
TestAccDataformRepository_updated[Error message] [Debug log]
TestAccDataprocCluster_withAutoscalingPolicy[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

modular-magician · 2024-10-03T20:32:52Z

🟢 Tests passed during RECORDING mode:
TestAccFrameworkProviderBasePath_setBasePath[Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🔴 Tests failed during RECORDING mode:
TestAccDataSourceGoogleQuotaInfos_basic[Error message] [Debug log]
TestAccDataformRepositoryReleaseConfig_dataformRepositoryReleaseConfigExample[Error message] [Debug log]
TestAccDataformRepositoryWorkflowConfig_dataformRepositoryWorkflowConfigExample[Error message] [Debug log]
TestAccDataformRepository_dataformRepositoryWithCloudsourceRepoAndSshExample[Error message] [Debug log]
TestAccDataformRepository_updated[Error message] [Debug log]
TestAccDataprocCluster_withAutoscalingPolicy[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

rainshen49

Approval for Firebase since the changes are mechanical in nature and Firebase tests are passing.

…atch

…ruct This allows the PF provider to access any data on the SDK provider, including the meta/Config struct that will be created when the SDK provider is configured.

…struct to all data sources and resources, instead of `FrameworkProviderConfig`

… Config struct to be usable in those places. - Replace use of FrameworkProviderConfig with Config - Add Beta-only `NewFirebaseClient` method to Config struct for use with Firebase data sources - Update LocationDescriber interface - Misc places where the SDK and PF type systems meet and string needs to be converted to types.StringType

…, adapt to type system changes

…rovider

- This carries over the idea of configuring the PF provider using the SDK provider. The changes in the MuxedProviders func mimic changes already made in main.go. - Remove unnecessary duplication of cached configs per test name; now one used regardless of PF/SDK - Updates to some DestroyProducer functions so they access the cached SDK Config struct to get a client - Remove GetFwTestProvider and the file containing it - this isn't needed.

…ovider-google#14158 - Use of older TPG versions through ExternalProviders breaks VCR, so that is also removed from TestAccDataSourceGoogleFirebaseAppleAppConfig

…" in the PF provider's meta struct

…e now ignored and ENVs can be used instead

…el_addition_strategy` acctest to reflect how the SDK configuration logic now affects the PF provider

…se of ExternalProviders to get other versions of TPG/TPGB

… to PF-implemented stuff

modular-magician · 2024-11-11T13:29:15Z

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 ( 25 files changed, 250 insertions(+), 231 deletions(-))
google-beta provider: Diff ( 31 files changed, 295 insertions(+), 275 deletions(-))

modular-magician · 2024-11-11T14:44:40Z

Tests analytics

Total tests: 4285
Passed tests: 3874
Skipped tests: 408
Affected tests: 3

Click here to see the affected service packages

All service packages are affected

Action taken

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

TestAccBackupDRBackupPlan_backupDrBackupPlanSimpleExample

TestAccComputeRegionPerInstanceConfig_removeInstanceOnDestroy

TestAccContainerCluster_withFleetConfig

Get to know how VCR tests work

modular-magician · 2024-11-11T15:00:43Z

🟢 Tests passed during RECORDING mode:
TestAccComputeRegionPerInstanceConfig_removeInstanceOnDestroy [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🔴 Tests failed during RECORDING mode:
TestAccBackupDRBackupPlan_backupDrBackupPlanSimpleExample [Error message] [Debug log]
TestAccContainerCluster_withFleetConfig [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

NickElliot

LGTM, I think the comment updates achieve what I was looking for

c2thorn

I think we should be good to merge this. LGTM, thanks @SarahFrench

SarahFrench · 2024-11-21T13:35:41Z

/gcbrun

SarahFrench · 2024-11-21T13:36:35Z

Thank you both! I'm just going to do one last test run before merging, partly so that there's an autogen pr branch for this PR for reference in future (the old one was deleted recently).

modular-magician · 2024-11-21T13:46:11Z

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 ( 25 files changed, 250 insertions(+), 231 deletions(-))
google-beta provider: Diff ( 31 files changed, 295 insertions(+), 275 deletions(-))

modular-magician · 2024-11-21T14:59:49Z

Tests analytics

Total tests: 4306
Passed tests: 3899
Skipped tests: 405
Affected tests: 2

Click here to see the affected service packages

All service packages are affected

Action taken

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

TestAccApigeeDeveloper_apigeeDeveloperUpdateTest

TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy

Get to know how VCR tests work

modular-magician · 2024-11-21T15:43:28Z

🟢 Tests passed during RECORDING mode:
TestAccApigeeDeveloper_apigeeDeveloperUpdateTest [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🔴 Tests failed during RECORDING mode:
TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy [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

…tform#11903 (GoogleCloudPlatform#11578)

…oviders, fix VCR testing (GoogleCloudPlatform#11903)

…tform#11903 (GoogleCloudPlatform#11578)

SarahFrench mentioned this pull request Oct 3, 2024

Refactor muxing 1 : Re-use same config to configure the SDK and PF providers, fix VCR testing #11577

Closed

modular-magician added the service/firebase label Oct 3, 2024

modular-magician requested a review from rainshen49 October 3, 2024 09:18

SarahFrench mentioned this pull request Oct 3, 2024

Failing test(s): TestAccDataformRepository* (Beta) hashicorp/terraform-provider-google#19734

Closed

This comment was marked as outdated.

Sign in to view

SarahFrench mentioned this pull request Oct 4, 2024

Refactor muxing 2 : Remove unused code, resulting from #11903 #11578

Merged

rainshen49 approved these changes Oct 15, 2024

View reviewed changes

SarahFrench mentioned this pull request Oct 18, 2024

google_client_config data-source fails to issue token : oauth2/google: invalid response from Secure Token Server: Post "https://sts.googleapis.com/v1/token": context canceled hashicorp/terraform-provider-google#18774

Closed

SarahFrench added 12 commits October 25, 2024 10:51

Add comments highlighting that parallel schemas are needed and must m…

adb7ffa

…atch

When creating the PF provider, store a pointer to the SDK provider st…

8ceeaec

…ruct This allows the PF provider to access any data on the SDK provider, including the meta/Config struct that will be created when the SDK provider is configured.

Update the plugin-framework provider to pass the SDK's Config meta …

6d447a5

…struct to all data sources and resources, instead of `FrameworkProviderConfig`

Update google_provider_config_plugin_framework to use Config struct…

767e709

…, adapt to type system changes

Update TestFrameworkProvider_impl to use primary when creating PF p…

cddd298

…rovider

Remove most instances of VCR skips referencing hashicorp/terraform-pr…

80674a9

…ovider-google#14158 - Use of older TPG versions through ExternalProviders breaks VCR, so that is also removed from TestAccDataSourceGoogleFirebaseAppleAppConfig

Update project acctest to reflect how unset string values are now "…

5ade5f7

…" in the PF provider's meta struct

Update request_reason acctest to reflect how unset string values ar…

42baac2

…e now ignored and ENVs can be used instead

Update add_terraform_attribution_label + `terraform_attribution_lab…

13e4829

…el_addition_strategy` acctest to reflect how the SDK configuration logic now affects the PF provider

Fix TestAccFrameworkProviderBasePath_setBasePath in VCR by removing u…

8a5f263

…se of ExternalProviders to get other versions of TPG/TPGB

This comment was marked as duplicate.

Sign in to view

SarahFrench removed the request for review from rainshen49 November 7, 2024 20:01

This comment was marked as outdated.

Sign in to view

Add comment about need to stop empty strings being passed from Config…

d81573a

… to PF-implemented stuff

modular-magician requested a review from rainshen49 November 11, 2024 13:29

SarahFrench requested review from c2thorn and NickElliot and removed request for rainshen49 November 11, 2024 13:39

NickElliot approved these changes Nov 19, 2024

View reviewed changes

c2thorn approved these changes Nov 20, 2024

View reviewed changes

modular-magician requested a review from rainshen49 November 21, 2024 13:46

SarahFrench removed the request for review from rainshen49 November 21, 2024 16:45

SarahFrench merged commit 4760ae5 into GoogleCloudPlatform:main Nov 21, 2024
12 of 13 checks passed

SarahFrench added a commit that referenced this pull request Nov 21, 2024

Refactor muxing 2 : Remove unused code, resulting from #11903 (#11578)

665013b

This was referenced Nov 21, 2024

Refactor muxing 2 : Remove unused code, resulting from #11903 hashicorp/terraform-provider-google-beta#8752

Merged

Refactor muxing 2 : Remove unused code, resulting from #11903 hashicorp/terraform-provider-google#20433

Merged

SarahFrench added a commit to SarahFrench/magic-modules that referenced this pull request Nov 21, 2024

Refactor muxing 2 : Remove unused code, resulting from GoogleCloudPla…

764c4d4

…tform#11903 (GoogleCloudPlatform#11578)

amanMahendroo pushed a commit to amanMahendroo/magic-modules that referenced this pull request Dec 17, 2024

Refactor muxing 1 : Re-use same config to configure the SDK and PF pr…

00d9406

…oviders, fix VCR testing (GoogleCloudPlatform#11903)

amanMahendroo pushed a commit to amanMahendroo/magic-modules that referenced this pull request Dec 17, 2024

Refactor muxing 2 : Remove unused code, resulting from GoogleCloudPla…

5c81e41

…tform#11903 (GoogleCloudPlatform#11578)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor muxing 1 : Re-use same config to configure the SDK and PF providers, fix VCR testing #11903

Refactor muxing 1 : Re-use same config to configure the SDK and PF providers, fix VCR testing #11903

SarahFrench commented Oct 3, 2024 •

edited

Loading

modular-magician commented Oct 3, 2024

SarahFrench commented Oct 3, 2024 •

edited

Loading

modular-magician commented Oct 3, 2024

modular-magician commented Oct 3, 2024

SarahFrench commented Oct 3, 2024

This comment was marked as outdated.

This comment was marked as outdated.

modular-magician commented Oct 3, 2024

This comment was marked as outdated.

This comment was marked as outdated.

modular-magician commented Oct 3, 2024

rainshen49 left a comment

This comment was marked as duplicate.

This comment was marked as outdated.

modular-magician commented Nov 11, 2024

modular-magician commented Nov 11, 2024

modular-magician commented Nov 11, 2024

NickElliot left a comment

c2thorn left a comment

SarahFrench commented Nov 21, 2024

SarahFrench commented Nov 21, 2024

modular-magician commented Nov 21, 2024

modular-magician commented Nov 21, 2024

modular-magician commented Nov 21, 2024

Refactor muxing 1 : Re-use same config to configure the SDK and PF providers, fix VCR testing #11903

Refactor muxing 1 : Re-use same config to configure the SDK and PF providers, fix VCR testing #11903

Conversation

SarahFrench commented Oct 3, 2024 • edited Loading

Summary

Things to pay attention to during review/testing

modular-magician commented Oct 3, 2024

Diff report

SarahFrench commented Oct 3, 2024 • edited Loading

modular-magician commented Oct 3, 2024

Tests analytics

Action taken

modular-magician commented Oct 3, 2024

SarahFrench commented Oct 3, 2024

This comment was marked as outdated.

This comment was marked as outdated.

modular-magician commented Oct 3, 2024

This comment was marked as outdated.

This comment was marked as outdated.

modular-magician commented Oct 3, 2024

rainshen49 left a comment

Choose a reason for hiding this comment

This comment was marked as duplicate.

This comment was marked as outdated.

modular-magician commented Nov 11, 2024

Diff report

modular-magician commented Nov 11, 2024

Tests analytics

Action taken

modular-magician commented Nov 11, 2024

NickElliot left a comment

Choose a reason for hiding this comment

c2thorn left a comment

Choose a reason for hiding this comment

SarahFrench commented Nov 21, 2024

SarahFrench commented Nov 21, 2024

modular-magician commented Nov 21, 2024

Diff report

modular-magician commented Nov 21, 2024

Tests analytics

Action taken

modular-magician commented Nov 21, 2024

SarahFrench commented Oct 3, 2024 •

edited

Loading

SarahFrench commented Oct 3, 2024 •

edited

Loading