Add --from-plan flag to terraform apply/deploy commands. Add `descr…

…ibe config` CLI command (#71) * Add `--from-plan` flag to terraform apply/deploy commands * Add `describe config` CLI command * Update `GetGlobMatches` function * Update `GetGlobMatches` function * Update `GetGlobMatches` function * Update `GetGlobMatches` function * Update `GetGlobMatches` function * Update doublestar to V4 * partial implementation of `terraform clean` * cleanup after testing * go imports formatting * Update `GetGlobMatches` function Co-authored-by: Nuru <[email protected]>
cloudposse · Nov 3, 2021 · d1f3e94 · d1f3e94
1 parent 302aa83
commit d1f3e94
Show file tree

Hide file tree

Showing 14 changed files with 140 additions and 34 deletions.
diff --git a/Makefile b/Makefile
@@ -18,3 +18,5 @@ build:
 
 deps:
 	go mod download
+
+.PHONY: lint build deps
diff --git a/cmd/describe.go b/cmd/describe.go
@@ -8,7 +8,7 @@ import (
 var describeCmd = &cobra.Command{
 	Use:                "describe",
 	Short:              "describe",
-	Long:               `This command shows configuration for stacks and components`,
+	Long:               `This command shows configuration for CLI, stacks and components`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: true},
 }
 

diff --git a/cmd/describe_config.go b/cmd/describe_config.go
@@ -0,0 +1,32 @@
+package cmd
+
+import (
+	"fmt"
+	e "github.com/cloudposse/atmos/internal/exec"
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+	"os"
+)
+
+// describeComponentCmd describes configuration for components
+var describeConfigCmd = &cobra.Command{
+	Use:                "config",
+	Short:              "describe config",
+	Long:               `This command shows CLI configuration`,
+	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: true},
+	Run: func(cmd *cobra.Command, args []string) {
+		err := e.ExecuteDescribeConfig(cmd, args)
+		if err != nil {
+			color.Red("%s\n", err)
+			fmt.Println()
+			os.Exit(1)
+		}
+	},
+}
+
+func init() {
+	describeConfigCmd.DisableFlagParsing = false
+	describeConfigCmd.PersistentFlags().StringP("format", "f", "json", "'atmos describe config -f json' or 'atmos describe config -f yaml'")
+
+	describeCmd.AddCommand(describeConfigCmd)
+}
diff --git a/go.mod b/go.mod
@@ -3,7 +3,7 @@ module github.com/cloudposse/atmos
 go 1.16
 
 require (
-	github.com/bmatcuk/doublestar v1.3.4
+	github.com/bmatcuk/doublestar/v4 v4.0.2
 	github.com/fatih/color v1.13.0
 	github.com/imdario/mergo v0.3.12
 	github.com/json-iterator/go v1.1.12

diff --git a/go.sum b/go.sum
@@ -53,8 +53,8 @@ github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj
 github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
 github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
 github.com/bketelsen/crypt v0.0.4/go.mod h1:aI6NrJ0pMGgvZKL1iVgXLnfIFJtfV+bKCoqOes/6LfM=
-github.com/bmatcuk/doublestar v1.3.4 h1:gPypJ5xD31uhX6Tf54sDPUOBXTqKH4c9aPY66CyQrS0=
-github.com/bmatcuk/doublestar v1.3.4/go.mod h1:wiQtGV+rzVYxB7WIlirSN++5HPtPlXEo9MEoZQC/PmE=
+github.com/bmatcuk/doublestar/v4 v4.0.2 h1:X0krlUVAVmtr2cRoTqR8aDMrDqnB36ht8wpWTiQ3jsA=
+github.com/bmatcuk/doublestar/v4 v4.0.2/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=

diff --git a/internal/exec/describe.go b/internal/exec/describe.go
@@ -2,7 +2,7 @@ package exec
 
 import (
 	"fmt"
-	"github.com/cloudposse/atmos/pkg/config"
+	c "github.com/cloudposse/atmos/pkg/config"
 	g "github.com/cloudposse/atmos/pkg/globals"
 	s "github.com/cloudposse/atmos/pkg/stack"
 	u "github.com/cloudposse/atmos/pkg/utils"
@@ -24,15 +24,15 @@ func ExecuteDescribeComponent(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	var configAndStacksInfo config.ConfigAndStacksInfo
+	var configAndStacksInfo c.ConfigAndStacksInfo
 	configAndStacksInfo.Stack = stack
 
-	err = config.InitConfig()
+	err = c.InitConfig()
 	if err != nil {
 		return err
 	}
 
-	err = config.ProcessConfig(configAndStacksInfo)
+	err = c.ProcessConfig(configAndStacksInfo)
 	if err != nil {
 		return err
 	}
@@ -43,22 +43,22 @@ func ExecuteDescribeComponent(cmd *cobra.Command, args []string) error {
 	if g.LogVerbose {
 		fmt.Println()
 		var msg string
-		if config.ProcessedConfig.StackType == "Directory" {
+		if c.ProcessedConfig.StackType == "Directory" {
 			msg = "Found the config file for the provided stack:"
 		} else {
 			msg = "Found config files:"
 		}
 		color.Cyan(msg)
 
-		err = u.PrintAsYAML(config.ProcessedConfig.StackConfigFilesRelativePaths)
+		err = u.PrintAsYAML(c.ProcessedConfig.StackConfigFilesRelativePaths)
 		if err != nil {
 			return err
 		}
 	}
 
 	_, stacksMap, err := s.ProcessYAMLConfigFiles(
-		config.ProcessedConfig.StacksBaseAbsolutePath,
-		config.ProcessedConfig.StackConfigFilesAbsolutePaths,
+		c.ProcessedConfig.StacksBaseAbsolutePath,
+		c.ProcessedConfig.StackConfigFilesAbsolutePaths,
 		true,
 		true)
 
@@ -70,7 +70,7 @@ func ExecuteDescribeComponent(cmd *cobra.Command, args []string) error {
 	var componentVarsSection map[interface{}]interface{}
 
 	// Check and process stacks
-	if config.ProcessedConfig.StackType == "Directory" {
+	if c.ProcessedConfig.StackType == "Directory" {
 		componentSection,
 			componentVarsSection,
 			_, _, _, _,
@@ -89,12 +89,12 @@ func ExecuteDescribeComponent(cmd *cobra.Command, args []string) error {
 			color.Cyan("Searching for stack config where the component '%s' is defined\n", component)
 		}
 
-		if len(config.Config.Stacks.NamePattern) < 1 {
+		if len(c.Config.Stacks.NamePattern) < 1 {
 			return errors.New("stack name pattern must be provided in 'stacks.name_pattern' config or 'ATMOS_STACKS_NAME_PATTERN' ENV variable")
 		}
 
 		stackParts := strings.Split(stack, "-")
-		stackNamePatternParts := strings.Split(config.Config.Stacks.NamePattern, "-")
+		stackNamePatternParts := strings.Split(c.Config.Stacks.NamePattern, "-")
 
 		var tenant string
 		var environment string
@@ -168,7 +168,7 @@ func ExecuteDescribeComponent(cmd *cobra.Command, args []string) error {
 				"Are the component and stack names correct? Did you forget an import?",
 				component,
 				stack,
-				config.Config.Stacks.NamePattern,
+				c.Config.Stacks.NamePattern,
 			))
 		}
 	}
@@ -184,3 +184,31 @@ func ExecuteDescribeComponent(cmd *cobra.Command, args []string) error {
 
 	return nil
 }
+
+// ExecuteDescribeConfig executes `describe config` command
+func ExecuteDescribeConfig(cmd *cobra.Command, args []string) error {
+	flags := cmd.Flags()
+
+	format, err := flags.GetString("format")
+	if err != nil {
+		return err
+	}
+
+	err = c.InitConfig()
+	if err != nil {
+		return err
+	}
+
+	if format == "json" {
+		err = u.PrintAsJSON(c.Config)
+	} else if format == "yaml" {
+		err = u.PrintAsYAML(c.Config)
+	} else {
+		err = errors.New("invalid flag '--format'. Accepted values are 'json' or 'yaml'")
+	}
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
diff --git a/internal/exec/terraform.go b/internal/exec/terraform.go
@@ -125,6 +125,7 @@ func ExecuteTerraform(cmd *cobra.Command, args []string) error {
 	runTerraformInit := true
 	if info.SubCommand == "init" ||
 		info.SubCommand == "workspace" ||
+		info.SubCommand == "clean" ||
 		(info.SubCommand == "deploy" && c.Config.Components.Terraform.DeployRunInit == false) {
 		runTerraformInit = false
 	}
@@ -138,13 +139,13 @@ func ExecuteTerraform(cmd *cobra.Command, args []string) error {
 	// Handle `terraform deploy` custom command
 	if info.SubCommand == "deploy" {
 		info.SubCommand = "apply"
-		if !utils.SliceContainsString(info.AdditionalArgsAndFlags, autoApproveFlag) {
+		if info.UseTerraformPlan == false && !utils.SliceContainsString(info.AdditionalArgsAndFlags, autoApproveFlag) {
 			info.AdditionalArgsAndFlags = append(info.AdditionalArgsAndFlags, autoApproveFlag)
 		}
 	}
 
 	// Handle Config.Components.Terraform.ApplyAutoApprove flag
-	if info.SubCommand == "apply" && c.Config.Components.Terraform.ApplyAutoApprove == true {
+	if info.SubCommand == "apply" && c.Config.Components.Terraform.ApplyAutoApprove == true && info.UseTerraformPlan == false {
 		if !utils.SliceContainsString(info.AdditionalArgsAndFlags, autoApproveFlag) {
 			info.AdditionalArgsAndFlags = append(info.AdditionalArgsAndFlags, autoApproveFlag)
 		}
@@ -189,19 +190,27 @@ func ExecuteTerraform(cmd *cobra.Command, args []string) error {
 		allArgsAndFlags = append(allArgsAndFlags, []string{"-var-file", varFile}...)
 		break
 	case "apply":
-		allArgsAndFlags = append(allArgsAndFlags, []string{"-var-file", varFile}...)
+		if info.UseTerraformPlan == true {
+			allArgsAndFlags = append(allArgsAndFlags, []string{planFile}...)
+		} else {
+			allArgsAndFlags = append(allArgsAndFlags, []string{"-var-file", varFile}...)
+		}
 		break
 	}
 
 	allArgsAndFlags = append(allArgsAndFlags, info.AdditionalArgsAndFlags...)
 
 	// Run `terraform workspace`
-	err = execCommand(info.Command, []string{"workspace", "select", workspaceName}, componentPath, nil)
-	if err != nil {
-		err = execCommand(info.Command, []string{"workspace", "new", workspaceName}, componentPath, nil)
+	if info.SubCommand != "clean" {
+		err = execCommand(info.Command, []string{"workspace", "select", workspaceName}, componentPath, nil)
 		if err != nil {
-			return err
+			err = execCommand(info.Command, []string{"workspace", "new", workspaceName}, componentPath, nil)
+			if err != nil {
+				return err
+			}
 		}
+	} else {
+		return errors.New("terraform clean not implemented")
 	}
 
 	// Check if the terraform command requires a user interaction,

diff --git a/internal/exec/utils.go b/internal/exec/utils.go
@@ -27,6 +27,7 @@ var (
 		g.GlobalOptionsFlag,
 		g.DeployRunInitFlag,
 		g.AutoGenerateBackendFileFlag,
+		g.FromPlanFlag,
 	}
 )
 
@@ -125,6 +126,7 @@ func processConfigAndStacks(componentType string, cmd *cobra.Command, args []str
 	configAndStacksInfo.ConfigDir = argsAndFlagsInfo.ConfigDir
 	configAndStacksInfo.DeployRunInit = argsAndFlagsInfo.DeployRunInit
 	configAndStacksInfo.AutoGenerateBackendFile = argsAndFlagsInfo.AutoGenerateBackendFile
+	configAndStacksInfo.UseTerraformPlan = argsAndFlagsInfo.UseTerraformPlan
 
 	// Check if component was provided
 	if len(configAndStacksInfo.ComponentFromArg) < 1 {
@@ -454,6 +456,10 @@ func processArgsAndFlags(inputArgsAndFlags []string) (config.ArgsAndFlagsInfo, e
 			info.AutoGenerateBackendFile = autoGenerateBackendFileFlagParts[1]
 		}
 
+		if arg == g.FromPlanFlag {
+			info.UseTerraformPlan = true
+		}
+
 		for _, f := range commonFlags {
 			if arg == f {
 				indexesToRemove = append(indexesToRemove, i)

diff --git a/main.go b/main.go
@@ -1,9 +1,10 @@
 package main
 
 import (
+	"os"
+
 	"github.com/cloudposse/atmos/cmd"
 	"github.com/fatih/color"
-	"os"
 )
 
 func main() {

diff --git a/pkg/config/schema.go b/pkg/config/schema.go
@@ -67,6 +67,7 @@ type ArgsAndFlagsInfo struct {
 	StacksDir               string
 	DeployRunInit           string
 	AutoGenerateBackendFile string
+	UseTerraformPlan        bool
 }
 
 type ConfigAndStacksInfo struct {
@@ -92,4 +93,5 @@ type ConfigAndStacksInfo struct {
 	ContextPrefix           string
 	DeployRunInit           string
 	AutoGenerateBackendFile string
+	UseTerraformPlan        bool
 }
diff --git a/pkg/config/utils.go b/pkg/config/utils.go
@@ -2,7 +2,7 @@ package config
 
 import (
 	"errors"
-	"github.com/bmatcuk/doublestar"
+	"github.com/bmatcuk/doublestar/v4"
 	g "github.com/cloudposse/atmos/pkg/globals"
 	s "github.com/cloudposse/atmos/pkg/stack"
 	u "github.com/cloudposse/atmos/pkg/utils"

diff --git a/pkg/globals/globals.go b/pkg/globals/globals.go
@@ -16,6 +16,8 @@ const (
 	StackDirFlag                = "--stacks-dir"
 	DeployRunInitFlag           = "--deploy-run-init"
 	AutoGenerateBackendFileFlag = "--auto-generate-backend-file"
+
+	FromPlanFlag = "--from-plan"
 )
 
 var (

diff --git a/pkg/stack/stack_processor.go b/pkg/stack/stack_processor.go
@@ -155,10 +155,18 @@ func ProcessYAMLConfigFile(
 			}
 
 			if importMatches == nil {
-				errorMessage := fmt.Sprintf("Invalid import in the config file %s.\nNo matches found for the import '%s'",
+				errorMessage := fmt.Sprintf("Invalid import in the config file %s.\nNo matches found for the import '%s' using the pattern '%s'",
 					filePath,
-					strings.Replace(impWithExt, basePath+"/", "", 1))
-				return nil, nil, errors.New(errorMessage)
+					imp,
+					impWithExtPath)
+
+				importMatches, err = GetGlobMatches(impWithExtPath)
+				if err != nil {
+					return nil, nil, err
+				}
+				if importMatches == nil {
+					return nil, nil, errors.New(errorMessage)
+				}
 			}
 
 			for _, importFile := range importMatches {

diff --git a/pkg/stack/stack_processor_utils.go b/pkg/stack/stack_processor_utils.go
@@ -2,16 +2,18 @@ package stack
 
 import (
 	"fmt"
-	"github.com/bmatcuk/doublestar"
-	g "github.com/cloudposse/atmos/pkg/globals"
-	"github.com/cloudposse/atmos/pkg/utils"
 	"io/ioutil"
 	"os"
 	"path"
 	"path/filepath"
 	"sort"
 	"strings"
 	"sync"
+
+	"github.com/bmatcuk/doublestar/v4"
+	g "github.com/cloudposse/atmos/pkg/globals"
+	"github.com/cloudposse/atmos/pkg/utils"
+	"github.com/fatih/color"
 )
 
 var (
@@ -231,11 +233,25 @@ func GetGlobMatches(pattern string) ([]string, error) {
 		return strings.Split(fmt.Sprintf("%s", existingMatches), ","), nil
 	}
 
-	matches, err := doublestar.Glob(pattern)
+	base, cleanPattern := doublestar.SplitPattern(pattern)
+	f := os.DirFS(base)
+
+	matches, err := doublestar.Glob(f, cleanPattern)
 	if err != nil {
 		return nil, err
 	}
-	getGlobMatchesSyncMap.Store(pattern, strings.Join(matches, ","))
 
-	return matches, nil
+	if matches == nil {
+		color.Red(fmt.Sprintf("Import of %s (-> %s + %s) failed to find a match.", pattern, base, cleanPattern))
+		return nil, nil
+	}
+
+	var fullMatches []string
+	for _, match := range matches {
+		fullMatches = append(fullMatches, path.Join(base, match))
+	}
+
+	getGlobMatchesSyncMap.Store(pattern, strings.Join(fullMatches, ","))
+
+	return fullMatches, nil
 }