Merge pull request #5 from FireDrunk/feature/json-support

JSON (Metrics) Support
containerscrew · Mar 28, 2024 · ab409ee · ab409ee
2 parents 6e45a40 + f87bf92
commit ab409ee
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 12 deletions.
diff --git a/cmd/commands.go b/cmd/commands.go
@@ -21,13 +21,17 @@ var (
 	showUnchanged bool
 	compact       bool
 	useMarkdown   bool
+	useJson       bool
+	metrics       bool
 )
 
 func init() {
 	summarizeCmd.Flags().BoolVarP(&showTags, "show-tags", "t", false, "Show resources with tag changes")
 	summarizeCmd.Flags().BoolVarP(&showUnchanged, "show-unchanged", "u", false, "Show resources with no changes")
 	summarizeCmd.Flags().BoolVarP(&compact, "compact", "c", false, "Use compact formatting")
 	summarizeCmd.Flags().BoolVarP(&useMarkdown, "markdown", "m", false, "Use markdown formatting")
+	summarizeCmd.Flags().BoolVarP(&useJson, "json", "j", false, "Use JSON output")
+	summarizeCmd.Flags().BoolVarP(&metrics, "metrics", "s", false, "Output metrics")
 }
 
 // summarizeCmd will parse the tf plan output json to scrape created|updated|deleted resources in a clear outout
@@ -36,12 +40,22 @@ var summarizeCmd = &cobra.Command{
 	Short: "Get a summary of terraform/terragrunt output",
 	Long:  "Get a summary of terraform/terragrunt output plan (created|updated|destroyed...)",
 	Run: func(cmd *cobra.Command, args []string) {
+		if useMarkdown && useJson {
+			fmt.Println("-m (Markdown output) and -j (JSON output) are mutually exclusive")
+			os.Exit(1)
+		}
+
+		if metrics && !useJson {
+			fmt.Println("Metric output can only be used with JSON output")
+			os.Exit(1)
+		}
+
 		output, err := reader.Reader(os.Stdin)
 		if err != nil {
 			panic(err)
 		}
 
-		parser.Parser(output, showTags, showUnchanged, compact, useMarkdown)
+		parser.Parser(output, showTags, showUnchanged, compact, useMarkdown, useJson, metrics)
 	},
 }
 

diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/containerscrew/tftools
 
-go 1.21.5
+go 1.21
 
 require (
 	github.com/charmbracelet/glamour v0.6.0

diff --git a/internal/parser/parser.go b/internal/parser/parser.go
@@ -20,7 +20,7 @@ var (
 	resourcesList = make(map[string][]string)
 )
 
-func Parser(output []byte, showTags, showUnchanged, compact, useMarkdown bool) {
+func Parser(output []byte, showTags, showUnchanged, compact, useMarkdown bool, useJson bool, metrics bool) {
 	var data tfjson.Plan
 	if err := json.Unmarshal(output, &data); err != nil {
 		fmt.Printf("Error unmarshalling plan: %v\n", err)
@@ -31,7 +31,7 @@ func Parser(output []byte, showTags, showUnchanged, compact, useMarkdown bool) {
 		processResourceChange(resourceChange, showTags)
 	}
 
-	PrintPlanSummary(showTags, showUnchanged, compact, useMarkdown)
+	PrintPlanSummary(showTags, showUnchanged, compact, useMarkdown, useJson, metrics)
 }
 
 func processResourceChange(resourceChange *tfjson.ResourceChange, showTags bool) {
@@ -140,16 +140,66 @@ func PrintResources(message string, resources []string, bulletSymbol string, col
 	}
 }
 
-func PrintPlanSummary(showTags, showUnchanged, compact, useMarkdown bool) {
-	if showUnchanged {
-		PrintResources("🔵 Unchanged:", resourcesList[NOOP], "•", color.New(color.FgBlue), compact, useMarkdown)
+func PrintPlanSummary(showTags, showUnchanged, compact, useMarkdown bool, useJson bool, metrics bool) {
+	if !useJson {
+		if showUnchanged {
+			PrintResources("🔵 Unchanged:", resourcesList[NOOP], "•", color.New(color.FgBlue), compact, useMarkdown)
+		}
+		if showTags {
+			PrintResources("🟣 Tag/Untag:", resourcesList[TAG], "#", color.New(color.FgMagenta), compact, useMarkdown)
+		}
+		PrintResources("🟢 Create:", resourcesList[CREATE], "+", color.New(color.FgGreen), compact, useMarkdown)
+		PrintResources("🟡 Update:", resourcesList[UPDATE], "~", color.New(color.FgYellow), compact, useMarkdown)
+		PrintResources("🔴 Destroy:", resourcesList[DELETE], "-", color.New(color.FgRed), compact, useMarkdown)
+	} else {
+		PrintResourcesJson(showTags, showUnchanged, metrics)
 	}
-	if showTags {
-		PrintResources("🟣 Tag/Untag:", resourcesList[TAG], "#", color.New(color.FgMagenta), compact, useMarkdown)
+}
+
+func PrintResourcesJson(showTags bool, showUnchanged bool, metrics bool) {
+	if metrics {
+		var metricsData = make(map[string]int)
+
+		if showUnchanged {
+			metricsData["unchanged"] = len(resourcesList[NOOP])
+		}
+
+		if showTags {
+			metricsData["tag"] = len(resourcesList[TAG])
+		}
+
+		metricsData["create"] = len(resourcesList[CREATE])
+		metricsData["update"] = len(resourcesList[UPDATE])
+		metricsData["delete"] = len(resourcesList[DELETE])
+
+		result, _ := json.Marshal(metricsData)
+		fmt.Println(string(result))
+	} else {
+		var data = make(map[string][]string)
+
+		if showUnchanged && len(resourcesList[NOOP]) > 0 {
+			data["unchanged"] = resourcesList[NOOP]
+		}
+
+		if showTags && len(resourcesList[TAG]) > 0 {
+			data["tag"] = resourcesList[TAG]
+		}
+
+		if len(resourcesList[CREATE]) > 0 {
+			data["create"] = resourcesList[CREATE]
+		}
+
+		if len(resourcesList[UPDATE]) > 0 {
+			data["update"] = resourcesList[UPDATE]
+		}
+
+		if len(resourcesList[DELETE]) > 0 {
+			data["delete"] = resourcesList[DELETE]
+		}
+
+		result, _ := json.Marshal(data)
+		fmt.Println(string(result))
 	}
-	PrintResources("🟢 Create:", resourcesList[CREATE], "+", color.New(color.FgGreen), compact, useMarkdown)
-	PrintResources("🟡 Update:", resourcesList[UPDATE], "~", color.New(color.FgYellow), compact, useMarkdown)
-	PrintResources("🔴 Destroy:", resourcesList[DELETE], "-", color.New(color.FgRed), compact, useMarkdown)
 }
 
 func checkOnlyTagChanges(resourceChange *tfjson.ResourceChange) (bool, error) {