Implement Dry Run Feature (#257)

* (feat) implement dry run feature

* test with no args provided

main.go

@@ -89,6 +89,7 @@ func tagCommand() *cli.Command {
 	externalConfPath := "config-file"
 	skipResourceTypesArg := "skip-resource-types"
 	parsersArgs := "parsers"
+	dryRunArgs := "dry-run"
 	return &cli.Command{
 		Name:                   "tag",
 		Usage:                  "apply tagging across your directory",
@@ -107,6 +108,7 @@ func tagCommand() *cli.Command {
 				ConfigFile:        c.String(externalConfPath),
 				SkipResourceTypes: c.StringSlice(skipResourceTypesArg),
 				Parsers:           c.StringSlice(parsersArgs),
+				DryRun:            c.Bool(dryRunArgs),
 			}
 
 			options.Validate()
@@ -185,6 +187,12 @@ func tagCommand() *cli.Command {
 				Value:       cli.NewStringSlice("Terraform", "CloudFormation", "Serverless"),
 				DefaultText: "Terraform,CloudFormation,Serverless",
 			},
+			&cli.BoolFlag{
+				Name:        dryRunArgs,
+				Usage:       "skip resource tagging",
+				Value:       false,
+				DefaultText: "false",
+			},
 		},
 	}
 }

src/common/clioptions/cli.go

@@ -26,6 +26,7 @@ type TagOptions struct {
 	ConfigFile        string   `validate:"config-file"`
 	SkipResourceTypes []string
 	Parsers           []string
+	DryRun            bool
 }
 
 type ListTagsOptions struct {

src/common/clioptions/cli_test.go

@@ -19,6 +19,7 @@ func TestCliArgParsing(t *testing.T) {
 			Output:         "cli",
 			OutputJSONFile: "",
 			ConfigFile:     "",
+			DryRun:         true,
 		}
 		// Expect the validation to pass without throwing errors
 		options.Validate()
@@ -89,6 +90,7 @@ func TestOutputCrasher(t *testing.T) {
 			Output:         "junitxml",
 			OutputJSONFile: "",
 			TagGroups:      []string{"git", "custom"},
+			DryRun:         true,
 		}
 		options.Validate()
 	}
@@ -105,6 +107,7 @@ func TestTagGroupCrasher(t *testing.T) {
 			Output:         "cli",
 			OutputJSONFile: "",
 			TagGroups:      []string{"git", "custom"},
+			DryRun:         true,
 		}
 		options.Validate()
 	}

src/common/runner/runner.go

@@ -36,6 +36,7 @@ type Runner struct {
 	configFilePath       string
 	skippedResourceTypes []string
 	workersNum           int
+	dryRun               bool
 }
 
 const WorkersNumEnvKey = "YOR_WORKER_NUM"
@@ -90,6 +91,7 @@ func (r *Runner) Init(commands *clioptions.TagOptions) error {
 	r.skippedTags = commands.SkipTags
 	r.skipDirs = append(commands.SkipDirs, ".git")
 	r.configFilePath = commands.ConfigFile
+	r.dryRun = commands.DryRun
 	if utils.InSlice(r.skipDirs, r.dir) {
 		logger.Warning(fmt.Sprintf("Selected dir, %s, is skipped - expect an empty result", r.dir))
 	}
@@ -186,7 +188,7 @@ func (r *Runner) TagFile(file string) {
 			}
 			r.ChangeAccumulator.AccumulateChanges(block)
 		}
-		if isFileTaggable {
+		if isFileTaggable && !r.dryRun {
 			err = parser.WriteFile(file, blocks, file)
 			if err != nil {
 				logger.Warning(fmt.Sprintf("Failed writing tags to file %s, because %v", file, err))