Merge pull request #300 from cderici/remove-sdk2-mux-take-2

Remove sdk2 from provider & provider_tests

Author: cderici

go.mod

@@ -5,7 +5,6 @@ go 1.20
 require (
 	github.com/bflad/tfproviderlint v0.29.0
 	github.com/hashicorp/terraform-plugin-docs v0.16.0
-	github.com/hashicorp/terraform-plugin-sdk/v2 v2.28.0
 	// 2.9.43
 	github.com/juju/juju v0.0.0-20230601044333-3cb3f8beac4a
 
@@ -93,6 +92,7 @@ require (
 	github.com/hashicorp/raft v1.3.2-0.20210825230038-1a621031eb2b // indirect
 	github.com/hashicorp/terraform-exec v0.18.1 // indirect
 	github.com/hashicorp/terraform-json v0.17.1 // indirect
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.28.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.2.1 // indirect
 	github.com/hashicorp/terraform-svchost v0.1.1 // indirect
 	github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect

internal/provider/provider.go

@@ -13,13 +13,11 @@ import (
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
-	frameworkdiag "github.com/hashicorp/terraform-plugin-framework/diag"
-	frameworkprovider "github.com/hashicorp/terraform-plugin-framework/provider"
-	frameworkschema "github.com/hashicorp/terraform-plugin-framework/provider/schema"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/provider"
+	"github.com/hashicorp/terraform-plugin-framework/provider/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
-	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 
 	"github.com/juju/terraform-provider-juju/internal/juju"
 )
@@ -36,133 +34,6 @@ const (
 	JujuCACert     = "ca_certificate"
 )
 
-// New returns an sdk2 style terraform provider.
-func New(version string) func() *schema.Provider {
-	return func() *schema.Provider {
-		p := &schema.Provider{
-			Schema: map[string]*schema.Schema{
-				JujuController: {
-					Type:        schema.TypeString,
-					Description: fmt.Sprintf("This is the Controller addresses to connect to, defaults to localhost:17070, multiple addresses can be provided in this format: <host>:<port>,<host>:<port>,.... This can also be set by the `%s` environment variable.", JujuControllerEnvKey),
-					Optional:    true,
-				},
-				JujuUsername: {
-					Type:        schema.TypeString,
-					Description: fmt.Sprintf("This is the username registered with the controller to be used. This can also be set by the `%s` environment variable", JujuUsernameEnvKey),
-					Optional:    true,
-				},
-				JujuPassword: {
-					Type:        schema.TypeString,
-					Description: fmt.Sprintf("This is the password of the username to be used. This can also be set by the `%s` environment variable", JujuPasswordEnvKey),
-					Optional:    true,
-					Sensitive:   true,
-				},
-				JujuCACert: {
-					Type:        schema.TypeString,
-					Description: fmt.Sprintf("This is the certificate to use for identification. This can also be set by the `%s` environment variable", JujuCACertEnvKey),
-					Optional:    true,
-				},
-			},
-			ResourcesMap: map[string]*schema.Resource{},
-		}
-		p.ConfigureContextFunc = configure()
-
-		return p
-	}
-}
-
-func configure() func(context.Context, *schema.ResourceData) (interface{}, diag.Diagnostics) {
-	return func(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
-		var diags diag.Diagnostics
-
-		controllerAddresses := strings.Split(d.Get(JujuController).(string), ",")
-		username := d.Get(JujuUsername).(string)
-		password := d.Get(JujuPassword).(string)
-		caCert := d.Get(JujuCACert).(string)
-
-		if (len(controllerAddresses) == 1 && controllerAddresses[0] == "") ||
-			username == "" || password == "" || caCert == "" {
-			// Look for any config data not directly supplied in
-			// the plan.
-			liveData, err := populateJujuProviderModelLive()
-			if err != nil {
-				diags = append(diags, diag.Diagnostic{
-					Severity: diag.Error,
-					Summary:  "Gather live client data",
-					Detail:   err.Error(),
-				})
-				return nil, diags
-			}
-			if len(controllerAddresses) == 1 && controllerAddresses[0] == "" {
-				controllerAddresses = strings.Split(liveData.ControllerAddrs.ValueString(), ",")
-			}
-			if username == "" {
-				username = liveData.UserName.ValueString()
-			}
-			if password == "" {
-				password = liveData.Password.ValueString()
-			}
-			if caCert == "" {
-				caCert = liveData.CACert.ValueString()
-			}
-		}
-
-		// Validate the controller config.
-		if username == "" || password == "" {
-			diags = append(diags, diag.Diagnostic{
-				Severity: diag.Error,
-				Summary:  "Username and password must be set",
-				Detail:   "Currently the provider can only authenticate using username and password based authentication, if both are empty the provider will panic",
-			})
-		}
-		if len(controllerAddresses) > 1 && controllerAddresses[0] == "" {
-			diags = append(diags, diag.Diagnostic{
-				Severity: diag.Error,
-				Summary:  "Controller address required",
-				Detail:   "The provider must know which juju controller to use.",
-			})
-		}
-		if caCert == "" {
-			diags = append(diags, diag.Diagnostic{
-				Severity: diag.Error,
-				Summary:  "Controller CACert",
-				Detail:   "Required for the Juju certificate authority to be trusted by your system",
-			})
-		}
-
-		if diags.HasError() {
-			return nil, diags
-		}
-
-		config := juju.ControllerConfiguration{
-			ControllerAddresses: controllerAddresses,
-			Username:            username,
-			Password:            password,
-			CACert:              caCert,
-		}
-		client, err := juju.NewClient(ctx, config)
-		if err != nil {
-			return nil, diag.FromErr(err)
-		}
-
-		// Here we are testing that we can connect successfully to the Juju server
-		// this prevents having logic to check the connection is OK in every function
-		testConn, err := client.Models.GetConnection(nil)
-		if err != nil {
-			for _, v := range checkClientErr(err, config) {
-				diags = append(diags, diag.Diagnostic{
-					Summary: v.Summary(),
-					Detail:  v.Detail(),
-				})
-			}
-			return nil, diags
-		}
-		_ = testConn.Close()
-
-		return client, diags
-	}
-}
-
 // populateJujuProviderModelLive gets the controller config,
 // first from environment variables, then from a live juju
 // controller as a fallback.
@@ -192,10 +63,10 @@ func getField(field string, config map[string]string) string {
 }
 
 // Ensure jujuProvider satisfies various provider interfaces.
-var _ frameworkprovider.Provider = &jujuProvider{}
+var _ provider.Provider = &jujuProvider{}
 
 // NewJujuProvider returns a framework style terraform provider.
-func NewJujuProvider(version string) frameworkprovider.Provider {
+func NewJujuProvider(version string) provider.Provider {
 	return &jujuProvider{version: version}
 }
 
@@ -219,31 +90,31 @@ func (j jujuProviderModel) valid() bool {
 
 // Metadata returns the metadata for the provider, such as
 // a type name and version data.
-func (p *jujuProvider) Metadata(_ context.Context, _ frameworkprovider.MetadataRequest, resp *frameworkprovider.MetadataResponse) {
+func (p *jujuProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse) {
 	resp.TypeName = "juju"
 	resp.Version = p.version
 }
 
 // Schema returns the schema for this provider, specifically
 // it defines the juju controller config necessary to create
 // a juju client.
-func (p *jujuProvider) Schema(_ context.Context, _ frameworkprovider.SchemaRequest, resp *frameworkprovider.SchemaResponse) {
-	resp.Schema = frameworkschema.Schema{
-		Attributes: map[string]frameworkschema.Attribute{
-			JujuController: frameworkschema.StringAttribute{
+func (p *jujuProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Attributes: map[string]schema.Attribute{
+			JujuController: schema.StringAttribute{
 				Description: fmt.Sprintf("This is the Controller addresses to connect to, defaults to localhost:17070, multiple addresses can be provided in this format: <host>:<port>,<host>:<port>,.... This can also be set by the `%s` environment variable.", JujuControllerEnvKey),
 				Optional:    true,
 			},
-			JujuUsername: frameworkschema.StringAttribute{
+			JujuUsername: schema.StringAttribute{
 				Description: fmt.Sprintf("This is the username registered with the controller to be used. This can also be set by the `%s` environment variable", JujuUsernameEnvKey),
 				Optional:    true,
 			},
-			JujuPassword: frameworkschema.StringAttribute{
+			JujuPassword: schema.StringAttribute{
 				Description: fmt.Sprintf("This is the password of the username to be used. This can also be set by the `%s` environment variable", JujuPasswordEnvKey),
 				Optional:    true,
 				Sensitive:   true,
 			},
-			JujuCACert: frameworkschema.StringAttribute{
+			JujuCACert: schema.StringAttribute{
 				Description: fmt.Sprintf("This is the certificate to use for identification. This can also be set by the `%s` environment variable", JujuCACertEnvKey),
 				Optional:    true,
 			},
@@ -258,7 +129,7 @@ func (p *jujuProvider) Schema(_ context.Context, _ frameworkprovider.SchemaReque
 // Values from provider configuration are often used to initialise an
 // API client, which should be stored on the struct implementing the
 // Provider interface.
-func (p *jujuProvider) Configure(ctx context.Context, req frameworkprovider.ConfigureRequest, resp *frameworkprovider.ConfigureResponse) {
+func (p *jujuProvider) Configure(ctx context.Context, req provider.ConfigureRequest, resp *provider.ConfigureResponse) {
 	// Get data required for configuring the juju client.
 	data, diags := getJujuProviderModel(ctx, req)
 	if diags.HasError() {
@@ -294,9 +165,9 @@ func (p *jujuProvider) Configure(ctx context.Context, req frameworkprovider.Conf
 // getJujuProviderModel a filled in jujuProviderModel if able. First check
 // the plan being used, then fall back to the JUJU_ environment variables,
 // lastly check to see if an active juju can supply the data.
-func getJujuProviderModel(ctx context.Context, req frameworkprovider.ConfigureRequest) (jujuProviderModel, frameworkdiag.Diagnostics) {
+func getJujuProviderModel(ctx context.Context, req provider.ConfigureRequest) (jujuProviderModel, diag.Diagnostics) {
 	var data jujuProviderModel
-	var diags frameworkdiag.Diagnostics
+	var diags diag.Diagnostics
 
 	// Read Terraform configuration data into the data model
 	diags.Append(req.Config.Get(ctx, &data)...)
@@ -377,9 +248,9 @@ func (p *jujuProvider) DataSources(_ context.Context) []func() datasource.DataSo
 	}
 }
 
-func checkClientErr(err error, config juju.ControllerConfiguration) frameworkdiag.Diagnostics {
+func checkClientErr(err error, config juju.ControllerConfiguration) diag.Diagnostics {
 	var errDetail string
-	var diags frameworkdiag.Diagnostics
+	var diags diag.Diagnostics
 
 	x509error := &x509.UnknownAuthorityError{}
 	netOpError := &net.OpError{}