address RFC and PR comments

Author: appilon

diag/diagnostic.go

@@ -1,88 +1,36 @@
 package diag
 
 import (
-	"errors"
-	"fmt"
-
-	"github.com/hashicorp/go-multierror"
 	"github.com/zclconf/go-cty/cty"
 )
 
-type Diagnostics []*Diagnostic
+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 *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 {
+func (diags Diagnostics) HasError() bool {
+	for i := range diags {
+		if diags[i].Severity == Error {
 			return true
 		}
 	}
 	return false
 }
 
-func (diags Diagnostics) Errors() []error {
-	var errs []error
-	for _, d := range diags {
-		if d.Severity == Error {
-			errs = append(errs, error(d))
-		}
-	}
-	return errs
-}
-
-func (diags Diagnostics) Warnings() []string {
-	var warns []string
-	for _, d := range diags {
-		if d.Severity == Warning {
-			warns = append(warns, d.Error())
-		}
-	}
-	return warns
-}
-
 type Diagnostic struct {
 	Severity      Severity
 	Summary       string
 	Detail        string
 	AttributePath cty.Path
 }
 
-func (d *Diagnostic) Error() string {
-	s := fmt.Sprintf("%s: %s", d.Severity, d.Summary)
-	if d.Detail != "" {
-		s = fmt.Sprintf("%s: %s", s, d.Detail)
+func FromErr(err error) Diagnostic {
+	return Diagnostic{
+		Severity: Error,
+		Summary:  err.Error(),
 	}
-	return s
 }
 
 type Severity int
 
-//go:generate go run golang.org/x/tools/cmd/stringer -type=Severity
-
 const (
 	Error Severity = iota
 	Warning

diag/path.go

@@ -0,0 +1,16 @@
+package diag
+
+import "github.com/zclconf/go-cty/cty"
+
+func JoinPath(parent cty.Path, child cty.Path) cty.Path {
+	if len(parent) > len(child) {
+		tmp := parent
+		parent = child
+		child = tmp
+	}
+	if child.HasPrefix(parent) {
+		return child
+	} else {
+		return append(parent, child...)
+	}
+}

diag/severity_string.go

@@ -0,0 +1,45 @@
+package schema
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/hashicorp/go-multierror"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+)
+
+type errorDiags diag.Diagnostics
+
+func (diags errorDiags) Errors() []error {
+	var es []error
+	for i := range diags {
+		if diags[i].Severity == diag.Error {
+			s := fmt.Sprintf("Error: %s", diags[i].Summary)
+			if diags[i].Detail != "" {
+				s = fmt.Sprintf("%s: %s", s, diags[i].Detail)
+			}
+			es = append(es, errors.New(s))
+		}
+	}
+	return es
+}
+
+func (diags errorDiags) Error() string {
+	return multierror.ListFormatFunc(diags.Errors())
+}
+
+type warningDiags diag.Diagnostics
+
+func (diags warningDiags) Warnings() []string {
+	var ws []string
+	for i := range diags {
+		if diags[i].Severity == diag.Warning {
+			s := fmt.Sprintf("Warning: %s", diags[i].Summary)
+			if diags[i].Detail != "" {
+				s = fmt.Sprintf("%s: %s", s, diags[i].Detail)
+			}
+			ws = append(ws, s)
+		}
+	}
+	return ws
+}

helper/schema/diagnostic.go

@@ -190,7 +190,7 @@ func (p *Provider) GetSchema(req *terraform.ProviderSchemaRequest) (*terraform.P
 // set.
 func (p *Provider) Validate(c *terraform.ResourceConfig) diag.Diagnostics {
 	if err := p.InternalValidate(); err != nil {
-		return []*diag.Diagnostic{
+		return []diag.Diagnostic{
 			{
 				Severity: diag.Error,
 				Summary:  "InternalValidate",
@@ -217,7 +217,7 @@ func (p *Provider) ValidateResource(
 	t string, c *terraform.ResourceConfig) diag.Diagnostics {
 	r, ok := p.ResourcesMap[t]
 	if !ok {
-		return []*diag.Diagnostic{
+		return []diag.Diagnostic{
 			{
 				Severity: diag.Error,
 				Summary:  fmt.Sprintf("Provider doesn't support resource: %s", t),
@@ -381,7 +381,7 @@ func (p *Provider) ValidateDataSource(
 	t string, c *terraform.ResourceConfig) diag.Diagnostics {
 	r, ok := p.DataSourcesMap[t]
 	if !ok {
-		return []*diag.Diagnostic{
+		return []diag.Diagnostic{
 			{
 				Severity: diag.Error,
 				Summary:  fmt.Sprintf("Provider doesn't support data source: %s", t),

helper/schema/provider.go

@@ -283,8 +283,8 @@ func TestProviderValidate(t *testing.T) {
 	for i, tc := range cases {
 		c := terraform.NewResourceConfigRaw(tc.Config)
 		diags := tc.P.Validate(c)
-		if diags.HasErrors() != tc.Err {
-			t.Fatalf("%d: %#v", i, diags.Err())
+		if diags.HasError() != tc.Err {
+			t.Fatalf("%d: %#v", i, diags)
 		}
 	}
 }
@@ -396,8 +396,8 @@ func TestProviderValidateResource(t *testing.T) {
 	for i, tc := range cases {
 		c := terraform.NewResourceConfigRaw(tc.Config)
 		diags := tc.P.ValidateResource(tc.Type, c)
-		if diags.HasErrors() != tc.Err {
-			t.Fatalf("%d: %#v", i, diags.Err())
+		if diags.HasError() != tc.Err {
+			t.Fatalf("%d: %#v", i, diags)
 		}
 	}
 }