fix: mark invalid UUIDs as known (#148)

Author: ethanndickson

internal/provider/user_data_source_test.go

@@ -57,6 +57,7 @@ func TestAccUserDataSource(t *testing.T) {
 			Username: ptr.Ref(user.Username),
 		}
 		resource.Test(t, resource.TestCase{
+			IsUnitTest:               true,
 			PreCheck:                 func() { testAccPreCheck(t) },
 			ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 			Steps: []resource.TestStep{
@@ -75,6 +76,7 @@ func TestAccUserDataSource(t *testing.T) {
 			ID:    ptr.Ref(user.ID.String()),
 		}
 		resource.Test(t, resource.TestCase{
+			IsUnitTest:               true,
 			PreCheck:                 func() { testAccPreCheck(t) },
 			ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 			// User by ID
@@ -92,6 +94,7 @@ func TestAccUserDataSource(t *testing.T) {
 			Token: client.SessionToken(),
 		}
 		resource.Test(t, resource.TestCase{
+			IsUnitTest:               true,
 			PreCheck:                 func() { testAccPreCheck(t) },
 			ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 			// Neither ID nor Username
@@ -104,6 +107,24 @@ func TestAccUserDataSource(t *testing.T) {
 		})
 	})
 
+	t.Run("InvalidUUIDError", func(t *testing.T) {
+		cfg := testAccUserDataSourceConfig{
+			URL:   client.URL.String(),
+			Token: client.SessionToken(),
+			ID:    ptr.Ref("invalid-uuid"),
+		}
+		resource.Test(t, resource.TestCase{
+			IsUnitTest:               true,
+			PreCheck:                 func() { testAccPreCheck(t) },
+			ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+			Steps: []resource.TestStep{
+				{
+					Config:      cfg.String(t),
+					ExpectError: regexp.MustCompile(`The provided value cannot be parsed as a UUID`),
+				},
+			},
+		})
+	})
 }
 
 type testAccUserDataSourceConfig struct {

internal/provider/uuid.go

@@ -48,16 +48,16 @@ func (t uuidType) ValueFromString(ctx context.Context, in basetypes.StringValue)
 		return NewUUIDUnknown(), diags
 	}
 
-	value, err := uuid.Parse(in.ValueString())
-	if err != nil {
-		// The framework doesn't want us to return validation errors here
-		// for some reason. They get caught by `ValidateAttribute` instead,
-		// and this function isn't called directly by our provider - UUIDValue
-		// takes a valid UUID instead of a string.
-		return NewUUIDUnknown(), diags
-	}
-
-	return UUIDValue(value), diags
+	// This function deliberately does not handle invalid UUIDs.
+	// Instead, `ValidateAttribute` will be called
+	// on the stored string during `validate` `plan` and `apply`,
+	// which will also create an error diagnostic.
+	// For that reason, storing the zero UUID is fine.
+	v, _ := uuid.Parse(in.ValueString())
+	return UUID{
+		StringValue: in,
+		value:       v,
+	}, diags
 }
 
 // ValueFromTerraform implements basetypes.StringTypable.

internal/provider/uuid_internal_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/google/uuid"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 	"github.com/stretchr/testify/require"
 )
@@ -37,9 +38,12 @@ func TestUUIDTypeValueFromTerraform(t *testing.T) {
 			expected: UUIDValue(ValidUUID),
 		},
 		{
-			name:     "invalid UUID",
-			input:    tftypes.NewValue(tftypes.String, "invalid"),
-			expected: NewUUIDUnknown(),
+			name:  "invalid UUID",
+			input: tftypes.NewValue(tftypes.String, "invalid"),
+			expected: UUID{
+				StringValue: basetypes.NewStringValue("invalid"),
+				value:       uuid.Nil,
+			},
 		},
 	}