Merge pull request #4 from ssulei7/ssulei7/support-json-output

Support JSON output type

Author: ssulei7

.github/release-drafter.yml

@@ -27,7 +27,7 @@ change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
 version-resolver:
   major:
     labels:
-      - 'type: breaking'
+      - 'type: feature'
   minor:
     labels:
       - 'type: enhancement'

cmd/report.go

@@ -28,8 +28,12 @@ var reportCmd = &cobra.Command{
 			log.Fatalf("Error getting number of workflow runs to evaluate: %v", err)
 		}
 
-		// Create the report CSV file
-		report.CreateInitialReportCSVFile(orgName)
+		outputType, err := cmd.Flags().GetString("output-type")
+		if err != nil {
+			log.Fatalf("Error getting output type: %v", err)
+		}
+
+		report.CreateInitialOutputFile(outputType, orgName)
 
 		// Get repositories in the organization
 		repositories := repository.GetOrgRepositories(orgName)
@@ -90,8 +94,8 @@ var reportCmd = &cobra.Command{
 					}
 				}
 
-				// Write as a row in a CSV file
-				report.AddRecordToCSVFile(orgName, repo.FullName, workflow, total/float64(numberOfWorkflowRunsToEvaluate))
+				// Write a new record to the output file
+				report.AddRecord(outputType, orgName, repo.FullName, workflow, total/float64(numberOfWorkflowRunsToEvaluate))
 			}
 		}
 	},

cmd/root.go

@@ -15,6 +15,7 @@ func init() {
 	reportCmd.Flags().String("org-name", "", "The name of the GitHub organization")
 	reportCmd.Flags().StringSlice("runner-labels", []string{}, "The labels that you use for your jobs (can be both user defined and GitHub defined) separated by commas")
 	reportCmd.Flags().Int("num-workflow-runs-to-evaluate", 1, "The number of workflow runs to evaluate for a workflow")
+	reportCmd.Flags().String("output-type", "csv", "The type of output to generate (csv or json)")
 	err := reportCmd.MarkFlagRequired("org-name")
 	if err != nil {
 		log.Fatal(err)

internal/report/report.go

@@ -2,10 +2,22 @@ package report
 
 import (
 	"encoding/csv"
+	"encoding/json"
+	"fmt"
 	"os"
 	"strconv"
 )
 
+type JSONRecordArray []map[string]string
+
+func CreateInitialOutputFile(outputType string, orgName string) {
+	if outputType == "csv" {
+		CreateInitialReportCSVFile(orgName)
+	} else if outputType == "json" {
+		CreateInitialJSONFile(orgName)
+	}
+}
+
 func CreateInitialReportCSVFile(orgName string) {
 	// Create a new csv file
 	file, err := os.Create(orgName + "-runner-minute-average-report.csv")
@@ -28,6 +40,27 @@ func CreateInitialReportCSVFile(orgName string) {
 	writer.Flush()
 }
 
+func CreateInitialJSONFile(orgName string) {
+	// Create a new json file
+	file, err := os.Create(orgName + "-runner-minute-average-report.json")
+	if err != nil {
+		panic(err)
+	}
+
+	defer file.Close()
+
+	// Write opening bracket and closing bracket to the json file
+	file.WriteString("[\n]")
+}
+
+func AddRecord(outputType string, orgName string, repoName string, workflowName string, averageSelfHostedMinutes float64) {
+	if outputType == "csv" {
+		AddRecordToCSVFile(orgName, repoName, workflowName, averageSelfHostedMinutes)
+	} else if outputType == "json" {
+		AddRecordToJSONFile(orgName, repoName, workflowName, averageSelfHostedMinutes)
+	}
+}
+
 func AddRecordToCSVFile(orgName string, repoName string, workflowName string, averageSelfHostedMinutes float64) {
 	// Open the csv file
 	file, err := os.OpenFile(orgName+"-runner-minute-average-report.csv", os.O_APPEND|os.O_WRONLY, os.ModeAppend)
@@ -49,3 +82,45 @@ func AddRecordToCSVFile(orgName string, repoName string, workflowName string, av
 	// Flush the csv writer to write any buffered data to the file
 	writer.Flush()
 }
+
+func AddRecordToJSONFile(orgName string, repoName string, workflowName string, averageSelfHostedMinutes float64) {
+	// Load JSON file as an array of struct
+	var records JSONRecordArray
+
+	// Open the json file
+	file, err := os.ReadFile(orgName + "-runner-minute-average-report.json")
+	if err != nil {
+		panic(err)
+	}
+
+	// Unmarshal the json file into the records array using json.Unmarshal
+	err = json.Unmarshal(file, &records)
+	if err != nil {
+		panic(err)
+	}
+
+	// Print the records array
+	fmt.Println(records)
+
+	// Create a new record
+	record := map[string]string{
+		"Repository":             repoName,
+		"Workflow":               workflowName,
+		"Average Runner Minutes": strconv.FormatFloat(averageSelfHostedMinutes, 'f', 2, 64),
+	}
+
+	// Append the new record to the records array
+	records = append(records, record)
+
+	// Marshal the records array into a json string
+	jsonString, err := json.MarshalIndent(records, "", "  ")
+	if err != nil {
+		panic(err)
+	}
+
+	// Write the json string to the json file
+	err = os.WriteFile(orgName+"-runner-minute-average-report.json", jsonString, 0644)
+	if err != nil {
+		panic(err)
+	}
+}