function: Replace usage of diagnostics with function errors during execution of provider-defined functions

diag/diagnostics.go

@@ -13,18 +13,6 @@ import (
 // or consistent.
 type Diagnostics []Diagnostic
 
-// AddArgumentError adds a generic function argument error diagnostic to the
-// collection.
-func (diags *Diagnostics) AddArgumentError(position int, summary string, detail string) {
-	diags.Append(NewArgumentErrorDiagnostic(position, summary, detail))
-}
-
-// AddArgumentWarning adds a function argument warning diagnostic to the
-// collection.
-func (diags *Diagnostics) AddArgumentWarning(position int, summary string, detail string) {
-	diags.Append(NewArgumentWarningDiagnostic(position, summary, detail))
-}
-
 // AddAttributeError adds a generic attribute error diagnostic to the collection.
 func (diags *Diagnostics) AddAttributeError(path path.Path, summary string, detail string) {
 	diags.Append(NewAttributeErrorDiagnostic(path, summary, detail))

diag/diagnostics_test.go

@@ -12,130 +12,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/path"
 )
 
-func TestDiagnosticsAddArgumentError(t *testing.T) {
-	t.Parallel()
-
-	testCases := map[string]struct {
-		diags    diag.Diagnostics
-		position int
-		summary  string
-		detail   string
-		expected diag.Diagnostics
-	}{
-		"nil-add": {
-			diags:    nil,
-			position: 0,
-			summary:  "one summary",
-			detail:   "one detail",
-			expected: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-			},
-		},
-		"add": {
-			diags: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-			},
-			position: 0,
-			summary:  "three summary",
-			detail:   "three detail",
-			expected: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-				diag.NewArgumentErrorDiagnostic(0, "three summary", "three detail"),
-			},
-		},
-		"duplicate": {
-			diags: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-			},
-			position: 0,
-			summary:  "one summary",
-			detail:   "one detail",
-			expected: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-			},
-		},
-	}
-
-	for name, tc := range testCases {
-		name, tc := name, tc
-		t.Run(name, func(t *testing.T) {
-			t.Parallel()
-
-			tc.diags.AddArgumentError(tc.position, tc.summary, tc.detail)
-
-			if diff := cmp.Diff(tc.diags, tc.expected); diff != "" {
-				t.Errorf("Unexpected response (+wanted, -got): %s", diff)
-			}
-		})
-	}
-}
-
-func TestDiagnosticsAddArgumentWarning(t *testing.T) {
-	t.Parallel()
-
-	testCases := map[string]struct {
-		diags    diag.Diagnostics
-		position int
-		summary  string
-		detail   string
-		expected diag.Diagnostics
-	}{
-		"nil-add": {
-			diags:    nil,
-			position: 0,
-			summary:  "one summary",
-			detail:   "one detail",
-			expected: diag.Diagnostics{
-				diag.NewArgumentWarningDiagnostic(0, "one summary", "one detail"),
-			},
-		},
-		"add": {
-			diags: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-			},
-			position: 0,
-			summary:  "three summary",
-			detail:   "three detail",
-			expected: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-				diag.NewArgumentWarningDiagnostic(0, "three summary", "three detail"),
-			},
-		},
-		"duplicate": {
-			diags: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-			},
-			position: 0,
-			summary:  "two summary",
-			detail:   "two detail",
-			expected: diag.Diagnostics{
-				diag.NewArgumentErrorDiagnostic(0, "one summary", "one detail"),
-				diag.NewArgumentWarningDiagnostic(0, "two summary", "two detail"),
-			},
-		},
-	}
-
-	for name, tc := range testCases {
-		name, tc := name, tc
-		t.Run(name, func(t *testing.T) {
-			t.Parallel()
-
-			tc.diags.AddArgumentWarning(tc.position, tc.summary, tc.detail)
-
-			if diff := cmp.Diff(tc.diags, tc.expected); diff != "" {
-				t.Errorf("Unexpected response (+wanted, -got): %s", diff)
-			}
-		})
-	}
-}
-
 func TestDiagnosticsAddAttributeError(t *testing.T) {
 	t.Parallel()
 

function/arguments_data.go

@@ -8,7 +8,7 @@ import (
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
-	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/fwerror"
 	fwreflect "github.com/hashicorp/terraform-plugin-framework/internal/reflect"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 )
@@ -49,30 +49,28 @@ func (d ArgumentsData) Equal(o ArgumentsData) bool {
 // type with an element type appropriate for the parameter definition ([]T). The
 // framework automatically populates this list with elements matching the zero,
 // one, or more arguments passed.
-func (d ArgumentsData) Get(ctx context.Context, targets ...any) diag.Diagnostics {
-	var diags diag.Diagnostics
+func (d ArgumentsData) Get(ctx context.Context, targets ...any) fwerror.FunctionErrors {
+	var fe fwerror.FunctionErrors
 
 	if len(d.values) == 0 {
-		diags.AddError(
-			"Invalid Argument Data Usage",
-			"When attempting to fetch argument data during the function call, the provider code incorrectly attempted to read argument data. "+
-				"This is always an issue in the provider code and should be reported to the provider developers.\n\n"+
-				"Function does not have argument data.",
-		)
-
-		return diags
+		msg := "Invalid Argument Data Usage: When attempting to fetch argument data during the function call, the provider code incorrectly attempted to read argument data. " +
+			"This is always an issue in the provider code and should be reported to the provider developers.\n\n" +
+			"Function does not have argument data."
+
+		fe.AddError(msg)
+
+		return fe
 	}
 
 	if len(targets) != len(d.values) {
-		diags.AddError(
-			"Invalid Argument Data Usage",
-			"When attempting to fetch argument data during the function call, the provider code incorrectly attempted to read argument data. "+
-				"The Get call requires all parameters and the final variadic parameter, if implemented, to be in the targets. "+
-				"This is always an error in the provider code and should be reported to the provider developers.\n\n"+
-				fmt.Sprintf("Given targets count: %d, expected targets count: %d", len(targets), len(d.values)),
-		)
+		msg := "Invalid Argument Data Usage: When attempting to fetch argument data during the function call, the provider code incorrectly attempted to read argument data. " +
+			"The Get call requires all parameters and the final variadic parameter, if implemented, to be in the targets. " +
+			"This is always an error in the provider code and should be reported to the provider developers.\n\n" +
+			fmt.Sprintf("Given targets count: %d, expected targets count: %d", len(targets), len(d.values))
+
+		fe.AddError(msg)
 
-		return diags
+		return fe
 	}
 
 	for position, attrValue := range d.values {
@@ -85,27 +83,26 @@ func (d ArgumentsData) Get(ctx context.Context, targets ...any) diag.Diagnostics
 			continue
 		}
 
-		tfValue, err := attrValue.ToTerraformValue(ctx)
+		tfValue, tfValueErr := attrValue.ToTerraformValue(ctx)
 
-		if err != nil {
-			diags.AddError(
-				"Argument Value Conversion Error",
-				fmt.Sprintf("An unexpected error was encountered converting a %T to its equivalent Terraform representation. "+
-					"This is always an error in the provider code and should be reported to the provider developers.\n\n"+
-					"Position: %d\n"+
-					"Error: %s",
-					attrValue, position, err),
-			)
+		if tfValueErr != nil {
+			msg := fmt.Sprintf("Argument Value Conversion Error: An unexpected error was encountered converting a %T to its equivalent Terraform representation. "+
+				"This is always an error in the provider code and should be reported to the provider developers.\n\n"+
+				"Position: %d\n"+
+				"Error: %s",
+				attrValue, position, tfValueErr)
+
+			fe.AddArgumentError(position, msg)
 
 			continue
 		}
 
 		reflectDiags := fwreflect.Into(ctx, attrValue.Type(ctx), tfValue, target, fwreflect.Options{}, path.Empty())
 
-		diags.Append(reflectDiags...)
+		fe.Append(fwerror.FunctionErrorsFromDiags(ctx, reflectDiags)...)
 	}
 
-	return diags
+	return fe
 }
 
 // GetArgument retrieves the argument data found at the given zero-based
@@ -116,30 +113,28 @@ func (d ArgumentsData) Get(ctx context.Context, targets ...any) diag.Diagnostics
 // type with an element type appropriate for the parameter definition ([]T) at
 // the position after all parameters. The framework automatically populates this
 // list with elements matching the zero, one, or more arguments passed.
-func (d ArgumentsData) GetArgument(ctx context.Context, position int, target any) diag.Diagnostics {
-	var diags diag.Diagnostics
+func (d ArgumentsData) GetArgument(ctx context.Context, position int, target any) fwerror.FunctionErrors {
+	var fe fwerror.FunctionErrors
 
 	if len(d.values) == 0 {
-		diags.AddError(
-			"Invalid Argument Data Usage",
-			"When attempting to fetch argument data during the function call, the provider code incorrectly attempted to read argument data. "+
-				"This is always an issue in the provider code and should be reported to the provider developers.\n\n"+
-				"Function does not have argument data.",
-		)
-
-		return diags
+		msg := "Invalid Argument Data Usage: When attempting to fetch argument data during the function call, the provider code incorrectly attempted to read argument data. " +
+			"This is always an issue in the provider code and should be reported to the provider developers.\n\n" +
+			"Function does not have argument data."
+
+		fe.AddArgumentError(position, msg)
+
+		return fe
 	}
 
 	if position >= len(d.values) {
-		diags.AddError(
-			"Invalid Argument Data Position",
-			"When attempting to fetch argument data during the function call, the provider code attempted to read a non-existent argument position. "+
-				"Function argument positions are 0-based and any final variadic parameter is represented as one argument position with an ordered list of the parameter data type. "+
-				"This is always an error in the provider code and should be reported to the provider developers.\n\n"+
-				fmt.Sprintf("Given argument position: %d, last argument position: %d", position, len(d.values)-1),
-		)
+		msg := "Invalid Argument Data Position: When attempting to fetch argument data during the function call, the provider code attempted to read a non-existent argument position. " +
+			"Function argument positions are 0-based and any final variadic parameter is represented as one argument position with an ordered list of the parameter data type. " +
+			"This is always an error in the provider code and should be reported to the provider developers.\n\n" +
+			fmt.Sprintf("Given argument position: %d, last argument position: %d", position, len(d.values)-1)
+
+		fe.AddArgumentError(position, msg)
 
-		return diags
+		return fe
 	}
 
 	attrValue := d.values[position]
@@ -154,20 +149,20 @@ func (d ArgumentsData) GetArgument(ctx context.Context, position int, target any
 	tfValue, err := attrValue.ToTerraformValue(ctx)
 
 	if err != nil {
-		diags.AddError(
-			"Argument Value Conversion Error",
-			fmt.Sprintf("An unexpected error was encountered converting a %T to its equivalent Terraform representation. "+
-				"This is always an error in the provider code and should be reported to the provider developers.\n\n"+
-				"Error: %s", attrValue, err),
-		)
-		return diags
+		msg := fmt.Sprintf("Argument Value Conversion Error: An unexpected error was encountered converting a %T to its equivalent Terraform representation. "+
+			"This is always an error in the provider code and should be reported to the provider developers.\n\n"+
+			"Error: %s", attrValue, err)
+
+		fe.AddArgumentError(position, msg)
+
+		return fe
 	}
 
 	reflectDiags := fwreflect.Into(ctx, attrValue.Type(ctx), tfValue, target, fwreflect.Options{}, path.Empty())
 
-	diags.Append(reflectDiags...)
+	fe.Append(fwerror.FunctionErrorsFromDiags(ctx, reflectDiags)...)
 
-	return diags
+	return fe
 }
 
 // NewArgumentsData creates an ArgumentsData. This is only necessary for unit