Add identity fields to Plan struct (#158)

Author: dbanck

parse_test.go

@@ -6,7 +6,6 @@ package tfjson
 import (
 	"bytes"
 	"encoding/json"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"reflect"
@@ -21,7 +20,7 @@ const testGoldenStateFileName = "state.json"
 const testGoldenSchemasFileName = "schemas.json"
 
 func testParse(t *testing.T, filename string, typ reflect.Type) {
-	entries, err := ioutil.ReadDir(testFixtureDir)
+	entries, err := os.ReadDir(testFixtureDir)
 	if err != nil {
 		t.Fatalf("err: %s", err)
 	}
@@ -32,7 +31,7 @@ func testParse(t *testing.T, filename string, typ reflect.Type) {
 		}
 
 		t.Run(e.Name(), func(t *testing.T) {
-			expected, err := ioutil.ReadFile(filepath.Join(testFixtureDir, e.Name(), filename))
+			expected, err := os.ReadFile(filepath.Join(testFixtureDir, e.Name(), filename))
 			if err != nil {
 				if os.IsNotExist(err) {
 					t.Skip(err.Error())

plan.go

@@ -266,13 +266,28 @@ type Change struct {
 	// is either an integer pointing to a child of a set/list, or a string
 	// pointing to the child of a map, object, or block.
 	ReplacePaths []interface{} `json:"replace_paths,omitempty"`
+
+	// BeforeIdentity and AfterIdentity are representations of the resource
+	// identity value both before and after the action.
+	BeforeIdentity interface{} `json:"before_identity,omitempty"`
+	AfterIdentity  interface{} `json:"after_identity,omitempty"`
 }
 
 // Importing is a nested object for the resource import metadata.
 type Importing struct {
 	// The original ID of this resource used to target it as part of planned
 	// import operation.
 	ID string `json:"id,omitempty"`
+
+	// Unknown indicates the ID or identity was unknown at the time of
+	// planning. This would have led to the overall change being deferred, as
+	// such this should only be true when processing changes from the deferred
+	// changes list.
+	Unknown bool `json:"unknown,omitempty"`
+
+	// The identity can be used instead of the ID to target the resource as part
+	// of the planned import operation.
+	Identity interface{} `json:"identity,omitempty"`
 }
 
 // PlanVariable is a top-level variable in the Terraform plan.

plan_test.go

@@ -13,19 +13,34 @@ import (
 )
 
 func TestPlanValidate(t *testing.T) {
-	f, err := os.Open("testdata/basic/plan.json")
-	if err != nil {
-		t.Fatal(err)
+	cases := map[string]struct {
+		planPath string
+	}{
+		"basic plan": {
+			planPath: "testdata/basic/plan.json",
+		},
+		"plan with identity": {
+			planPath: "testdata/identity/plan.json",
+		},
 	}
-	defer f.Close()
 
-	var plan *Plan
-	if err := json.NewDecoder(f).Decode(&plan); err != nil {
-		t.Fatal(err)
-	}
+	for tn, tc := range cases {
+		t.Run(tn, func(t *testing.T) {
+			f, err := os.Open(tc.planPath)
+			if err != nil {
+				t.Fatal(err)
+			}
+			defer f.Close()
 
-	if err := plan.Validate(); err != nil {
-		t.Fatal(err)
+			var plan *Plan
+			if err := json.NewDecoder(f).Decode(&plan); err != nil {
+				t.Fatal(err)
+			}
+
+			if err := plan.Validate(); err != nil {
+				t.Fatal(err)
+			}
+		})
 	}
 }
 

testdata/identity/plan.json

@@ -0,0 +1 @@
+{"format_version":"1.2","terraform_version":"1.13.0-dev","planned_values":{"root_module":{"resources":[{"address":"corner_user_identity.user","mode":"managed","type":"corner_user_identity","name":"user","provider_name":"registry.terraform.io/hashicorp/corner","schema_version":0,"values":{"age":999,"email":"[email protected]","id":"[email protected]","name":"test"},"sensitive_values":{},"identity_schema_version":1,"identity":{"email":"[email protected]"}}]}},"resource_changes":[{"address":"corner_user_identity.user","mode":"managed","type":"corner_user_identity","name":"user","provider_name":"registry.terraform.io/hashicorp/corner","change":{"actions":["update"],"before":{"age":null,"email":"[email protected]","id":"[email protected]","name":null},"after":{"age":999,"email":"[email protected]","id":"[email protected]","name":"test"},"after_unknown":{},"before_sensitive":{},"after_sensitive":{},"importing":{"identity":{"email":"[email protected]"}},"before_identity":{"email":"[email protected]"},"after_identity":{"email":"[email protected]"}}}],"prior_state":{"format_version":"1.0","terraform_version":"1.13.0","values":{"root_module":{"resources":[{"address":"corner_user_identity.user","mode":"managed","type":"corner_user_identity","name":"user","provider_name":"registry.terraform.io/hashicorp/corner","schema_version":0,"values":{"age":null,"email":"[email protected]","id":"[email protected]","name":null},"sensitive_values":{},"identity_schema_version":1,"identity":{"email":"[email protected]"}}]}}},"configuration":{"provider_config":{"corner":{"name":"corner","full_name":"registry.terraform.io/hashicorp/corner"}},"root_module":{"resources":[{"address":"corner_user_identity.user","mode":"managed","type":"corner_user_identity","name":"user","provider_config_key":"corner","expressions":{"age":{"constant_value":999},"email":{"constant_value":"[email protected]"},"name":{"constant_value":"test"}},"schema_version":0}]}},"timestamp":"2025-04-30T11:34:17Z"}