Add protobuf support for resource identity messages and rpcs (#472)

* Add protobuf support for resource identity messages and rpcs
* add more identity procotol changes made by core
* implement core change to rename prior_identity to planned_identity for ApplyResourceChange.Request

Author: ansgarm

tfprotov5/internal/tfplugin5/tfplugin5.pb.go

@@ -1,9 +1,9 @@
 // Copyright (c) HashiCorp, Inc.
 // SPDX-License-Identifier: MPL-2.0
 
-// Terraform Plugin RPC protocol version 5.8
+// Terraform Plugin RPC protocol version 5.9
 //
-// This file defines version 5.8 of the RPC protocol. To implement a plugin
+// This file defines version 5.9 of the RPC protocol. To implement a plugin
 // against this protocol, copy this definition into your own codebase and
 // use protoc to generate stubs for your target language.
 //
@@ -142,6 +142,32 @@ message Schema {
     Block block = 2;
 }
 
+// ResourceIdentitySchema is the identity schema for a Resource.
+message ResourceIdentitySchema {
+    // IdentityAttribute represents one value of data within resource identity.
+    // These are always used in resource identity comparisons.
+    message IdentityAttribute {
+        string name = 1;
+        bytes type = 2;
+        bool required_for_import = 3;
+        bool optional_for_import = 4;
+        string description = 5;
+    }
+
+    // The version of the schema
+    int64 identity_version = 1;
+
+    // The list of attributes that make up the identity of the resource
+    repeated IdentityAttribute identity_attributes = 2;
+}
+
+// ResourceIdentityData is a separate message for better extensibility
+message ResourceIdentityData {
+    // identity_data is the resource identity data for the given definition.
+    // It should be decoded using the identity schema.
+    DynamicValue identity_data = 1;
+}
+
 // ServerCapabilities allows providers to communicate extra information
 // regarding supported protocol features. This is used to indicate
 // availability of certain forward-compatible changes which may be optional
@@ -263,10 +289,12 @@ service Provider {
     // GetSchema returns schema information for the provider, data resources,
     // and managed resources.
     rpc GetSchema(GetProviderSchema.Request) returns (GetProviderSchema.Response);
+    rpc GetResourceIdentitySchemas(GetResourceIdentitySchemas.Request) returns (GetResourceIdentitySchemas.Response);
     rpc PrepareProviderConfig(PrepareProviderConfig.Request) returns (PrepareProviderConfig.Response);
     rpc ValidateResourceTypeConfig(ValidateResourceTypeConfig.Request) returns (ValidateResourceTypeConfig.Response);
     rpc ValidateDataSourceConfig(ValidateDataSourceConfig.Request) returns (ValidateDataSourceConfig.Response);
     rpc UpgradeResourceState(UpgradeResourceState.Request) returns (UpgradeResourceState.Response);
+    rpc UpgradeResourceIdentity(UpgradeResourceIdentity.Request) returns (UpgradeResourceIdentity.Response);
 
     //////// One-time initialization, called before other functions below
     rpc Configure(Configure.Request) returns (Configure.Response);
@@ -441,6 +469,7 @@ message ReadResource {
         bytes private = 3;
         DynamicValue provider_meta = 4;
         ClientCapabilities client_capabilities = 5;
+        ResourceIdentityData current_identity = 6;
     }
     message Response {
         DynamicValue new_state = 1;
@@ -449,6 +478,7 @@ message ReadResource {
         // deferred is set if the provider is deferring the change. If set the caller
         // needs to handle the deferral.
         Deferred deferred = 4;
+        ResourceIdentityData new_identity = 5;
     }
 }
 
@@ -461,6 +491,7 @@ message PlanResourceChange {
         bytes prior_private = 5;
         DynamicValue provider_meta = 6;
         ClientCapabilities client_capabilities = 7;
+        ResourceIdentityData prior_identity = 8;
     }
 
     message Response {
@@ -485,6 +516,7 @@ message PlanResourceChange {
         // deferred is set if the provider is deferring the change. If set the caller
         // needs to handle the deferral.
         Deferred deferred = 6;
+        ResourceIdentityData planned_identity = 7;
     }
 }
 
@@ -496,6 +528,7 @@ message ApplyResourceChange {
         DynamicValue config = 4;
         bytes planned_private = 5;
         DynamicValue provider_meta = 6;
+        ResourceIdentityData planned_identity = 7;
     }
     message Response {
         DynamicValue new_state = 1;
@@ -514,6 +547,7 @@ message ApplyResourceChange {
         //     ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ====
         //     ====              DO NOT USE THIS              ====
         bool legacy_type_system = 4;
+        ResourceIdentityData new_identity = 5;
     }
 }
 
@@ -522,12 +556,14 @@ message ImportResourceState {
         string type_name = 1;
         string id = 2;
         ClientCapabilities client_capabilities = 3;
+        ResourceIdentityData identity = 4;
     }
 
     message ImportedResource {
         string type_name = 1;
         DynamicValue state = 2;
         bytes private = 3;
+        ResourceIdentityData identity = 4;
     }
 
     message Response {
@@ -561,6 +597,8 @@ message MoveResourceState {
 
         // The private state of the resource being moved.
         bytes source_private = 6;
+
+        ResourceIdentityData source_identity = 7;
     }
 
     message Response {
@@ -572,6 +610,8 @@ message MoveResourceState {
 
         // The private state of the resource after it has been moved.
         bytes target_private = 3;
+
+        ResourceIdentityData target_identity = 4;
     }
 }
 
@@ -704,4 +744,31 @@ message CloseEphemeralResource {
     message Response {
         repeated Diagnostic diagnostics = 1;
     }
-}
+}
+
+// Returns resource identity schemas for all resources
+message GetResourceIdentitySchemas {
+    message Request {
+    }
+    message Response {
+        map<string, ResourceIdentitySchema> identity_schemas = 1;
+        repeated Diagnostic diagnostics = 2;
+    }
+}
+
+message UpgradeResourceIdentity {
+    message Request {
+        string type_name = 1;
+
+        // version is the identity_schema_version number recorded in
+        // the state file
+        int64 version = 2;
+
+        // raw_identity is the stored identity from the state in json
+        bytes raw_identity = 3;
+    }
+    message Response {
+        ResourceIdentityData upgraded_identity = 1;
+        repeated Diagnostic diagnostics = 2;
+    }
+}

tfprotov5/internal/tfplugin5/tfplugin5.proto

@@ -49,7 +49,7 @@ const (
 	//
 	// In the future, it may be possible to include this information directly
 	// in the protocol buffers rather than recreating a constant here.
-	protocolVersionMinor uint = 8
+	protocolVersionMinor uint = 9
 )
 
 // protocolVersion represents the combined major and minor version numbers of