Merge pull request #92 from Venafi/migration-to-sdkv2

Migration to sdkv2

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.16.0 (May 16, 2022)
+Upgraded plugin to SDKv2
+
 ## 0.15.5 (April 14, 2022)
 
 Fixed a bug in backward compatibility with PKCS#1 Keys

README.md

@@ -134,6 +134,9 @@ this transition in [here](https://github.com/Venafi/vcert/releases/tag/v4.17.0))
 For backward compatibility during Terraform state refresh please update to version
 0.15.5 or above.
 
+> :warning: As a part for upgrading our provider to SDK version 2, we dropped support
+for Terraform version 0.11 and below.
+
 1. Declare that the Venafi Provider is required:
 
    ```text

go.mod

@@ -3,11 +3,16 @@ module github.com/terraform-providers/terraform-provider-venafi
 go 1.12
 
 require (
-	github.com/Venafi/vcert/v4 v4.18.2
+	github.com/Venafi/vcert/v4 v4.19.0
 	github.com/client9/misspell v0.3.4
 	github.com/golangci/golangci-lint v1.21.0
-	github.com/hashicorp/terraform-plugin-sdk v1.1.0
-	github.com/pkg/errors v0.8.1
+	github.com/hashicorp/terraform-plugin-log v0.3.0
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.14.0
+	github.com/pkg/errors v0.9.1
+	github.com/spf13/afero v1.2.2 // indirect
 	github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a
+	golang.org/x/tools v0.0.0-20201028111035-eafbe7b904eb // indirect
+	google.golang.org/genproto v0.0.0-20200904004341-0bd0a958aa1d // indirect
+	honnef.co/go/tools v0.0.1-2020.1.4 // indirect
 	software.sslmate.com/src/go-pkcs12 v0.0.0-20180114231543-2291e8f0f237
 )

main.go

@@ -1,12 +1,29 @@
 package main
 
 import (
-	"github.com/hashicorp/terraform-plugin-sdk/plugin"
+	"flag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
 	"github.com/terraform-providers/terraform-provider-venafi/venafi"
+	"log"
 )
 
 func main() {
-	plugin.Serve(&plugin.ServeOpts{
-		ProviderFunc: venafi.Provider,
-	})
+	// remove date and time stamp from log output as the plugin SDK already adds its own
+	log.SetFlags(log.Flags() &^ (log.Ldate | log.Ltime))
+
+	var debugMode bool
+
+	flag.BoolVar(&debugMode, "debuggable", false, "set to true to run the provider with support for debuggers like delve")
+	flag.Parse()
+
+	if debugMode {
+		plugin.Serve(&plugin.ServeOpts{
+			ProviderFunc: venafi.Provider,
+			Debug:        true,
+		})
+	} else {
+		plugin.Serve(&plugin.ServeOpts{
+			ProviderFunc: venafi.Provider,
+		})
+	}
 }

venafi/provider.go

@@ -1,19 +1,21 @@
 package venafi
 
 import (
+	"context"
 	"fmt"
 	"github.com/Venafi/vcert/v4"
 	"github.com/Venafi/vcert/v4/pkg/endpoint"
-	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
-	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"log"
 	"strings"
 )
 
 const (
 	messageVenafiPingFailed       = "Failed to ping Venafi endpoint: "
 	messageVenafiPingSuccessful   = "Venafi ping successful"
-	messageVenafiClientInitFailed = "Failed to initialize Venafi client: "
+	messageVenafiClientInitFailed = "Failed to initialize Venafi client"
 	messageVenafiConfigFailed     = "Failed to build config for Venafi issuer: "
 	messageUseDevMode             = "Using dev mode to issue certificate"
 	messageUseVaas                = "Using VaaS to issue certificate"
@@ -22,7 +24,7 @@ const (
 )
 
 // Provider returns a terraform.ResourceProvider.
-func Provider() terraform.ResourceProvider {
+func Provider() *schema.Provider {
 	return &schema.Provider{
 		Schema: map[string]*schema.Schema{
 			"url": &schema.Schema{
@@ -31,7 +33,6 @@ func Provider() terraform.ResourceProvider {
 				DefaultFunc: schema.EnvDefaultFunc("VENAFI_URL", nil),
 				Description: `The Venafi Web Service URL.. Example: https://tpp.venafi.example/vedsdk`,
 			},
-
 			"zone": &schema.Schema{
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -40,7 +41,6 @@ func Provider() terraform.ResourceProvider {
 Example for Platform: testpolicy\\vault
 Example for Venafi as a Service: Default`,
 			},
-
 			"tpp_username": &schema.Schema{
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -81,43 +81,44 @@ Example:
 				Description: `When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using Venafi as a Service or Trust Protection Platform. Useful for development and testing.`,
 			},
 		},
-
 		ResourcesMap: map[string]*schema.Resource{
 			"venafi_certificate":     resourceVenafiCertificate(),
 			"venafi_policy":          resourceVenafiPolicy(),
 			"venafi_ssh_certificate": resourceVenafiSshCertificate(),
 			"venafi_ssh_config":      resourceVenafiSshConfig(),
 		},
-
-		ConfigureFunc: providerConfigure,
+		ConfigureContextFunc: providerConfigure,
 	}
 }
 
-func providerConfigure(d *schema.ResourceData) (interface{}, error) {
+func providerConfigure(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
 
-	log.Printf("Configuring provider\n")
+	tflog.Info(ctx, "Configuring provider\n")
 	apiKey := d.Get("api_key").(string)
 	url := d.Get("url").(string)
 	tppUser := d.Get("tpp_username").(string)
 	tppPassword := d.Get("tpp_password").(string)
 	accessToken := d.Get("access_token").(string)
 	zone := d.Get("zone").(string)
-	log.Printf("====ZONE==== : %s", zone)
+	tflog.Info(ctx, fmt.Sprintf("====ZONE==== : %s", zone))
 	devMode := d.Get("dev_mode").(bool)
 	trustBundle := d.Get("trust_bundle").(string)
 
+	// Warning or errors can be collected in a slice type
+	var diags diag.Diagnostics
+
 	var cfg vcert.Config
 
 	zone = normalizeZone(zone)
 
 	if devMode {
-		log.Print(messageUseDevMode)
+		tflog.Info(ctx, messageUseDevMode)
 		cfg = vcert.Config{
 			ConnectorType: endpoint.ConnectorTypeFake,
 			LogVerbose:    true,
 		}
 	} else if tppUser != "" && tppPassword != "" && accessToken == "" {
-		log.Printf("Using Platform with url %s to issue certificate\n", url)
+		tflog.Info(ctx, fmt.Sprintf("Using Platform with url %s to issue certificate\n", url))
 		cfg = vcert.Config{
 			ConnectorType: endpoint.ConnectorTypeTPP,
 			BaseUrl:       url,
@@ -129,7 +130,7 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
 			LogVerbose: true,
 		}
 	} else if accessToken != "" {
-		log.Printf("Using Platform with url %s to issue certificate\n", url)
+		tflog.Info(ctx, fmt.Sprintf("Using Platform with url %s to issue certificate\n", url))
 		cfg = vcert.Config{
 			ConnectorType: endpoint.ConnectorTypeTPP,
 			BaseUrl:       url,
@@ -141,7 +142,7 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
 		}
 	} else if apiKey != "" {
 		if url != "" {
-			log.Println(messageUseVaas)
+			tflog.Info(ctx, messageUseVaas)
 			cfg = vcert.Config{
 				ConnectorType: endpoint.ConnectorTypeCloud,
 				BaseUrl:       url,
@@ -152,7 +153,7 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
 				LogVerbose: true,
 			}
 		} else {
-			log.Println(messageUseVaas)
+			tflog.Info(ctx, messageUseVaas)
 			cfg = vcert.Config{
 				ConnectorType: endpoint.ConnectorTypeCloud,
 				Credentials: &endpoint.Authentication{
@@ -163,25 +164,38 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
 			}
 		}
 	} else {
-		return nil, fmt.Errorf(messageVenafiConfigFailed)
+		diags = append(diags, diag.Diagnostic{
+			Severity: diag.Error,
+			Summary:  messageVenafiClientInitFailed,
+			Detail:   messageVenafiConfigFailed,
+		})
+		return nil, diags
 	}
 
 	if trustBundle != "" {
-		log.Printf("Importing trusted certificate: \n %s", trustBundle)
+		tflog.Info(ctx, fmt.Sprintf("Importing trusted certificate: \n %s", trustBundle))
 		cfg.ConnectionTrust = trustBundle
 	}
 	cl, err := vcert.NewClient(&cfg)
 	if err != nil {
-		log.Printf(messageVenafiClientInitFailed + err.Error())
-		return nil, err
+		diags = append(diags, diag.Diagnostic{
+			Severity: diag.Error,
+			Summary:  messageVenafiClientInitFailed,
+			Detail:   messageVenafiConfigFailed + ": " + err.Error(),
+		})
+		return nil, diags
 	}
 	err = cl.Ping()
 	if err != nil {
-		log.Printf(messageVenafiPingFailed + err.Error())
-		return nil, err
+		diags = append(diags, diag.Diagnostic{
+			Severity: diag.Error,
+			Summary:  messageVenafiPingFailed,
+			Detail:   messageVenafiConfigFailed + ": " + err.Error(),
+		})
+		return nil, diags
 	}
 
-	return &cfg, nil
+	return &cfg, diags
 }
 
 func normalizeZone(zone string) string {
@@ -205,6 +219,6 @@ func normalizeZone(zone string) string {
 		newZone = "\\" + newZone
 	}
 
-	log.Printf("Normalized zone : %s", newZone)
+	log.Printf("[INFO] Normalized zone : %s", newZone)
 	return newZone
 }