Update to use Terraform Multiplexer #565

AnPucel · 2023-07-27T17:51:26Z

🛠️ Description

This PR introduces the Terraform framework multiplexer at the top level to allow for the migration of Terraform resources from the SDKv2 to the plugin framework.

This also includes migrating the Vault Secrets App data source to the new plugin framework.

There have been manual upgrade tests run on the following resources by creating resources using the HCP Provider version 0.68.0 and switching to a local dev provider with the muxer changes to verify no changes were expected. The following manual tests were run on the following resources:

boundary cluster
consul cluster
vault cluster
hvn

This also contains maintainability fixes moving forward:

Moving all providers into a new package providersdkv2
Creating a separate package for resources and data sources within a new package

🏗️ Acceptance tests

Are there any feature flags that are required to use this functionality?
Have you added an acceptance test for the functionality being added?
Have you run the acceptance tests on this branch?

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccXXX'

# Vault Secrets tests
=== RUN   TestAcc_dataSourceVaultSecretsAppMigration
--- PASS: TestAcc_dataSourceVaultSecretsAppMigration (33.25s)
=== RUN   TestAcc_dataSourceVaultSecretsApp
--- PASS: TestAcc_dataSourceVaultSecretsApp (17.08s)

# Boundary tests
--- PASS: TestAccBoundaryCluster (246.51s)
PASS

# Consul tests
--- PASS: TestAccConsulCluster (1393.78s)
--- PASS: TestAccConsulSnapshot (1132.88s)
--- PASS: Test_validateConsulClusterTier (0.00s)
    --- PASS: Test_validateConsulClusterTier/development (0.00s)
    --- PASS: Test_validateConsulClusterTier/standard (0.00s)
    --- PASS: Test_validateConsulClusterTier/plus (0.00s)
    --- PASS: Test_validateConsulClusterTier/valid_tier_lowercase (0.00s)
    --- PASS: Test_validateConsulClusterTier/valid_tier_uppercase (0.00s)
    --- PASS: Test_validateConsulClusterTier/valid_tier_mixedcase (0.00s)
    --- PASS: Test_validateConsulClusterTier/invalid_tier (0.00s)
--- PASS: Test_validateConsulClusterSize (0.00s)
    --- PASS: Test_validateConsulClusterSize/valid_size (0.00s)
    --- PASS: Test_validateConsulClusterSize/valid_size_lowercase (0.00s)
    --- PASS: Test_validateConsulClusterSize/valid_size_uppercase (0.00s)
    --- PASS: Test_validateConsulClusterSize/valid_size_mixedcase (0.00s)
    --- PASS: Test_validateConsulClusterSize/invalid_tier (0.00s)
--- PASS: Test_validateConsulClusterCIDR (0.00s)
    --- PASS: Test_validateConsulClusterCIDR/valid_IP_address (0.00s)
    --- PASS: Test_validateConsulClusterCIDR/invalid_ip_address (0.00s)
    --- PASS: Test_validateConsulClusterCIDR/IPV6_unsupported (0.00s)
--- PASS: Test_validateConsulClusterCIDRDescription (0.00s)
    --- PASS: Test_validateConsulClusterCIDRDescription/valid_description (0.00s)
    --- PASS: Test_validateConsulClusterCIDRDescription/invalid_ip_address (0.00s)
PASS
ok      github.com/hashicorp/terraform-provider-hcp/internal/provider   2527.642s

# HVN tests
--- PASS: TestAccHvnPeeringConnection (242.92s)
--- PASS: TestAccHvnRoute (357.69s)
--- PASS: TestAccAwsHvnOnly (163.24s)
--- PASS: TestAccAzureHvnOnly (296.61s)
PASS

# Packer tests
--- PASS: TestAcc_dataSourcePackerBucketNames (57.22s)
--- PASS: TestAcc_dataSourcePacker (15.79s)
--- PASS: TestAcc_dataSourcePacker_revokedIteration (21.30s)
--- PASS: TestAcc_dataSourcePackerRunTask (29.88s)
--- PASS: TestAccPackerRunTask (66.07s)
--- PASS: TestAcc_dataSourcePackerImage_emptyChannel (4.77s)
--- PASS: TestAccPackerChannelAssignment_HCPManagedChannelErrors (12.45s)
--- PASS: TestAcc_dataSourcePackerIteration_revokedIteration (15.56s)
--- PASS: TestAcc_dataSourcePackerImage_channelAndIterationIDReject (0.30s)
--- PASS: TestAccPackerChannelAssignment_InvalidInputs (19.38s)
--- PASS: TestAcc_dataSourcePackerImage_revokedIteration (15.48s)
--- PASS: TestAcc_dataSourcePackerImage_IterationID (16.36s)
--- PASS: TestAcc_dataSourcePackerIteration_Simple (29.29s)
--- PASS: TestAcc_dataSourcePackerImage_Simple (32.40s)
--- PASS: TestAccPackerChannelAssignment_SimpleSetUnset (42.60s)
--- PASS: TestAccPackerChannelAssignment_AssignLatest (48.44s)
--- PASS: TestAccPackerChannelAssignment_CreateFailsWhenPreassigned (27.24s)
--- PASS: TestAccPackerChannel (56.54s)
--- PASS: TestAccPackerChannel_HCPManaged (58.11s)
--- PASS: TestAccPackerChannel_RestrictionDrift (64.74s)
--- PASS: TestAccPackerChannel_RestrictionDriftHCPManaged (65.23s)
--- PASS: TestAccPackerChannelAssignment_EnforceNull (96.65s)
PASS

internal/provider/provider_test.go

internal/provider/data_source_vault_secrets_app.go

aidan-mundy

Great stuff! Just a few minor nits regarding naming/style and duplicated code

internal/provider/test_helpers.go

aidan-mundy · 2023-09-08T20:45:06Z

internal/provider/statuspage.go

@@ -9,7 +9,7 @@ import (
 	"io"


We can deduplicate this code by writing a method that converts the diagnostics. I would use this file as the default implementation, and have the conversion method take new diags, and convert them to old diags.

Theoretically, this should be the statuspage that we end up using in the long run anyway. And the old one should go away. I think the duplication makes sense when all of the products convert and we can remove the old code. And I don't know if we gain a lot by having a method to convert diagnostics, if this is one of the only methods we have to do it for.

I think it will take a long time to convert all resources, so I would prioritize minimal duplication where possible. Converting diagnostics should be trivial, there may even be a method for it already in the mux package somewhere.

aidan-mundy · 2023-09-08T20:50:08Z

internal/provider/provider.go

 }

 // getProjectFromCredentials uses the configured client credentials to
 // fetch the associated organization and returns that organization's
 // single project.
-func getProjectFromCredentials(ctx context.Context, client *clients.Client) (project *models.HashicorpCloudResourcemanagerProject, diags diag.Diagnostics) {
+// This differs from the provider.go implementation due to the diagnostics used
+// by the plugin framework.


We should deduplicate this code, similar to the approach described for statuspage.go

aidan-mundy · 2023-09-08T20:52:06Z

internal/providersdkv2/provider.go

+}
+
+// getOldestProject retrieves the oldest project from a list based on its created_at time.
+func GetOldestProject(projects []*models.HashicorpCloudResourcemanagerProject) (oldestProj *models.HashicorpCloudResourcemanagerProject) {


Code is duplicated 1:1 in the framework provider. Can this be deduped?

Co-authored-by: Aidan Mundy <[email protected]>

aidan-mundy

Approving to unblock. We can follow up on some of the duplicated code in a future PR

…rm-provider-hcp into anpucel/TFFrameworkMux

AnPucel added 11 commits July 18, 2023 11:25

Test provider

f9ddece

Move implementation to internal provider

855df26

Fix versioning

e839d2c

Add debugging back

bdb752e

Fix debug mode

93f1f5a

Removing duplicate function

8b5b845

Get HCP Operational working

570d0aa

Merge conflicts

a6c7e49

Updating tests to use mux provider

dceb82e

Updating test entry point

10a0e10

Reminder

e2765dc

AnPucel changed the base branch from main to anpucel/HVSFeatures August 4, 2023 16:51

Changelog

422dae6

AnPucel changed the title ~~[WIP] Update to use Terraform Multiplexer~~ Update to use Terraform Multiplexer Aug 4, 2023

AnPucel commented Aug 7, 2023

View reviewed changes

internal/provider/provider_test.go Show resolved Hide resolved

AnPucel marked this pull request as ready for review August 7, 2023 20:38

AnPucel requested a review from a team as a code owner August 7, 2023 20:38

AnPucel requested a review from a team August 7, 2023 20:38

AnPucel requested a review from a team as a code owner August 7, 2023 20:38

AnPucel requested review from codergs and hashiblaum and removed request for a team August 7, 2023 20:38

AnPucel commented Aug 8, 2023

View reviewed changes

internal/provider/data_source_vault_secrets_app.go Outdated Show resolved Hide resolved

AnPucel added 2 commits August 7, 2023 19:14

Renaming

7f64bdd

License

b368c0f

AnPucel changed the base branch from anpucel/HVSFeatures to main August 8, 2023 16:15

AnPucel added 4 commits August 8, 2023 13:36

Merge branch 'main' into anpucel/TFFrameworkMux

c438b44

Fix CI build issue

49cb0a9

Formatting

4036d8f

Remoing comments

3a6284a

AnPucel requested a review from blueberry-pi August 30, 2023 23:26

AnPucel added 2 commits August 31, 2023 07:55

Update contributing docs with a note

b961997

Update contributing docs

08ea9dd

blueberry-pi approved these changes Aug 31, 2023

View reviewed changes

AnPucel added 2 commits August 31, 2023 20:34

Fixing provider

2014b98

Move framework specifics into provider folder

a8c2ebd

uruemu approved these changes Sep 1, 2023

View reviewed changes

Remove proto6

552af19

mkam approved these changes Sep 5, 2023

View reviewed changes

AnPucel added 7 commits September 5, 2023 20:04

Restructuring

3b74543

Resolving conflicts

3c6d546

Fixing build

300170f

mod tidy

b31fd2d

Fix acceptance tests

5bddd95

Fixing tests

f82b059

Bad merge. Fixing tests

464777c

aidan-mundy suggested changes Sep 8, 2023

View reviewed changes

AnPucel and others added 7 commits September 8, 2023 14:04

Update internal/provider/test_helpers.go

96b10ea

Co-authored-by: Aidan Mundy <[email protected]>

Update reference

f524b22

Rename factory

7a1114e

Update client name

f311b10

Rename test helpers

25a6696

Fixing build

f38a004

Merge branch 'main' into anpucel/TFFrameworkMux

93ce0d5

aidan-mundy approved these changes Sep 8, 2023

View reviewed changes

AnPucel added 3 commits September 12, 2023 12:54

Merge branch 'main' into anpucel/TFFrameworkMux

9791ea8

Merge branch 'anpucel/TFFrameworkMux' of github.com:hashicorp/terrafo…

0b06601

…rm-provider-hcp into anpucel/TFFrameworkMux

Merge branch 'main' into anpucel/TFFrameworkMux

ce21572

AnPucel merged commit 99f6196 into main Sep 13, 2023

AnPucel deleted the anpucel/TFFrameworkMux branch September 13, 2023 16:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to use Terraform Multiplexer #565

Update to use Terraform Multiplexer #565

AnPucel commented Jul 27, 2023 •

edited

Loading

aidan-mundy left a comment

aidan-mundy Sep 8, 2023

AnPucel Sep 8, 2023

aidan-mundy Sep 8, 2023

aidan-mundy Sep 8, 2023

aidan-mundy Sep 8, 2023

aidan-mundy left a comment

Update to use Terraform Multiplexer #565

Update to use Terraform Multiplexer #565

Conversation

AnPucel commented Jul 27, 2023 • edited Loading

🛠️ Description

🏗️ Acceptance tests

aidan-mundy left a comment

Choose a reason for hiding this comment

aidan-mundy Sep 8, 2023

Choose a reason for hiding this comment

AnPucel Sep 8, 2023

Choose a reason for hiding this comment

aidan-mundy Sep 8, 2023

Choose a reason for hiding this comment

aidan-mundy Sep 8, 2023

Choose a reason for hiding this comment

aidan-mundy Sep 8, 2023

Choose a reason for hiding this comment

aidan-mundy left a comment

Choose a reason for hiding this comment

AnPucel commented Jul 27, 2023 •

edited

Loading