Merge pull request #13 from patrickcping/11-terraform-plan-fails-when-the-davinci_flow-resource-name-in-subflow_link-blocks-does-not-match-the-actual-davinci_flow-resource-definition

Re-map all `subflow_link` flow references based on provided subflows

Author: patrickcping

.gitignore

@@ -2,4 +2,5 @@ testoutput*
 vendor
 env*.sh
 output.log
-generated*
+generated*
+dvtf-pingctl

cmd/root.go

@@ -132,6 +132,7 @@ func initConfig() error {
 }
 
 func bindParams(cmd *cobra.Command) error {
+	var err error
 	cmd.Flags().VisitAll(func(f *pflag.Flag) {
 		configName := strings.ReplaceAll(f.Name, "-", "")
 
@@ -151,12 +152,15 @@ func bindParams(cmd *cobra.Command) error {
 				for _, val := range v {
 					values = append(values, fmt.Sprintf("%v", val))
 				}
-				cmd.Flags().Set(f.Name, strings.Join(values, ","))
+				err = cmd.Flags().Set(f.Name, strings.Join(values, ","))
 			default:
-				cmd.Flags().Set(f.Name, fmt.Sprintf("%v", v))
+				err = cmd.Flags().Set(f.Name, fmt.Sprintf("%v", v))
+			}
+			if err != nil {
+				return
 			}
 		}
 	})
 
-	return nil
+	return err
 }

internal/flow/export.go

@@ -25,7 +25,10 @@ func NewFromPath(pathToJson string) (*DaVinciExport, error) {
 	}
 
 	// Get the string from file
-	dvExport.readJSONFile()
+	err := dvExport.readJSONFile()
+	if err != nil {
+		return nil, err
+	}
 
 	return &dvExport, nil
 }

internal/generate/generate.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/patrickcping/dvtf-pingctl/internal/generate/export"
 	"github.com/patrickcping/dvtf-pingctl/internal/logger"
+	"github.com/patrickcping/dvtf-pingctl/internal/output"
 	"github.com/patrickcping/dvtf-pingctl/internal/terraform"
 	"github.com/samir-gandhi/davinci-client-go/davinci"
 )
@@ -24,13 +25,15 @@ type DaVinciGenerator struct {
 	connectionsData []connectionData
 	variablesData   []variableData
 	flowAssets      []flowAssetData
+	flowNames       map[string]string
 }
 
 func New(exportDefs []export.DaVinciGeneratorExport, resources []terraform.ProviderResource, outputPath string) *DaVinciGenerator {
 	return &DaVinciGenerator{
 		exportDefs: exportDefs,
 		resources:  resources,
 		outputPath: outputPath,
+		flowNames:  map[string]string{},
 	}
 }
 
@@ -54,6 +57,9 @@ func (d *DaVinciGenerator) Generate(version string, overwrite bool) error {
 		}
 	}
 
+	// Re-write the subflow names to fix issue https://github.com/patrickcping/dvtf-pingctl/issues/11
+	d.rewriteSubflowNames()
+
 	// Write the HCL configuration
 	err = d.write(version, overwrite)
 	if err != nil {
@@ -63,6 +69,34 @@ func (d *DaVinciGenerator) Generate(version string, overwrite bool) error {
 	return nil
 }
 
+func (d *DaVinciGenerator) rewriteSubflowNames() {
+	updatedFlowsData := make([]flowData, 0)
+	for _, flowData := range d.flowsData {
+		updatedSubflowLinks := make([]flowSubflowLink, 0)
+		for _, subflowLink := range flowData.SubflowLinks {
+			if subFlowName, ok := d.flowNames[subflowLink.ReplaceSubflowID]; ok {
+				// update the subflow link name
+				subflowLink.FlowRefID = d.sanitiseResourceName(subFlowName)
+				subflowLink.SubFlowName = subFlowName
+			} else {
+				// Issue warning that subflow hasn't been included in the `-e` param list
+				output.Print(output.Opts{
+					Message: "Warning: Subflow has not been found in any of the JSON files provided in the `-e` param list. Plan errors may occur.",
+					Fields: map[string]interface{}{
+						"Missing Subflow ID": subflowLink.ReplaceSubflowID,
+					},
+				})
+			}
+			updatedSubflowLinks = append(updatedSubflowLinks, subflowLink)
+		}
+		flowData.SubflowLinks = updatedSubflowLinks
+
+		updatedFlowsData = append(updatedFlowsData, flowData)
+	}
+
+	d.flowsData = updatedFlowsData
+}
+
 func (d *DaVinciGenerator) parseFlows() error {
 
 	newExportDefs := make([]export.DaVinciGeneratorExport, 0)
@@ -128,6 +162,7 @@ func (d *DaVinciGenerator) buildDataSingleFlow(flow davinci.Flow, parsedIntf map
 	l.Debug().Msgf("buildDataSingleFlow Command called.")
 
 	flowResourceName := d.sanitiseResourceName(flow.Name)
+	d.flowNames[flow.FlowID] = flow.Name
 
 	pathVar := fmt.Sprintf("assets/flows/%s.json", flowResourceName)
 	createFlow := true
@@ -278,7 +313,7 @@ func (d *DaVinciGenerator) buildDataSingleFlow(flow davinci.Flow, parsedIntf map
 		DependsOnVarRefs: dependsOnVarRefs,
 		Name:             d.sanitiseStringFieldPtr(&flow.Name),
 		Description:      d.sanitiseStringFieldPtr(flow.Description),
-		FlowJSONPath:     fmt.Sprintf("%s", pathVar),
+		FlowJSONPath:     pathVar,
 		ConnectionLinks:  flowConnectionLinks,
 		SubflowLinks:     subflowLinks,
 	})
@@ -356,7 +391,7 @@ func (d *DaVinciGenerator) writeVariables(version string, overwrite bool) error
 		return fmt.Errorf("failed to parse variable HCL template. err: %s", err.Error())
 	}
 
-	fileName := d.outputPath + fmt.Sprintf("/davinci_variables.tf")
+	fileName := fmt.Sprintf("%s/davinci_variables.tf", d.outputPath)
 
 	// Check if the file exists
 	if _, err := os.Stat(fileName); err == nil {
@@ -368,10 +403,10 @@ func (d *DaVinciGenerator) writeVariables(version string, overwrite bool) error
 	}
 
 	outputFile, err := os.Create(fileName)
-	defer outputFile.Close()
 	if err != nil {
 		return err
 	}
+	defer outputFile.Close()
 
 	for _, variableData := range d.variablesData {
 		err = hclTemplate.Execute(outputFile, variableData)
@@ -398,7 +433,7 @@ func (d *DaVinciGenerator) writeConnections(version string, overwrite bool) erro
 		return fmt.Errorf("failed to parse connection HCL template. err: %s", err.Error())
 	}
 
-	fileName := d.outputPath + fmt.Sprintf("/davinci_connectors.tf")
+	fileName := fmt.Sprintf("%s/davinci_connectors.tf", d.outputPath)
 
 	// Check if the file exists
 	if _, err := os.Stat(fileName); err == nil {
@@ -410,10 +445,10 @@ func (d *DaVinciGenerator) writeConnections(version string, overwrite bool) erro
 	}
 
 	outputFile, err := os.Create(fileName)
-	defer outputFile.Close()
 	if err != nil {
 		return err
 	}
+	defer outputFile.Close()
 
 	for _, connectionData := range d.connectionsData {
 		err = hclTemplate.Execute(outputFile, connectionData)
@@ -439,7 +474,7 @@ func (d *DaVinciGenerator) writeFlows(version string, overwrite bool) error {
 		return fmt.Errorf("failed to parse flow HCL template. err: %s", err.Error())
 	}
 
-	fileName := d.outputPath + fmt.Sprintf("/davinci_flows.tf")
+	fileName := fmt.Sprintf("%s/davinci_flows.tf", d.outputPath)
 
 	// Check if the file exists
 	if _, err := os.Stat(fileName); err == nil {
@@ -451,10 +486,10 @@ func (d *DaVinciGenerator) writeFlows(version string, overwrite bool) error {
 	}
 
 	outputFile, err := os.Create(fileName)
-	defer outputFile.Close()
 	if err != nil {
 		return err
 	}
+	defer outputFile.Close()
 
 	for _, flowData := range d.flowsData {
 		err = hclTemplate.Execute(outputFile, flowData)
@@ -468,7 +503,7 @@ func (d *DaVinciGenerator) writeFlows(version string, overwrite bool) error {
 
 func (d *DaVinciGenerator) writeAssets() error {
 
-	outputDir := d.outputPath + fmt.Sprintf("/assets/flows/")
+	outputDir := fmt.Sprintf("%s/assets/flows/", d.outputPath)
 
 	err := os.MkdirAll(outputDir, os.ModePerm)
 	if err != nil {
@@ -488,6 +523,9 @@ func (d *DaVinciGenerator) writeAssets() error {
 func (d *DaVinciGenerator) writeAsset(flowAsset flowAssetData) error {
 
 	fileData, err := json.MarshalIndent(flowAsset.flowMap, "", "  ")
+	if err != nil {
+		return fmt.Errorf("Cannot marshal asset data: %s", err)
+	}
 
 	err = os.WriteFile(fmt.Sprintf("%s/%s", d.outputPath, flowAsset.path), fileData, 0644)
 	if err != nil {

internal/validate/validate.go

@@ -182,42 +182,42 @@ func (d *DaVinciValidator) OutputValidationResponse(vErr error) (ok, warning boo
 	case errors.Is(vErr, ErrSubflowsPresent):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("Subflows are present in the export file.  Subflows must be managed as their own independent davinci_flow resources.  Please re-export the DaVinci flow without subflows."),
+			Message: "Subflows are present in the export file.  Subflows must be managed as their own independent davinci_flow resources.  Please re-export the DaVinci flow without subflows.",
 			Result:  output.ENUM_RESULT_FAILURE,
 		}
 
 	case errors.Is(vErr, davinci.ErrInvalidJson):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("The DaVinci Flow Export JSON is not valid JSON.  Please re-export the DaVinci flow."),
+			Message: "The DaVinci Flow Export JSON is not valid JSON.  Please re-export the DaVinci flow.",
 			Result:  output.ENUM_RESULT_FAILURE,
 		}
 
 	case errors.Is(vErr, davinci.ErrEmptyFlow):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("The DaVinci Flow Export JSON is empty.  Please re-export the DaVinci flow."),
+			Message: "The DaVinci Flow Export JSON is empty.  Please re-export the DaVinci flow.",
 			Result:  output.ENUM_RESULT_FAILURE,
 		}
 
 	case errors.Is(vErr, davinci.ErrNoFlowDefinition):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("No flow definition found in the DaVinci Flow Export JSON.  Expecting exactly one flow definition.  Please re-export the DaVinci flow."),
+			Message: "No flow definition found in the DaVinci Flow Export JSON.  Expecting exactly one flow definition.  Please re-export the DaVinci flow.",
 			Result:  output.ENUM_RESULT_FAILURE,
 		}
 
 	case errors.Is(vErr, davinci.ErrMissingSaveVariableValues):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("Save flow variable nodes are present but are missing variable values in the DaVinci Flow Export JSON.  Please re-export the DaVinci flow ensuring that variable values are included."),
+			Message: "Save flow variable nodes are present but are missing variable values in the DaVinci Flow Export JSON.  Please re-export the DaVinci flow ensuring that variable values are included.",
 			Result:  output.ENUM_RESULT_FAILURE,
 		}
 
 	case errors.As(vErr, &equatesEmptyError):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("The JSON does not appear to be a valid DaVinci export file.  Please re-export the DaVinci flow."),
+			Message: "The JSON does not appear to be a valid DaVinci export file.  Please re-export the DaVinci flow.",
 			Result:  output.ENUM_RESULT_FAILURE,
 			Fields: map[string]interface{}{
 				"Computed Difference (empty is failure)": equatesEmptyError.Diff,
@@ -227,7 +227,7 @@ func (d *DaVinciValidator) OutputValidationResponse(vErr error) (ok, warning boo
 	case errors.As(vErr, &missingRequiredFlowFieldsError):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("The DaVinci Flow Export JSON has been evaluated to be missing required fields.  Please re-export the DaVinci flow."),
+			Message: "The DaVinci Flow Export JSON has been evaluated to be missing required fields.  Please re-export the DaVinci flow.",
 			Result:  output.ENUM_RESULT_FAILURE,
 			Fields: map[string]interface{}{
 				"Computed Difference": missingRequiredFlowFieldsError.Diff,
@@ -237,7 +237,7 @@ func (d *DaVinciValidator) OutputValidationResponse(vErr error) (ok, warning boo
 	case errors.As(vErr, &unknownAdditionalFieldsError):
 
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("The DaVinci flow will be accepted by the provider, but the DaVinci Flow Export contains unknown properties that cannot be validated.  These parameters will be preserved on import to the DaVinci service, but there may be unpredictable results in difference calculation."),
+			Message: "The DaVinci flow will be accepted by the provider, but the DaVinci Flow Export contains unknown properties that cannot be validated.  These parameters will be preserved on import to the DaVinci service, but there may be unpredictable results in difference calculation.",
 			Result:  output.ENUM_RESULT_NOACTION_WARN,
 			Fields: map[string]interface{}{
 				"Computed Difference": unknownAdditionalFieldsError.Diff,
@@ -278,7 +278,7 @@ func (d *DaVinciValidator) OutputValidationResponse(vErr error) (ok, warning boo
 
 	case errors.Is(vErr, io.EOF):
 		outputOpts = output.Opts{
-			Message: fmt.Sprintf("The export contents cannot be empty"),
+			Message: "The export contents cannot be empty",
 			Result:  output.ENUM_RESULT_FAILURE,
 		}
 

scripts/generate-test.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+go build .
+
+# Directory containing the files
+directory=$1
+
+# Directory containing the script
+script_dir=$(dirname "$(realpath "$0")")
+
+# Directory to generate HCL in
+DIR="$directory/testoutput"
+
+if [ -d "$DIR" ]; then
+  echo "Directory $DIR exists.  Removing it."
+  rm -r $DIR
+fi
+
+# Initialize the command variable
+command=""
+
+# Loop through all JSON (export) files in the directory
+for file in "$directory"/*.json; do
+
+  # ./dvtf-pingctl validate -e "$file"
+  # validateResponse=$?
+  # # Check if the command failed
+  # if [ $validateResponse -eq 1 ]; then
+  #   echo "Validation failed"
+  #   exit 1
+  # fi
+  # if [ $validateResponse -eq 2 ]; then
+  #   echo "Validation warning"
+  # fi
+
+  # Add each file as a parameter
+  command+=" -e \"$file\""
+done
+
+set -e
+
+# Execute the command
+./dvtf-pingctl generate -o $DIR $command
+
+if [ -d "$DIR" ]; then
+  echo "Directory $DIR exists.  Bootstrapping it."
+
+  cp $script_dir/../testing/bootstrap-hcl/* $DIR
+  cp $directory/*.tftest.hcl $DIR
+  
+  pushd $DIR
+    terraform init
+    terraform validate
+    terraform test
+  popd
+else
+  echo "Directory $DIR does not exist."
+  exit 1
+fi