Support for extended/reduced output

Author: rjtokenring

cli/ota/status.go

@@ -31,6 +31,7 @@ import (
 type statusFlags struct {
 	otaID    string
 	deviceId string
+	wide     bool
 }
 
 func initOtaStatusCommand() *cobra.Command {
@@ -48,6 +49,7 @@ 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().BoolVarP(&flags.wide, "wide", "w", false, "Show more status details")
 
 	return uploadCommand
 }
@@ -62,5 +64,5 @@ func runOtaStatusCommand(flags *statusFlags) error {
 		return fmt.Errorf("retrieving credentials: %w", err)
 	}
 
-	return ota.PrintOtaStatus(flags.otaID, flags.deviceId, cred)
+	return ota.PrintOtaStatus(flags.otaID, flags.deviceId, flags.wide, cred)
 }

command/ota/status.go

@@ -8,29 +8,60 @@ import (
 	otaapi "github.com/arduino/arduino-cloud-cli/internal/ota-api"
 )
 
-func PrintOtaStatus(otaid, device string, cred *config.Credentials) error {
+func formatOutput(wideOutput bool, status any) {
+	if st, ok := status.(otaapi.Ota); ok {
+		if !wideOutput {
+			st.ID = ""
+			st.DeviceID = ""
+			st.ErrorReason = ""
+			st.Sha256 = ""
+		}
+		printJson(st)
+	}
+}
+
+func formatOutputSlice(wideOutput bool, st []otaapi.Ota) {
+	if st == nil {
+		st = []otaapi.Ota{}
+	}
+	for i := range st {
+		if !wideOutput {
+			st[i].ID = ""
+			st[i].DeviceID = ""
+			st[i].ErrorReason = ""
+			st[i].Sha256 = ""
+		}
+	}
+	printJson(st)
+}
+
+func printJson(res any) {
+	jsonRes, _ := json.MarshalIndent(res, "", "  ")
+	if jsonRes != nil {
+		fmt.Println(string(jsonRes))
+	}
+}
+
+func PrintOtaStatus(otaid, device string, wideOutput bool, cred *config.Credentials) error {
 	otapi := otaapi.NewClient(cred)
 
 	var res any
 	var err error
 	if otaid != "" {
 		res, err = otapi.GetOtaStatusByOtaID(otaid)
 		if err == nil {
-			res = res.(*otaapi.OtaStatusResponse).Ota
+			formatOutput(wideOutput, res.(*otaapi.OtaStatusResponse).Ota)
 		}
 	}
 	if device != "" {
 		res, err = otapi.GetOtaStatusByDeviceID(device)
 		if err == nil {
-			res = res.(*otaapi.OtaStatusByDeviceResponse).Ota
+			formatOutputSlice(wideOutput, res.(*otaapi.OtaStatusByDeviceResponse).Ota)
 		}
 	}
 	if err != nil {
 		return err
 	}
 
-	jsonRes, _ := json.MarshalIndent(res, "", "\t")
-	fmt.Println(string(jsonRes))
-
 	return nil
 }

internal/ota-api/client.go

@@ -98,6 +98,8 @@ func (c *OtaApiClient) GetOtaStatusByOtaID(otaid string) (*OtaStatusResponse, er
 			}
 		}
 		return &otaResponse, nil
+	} else if res.StatusCode == 404 || res.StatusCode == 400 {
+		return nil, fmt.Errorf("ota-id %s not found", otaid)
 	}
 
 	return nil, err
@@ -147,6 +149,8 @@ func (c *OtaApiClient) GetOtaStatusByDeviceID(deviceID string) (*OtaStatusByDevi
 				}
 				return t1.After(t2)
 			})
+		} else if res.StatusCode == 404 || res.StatusCode == 400 {
+			return nil, fmt.Errorf("device-id %s not found", deviceID)
 		}
 
 		return &otaResponse, nil

internal/ota-api/dto.go

@@ -28,19 +28,19 @@ type (
 	}
 
 	Ota struct {
-		ID          string `json:"id"`
-		DeviceID    string `json:"device_id"`
+		ID          string `json:"id,omitempty"`
+		DeviceID    string `json:"device_id,omitempty"`
 		Status      string `json:"status"`
 		StartedAt   string `json:"started_at"`
-		EndedAt     string `json:"ended_at"`
+		EndedAt     string `json:"ended_at,omitempty"`
 		ErrorReason string `json:"error_reason,omitempty"`
-		Sha256      string `json:"sha256"`
+		Sha256      string `json:"sha256,omitempty"`
 	}
 
 	State struct {
 		OtaID     string `json:"ota_id"`
 		State     string `json:"state"`
-		StateData string `json:"state_data"`
-		Timestamp string `json:"timestamp"`
+		StateData string `json:"state_data,omitempty"`
+		Timestamp string `json:"timestamp,omitempty"`
 	}
 )