Skip to content
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

feat: switch from Terraform Plugin SDK v2 to Terraform Plugin Framework #302

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
5eda846
feat: switch from Terraform Plugin SDK v2 to Terraform Plugin Framework
sorccu Nov 19, 2024
20de37a
fix: check 404 in all resource Read handlers and remove resource if n…
sorccu Nov 25, 2024
cb41030
feat: pump protocol version to 6.0
sorccu Nov 25, 2024
d9c8532
fix: tfplugindocs says that attributes with Default values must be Co…
sorccu Dec 3, 2024
98bcc82
feat: update doc generation script and update docs
sorccu Dec 3, 2024
a36062e
refactor: use a common ID attribute schema for all resource and data …
sorccu Dec 3, 2024
3df37b8
refactor: change heartbeat from legacy single-item Set to SingleNeste…
sorccu Dec 3, 2024
1c4aa86
refactor: move sdk utilities into a separate sdkutil package
sorccu Dec 3, 2024
36daf1d
refactor: start reorganizing files into a logical structure
sorccu Dec 3, 2024
4fb539e
refactor: use more accurate name for string set utility file
sorccu Dec 3, 2024
9c53f12
chore: remove files that have become unused
sorccu Dec 3, 2024
dc1869a
chore: go mod tidy
sorccu Dec 6, 2024
f03271a
feat: move component registration to a separate package
sorccu Dec 6, 2024
b5a674c
fix: ClientFromProviderData must allow nil ProviderData
sorccu Dec 6, 2024
44e087a
feat: add first provider tests
sorccu Dec 6, 2024
e17ef61
feat: convert static_ips data source tests
sorccu Dec 6, 2024
9f6dd5b
chore: remove old provider test file
sorccu Dec 6, 2024
1c19375
feat: convert snippet resource tests
sorccu Dec 6, 2024
7e915e3
chore: reorder imports so that our own code is in its own section
sorccu Dec 6, 2024
f01b286
feat: convert private_location resource tests
sorccu Dec 6, 2024
c4c8f40
feat: convert environment variable resource tests and fix behavior
sorccu Dec 6, 2024
0391be7
feat: convert the rest of the codebase with new abstractions
sorccu Jan 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: move sdk utilities into a separate sdkutil package
sorccu committed Dec 3, 2024
commit 1c4aa869f6b0e058334ff37b024dbdce83a858b5
13 changes: 7 additions & 6 deletions internal/provider/alert_channel_resource.go
Original file line number Diff line number Diff line change
@@ -18,6 +18,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -346,7 +347,7 @@ func (r *AlertChannelResource) Read(

realizedModel, err := r.client.GetAlertChannel(ctx, id)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
@@ -419,7 +420,7 @@ func (r *AlertChannelResource) Update(
}
}

var AlertChannelID = SDKIdentifier{
var AlertChannelID = sdkutil.Identifier{
Path: path.Root("id"),
Title: "Checkly Alert Channel ID",
}
@@ -667,8 +668,8 @@ type WebhookAttributeModel struct {
func (m *WebhookAttributeModel) Refresh(ctx context.Context, from *checkly.AlertChannelWebhook, flags RefreshFlags) diag.Diagnostics {
m.Name = types.StringValue(from.Name)
m.Method = types.StringValue(from.Method)
m.Headers = SDKKeyValuesIntoMap(&from.Headers)
m.QueryParameters = SDKKeyValuesIntoMap(&from.QueryParameters)
m.Headers = sdkutil.KeyValuesIntoMap(&from.Headers)
m.QueryParameters = sdkutil.KeyValuesIntoMap(&from.QueryParameters)
m.Template = types.StringValue(from.Template)
m.URL = types.StringValue(from.URL)
m.WebhookSecret = types.StringValue(from.WebhookSecret)
@@ -680,8 +681,8 @@ func (m *WebhookAttributeModel) Refresh(ctx context.Context, from *checkly.Alert
func (m *WebhookAttributeModel) Render(ctx context.Context, into *checkly.AlertChannelWebhook) diag.Diagnostics {
into.Name = m.Name.ValueString()
into.Method = m.Method.ValueString()
into.Headers = SDKKeyValuesFromMap(m.Headers)
into.QueryParameters = SDKKeyValuesFromMap(m.QueryParameters)
into.Headers = sdkutil.KeyValuesFromMap(m.Headers)
into.QueryParameters = sdkutil.KeyValuesFromMap(m.QueryParameters)
into.Template = m.Template.ValueString()
into.URL = m.URL.ValueString()
into.WebhookSecret = m.WebhookSecret.ValueString()
9 changes: 5 additions & 4 deletions internal/provider/check_api_check_defaults_attribute.go
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -41,8 +42,8 @@ func (m *CheckAPICheckDefaultsAttributeModel) Refresh(ctx context.Context, from
var diags diag.Diagnostics

m.URL = types.StringValue(from.BaseURL)
m.Headers = SDKKeyValuesIntoMap(&from.Headers)
m.QueryParameters = SDKKeyValuesIntoMap(&from.QueryParameters)
m.Headers = sdkutil.KeyValuesIntoMap(&from.Headers)
m.QueryParameters = sdkutil.KeyValuesIntoMap(&from.QueryParameters)

diags.Append(RefreshMany(ctx, from.Assertions, m.Assertions, flags)...)

@@ -55,8 +56,8 @@ func (m *CheckAPICheckDefaultsAttributeModel) Render(ctx context.Context, into *
var diags diag.Diagnostics

into.BaseURL = m.URL.ValueString()
into.Headers = SDKKeyValuesFromMap(m.Headers)
into.QueryParameters = SDKKeyValuesFromMap(m.QueryParameters)
into.Headers = sdkutil.KeyValuesFromMap(m.Headers)
into.QueryParameters = sdkutil.KeyValuesFromMap(m.QueryParameters)

diags.Append(RenderMany(ctx, m.Assertions, into.Assertions)...)

5 changes: 3 additions & 2 deletions internal/provider/check_group_resource.go
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -233,7 +234,7 @@ func (r *CheckGroupResource) Read(

realizedModel, err := r.client.GetGroup(ctx, id)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
@@ -306,7 +307,7 @@ func (r *CheckGroupResource) Update(
}
}

var CheckGroupID = SDKIdentifier{
var CheckGroupID = sdkutil.Identifier{
Path: path.Root("id"),
Title: "Checkly Check Group ID",
}
5 changes: 3 additions & 2 deletions internal/provider/check_headers_attribute.go
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -23,13 +24,13 @@ var CheckHeadersAttributeSchema = schema.MapAttribute{
type CheckHeadersAttributeModel types.Map

func (m *CheckHeadersAttributeModel) Refresh(ctx context.Context, from *[]checkly.KeyValue, flags RefreshFlags) diag.Diagnostics {
*m = CheckHeadersAttributeModel(SDKKeyValuesIntoMap(from))
*m = CheckHeadersAttributeModel(sdkutil.KeyValuesIntoMap(from))

return nil
}

func (m *CheckHeadersAttributeModel) Render(ctx context.Context, into *[]checkly.KeyValue) diag.Diagnostics {
*into = SDKKeyValuesFromMap(types.Map(*m))
*into = sdkutil.KeyValuesFromMap(types.Map(*m))

return nil
}
5 changes: 3 additions & 2 deletions internal/provider/check_query_parameters_attribute.go
Original file line number Diff line number Diff line change
@@ -8,6 +8,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -23,13 +24,13 @@ var CheckQueryParametersAttributeSchema = schema.MapAttribute{
type CheckQueryParametersAttributeModel types.Map

func (m *CheckQueryParametersAttributeModel) Refresh(ctx context.Context, from *[]checkly.KeyValue, flags RefreshFlags) diag.Diagnostics {
*m = CheckQueryParametersAttributeModel(SDKKeyValuesIntoMap(from))
*m = CheckQueryParametersAttributeModel(sdkutil.KeyValuesIntoMap(from))

return nil
}

func (m *CheckQueryParametersAttributeModel) Render(ctx context.Context, into *[]checkly.KeyValue) diag.Diagnostics {
*into = SDKKeyValuesFromMap(types.Map(*m))
*into = sdkutil.KeyValuesFromMap(types.Map(*m))

return nil
}
9 changes: 5 additions & 4 deletions internal/provider/check_request_attribute.go
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -102,8 +103,8 @@ func (m *CheckRequestAttributeModel) Refresh(ctx context.Context, from *checkly.
m.URL = types.StringValue(from.URL)
m.FollowRedirects = types.BoolValue(from.FollowRedirects)
m.SkipSSL = types.BoolValue(from.SkipSSL)
m.Headers = SDKKeyValuesIntoMap(&from.Headers)
m.QueryParameters = SDKKeyValuesIntoMap(&from.QueryParameters)
m.Headers = sdkutil.KeyValuesIntoMap(&from.Headers)
m.QueryParameters = sdkutil.KeyValuesIntoMap(&from.QueryParameters)
m.Body = types.StringValue(from.Body)
m.BodyType = types.StringValue(from.BodyType)

@@ -127,8 +128,8 @@ func (m *CheckRequestAttributeModel) Render(ctx context.Context, into *checkly.R
into.URL = m.URL.ValueString()
into.FollowRedirects = m.FollowRedirects.ValueBool()
into.SkipSSL = m.SkipSSL.ValueBool()
into.Headers = SDKKeyValuesFromMap(m.Headers)
into.QueryParameters = SDKKeyValuesFromMap(m.QueryParameters)
into.Headers = sdkutil.KeyValuesFromMap(m.Headers)
into.QueryParameters = sdkutil.KeyValuesFromMap(m.QueryParameters)
into.Body = m.Body.ValueString()
into.BodyType = m.Body.ValueString()

3 changes: 2 additions & 1 deletion internal/provider/check_resource.go
Original file line number Diff line number Diff line change
@@ -17,6 +17,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -302,7 +303,7 @@ func (r *CheckResource) Read(

realizedModel, err := r.client.GetCheck(ctx, state.ID.ValueString())
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
3 changes: 2 additions & 1 deletion internal/provider/dashboard_resource.go
Original file line number Diff line number Diff line change
@@ -17,6 +17,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -249,7 +250,7 @@ func (r *DashboardResource) Read(

realizedModel, err := r.client.GetDashboard(ctx, state.ID.ValueString())
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
3 changes: 2 additions & 1 deletion internal/provider/environment_variable_resource.go
Original file line number Diff line number Diff line change
@@ -12,6 +12,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -174,7 +175,7 @@ func (r *EnvironmentVariableResource) Read(
state.ID.ValueString(),
)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
3 changes: 2 additions & 1 deletion internal/provider/heartbeat_resource.go
Original file line number Diff line number Diff line change
@@ -14,6 +14,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -209,7 +210,7 @@ func (r *HeartbeatResource) Read(

realizedModel, err := r.client.GetHeartbeatCheck(ctx, state.ID.ValueString())
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
5 changes: 3 additions & 2 deletions internal/provider/maintenance_windows_resource.go
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -192,7 +193,7 @@ func (r *MaintenanceWindowsResource) Read(

realizedModel, err := r.client.GetMaintenanceWindow(ctx, id)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
@@ -265,7 +266,7 @@ func (r *MaintenanceWindowsResource) Update(
}
}

var MaintenanceWindowID = SDKIdentifier{
var MaintenanceWindowID = sdkutil.Identifier{
Path: path.Root("id"),
Title: "Checkly Maintenance Window ID",
}
3 changes: 2 additions & 1 deletion internal/provider/private_location_resource.go
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -168,7 +169,7 @@ func (r *PrivateLocationResource) Read(

realizedModel, err := r.client.GetPrivateLocation(ctx, state.ID.ValueString())
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
5 changes: 3 additions & 2 deletions internal/provider/snippet_resource.go
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -168,7 +169,7 @@ func (r *SnippetResource) Read(

realizedModel, err := r.client.GetSnippet(ctx, id)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
@@ -241,7 +242,7 @@ func (r *SnippetResource) Update(
}
}

var SnippetID = SDKIdentifier{
var SnippetID = sdkutil.Identifier{
Path: path.Root("id"),
Title: "Checkly Snippet ID",
}
5 changes: 3 additions & 2 deletions internal/provider/trigger_check_resource.go
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -160,7 +161,7 @@ func (r *TriggerCheckResource) Read(
state.CheckID.ValueString(),
)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
@@ -220,7 +221,7 @@ func (r *TriggerCheckResource) Update(
}
}

var TriggerCheckID = SDKIdentifier{
var TriggerCheckID = sdkutil.Identifier{
Path: path.Root("id"),
Title: "Checkly Trigger Check ID",
}
5 changes: 3 additions & 2 deletions internal/provider/trigger_group_resource.go
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/types"

checkly "github.com/checkly/checkly-go-sdk"
"github.com/checkly/terraform-provider-checkly/internal/sdkutil"
)

var (
@@ -160,7 +161,7 @@ func (r *TriggerGroupResource) Read(
state.GroupID.ValueInt64(),
)
if err != nil {
if SDKIsHTTPNotFoundError(err) {
if sdkutil.IsHTTPNotFoundError(err) {
resp.State.RemoveResource(ctx)
return
}
@@ -220,7 +221,7 @@ func (r *TriggerGroupResource) Update(
}
}

var TriggerGroupID = SDKIdentifier{
var TriggerGroupID = sdkutil.Identifier{
Path: path.Root("id"),
Title: "Checkly Trigger Group ID",
}
14 changes: 7 additions & 7 deletions internal/provider/sdk.go → internal/sdkutil/sdkutil.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package provider
package sdkutil

import (
"fmt"
@@ -13,12 +13,12 @@ import (
checkly "github.com/checkly/checkly-go-sdk"
)

type SDKIdentifier struct {
type Identifier struct {
Path path.Path
Title string
}

func (i *SDKIdentifier) FromString(id types.String) (int64, diag.Diagnostics) {
func (i *Identifier) FromString(id types.String) (int64, diag.Diagnostics) {
if id.IsUnknown() {
return 0, diag.Diagnostics{
diag.NewAttributeErrorDiagnostic(
@@ -53,11 +53,11 @@ func (i *SDKIdentifier) FromString(id types.String) (int64, diag.Diagnostics) {
return val, nil
}

func (i *SDKIdentifier) IntoString(id int64) types.String {
func (i *Identifier) IntoString(id int64) types.String {
return types.StringValue(fmt.Sprintf("%d", id))
}

func SDKKeyValuesFromMap(m types.Map) []checkly.KeyValue {
func KeyValuesFromMap(m types.Map) []checkly.KeyValue {
if m.IsNull() {
return nil
}
@@ -73,7 +73,7 @@ func SDKKeyValuesFromMap(m types.Map) []checkly.KeyValue {
return values
}

func SDKKeyValuesIntoMap(values *[]checkly.KeyValue) types.Map {
func KeyValuesIntoMap(values *[]checkly.KeyValue) types.Map {
if values == nil {
return types.MapNull(types.StringType)
}
@@ -86,7 +86,7 @@ func SDKKeyValuesIntoMap(values *[]checkly.KeyValue) types.Map {
return types.MapValueMust(types.StringType, mapValues)
}

func SDKIsHTTPNotFoundError(err error) bool {
func IsHTTPNotFoundError(err error) bool {
// Unfortunately the SDK presents HTTP errors in a completely unusable way,
// forcing us to match against string values.
msg := err.Error()