output refactoring

Author: rjtokenring

cli/ota/status.go

@@ -31,8 +31,6 @@ import (
 type statusFlags struct {
 	otaID    		string
 	deviceId 		string
-	otaIdsFilePath  string
-	wide     	    bool
 }
 
 func initOtaStatusCommand() *cobra.Command {
@@ -50,14 +48,12 @@ func initOtaStatusCommand() *cobra.Command {
 	}
 	uploadCommand.Flags().StringVarP(&flags.otaID, "ota-id", "o", "", "OTA ID")
 	uploadCommand.Flags().StringVarP(&flags.deviceId, "device-id", "d", "", "Device ID")
-	uploadCommand.Flags().StringVarP(&flags.otaIdsFilePath, "ota-ids", "i", "", "OTA IDs file path. If set, the command will read the OTA IDs from the file and get the status for each OTA ID.")
-	uploadCommand.Flags().BoolVarP(&flags.wide, "wide", "w", false, "Show more status details")
 
 	return uploadCommand
 }
 
 func runOtaStatusCommand(flags *statusFlags) error {
-	if flags.otaID == "" && flags.deviceId == "" && flags.otaIdsFilePath == "" {
+	if flags.otaID == "" && flags.deviceId == "" {
 		return fmt.Errorf("required flag(s) \"ota-id\" or \"device-id\" or \"ota-ids\" not set")
 	}
 
@@ -66,5 +62,5 @@ func runOtaStatusCommand(flags *statusFlags) error {
 		return fmt.Errorf("retrieving credentials: %w", err)
 	}
 
-	return ota.PrintOtaStatus(flags.otaID, flags.deviceId, flags.otaIdsFilePath, flags.wide, cred)
+	return ota.PrintOtaStatus(flags.otaID, flags.deviceId, cred)
 }

command/ota/status.go

@@ -10,30 +10,18 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-func formatOtaByIdOutput(wideOutput bool, st *otaapi.OtaStatusPrint) {
-	if !wideOutput {
-		st.Ota.DeviceID = ""
-		st.Ota.ErrorReason = ""
-		st.Ota.Sha256 = ""
-	}
-	printOut(st, wideOutput)
+func formatOtaByIdOutput( st *otaapi.OtaStatusPrint) {
+	printOut(st)
 }
 
-func formatOutputSlice(wideOutput bool, st []otaapi.Ota) {
+func formatOutputSlice(st []otaapi.Ota) {
 	if st == nil {
 		st = []otaapi.Ota{}
 	}
-	for i := range st {
-		if !wideOutput {
-			st[i].DeviceID = ""
-			st[i].ErrorReason = ""
-			st[i].Sha256 = ""
-		}
-	}
-	printOut(st, wideOutput)
+	printOut(st)
 }
 
-func printOut(res any, wideOutput bool) {
+func printOut(res any) {
 	outputformat := feedback.GetFormat()
 	if outputformat == feedback.JSON || outputformat == feedback.JSONMini {
 		jsonRes, _ := json.MarshalIndent(res, "", "  ")
@@ -59,37 +47,24 @@ func printOut(res any, wideOutput bool) {
 		if st, ok := res.([]otaapi.Ota); ok {
 
 			for i := range st {
-				if i == 0 {
-					if wideOutput {
-						fmt.Println(st[i].GetWideCSVHeader())
-					} else {
-						fmt.Println(st[i].GetCSVHeader())
-					}
-				}
-				if wideOutput {
-					fmt.Println(st[i].ToWideCSV())
-				} else {
-					fmt.Println(st[i].ToCSV())
-				}
+				fmt.Println(st[i].ToLine())
 			}
 		}
 	}
 }
 
-func PrintOtaStatus(otaid, device, otaidpath string, wideOutput bool, cred *config.Credentials) error {
+func PrintOtaStatus(otaid, device string, cred *config.Credentials) error {
 
 	if feedback.GetFormat() == feedback.JSONMini {
 		return fmt.Errorf("jsonmini format is not supported for this command")
 	}
 
 	otapi := otaapi.NewClient(cred)
 
-	if otaidpath != "" {
-		// TODO: implement
-	} else if otaid != "" {
+	if otaid != "" {
 		res, err := otapi.GetOtaStatusByOtaID(otaid)
 		if err == nil && res != nil {
-			formatOtaByIdOutput(wideOutput, &otaapi.OtaStatusPrint{
+			formatOtaByIdOutput(&otaapi.OtaStatusPrint{
 				Ota: res.Ota,
 				Details: res.States,
 			})
@@ -99,7 +74,7 @@ func PrintOtaStatus(otaid, device, otaidpath string, wideOutput bool, cred *conf
 	} else if device != "" {
 		res, err := otapi.GetOtaStatusByDeviceID(device)
 		if err == nil && res != nil {
-			formatOutputSlice(wideOutput, res.Ota)
+			formatOutputSlice(res.Ota)
 		} else if err != nil {
 			return err
 		}

internal/ota-api/dto.go

@@ -52,24 +52,15 @@ type (
 	}	
 )
 
-func (o Ota) GetWideCSVHeader() string {
-	return "ota_id,device_id,status,started_at,ended_at,error_reason"
-}
-
-func (o Ota) ToWideCSV() string {
-	return fmt.Sprintf("%s,%s,%s,%s,%s,%s", o.ID, o.DeviceID, o.Status, o.StartedAt, o.EndedAt, o.ErrorReason)
-}
-
-func (o Ota) GetCSVHeader() string {
-	return "ota_id,status,started_at,ended_at"
-}
-
-func (o Ota) ToCSV() string {
-	return fmt.Sprintf("%s,%s,%s,%s", o.ID, o.Status, o.StartedAt, o.EndedAt)
+func (o Ota) ToLine() string {
+	if o.ErrorReason != "" {
+		return fmt.Sprintf("ota_id: %s, started_at: %s, ended_at: %s, status: %s, error_reason: %s", o.ID, o.StartedAt, o.EndedAt, o.Status, o.ErrorReason)
+	}
+	return fmt.Sprintf("ota_id: %s, started_at: %s, ended_at: %s, status: %s", o.ID, o.StartedAt, o.EndedAt, o.Status)
 }
 
 func (o Ota) ToText() string {
-	out := fmt.Sprintf("ota_id: %s\nstatus: %s\nstarted_at: %s\nended_at: %s", o.ID, o.Status, o.StartedAt, o.EndedAt)
+	out := fmt.Sprintf("ota_id: %s\nstatus: %s\nstarted_at: %s\nended_at: %s\ndevice_id: %s", o.ID, o.Status, o.StartedAt, o.EndedAt, o.DeviceID)
 	if o.ErrorReason != "" {
 		out += fmt.Sprintf("\nerror_reason: %s", o.ErrorReason)
 	}