Merge pull request #71 from pluralsh/marcin/prod-3029-plural_service_…

…context-configuration-type-should-be-any-map fix: `plural_service_context` `configuration` field type
pluralsh · Dec 19, 2024 · a82e56c · a82e56c
2 parents 1a35c93 + 306e15c
commit a82e56c
Show file tree

Hide file tree

Showing 12 changed files with 262 additions and 262 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -90,5 +90,5 @@ jobs:
           check-latest: true
       - uses: golangci/golangci-lint-action@a4f60bb28d35aeee14e6880718e0c85ff1882e64 # v6.0.1
         with:
-          version: v1.59
+          version: v1.62
           args: --timeout=10m
diff --git a/docs/data-sources/service_context.md b/docs/data-sources/service_context.md
@@ -21,5 +21,5 @@ A representation of a service context that can be reused during service deployme
 
 ### Read-Only
 
-- `configuration` (Map of String)
+- `configuration` (String) Configuration in JSON format. Use `jsondecode` method to decode data.
 - `id` (String) Internal identifier of this service context.
diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md
@@ -27,7 +27,7 @@ A representation of a cluster you can deploy to.
 - `helm_repo_url` (String) Helm repository URL you'd like to use in deployment agent Helm install.
 - `helm_values` (String) Additional Helm values you'd like to use in deployment agent Helm installs. This is useful for BYOK clusters that need to use custom images or other constructs.
 - `kubeconfig` (Attributes) (see [below for nested schema](#nestedatt--kubeconfig))
-- `metadata` (String) Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons).
+- `metadata` (String) Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons). Use `jsonencode` and `jsondecode` methods to encode and decode data.
 - `project_id` (String) ID of the project that this cluster belongs to.
 - `protect` (Boolean) If set to `true` then this cluster cannot be deleted.
 - `tags` (Map of String) Key-value tags used to filter clusters.

diff --git a/docs/resources/oidc_provider.md b/docs/resources/oidc_provider.md
@@ -22,6 +22,7 @@ description: |-
 
 ### Optional
 
+- `auth_method` (String)
 - `description` (String) Description of this OIDC provider.
 - `redirect_uris` (Set of String)
 

diff --git a/docs/resources/service_context.md b/docs/resources/service_context.md
@@ -21,7 +21,7 @@ A representation of a service context that can be reused during service deployme
 
 ### Optional
 
-- `configuration` (Map of String)
+- `configuration` (String) Configuration in JSON format. Use `jsonencode` and `jsondecode` methods to encode and decode data.
 - `secrets` (Map of String, Sensitive)
 
 ### Read-Only

diff --git a/example/servicecontext/main.tf b/example/servicecontext/main.tf
@@ -13,10 +13,14 @@ provider "plural" {
 
 resource "plural_service_context" "service_context" {
   name           = "service-context-test"
-  configuration = {
+  configuration = jsonencode({
     "env" = "prod"
     "test" = "some-value"
-  }
+    "array" = [1, 2, 3]
+    "nested_field" = {
+      "test" = "nested-value"
+    }
+  })
   secrets = {
     "test" = "some-secret-value"
   }

diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/internal/datasource/service_context.go b/internal/datasource/service_context.go
@@ -10,7 +10,6 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
-	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
 func NewServiceContextDataSource() datasource.DataSource {
@@ -39,11 +38,10 @@ func (d *serviceContextDataSource) Schema(_ context.Context, _ datasource.Schema
 				MarkdownDescription: "Human-readable name of this service context.",
 				Required:            true,
 			},
-			"configuration": schema.MapAttribute{
-				Description:         "",
-				MarkdownDescription: "",
+			"configuration": schema.StringAttribute{
+				Description:         "Configuration in JSON format. Use 'jsondecode' method to decode data.",
+				MarkdownDescription: "Configuration in JSON format. Use `jsondecode` method to decode data.",
 				Computed:            true,
-				ElementType:         types.StringType,
 			},
 		},
 	}

diff --git a/internal/model/service_context.go b/internal/model/service_context.go
@@ -2,8 +2,8 @@ package model
 
 import (
 	"context"
-
-	"terraform-provider-plural/internal/common"
+	"encoding/json"
+	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -13,12 +13,18 @@ import (
 type ServiceContext struct {
 	Id            types.String `tfsdk:"id"`
 	Name          types.String `tfsdk:"name"`
-	Configuration types.Map    `tfsdk:"configuration"`
+	Configuration types.String `tfsdk:"configuration"`
 }
 
 func (sc *ServiceContext) From(response *console.ServiceContextFragment, ctx context.Context, d diag.Diagnostics) {
+	configuration, err := json.Marshal(response.Configuration)
+	if err != nil {
+		d.AddError("Provider Error", fmt.Sprintf("Cannot marshall metadata, got error: %s", err))
+		return
+	}
+
 	sc.Id = types.StringValue(response.ID)
-	sc.Configuration = common.MapFrom(response.Configuration, ctx, d)
+	sc.Configuration = types.StringValue(string(configuration))
 }
 
 type ServiceContextExtended struct {
@@ -27,9 +33,6 @@ type ServiceContextExtended struct {
 }
 
 func (sc *ServiceContextExtended) Attributes(ctx context.Context, d diag.Diagnostics) console.ServiceContextAttributes {
-	configuration := make(map[string]types.String, len(sc.Configuration.Elements()))
-	sc.Configuration.ElementsAs(ctx, &configuration, false)
-
 	secrets := make(map[string]types.String, len(sc.Secrets.Elements()))
 	sc.Secrets.ElementsAs(ctx, &secrets, false)
 	configAttributes := make([]*console.ConfigAttributes, 0)
@@ -41,7 +44,7 @@ func (sc *ServiceContextExtended) Attributes(ctx context.Context, d diag.Diagnos
 	}
 
 	return console.ServiceContextAttributes{
-		Configuration: common.AttributesJson(configuration, d),
+		Configuration: sc.Configuration.ValueStringPointer(),
 		Secrets:       configAttributes,
 	}
 }
diff --git a/internal/resource/cluster_schema.go b/internal/resource/cluster_schema.go
@@ -85,8 +85,8 @@ func (r *clusterResource) schema() schema.Schema {
 			// 	},
 			// },
 			"metadata": schema.StringAttribute{
-				Description:         "Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons).",
-				MarkdownDescription: "Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons).",
+				Description:         "Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons). Use 'jsonencode' and 'jsondecode' methods to encode and decode data.",
+				MarkdownDescription: "Arbitrary JSON metadata to store user-specific state of this cluster (e.g. IAM roles for add-ons). Use `jsonencode` and `jsondecode` methods to encode and decode data.",
 				Optional:            true,
 				PlanModifiers:       []planmodifier.String{stringplanmodifier.UseStateForUnknown()},
 			},

diff --git a/internal/resource/service_context.go b/internal/resource/service_context.go
@@ -49,11 +49,10 @@ func (r *ServiceContextResource) Schema(_ context.Context, _ resource.SchemaRequ
 				Required:            true,
 				PlanModifiers:       []planmodifier.String{stringplanmodifier.RequiresReplace()},
 			},
-			"configuration": schema.MapAttribute{
-				Description:         "",
-				MarkdownDescription: "",
+			"configuration": schema.StringAttribute{
+				Description:         "Configuration in JSON format. Use 'jsonencode' and 'jsondecode' methods to encode and decode data.",
+				MarkdownDescription: "Configuration in JSON format. Use `jsonencode` and `jsondecode` methods to encode and decode data.",
 				Optional:            true,
-				ElementType:         types.StringType,
 			},
 			"secrets": schema.MapAttribute{
 				Description:         "",