diagnostic support to ConfigureContextFunc

Author: appilon

helper/schema/provider.go

@@ -78,7 +78,7 @@ type ConfigureFunc func(*ResourceData) (interface{}, error)
 // the subsequent resources as the meta parameter. This return value is
 // usually used to pass along a configured API client, a configuration
 // structure, etc.
-type ConfigureContextFunc func(context.Context, *ResourceData) (interface{}, error)
+type ConfigureContextFunc func(context.Context, *ResourceData) (interface{}, diag.Diagnostics)
 
 // InternalValidate should be called to validate the structure
 // of the provider.
@@ -233,11 +233,14 @@ func (p *Provider) ValidateResource(
 //
 // This won't be called at all if no provider configuration is given.
 //
-// Configure returns an error if it occurred.
-func (p *Provider) Configure(ctx context.Context, c *terraform.ResourceConfig) error {
+// Configure returns Diagnostics.
+func (p *Provider) Configure(ctx context.Context, c *terraform.ResourceConfig) diag.Diagnostics {
+
+	var diags diag.Diagnostics
+
 	// No configuration
 	if p.ConfigureFunc == nil && p.ConfigureContextFunc == nil {
-		return nil
+		return diags
 	}
 
 	sm := schemaMap(p.Schema)
@@ -246,26 +249,31 @@ func (p *Provider) Configure(ctx context.Context, c *terraform.ResourceConfig) e
 	// generate an intermediary "diff" although that is never exposed.
 	diff, err := sm.Diff(ctx, nil, c, nil, p.meta, true)
 	if err != nil {
-		return err
+		return append(diags, diag.FromErr(err))
 	}
 
 	data, err := sm.Data(nil, diff)
 	if err != nil {
-		return err
+		return append(diags, diag.FromErr(err))
 	}
 
-	var meta interface{}
-	if p.ConfigureContextFunc != nil {
-		meta, err = p.ConfigureContextFunc(ctx, data)
-	} else {
-		meta, err = p.ConfigureFunc(data)
+	if p.ConfigureFunc != nil {
+		meta, err := p.ConfigureFunc(data)
+		if err != nil {
+			return append(diags, diag.FromErr(err))
+		}
+		p.meta = meta
 	}
-	if err != nil {
-		return err
+	if p.ConfigureContextFunc != nil {
+		meta, ds := p.ConfigureContextFunc(ctx, data)
+		diags = append(diags, ds...)
+		if diags.HasError() {
+			return diags
+		}
+		p.meta = meta
 	}
 
-	p.meta = meta
-	return nil
+	return diags
 }
 
 // Resources returns all the available resource types that this provider

helper/schema/provider_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/hashicorp/go-cty/cty"
 
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/internal/configs/configschema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
@@ -137,12 +138,12 @@ func TestProviderConfigure(t *testing.T) {
 					},
 				},
 
-				ConfigureContextFunc: func(ctx context.Context, d *ResourceData) (interface{}, error) {
+				ConfigureContextFunc: func(ctx context.Context, d *ResourceData) (interface{}, diag.Diagnostics) {
 					if d.Get("foo").(int) == 42 {
 						return nil, nil
 					}
 
-					return nil, fmt.Errorf("nope")
+					return nil, diag.Diagnostics{diag.FromErr(fmt.Errorf("nope"))}
 				},
 			},
 			Config: map[string]interface{}{
@@ -177,9 +178,9 @@ func TestProviderConfigure(t *testing.T) {
 
 	for i, tc := range cases {
 		c := terraform.NewResourceConfigRaw(tc.Config)
-		err := tc.P.Configure(context.Background(), c)
-		if err != nil != tc.Err {
-			t.Fatalf("%d: %s", i, err)
+		diags := tc.P.Configure(context.Background(), c)
+		if diags.HasError() != tc.Err {
+			t.Fatalf("%d: %s", i, errorDiags(diags))
 		}
 	}
 }
@@ -551,7 +552,7 @@ func TestProvider_InternalValidate(t *testing.T) {
 				ConfigureFunc: func(d *ResourceData) (interface{}, error) {
 					return nil, nil
 				},
-				ConfigureContextFunc: func(ctx context.Context, d *ResourceData) (interface{}, error) {
+				ConfigureContextFunc: func(ctx context.Context, d *ResourceData) (interface{}, diag.Diagnostics) {
 					return nil, nil
 				},
 			},

helper/schema/resource.go

@@ -514,7 +514,6 @@ func (r *Resource) RefreshWithoutUpgrade(
 	rt := ResourceTimeout{}
 	if _, ok := s.Meta[TimeoutKey]; ok {
 		if err := rt.StateDecode(s); err != nil {
-			// TODO should this be added to diags?
 			log.Printf("[ERR] Error decoding ResourceTimeout: %s", err)
 		}
 	}

internal/helper/plugin/grpc_provider.go

@@ -498,8 +498,8 @@ func (s *GRPCProviderServer) Configure(ctx context.Context, req *proto.Configure
 	}
 
 	config := terraform.NewResourceConfigShimmed(configVal, schemaBlock)
-	err = s.provider.Configure(ctx, config)
-	resp.Diagnostics = convert.AppendProtoDiag(resp.Diagnostics, err)
+	diags := s.provider.Configure(ctx, config)
+	resp.Diagnostics = convert.AppendProtoDiag(resp.Diagnostics, diags)
 
 	return resp, nil
 }