fix up package docs + build specific TODO comments

Author: austinvalle

internal/proto5server/server_upgraderesourceidentity.go

@@ -11,5 +11,5 @@ import (
 
 // UpgradeResourceIdentity satisfies the tfprotov5.ProviderServer interface.
 func (s *Server) UpgradeResourceIdentity(ctx context.Context, proto5Req *tfprotov5.UpgradeResourceIdentityRequest) (*tfprotov5.UpgradeResourceIdentityResponse, error) {
-	panic("unimplemented") // TODO: implement
+	panic("unimplemented") // TODO:ResourceIdentity: implement
 }

internal/proto6server/server_upgraderesourceidentity.go

@@ -11,5 +11,5 @@ import (
 
 // UpgradeResourceIdentity satisfies the tfprotov6.ProviderServer interface.
 func (s *Server) UpgradeResourceIdentity(ctx context.Context, proto6Req *tfprotov6.UpgradeResourceIdentityRequest) (*tfprotov6.UpgradeResourceIdentityResponse, error) {
-	panic("unimplemented") // TODO: implement
+	panic("unimplemented") // TODO:ResourceIdentity: implement
 }

resource/identityschema/doc.go

@@ -4,8 +4,6 @@
 // Package identityschema contains all available schema functionality for managed
 // resource identity.
 //
-// TODO: Verify these type names are what we ended with.
-//
 // Resource identity schemas define the structure and value types for identity state data.
 // Schemas are implemented via the resource.ResourceWithIdentity type IdentitySchema method.
 package identityschema

resource/identityschema/list_attribute.go

@@ -165,9 +165,5 @@ func (a ListAttribute) ValidateImplementation(ctx context.Context, req fwschema.
 		resp.Diagnostics.Append(fwschema.AttributeMissingElementTypeDiag(req.Path))
 	}
 
-	// TODO: Write validation similar to the dynamic type validation/diagnostic for detecting
-	// non-primitive element types
-	// if a.CustomType == nil && fwtype.ContainsCollectionWithDynamic(a.GetType()) {
-	// 	resp.Diagnostics.Append(fwtype.AttributeCollectionWithDynamicTypeDiag(req.Path))
-	// }
+	// TODO:ResourceIdentity: Write validation + tests that ensure the element type only contains primitive elements (bool, string, number)
 }

resource/identityschema/list_attribute_test.go

@@ -460,29 +460,6 @@ func TestListAttributeValidateImplementation(t *testing.T) {
 			},
 			expected: &fwschema.ValidateImplementationResponse{},
 		},
-		// TODO: Update this test once the validation logic is in place
-		// "elementtype-invalid": {
-		// 	attribute: identityschema.ListAttribute{
-		// 		RequiredForImport: true,
-		// 		ElementType:       types.DynamicType,
-		// 	},
-		// 	request: fwschema.ValidateImplementationRequest{
-		// 		Name: "test",
-		// 		Path: path.Root("test"),
-		// 	},
-		// 	expected: &fwschema.ValidateImplementationResponse{
-		// 		Diagnostics: diag.Diagnostics{
-		// 			diag.NewErrorDiagnostic(
-		// 				"Invalid Schema Implementation",
-		// 				"When validating the schema, an implementation issue was found. "+
-		// 					"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
-		// 					"\"test\" is an attribute that contains a collection type with a nested dynamic type.\n\n"+
-		// 					"Dynamic types inside of collections are not currently supported in terraform-plugin-framework. "+
-		// 					"If underlying dynamic values are required, replace the \"test\" attribute definition with DynamicAttribute instead.",
-		// 			),
-		// 		},
-		// 	},
-		// },
 		"elementtype-missing": {
 			attribute: identityschema.ListAttribute{
 				RequiredForImport: true,

resource/identityschema/schema.go

@@ -17,10 +17,8 @@ import (
 // Schema must satify the fwschema.Schema interface.
 var _ fwschema.Schema = Schema{}
 
-// TODO: Verify these type names are what we ended with.
-//
 // Schema defines the structure and value types of resource identity data. This type
-// is used as the resource.IdentitySchemaResponse type Schema field, which is
+// is used as the resource.IdentitySchemaResponse type IdentitySchema field, which is
 // implemented by the resource.ResourceWithIdentity type IdentitySchema method.
 type Schema struct {
 	// Attributes is the mapping of underlying attribute names to attribute
@@ -31,7 +29,7 @@ type Schema struct {
 
 	// Version indicates the current version of the resource identity schema. Resource
 	// identity schema versioning enables identity state upgrades in conjunction with the
-	// [resource.ResourceWithIdentityStateUpgrades] interface. Versioning is only
+	// [resource.ResourceWithUpgradeIdentity] interface. Versioning is only
 	// required if there is a breaking change involving existing identity state data,
 	// such as changing an attribute type in a manner that is incompatible with the Terraform type.
 	//

resource/resource.go

@@ -199,7 +199,7 @@ type ResourceWithValidateConfig interface {
 
 // ResourceWithIdentity is an interface type that extends Resource to implement managed resource identity.
 //
-// TODO: Describe identity concept in more detail, reference the upgrade identity interface
+// TODO:ResourceIdentity: Add more documentation here to describe what identity is used for.
 type ResourceWithIdentity interface {
 	Resource