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

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

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

scripts/test-bootstrap-hcl/main.tf

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# Directory containing the files
+directory=$1
+
+# Initialize the command variable
+command="go run ./ validate"
+
+# Loop through all files in the directory
+for file in "$directory"/*.json; do
+  # Add each file as a parameter
+  command+=" -e \"$file\""
+done
+
+# Execute the command
+eval $command

scripts/test-bootstrap-hcl/variables.tf

@@ -0,0 +1,19 @@
+resource "pingone_environment" "test_environment" {
+  name       = format("DVTF-PINGCTL Test Environment - %s", var.test_name)
+  type       = "SANDBOX"
+  license_id = var.license_id
+
+  services = [
+    {
+      type = "SSO"
+    },
+    {
+      type = "DaVinci",
+      tags = ["DAVINCI_MINIMAL"]
+    }
+  ]
+}
+
+locals {
+  pingone_environment_id = pingone_environment.test_environment.id
+}

scripts/test-bootstrap-hcl/versions.tf

@@ -0,0 +1,12 @@
+variable "license_id" {
+  type = string
+}
+
+variable "davinci_admin_environment_id" {
+  type = string
+}
+
+variable "test_name" {
+  type = string
+  default = "no-test"
+}

scripts/validate-test.sh

@@ -0,0 +1,36 @@
+terraform {
+  required_providers {
+    davinci = {
+      source  = "pingidentity/davinci"
+      version = ">= 0.4.2, < 1.0.0"
+    }
+    pingone = {
+      source  = "pingidentity/pingone"
+      version = ">= 1.1.0, < 2.0.0"
+    }
+  }
+}
+
+provider "pingone" {
+  # Configuration options
+  # Ref: https://registry.terraform.io/providers/pingidentity/pingone/latest/docs#provider-schema-reference
+
+  # Ensure the following environment variables are set:
+  # - PINGONE_CLIENT_ID
+  # - PINGONE_CLIENT_SECRET
+  # - PINGONE_ENVIRONMENT_ID
+  # - PINGONE_REGION_CODE
+}
+
+provider "davinci" {
+  # Configuration options
+  # Ref: https://registry.terraform.io/providers/pingidentity/davinci/latest/docs#schema
+  
+  # Ensure the following environment variables are set:
+  # - PINGONE_USERNAME
+  # - PINGONE_PASSWORD
+  # - TF_VAR_davinci_admin_environment_id
+  # - PINGONE_REGION
+
+  environment_id = var.davinci_admin_environment_id
+}