Merge pull request #126 from auth0/patch/DXCDT-103-post-sdk-v2-part-1

[3/3] DXCDT-103 Replace resource funcs to use context.Context and Diagnostics
auth0 · Apr 6, 2022 · 2b61551 · 2b61551
2 parents dd098e4 + 84e1bbc
commit 2b61551
Show file tree

Hide file tree

Showing 29 changed files with 490 additions and 423 deletions.
diff --git a/auth0/data_source_auth0_client.go b/auth0/data_source_auth0_client.go
@@ -1,18 +1,18 @@
 package auth0
 
 import (
-	"errors"
-	"fmt"
+	"context"
 
 	"github.com/auth0/go-auth0"
 	"github.com/auth0/go-auth0/management"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 func newDataClient() *schema.Resource {
 	return &schema.Resource{
-		Read:   readDataClient,
-		Schema: newClientSchema(),
+		ReadContext: readDataClient,
+		Schema:      newClientSchema(),
 	}
 }
 
@@ -23,30 +23,30 @@ func newClientSchema() map[string]*schema.Schema {
 	return clientSchema
 }
 
-func readDataClient(d *schema.ResourceData, m interface{}) error {
+func readDataClient(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	clientId := auth0.StringValue(String(d, "client_id"))
 	if clientId != "" {
 		d.SetId(clientId)
-		return readClient(d, m)
+		return readClient(ctx, d, m)
 	}
 
 	// If not provided ID, perform looking of client by name
 	name := auth0.StringValue(String(d, "name"))
 	if name == "" {
-		return errors.New("no 'client_id' or 'name' was specified")
+		return diag.Errorf("no 'client_id' or 'name' was specified")
 	}
 
 	api := m.(*management.Management)
 	clients, err := api.Client.List(management.IncludeFields("client_id", "name"))
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 	for _, client := range clients.Clients {
 		if auth0.StringValue(client.Name) == name {
 			clientId = auth0.StringValue(client.ClientID)
 			d.SetId(clientId)
-			return readClient(d, m)
+			return readClient(ctx, d, m)
 		}
 	}
-	return fmt.Errorf("no client found with 'name' = '%s'", name)
+	return diag.Errorf("no client found with 'name' = '%s'", name)
 }
diff --git a/auth0/data_source_auth0_global_client.go b/auth0/data_source_auth0_global_client.go
@@ -1,19 +1,22 @@
 package auth0
 
 import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 func newDataGlobalClient() *schema.Resource {
 	return &schema.Resource{
-		Read:   readDataGlobalClient,
-		Schema: newClientSchema(),
+		ReadContext: readDataGlobalClient,
+		Schema:      newClientSchema(),
 	}
 }
 
-func readDataGlobalClient(d *schema.ResourceData, m interface{}) error {
-	if err := readGlobalClientID(d, m); err != nil {
+func readDataGlobalClient(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
+	if err := readGlobalClientID(ctx, d, m); err != nil {
 		return err
 	}
-	return readClient(d, m)
+	return readClient(ctx, d, m)
 }
diff --git a/auth0/data_source_auth0_tenant.go b/auth0/data_source_auth0_tenant.go
@@ -1,18 +1,20 @@
 package auth0
 
 import (
+	"context"
 	"fmt"
 	"net/url"
 
 	"github.com/auth0/go-auth0/management"
 	"github.com/hashicorp/go-multierror"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 func newDataTenant() *schema.Resource {
 	return &schema.Resource{
-		Read: readDataTenant,
+		ReadContext: readDataTenant,
 		Schema: map[string]*schema.Schema{
 			"domain": {
 				Type:     schema.TypeString,
@@ -26,12 +28,12 @@ func newDataTenant() *schema.Resource {
 	}
 }
 
-func readDataTenant(d *schema.ResourceData, m interface{}) error {
+func readDataTenant(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	api := m.(*management.Management)
 
 	u, err := url.Parse(api.URI())
 	if err != nil {
-		return fmt.Errorf("unable to determine management API URL: %w", err)
+		return diag.FromErr(fmt.Errorf("unable to determine management API URL: %w", err))
 	}
 
 	d.SetId(resource.UniqueId())
@@ -40,5 +42,5 @@ func readDataTenant(d *schema.ResourceData, m interface{}) error {
 	result = multierror.Append(result, d.Set("domain", u.Hostname()))
 	result = multierror.Append(result, d.Set("management_api_identifier", u.String()))
 
-	return result.ErrorOrNil()
+	return diag.FromErr(result.ErrorOrNil())
 }
diff --git a/auth0/provider.go b/auth0/provider.go
@@ -1,11 +1,13 @@
 package auth0
 
 import (
+	"context"
 	"fmt"
 	"os"
 
 	"github.com/auth0/go-auth0"
 	"github.com/auth0/go-auth0/management"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/meta"
 
@@ -86,15 +88,17 @@ func Provider() *schema.Provider {
 		},
 	}
 
-	provider.ConfigureFunc = ConfigureProvider(provider.TerraformVersion)
+	provider.ConfigureContextFunc = ConfigureProvider(provider.TerraformVersion)
 
 	return provider
 }
 
 // ConfigureProvider will configure the *schema.Provider so that *management.Management
 // client is stored and passed into the subsequent resources as the meta parameter.
-func ConfigureProvider(terraformVersion string) func(data *schema.ResourceData) (interface{}, error) {
-	return func(data *schema.ResourceData) (interface{}, error) {
+func ConfigureProvider(
+	terraformVersion string,
+) func(ctx context.Context, data *schema.ResourceData) (interface{}, diag.Diagnostics) {
+	return func(ctx context.Context, data *schema.ResourceData) (interface{}, diag.Diagnostics) {
 		providerVersion := version.ProviderVersion
 		sdkVersion := auth0.Version
 		terraformSDKVersion := meta.SDKVersionString()
@@ -120,10 +124,15 @@ func ConfigureProvider(terraformVersion string) func(data *schema.ResourceData)
 			authenticationOption = management.WithClientCredentials(clientID, clientSecret)
 		}
 
-		return management.New(domain,
+		apiClient, err := management.New(domain,
 			authenticationOption,
 			management.WithDebug(debug),
 			management.WithUserAgent(userAgent),
 		)
+		if err != nil {
+			return nil, diag.FromErr(err)
+		}
+
+		return apiClient, nil
 	}
 }
diff --git a/auth0/provider_test.go b/auth0/provider_test.go
@@ -19,12 +19,16 @@ const wiremockHost = "localhost:8080"
 
 func providerWithTestingConfiguration() *schema.Provider {
 	provider := Provider()
-	provider.ConfigureFunc = func(data *schema.ResourceData) (interface{}, error) {
-		return management.New(
+	provider.ConfigureContextFunc = func(_ context.Context, data *schema.ResourceData) (interface{}, diag.Diagnostics) {
+		apiClient, err := management.New(
 			wiremockHost,
 			management.WithInsecure(),
 			management.WithDebug(true),
 		)
+		if err != nil {
+			return nil, diag.FromErr(err)
+		}
+		return apiClient, nil
 	}
 	return provider
 }

diff --git a/auth0/resource_auth0_action.go b/auth0/resource_auth0_action.go
@@ -1,12 +1,14 @@
 package auth0
 
 import (
+	"context"
 	"fmt"
 	"net/http"
 	"strings"
 
 	"github.com/auth0/go-auth0/management"
 	"github.com/hashicorp/go-multierror"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
@@ -16,12 +18,12 @@ import (
 
 func newAction() *schema.Resource {
 	return &schema.Resource{
-		Create: createAction,
-		Read:   readAction,
-		Update: updateAction,
-		Delete: deleteAction,
+		CreateContext: createAction,
+		ReadContext:   readAction,
+		UpdateContext: updateAction,
+		DeleteContext: deleteAction,
 		Importer: &schema.ResourceImporter{
-			State: schema.ImportStatePassthrough,
+			StateContext: schema.ImportStatePassthroughContext,
 		},
 		Schema: map[string]*schema.Schema{
 			"name": {
@@ -127,25 +129,25 @@ func newAction() *schema.Resource {
 	}
 }
 
-func createAction(d *schema.ResourceData, m interface{}) error {
+func createAction(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	action := expandAction(d)
 	api := m.(*management.Management)
 	if err := api.Action.Create(action); err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	d.SetId(action.GetID())
 
 	d.Partial(true)
 	if err := deployAction(d, m); err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 	d.Partial(false)
 
-	return readAction(d, m)
+	return readAction(ctx, d, m)
 }
 
-func readAction(d *schema.ResourceData, m interface{}) error {
+func readAction(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	api := m.(*management.Management)
 	action, err := api.Action.Read(d.Id())
 	if err != nil {
@@ -155,7 +157,7 @@ func readAction(d *schema.ResourceData, m interface{}) error {
 				return nil
 			}
 		}
-		return err
+		return diag.FromErr(err)
 	}
 
 	result := multierror.Append(
@@ -169,23 +171,23 @@ func readAction(d *schema.ResourceData, m interface{}) error {
 		result = multierror.Append(result, d.Set("version_id", action.DeployedVersion.GetID()))
 	}
 
-	return result.ErrorOrNil()
+	return diag.FromErr(result.ErrorOrNil())
 }
 
-func updateAction(d *schema.ResourceData, m interface{}) error {
+func updateAction(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	action := expandAction(d)
 	api := m.(*management.Management)
 	if err := api.Action.Update(d.Id(), action); err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	d.Partial(true)
 	if err := deployAction(d, m); err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 	d.Partial(false)
 
-	return readAction(d, m)
+	return readAction(ctx, d, m)
 }
 
 func deployAction(d *schema.ResourceData, m interface{}) error {
@@ -235,7 +237,7 @@ func deployAction(d *schema.ResourceData, m interface{}) error {
 	return nil
 }
 
-func deleteAction(d *schema.ResourceData, m interface{}) error {
+func deleteAction(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	api := m.(*management.Management)
 	if err := api.Action.Delete(d.Id()); err != nil {
 		if mErr, ok := err.(management.Error); ok {
@@ -244,7 +246,7 @@ func deleteAction(d *schema.ResourceData, m interface{}) error {
 				return nil
 			}
 		}
-		return err
+		return diag.FromErr(err)
 	}
 
 	return nil