switch API to use diag.Diagnostics

Author: appilon

diag/diagnostic.go

@@ -1,13 +1,38 @@
 package diag
 
 import (
+	"errors"
 	"fmt"
 
+	"github.com/hashicorp/go-multierror"
 	"github.com/zclconf/go-cty/cty"
 )
 
 type Diagnostics []*Diagnostic
 
+func (diags Diagnostics) Append(i interface{}) Diagnostics {
+	switch v := i.(type) {
+	case Diagnostics:
+		if len(v) != 0 {
+			diags = append(diags, v...)
+		}
+	case *Diagnostic:
+		diags = append(diags, v)
+	case error:
+		if v != nil {
+			diags = append(diags, &Diagnostic{
+				Severity: Error,
+				Summary:  v.Error(),
+			})
+		}
+	}
+	return diags
+}
+
+func (diags Diagnostics) Err() error {
+	return errors.New(multierror.ListFormatFunc(diags.Errors()))
+}
+
 func (diags Diagnostics) HasErrors() bool {
 	for _, d := range diags {
 		if d.Severity == Error {
@@ -42,11 +67,14 @@ type Diagnostic struct {
 	Summary       string
 	Detail        string
 	AttributePath cty.Path
-	MapKey        string
 }
 
 func (d *Diagnostic) Error() string {
-	return fmt.Sprintf("%s: %s: %s", d.Severity, d.Summary, d.Detail)
+	s := fmt.Sprintf("%s: %s", d.Severity, d.Summary)
+	if d.Detail != "" {
+		s = fmt.Sprintf("%s: %s", s, d.Detail)
+	}
+	return s
 }
 
 type Severity int

helper/schema/provider.go

@@ -180,23 +180,15 @@ func (p *Provider) GetSchema(req *terraform.ProviderSchemaRequest) (*terraform.P
 }
 
 // Validate is called once at the beginning with the raw configuration
-// (no interpolation done) and can return a list of warnings and/or
-// errors.
+// (no interpolation done) and can return diagnostics
 //
 // This is called once with the provider configuration only. It may not
 // be called at all if no provider configuration is given.
 //
 // This should not assume that any values of the configurations are valid.
 // The primary use case of this call is to check that required keys are
 // set.
-func (p *Provider) Validate(c *terraform.ResourceConfig) ([]string, []error) {
-
-	diags := p.ValidateDiag(c)
-
-	return diags.Warnings(), diags.Errors()
-}
-
-func (p *Provider) ValidateDiag(c *terraform.ResourceConfig) diag.Diagnostics {
+func (p *Provider) Validate(c *terraform.ResourceConfig) diag.Diagnostics {
 	if err := p.InternalValidate(); err != nil {
 		return []*diag.Diagnostic{
 			{
@@ -209,12 +201,11 @@ func (p *Provider) ValidateDiag(c *terraform.ResourceConfig) diag.Diagnostics {
 		}
 	}
 
-	return schemaMap(p.Schema).ValidateDiag(c)
+	return schemaMap(p.Schema).Validate(c)
 }
 
 // ValidateResource is called once at the beginning with the raw
-// configuration (no interpolation done) and can return a list of warnings
-// and/or errors.
+// configuration (no interpolation done) and can return diagnostics.
 //
 // This is called once per resource.
 //
@@ -223,12 +214,6 @@ func (p *Provider) ValidateDiag(c *terraform.ResourceConfig) diag.Diagnostics {
 // The primary use case of this call is to check that the required keys
 // are set and that the general structure is correct.
 func (p *Provider) ValidateResource(
-	t string, c *terraform.ResourceConfig) ([]string, []error) {
-	diags := p.ValidateResourceDiag(t, c)
-	return diags.Warnings(), diags.Errors()
-}
-
-func (p *Provider) ValidateResourceDiag(
 	t string, c *terraform.ResourceConfig) diag.Diagnostics {
 	r, ok := p.ResourcesMap[t]
 	if !ok {
@@ -240,7 +225,7 @@ func (p *Provider) ValidateResourceDiag(
 		}
 	}
 
-	return r.ValidateDiag(c)
+	return r.Validate(c)
 }
 
 // Configure configures the provider itself with the configuration
@@ -384,8 +369,7 @@ func (p *Provider) ImportState(
 }
 
 // ValidateDataSource is called once at the beginning with the raw
-// configuration (no interpolation done) and can return a list of warnings
-// and/or errors.
+// configuration (no interpolation done) and can return diagnostics.
 //
 // This is called once per data source instance.
 //
@@ -394,12 +378,6 @@ func (p *Provider) ImportState(
 // The primary use case of this call is to check that the required keys
 // are set and that the general structure is correct.
 func (p *Provider) ValidateDataSource(
-	t string, c *terraform.ResourceConfig) ([]string, []error) {
-	diags := p.ValidateDataSourceDiag(t, c)
-	return diags.Warnings(), diags.Errors()
-}
-
-func (p *Provider) ValidateDataSourceDiag(
 	t string, c *terraform.ResourceConfig) diag.Diagnostics {
 	r, ok := p.DataSourcesMap[t]
 	if !ok {
@@ -411,7 +389,7 @@ func (p *Provider) ValidateDataSourceDiag(
 		}
 	}
 
-	return r.ValidateDiag(c)
+	return r.Validate(c)
 }
 
 // DataSources returns all of the available data sources that this

helper/schema/provider_test.go

@@ -282,9 +282,9 @@ func TestProviderValidate(t *testing.T) {
 
 	for i, tc := range cases {
 		c := terraform.NewResourceConfigRaw(tc.Config)
-		_, es := tc.P.Validate(c)
-		if len(es) > 0 != tc.Err {
-			t.Fatalf("%d: %#v", i, es)
+		diags := tc.P.Validate(c)
+		if diags.HasErrors() != tc.Err {
+			t.Fatalf("%d: %#v", i, diags.Err())
 		}
 	}
 }
@@ -395,9 +395,9 @@ func TestProviderValidateResource(t *testing.T) {
 
 	for i, tc := range cases {
 		c := terraform.NewResourceConfigRaw(tc.Config)
-		_, es := tc.P.ValidateResource(tc.Type, c)
-		if len(es) > 0 != tc.Err {
-			t.Fatalf("%d: %#v", i, es)
+		diags := tc.P.ValidateResource(tc.Type, c)
+		if diags.HasErrors() != tc.Err {
+			t.Fatalf("%d: %#v", i, diags.Err())
 		}
 	}
 }