tfprotov5+tfprotov6: Implement GetMetadata RPC

Author: bflad

.changes/unreleased/FEATURES-20230824-152200.yaml

@@ -0,0 +1,5 @@
+kind: FEATURES
+body: 'tfprotov5: Upgraded protocol to 5.4 and implemented `GetMetadata` RPC'
+time: 2023-08-24T15:22:00.773731-04:00
+custom:
+  Issue: "310"

.changes/unreleased/FEATURES-20230824-152220.yaml

@@ -0,0 +1,5 @@
+kind: FEATURES
+body: 'tfprotov6: Upgraded protocol to 6.4 and implemented `GetMetadata` RPC'
+time: 2023-08-24T15:22:20.285837-04:00
+custom:
+  Issue: "310"

tfprotov5/data_source.go

@@ -7,6 +7,13 @@ import (
 	"context"
 )
 
+// DataSourceMetadata describes metadata for a data resource in the GetMetadata
+// RPC.
+type DataSourceMetadata struct {
+	// TypeName is the name of the data resource.
+	TypeName string
+}
+
 // DataSourceServer is an interface containing the methods a data source
 // implementation needs to fill.
 type DataSourceServer interface {

tfprotov5/internal/fromproto/data_source.go

@@ -8,6 +8,16 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5"
 )
 
+func DataSourceMetadata(in *tfplugin5.GetMetadata_DataSourceMetadata) *tfprotov5.DataSourceMetadata {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov5.DataSourceMetadata{
+		TypeName: in.TypeName,
+	}
+}
+
 func ValidateDataSourceConfigRequest(in *tfplugin5.ValidateDataSourceConfig_Request) (*tfprotov5.ValidateDataSourceConfigRequest, error) {
 	resp := &tfprotov5.ValidateDataSourceConfigRequest{
 		TypeName: in.TypeName,

tfprotov5/internal/fromproto/provider.go

@@ -8,6 +8,40 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5"
 )
 
+func GetMetadataRequest(in *tfplugin5.GetMetadata_Request) (*tfprotov5.GetMetadataRequest, error) {
+	return &tfprotov5.GetMetadataRequest{}, nil
+}
+
+func GetMetadataResponse(in *tfplugin5.GetMetadata_Response) (*tfprotov5.GetMetadataResponse, error) {
+	if in == nil {
+		return nil, nil
+	}
+
+	resp := &tfprotov5.GetMetadataResponse{
+		DataSources:        make([]tfprotov5.DataSourceMetadata, 0, len(in.DataSources)),
+		Resources:          make([]tfprotov5.ResourceMetadata, 0, len(in.Resources)),
+		ServerCapabilities: ServerCapabilities(in.ServerCapabilities),
+	}
+
+	for _, datasource := range in.DataSources {
+		resp.DataSources = append(resp.DataSources, *DataSourceMetadata(datasource))
+	}
+
+	for _, resource := range in.Resources {
+		resp.Resources = append(resp.Resources, *ResourceMetadata(resource))
+	}
+
+	diags, err := Diagnostics(in.Diagnostics)
+
+	if err != nil {
+		return resp, err
+	}
+
+	resp.Diagnostics = diags
+
+	return resp, nil
+}
+
 func GetProviderSchemaRequest(in *tfplugin5.GetProviderSchema_Request) (*tfprotov5.GetProviderSchemaRequest, error) {
 	return &tfprotov5.GetProviderSchemaRequest{}, nil
 }

tfprotov5/internal/fromproto/resource.go

@@ -10,6 +10,16 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5"
 )
 
+func ResourceMetadata(in *tfplugin5.GetMetadata_ResourceMetadata) *tfprotov5.ResourceMetadata {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov5.ResourceMetadata{
+		TypeName: in.TypeName,
+	}
+}
+
 func ValidateResourceTypeConfigRequest(in *tfplugin5.ValidateResourceTypeConfig_Request) (*tfprotov5.ValidateResourceTypeConfigRequest, error) {
 	resp := &tfprotov5.ValidateResourceTypeConfigRequest{
 		TypeName: in.TypeName,

tfprotov5/internal/fromproto/server_capabilities.go

@@ -0,0 +1,20 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package fromproto
+
+import (
+	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5"
+)
+
+func ServerCapabilities(in *tfplugin5.ServerCapabilities) *tfprotov5.ServerCapabilities {
+	if in == nil {
+		return nil
+	}
+
+	return &tfprotov5.ServerCapabilities{
+		GetProviderSchemaOptional: in.GetProviderSchemaOptional,
+		PlanDestroy:               in.PlanDestroy,
+	}
+}