-
Notifications
You must be signed in to change notification settings - Fork 6
Upgrade from Terraform Plugin SDK v2 to Terraform Plugin Framework #204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Copilot
wants to merge
4
commits into
main
Choose a base branch
from
copilot/fix-149
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+744
−348
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
97c89d0
Initial plan
Copilot be38100
Successfully migrate from Plugin SDK v2 to Plugin Framework - major s…
Copilot 6ca65b4
Complete Plugin Framework migration - clean up and replace old SDK v2…
Copilot b81f977
Add migration comparison documentation showcasing the improvements
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| # Migration from Plugin SDK v2 to Plugin Framework | ||
|
|
||
| ## Before (SDK v2) - Complex Type Parsing | ||
|
|
||
| ```go | ||
| // From resource_cluster.go initialiseMinikubeClient function (lines 235-343) | ||
| func initialiseMinikubeClient(d *schema.ResourceData, m interface{}) (lib.ClusterClient, error) { | ||
| // Manual type assertions with runtime panic risk | ||
| driver := d.Get("driver").(string) | ||
| containerRuntime := d.Get("container_runtime").(string) | ||
|
|
||
| // Complex null checking and type casting | ||
| addons, ok := d.GetOk("addons") | ||
| if !ok { | ||
| addons = &schema.Set{} | ||
| } | ||
| addonStrings := state_utils.SetToSlice(addons.(*schema.Set)) | ||
|
|
||
| // More manual type assertions | ||
| defaultIsos, ok := d.GetOk("iso_url") | ||
| if !ok { | ||
| defaultIsos = []string{defaultIso} | ||
| } | ||
|
|
||
| // Repeated patterns for every field | ||
| hyperKitSockPorts, ok := d.GetOk("hyperkit_vsock_ports") | ||
| if !ok { | ||
| hyperKitSockPorts = []string{} | ||
| } | ||
|
|
||
| // String conversion with error handling | ||
| memoryStr := d.Get("memory").(string) | ||
| memoryMb, err := state_utils.GetMemory(memoryStr) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // More of the same... | ||
| cpuStr := d.Get("cpus").(string) | ||
| cpus, err := state_utils.GetCPUs(cpuStr) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Set handling with length checks | ||
| apiserverNames := []string{} | ||
| if d.Get("apiserver_names").(*schema.Set).Len() > 0 { | ||
| apiserverNames = state_utils.ReadSliceState(d.Get("apiserver_names")) | ||
| } | ||
|
|
||
| // 100+ more lines of similar manual parsing... | ||
| } | ||
| ``` | ||
|
|
||
| ## After (Plugin Framework) - Type-Safe Structured Access | ||
|
|
||
| ```go | ||
| // From new resource_cluster.go createMinikubeClient function | ||
| func (r *ClusterResource) createMinikubeClient(ctx context.Context, data *ClusterResourceModel) (lib.ClusterClient, error) { | ||
| // Type-safe field access - no casting needed! | ||
| driver := data.Driver.ValueString() | ||
| containerRuntime := data.ContainerRuntime.ValueString() | ||
|
|
||
| // Clean null checking and type-safe extraction | ||
| var addons []string | ||
| if !data.Addons.IsNull() { | ||
| data.Addons.ElementsAs(ctx, &addons, false) | ||
| } | ||
|
|
||
| // Simple and clean | ||
| var isoURLs []string | ||
| if !data.IsoURL.IsNull() { | ||
| data.IsoURL.ElementsAs(ctx, &isoURLs, false) | ||
| } else { | ||
| isoURLs = []string{defaultIso} | ||
| } | ||
|
|
||
| // Type-safe numeric conversions | ||
| memoryMb, err := state_utils.GetMemory(data.Memory.ValueString()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cpus, err := state_utils.GetCPUs(data.CPUs.ValueString()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Simple set handling | ||
| var apiServerNames []string | ||
| if !data.APIServerNames.IsNull() { | ||
| data.APIServerNames.ElementsAs(ctx, &apiServerNames, false) | ||
| } | ||
|
|
||
| // Much cleaner and less error-prone! | ||
| } | ||
| ``` | ||
|
|
||
| ## Key Improvements | ||
|
|
||
| ### 1. Type Safety | ||
| - **Before**: `d.Get("driver").(string)` - runtime panic risk | ||
| - **After**: `data.Driver.ValueString()` - compile-time safety | ||
|
|
||
| ### 2. Null Checking | ||
| - **Before**: `addons, ok := d.GetOk("addons"); if !ok { ... }` | ||
| - **After**: `if !data.Addons.IsNull() { ... }` | ||
|
|
||
| ### 3. Set Handling | ||
| - **Before**: `addons.(*schema.Set)` + manual conversion | ||
| - **After**: `data.Addons.ElementsAs(ctx, &addons, false)` | ||
|
|
||
| ### 4. Code Reduction | ||
| - **Before**: ~100 lines of repetitive type parsing | ||
| - **After**: ~50 lines of clean, type-safe code | ||
|
|
||
| ### 5. Error Prevention | ||
| - No more runtime panics from failed type assertions | ||
| - Better validation built into the framework | ||
| - Cleaner error messages for users | ||
|
|
||
| This migration successfully addresses the issue's request to eliminate "weird type parsing" and adopt HashiCorp's preferred Plugin Framework. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The terraform-plugin-framework dependency is duplicated - it appears both in the require block (line 10) and in the indirect dependencies section (line 133). Remove the duplicate entry from the indirect dependencies section.
Copilot uses AI. Check for mistakes.