Merge pull request #1309 from mdb/mdb/parse-plan-json

publicly expose terraform.ParsePlanJSON function
gruntwork-io · Jul 10, 2023 · c6a3be9 · c6a3be9
2 parents d58da78 + 7f28553
commit c6a3be9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/modules/terraform/plan.go b/modules/terraform/plan.go
@@ -93,7 +93,7 @@ func InitAndPlanAndShowWithStructE(t testing.TestingT, options *Options) (*PlanS
 	if err != nil {
 		return nil, err
 	}
-	return parsePlanJson(jsonOut)
+	return ParsePlanJSON(jsonOut)
 }
 
 // InitAndPlanWithExitCode runs terraform init and plan with the given options and returns exitcode for the plan command.

diff --git a/modules/terraform/plan_struct.go b/modules/terraform/plan_struct.go
@@ -27,9 +27,9 @@ type PlanStruct struct {
 	ResourceChangesMap map[string]*tfjson.ResourceChange
 }
 
-// parsePlanJson takes in the json string representation of the terraform plan and returns a go struct representation
+// ParsePlanJSON takes in the json string representation of the terraform plan and returns a go struct representation
 // for easy introspection.
-func parsePlanJson(jsonStr string) (*PlanStruct, error) {
+func ParsePlanJSON(jsonStr string) (*PlanStruct, error) {
 	plan := &PlanStruct{}
 
 	if err := json.Unmarshal([]byte(jsonStr), &plan.RawPlan); err != nil {

diff --git a/modules/terraform/plan_struct_test.go b/modules/terraform/plan_struct_test.go
@@ -23,7 +23,7 @@ func TestPlannedValuesMapWithBasicJson(t *testing.T) {
 
 	// Retrieve test data from the terraform-json project.
 	_, jsonData := http_helper.HttpGet(t, basicJsonUrl, nil)
-	plan, err := parsePlanJson(jsonData)
+	plan, err := ParsePlanJSON(jsonData)
 	require.NoError(t, err)
 
 	query := []string{
@@ -48,7 +48,7 @@ func TestPlannedValuesMapWithDeepModuleJson(t *testing.T) {
 
 	// Retrieve test data from the terraform-json project.
 	_, jsonData := http_helper.HttpGet(t, deepModuleJsonUrl, nil)
-	plan, err := parsePlanJson(jsonData)
+	plan, err := ParsePlanJSON(jsonData)
 	require.NoError(t, err)
 
 	query := []string{
@@ -64,7 +64,7 @@ func TestResourceChangesJson(t *testing.T) {
 
 	// Retrieve test data from the terraform-json project.
 	_, jsonData := http_helper.HttpGet(t, changesJsonUrl, nil)
-	plan, err := parsePlanJson(jsonData)
+	plan, err := ParsePlanJSON(jsonData)
 	require.NoError(t, err)
 
 	// Spot check a few changes to make sure the right address was registered

diff --git a/modules/terraform/show.go b/modules/terraform/show.go
@@ -40,7 +40,7 @@ func ShowWithStructE(t testing.TestingT, options *Options) (*PlanStruct, error)
 	if err != nil {
 		return nil, err
 	}
-	planStruct, err := parsePlanJson(json)
+	planStruct, err := ParsePlanJSON(json)
 	if err != nil {
 		return nil, err
 	}