INITIAL DRAFT FOR FEEDBACK: Implement provider functions

[SarahFrench]

Description

This PR is an initial draft of implementing provider-defined functions for retrieving elements of a resource's self link or id.

Please see internal, shared doc for details about this work.

See comments for version of Terraform required to test locally!

My intention is to split this PR up in future:

• Bump dependencies in the first PR and add some changes present in this PR for mmv1/third_party/terraform/fwprovider/framework_provider.go.erb
  • See here : Update hashicorp/terraform-plugin-framework, hashicorp/terraform-plugin-mux, hashicorp/terraform-plugin-sdk/v2 #10009
• Subsequent PR(s) to add individual functions
• Those PRs would include documentation (absent from this PR currently)

I've put release notes in place on this PR that would be split between those future PRs as appropriate!

---

Release Note Template for Downstream PRs (will be copied)

[SarahFrench]

NOTE: Using Terraform 1.8.0 is required for this feature. I've built 1.8.0 locally from the hashicorp/terraform repo and used that during local development of this PR. I expect the tests above to fail!

I checked out the v1.8.0-alpha20240214 tag and build the provider locally:

% terraform version
Terraform v1.8.0-dev
on darwin_arm64

[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.

Terraform GA: Diff ( 9 files changed, 642 insertions(+), 142 deletions(-))
Terraform Beta: Diff ( 9 files changed, 642 insertions(+), 142 deletions(-))

[modular-magician]

Tests analytics

Total tests: 3445
Passed tests: 3090
Skipped tests: 353
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

TestAccContainerCluster_withGatewayApiConfig|TestAccWorkstationsWorkstationConfig_updateHostDetails

Get to know how VCR tests work

[modular-magician]

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccContainerCluster_withGatewayApiConfig[Error message] [Debug log]
TestAccWorkstationsWorkstationConfig_updateHostDetails[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
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.

Terraform GA: Diff ( 13 files changed, 1046 insertions(+), 142 deletions(-))
Terraform Beta: Diff ( 13 files changed, 1046 insertions(+), 142 deletions(-))

[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.

Terraform GA: Diff ( 13 files changed, 1046 insertions(+), 142 deletions(-))
Terraform Beta: Diff ( 13 files changed, 1046 insertions(+), 142 deletions(-))

[modular-magician]

Tests analytics

Total tests: 3451
Passed tests: 3094
Skipped tests: 355
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

TestAccContainerCluster_withGatewayApiConfig|TestAccWorkstationsWorkstationConfig_updateHostDetails

Get to know how VCR tests work

[modular-magician]

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccContainerCluster_withGatewayApiConfig[Error message] [Debug log]
TestAccWorkstationsWorkstationConfig_updateHostDetails[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
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.

Terraform GA: Diff ( 15 files changed, 1202 insertions(+), 142 deletions(-))
Terraform Beta: Diff ( 15 files changed, 1202 insertions(+), 142 deletions(-))

[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.

Terraform GA: Diff ( 15 files changed, 1197 insertions(+), 142 deletions(-))
Terraform Beta: Diff ( 15 files changed, 1197 insertions(+), 142 deletions(-))

[modular-magician]

Tests analytics

Total tests: 3453
Passed tests: 3095
Skipped tests: 351
Affected tests: 7

Click here to see the affected service packages

all service packages are affected

Action taken

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

TestAccContainerCluster_withGatewayApiConfig|TestAccProviderFunction_location_from_id|TestAccProviderFunction_name_from_id|TestAccProviderFunction_project_from_id|TestAccProviderFunction_region_from_id|TestAccProviderFunction_zone_from_id|TestAccWorkstationsWorkstationConfig_updateHostDetails

Get to know how VCR tests work

[modular-magician]

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccContainerCluster_withGatewayApiConfig[Error message] [Debug log]
TestAccProviderFunction_location_from_id[Error message] [Debug log]
TestAccProviderFunction_name_from_id[Error message] [Debug log]
TestAccProviderFunction_project_from_id[Error message] [Debug log]
TestAccProviderFunction_region_from_id[Error message] [Debug log]
TestAccProviderFunction_zone_from_id[Error message] [Debug log]
TestAccWorkstationsWorkstationConfig_updateHostDetails[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

[rileykarson]

Took an initial look yesterday and looked reasonable so far. Waiting to review until this moves out of draft.

[SarahFrench]

@rileykarson I marked this PR as out of draft, but I think I'll return it to draft and continue to split it out into multiple PRs now that I've received initial feedback on my approach. The PR is too big for thorough review, but if you have any more general feedback on the approach please post here!

I've broken out these two PRs that could be merged before the functions are:

• Bump dependencies : Update hashicorp/terraform-plugin-framework, hashicorp/terraform-plugin-mux, hashicorp/terraform-plugin-sdk/v2 #10009
  • We could merge this now!
• Update to enable functions: Add support for provider-defined functions #10013
  • Depends on first PR.
  • Merging into FEATURE-BRANCH-provider-functions

I'll continue to make PRs for the individual functions and include documentation in each.

[SarahFrench]

Now I've received initial feedback, I'm closing this PR in favour of using the FEATURE-BRANCH-provider-functions feature branch