Merge pull request #162 from equinix/silent-usage

silence usage messages when usage was valid and API errors are returned

internal/capacity/check.go

@@ -53,6 +53,12 @@ func (c *Client) Check() *cobra.Command {
 			if facility != "" {
 				facilities = append(facilities, facility)
 			}
+
+			if (len(facilities) > 0) == (len(metros) > 0) {
+				return errors.New("Either facilities or metros should be set")
+			}
+			cmd.SilenceUsage = true
+
 			if plan != "" {
 				plans = append(plans, plan)
 			}
@@ -87,8 +93,6 @@ func (c *Client) Check() *cobra.Command {
 						)
 					}
 				}
-			} else {
-				return errors.New("Either facility or metro should be set")
 			}
 
 			availability, _, err := checker(req)

internal/capacity/retrieve.go

@@ -40,6 +40,7 @@ Retrieve capacities:
 metal capacity get { --metro | --facility }
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			var err error
 			lister := c.Service.List
 			fieldName := "Facility"

internal/completion/completion.go

@@ -68,6 +68,7 @@ func NewCommand() *cobra.Command {
 		ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
 		Args:                  cobra.ExactValidArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			switch args[0] {
 			case "bash":
 				return cmd.Root().GenBashCompletion(os.Stdout)
@@ -82,6 +83,7 @@ func NewCommand() *cobra.Command {
 			return fmt.Errorf("unknown shell: %q", args[0])
 		},
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			return nil
 		},
 	}

internal/devices/create.go

@@ -69,6 +69,7 @@ metal device create --hostname [hostname] --plan [plan] --metro [metro_code] --f
 			if userdata != "" && userdataFile != "" {
 				return fmt.Errorf("Either userdata or userdata-file should be set")
 			}
+			cmd.SilenceUsage = true
 
 			if userdataFile != "" {
 				userdataRaw, readErr := ioutil.ReadFile(userdataFile)

internal/devices/delete.go

@@ -48,6 +48,7 @@ func (c *Client) Delete() *cobra.Command {
   
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			if !force {
 				prompt := promptui.Prompt{
 					Label:     fmt.Sprintf("Are you sure you want to delete device %s: ", deviceID),

internal/devices/reboot.go

@@ -39,6 +39,7 @@ metal device reboot --id [device_UUID]
 
 	  `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			_, err := c.Service.Reboot(deviceID)
 			if err != nil {
 				return errors.Wrap(err, "Could not reboot Device")

internal/devices/retrieve.go

@@ -44,7 +44,10 @@ metal device get --id [device_UUID]
 
 			if deviceID == "" && projectID == "" {
 				return fmt.Errorf("Either id or project-id should be set.")
-			} else if deviceID != "" {
+			}
+			cmd.SilenceUsage = true
+
+			if deviceID != "" {
 				device, _, err := c.Service.Get(deviceID, nil)
 				if err != nil {
 					return errors.Wrap(err, "Could not get Devices")
@@ -55,21 +58,20 @@ metal device get --id [device_UUID]
 				data[0] = []string{device.ID, device.Hostname, device.OS.Name, device.State, device.Created}
 
 				return c.Out.Output(device, header, &data)
-			} else if projectID != "" {
-				devices, _, err := c.Service.List(projectID, c.Servicer.ListOptions(nil, nil))
-				if err != nil {
-					return errors.Wrap(err, "Could not list Devices")
-				}
-				data := make([][]string, len(devices))
+			}
 
-				for i, dc := range devices {
-					data[i] = []string{dc.ID, dc.Hostname, dc.OS.Name, dc.State, dc.Created}
-				}
-				header := []string{"ID", "Hostname", "OS", "State", "Created"}
+			devices, _, err := c.Service.List(projectID, c.Servicer.ListOptions(nil, nil))
+			if err != nil {
+				return errors.Wrap(err, "Could not list Devices")
+			}
+			data := make([][]string, len(devices))
 
-				return c.Out.Output(devices, header, &data)
+			for i, dc := range devices {
+				data[i] = []string{dc.ID, dc.Hostname, dc.OS.Name, dc.State, dc.Created}
 			}
-			return nil
+			header := []string{"ID", "Hostname", "OS", "State", "Created"}
+
+			return c.Out.Output(devices, header, &data)
 		},
 	}
 

internal/devices/start.go

@@ -39,6 +39,7 @@ metal device start --id [device_UUID]
 
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			_, err := c.Service.PowerOn(deviceID)
 
 			if err != nil {

internal/devices/stop.go

@@ -38,6 +38,7 @@ func (c *Client) Stop() *cobra.Command {
   
   `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			_, err := c.Service.PowerOff(deviceID)
 
 			if err != nil {

internal/devices/update.go

@@ -51,6 +51,7 @@ metal device update --id [device_UUID] --hostname [new_hostname]
 
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			req := &packngo.DeviceUpdateRequest{}
 
 			if hostname != "" {

internal/docs/docs.go

@@ -34,9 +34,11 @@ func NewCommand() *cobra.Command {
 		DisableFlagsInUseLine: true,
 		Args:                  cobra.ExactValidArgs(1),
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			return nil
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			dest := args[0]
 			return doc.GenMarkdownTree(cmd.Parent(), dest)
 		},

internal/events/retrieve.go

@@ -58,6 +58,7 @@ metal event get
 When using "--json" or "--yaml", "--include=relationships" is implied.
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			var events []packngo.Event
 			var err error
 			header := []string{"ID", "Body", "Type", "Created"}

internal/facilities/retrieve.go

@@ -38,6 +38,7 @@ metal facilities get
 	
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			facilities, _, err := c.Service.List(c.Servicer.ListOptions(nil, nil))
 			if err != nil {
 				return errors.Wrap(err, "Could not list Facilities")

internal/hardware/move.go

@@ -36,6 +36,7 @@ func (c *Client) Move() *cobra.Command {
 metal hardware_reservation move -i [hardware_reservation_UUID] -p [project_UUID]
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			header := []string{"ID", "Facility", "Plan", "Created"}
 			r, _, err := c.Service.Move(hardwareReservationID, projectID)
 			if err != nil {

internal/hardware/retrieve.go

@@ -60,7 +60,10 @@ When using "--json" or "--yaml", "--include=project,facility,device" is implied.
 
 			if hardwareReservationID == "" && projectID == "" {
 				return fmt.Errorf("Either id or project-id should be set.")
-			} else if hardwareReservationID != "" {
+			}
+
+			cmd.SilenceUsage = true
+			if hardwareReservationID != "" {
 				getOpts := &packngo.GetOptions{Includes: listOpt.Includes, Excludes: listOpt.Excludes}
 				r, _, err := c.Service.Get(hardwareReservationID, getOpts)
 				if err != nil {
@@ -72,21 +75,20 @@ When using "--json" or "--yaml", "--include=project,facility,device" is implied.
 				data[0] = []string{r.ID, r.Facility.Code, r.Plan.Name, r.CreatedAt.String()}
 
 				return c.Out.Output(r, header, &data)
-			} else if projectID != "" {
-				reservations, _, err := c.Service.List(projectID, listOpt)
-				if err != nil {
-					return errors.Wrap(err, "Could not list Hardware Reservations")
-				}
+			}
 
-				data := make([][]string, len(reservations))
+			reservations, _, err := c.Service.List(projectID, listOpt)
+			if err != nil {
+				return errors.Wrap(err, "Could not list Hardware Reservations")
+			}
 
-				for i, r := range reservations {
-					data[i] = []string{r.ID, r.Facility.Code, r.Plan.Name, r.CreatedAt.String()}
-				}
+			data := make([][]string, len(reservations))
 
-				return c.Out.Output(reservations, header, &data)
+			for i, r := range reservations {
+				data[i] = []string{r.ID, r.Facility.Code, r.Plan.Name, r.CreatedAt.String()}
 			}
-			return nil
+
+			return c.Out.Output(reservations, header, &data)
 		},
 	}
 

internal/init/init.go

@@ -77,6 +77,7 @@ func (c *Client) NewCommand() *cobra.Command {
 	`,
 		DisableFlagsInUseLine: true,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			cmd.SilenceUsage = true
 			config, _ := cmd.Flags().GetString("config")
 			if config == "" {

internal/ips/assign.go

@@ -44,6 +44,7 @@ metal ip assign -d [device-id] -a [ip-address]
 
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			assignment, _, err := c.DeviceService.Assign(deviceID, &packngo.AddressStruct{Address: address})
 			if err != nil {
 				return errors.Wrap(err, "Could not assign Device IP address")

internal/ips/available.go

@@ -42,6 +42,7 @@ metal ip available --reservation-id [reservation_id] --cidr [size_of_subnet]
 
   `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			result, _, err := c.ProjectService.AvailableAddresses(reservationID, &packngo.AvailableRequest{CIDR: cidr})
 
 			if err != nil {

internal/ips/remove.go

@@ -39,6 +39,7 @@ metal ip remove --id [reservation-UUID]
 
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			_, err := c.ProjectService.Remove(reservationID)
 			if err != nil {
 				return errors.Wrap(err, "Could not remove IP address Reservation")

internal/ips/request.go

@@ -49,6 +49,7 @@ metal ip request --quantity [quantity] --facility [facility_code] --type [addres
 
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			req := &packngo.IPReservationRequest{
 				Type:     ttype,
 				Quantity: quantity,

internal/ips/retrieve.go

@@ -58,7 +58,14 @@ metal ip get --reservation-id [reservation_UUID]
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if assignmentID != "" && reservationID != "" {
 				return fmt.Errorf("Either assignment-id or reservation-id can be set.")
-			} else if assignmentID != "" {
+			}
+
+			if assignmentID == "" && reservationID == "" && projectID == "" {
+				return fmt.Errorf("Either project-id or assignment-id or reservation-id must be set.")
+			}
+
+			cmd.SilenceUsage = true
+			if assignmentID != "" {
 				ip, _, err := c.ProjectService.Get(assignmentID, nil)
 				if err != nil {
 					return errors.Wrap(err, "Could not get Device IP address")
@@ -82,27 +89,25 @@ metal ip get --reservation-id [reservation_UUID]
 				header := []string{"ID", "Address", "Facility", "Public", "Created"}
 
 				return c.Out.Output(ip, header, &data)
-			} else if projectID != "" {
-				ips, _, err := c.ProjectService.List(projectID, nil)
-				if err != nil {
-					return errors.Wrap(err, "Could not list Project IP addresses")
-				}
+			}
 
-				data := make([][]string, len(ips))
+			ips, _, err := c.ProjectService.List(projectID, nil)
+			if err != nil {
+				return errors.Wrap(err, "Could not list Project IP addresses")
+			}
 
-				for i, ip := range ips {
-					code := ""
-					if ip.Facility != nil {
-						code = ip.Facility.Code
-					}
-					data[i] = []string{ip.ID, ip.Address, code, strconv.FormatBool(ip.Public), ip.Created}
-				}
-				header := []string{"ID", "Address", "Facility", "Public", "Created"}
+			data := make([][]string, len(ips))
 
-				return c.Out.Output(ips, header, &data)
+			for i, ip := range ips {
+				code := ""
+				if ip.Facility != nil {
+					code = ip.Facility.Code
+				}
+				data[i] = []string{ip.ID, ip.Address, code, strconv.FormatBool(ip.Public), ip.Created}
 			}
+			header := []string{"ID", "Address", "Facility", "Public", "Created"}
 
-			return fmt.Errorf("Either project-id or assignment-id or reservation-id must be set.")
+			return c.Out.Output(ips, header, &data)
 		},
 	}
 

internal/ips/unassign.go

@@ -39,6 +39,7 @@ metal ip unassign --id [assignment-UUID]
 
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			_, err := c.DeviceService.Unassign(assignmentID)
 			if err != nil {
 				return errors.Wrap(err, "Could not unassign IP address")

internal/metros/retrieve.go

@@ -37,6 +37,7 @@ metal metros get
 	
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			metros, _, err := c.Service.List(c.Servicer.ListOptions(nil, nil))
 			if err != nil {
 				return errors.Wrap(err, "Could not list Metros")

internal/organizations/create.go

@@ -45,6 +45,7 @@ metal organization create -n [name]
 
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			req := &packngo.OrganizationCreateRequest{
 				Name: name,
 			}

internal/organizations/delete.go

@@ -53,6 +53,7 @@ metal organization delete -i [organization_UUID]
 
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			if !force {
 				prompt := promptui.Prompt{
 					Label:     fmt.Sprintf("Are you sure you want to delete organization %s: ", organizationID),

internal/organizations/payment.go

@@ -38,6 +38,7 @@ metal organization payment-methods --id [organization_UUID]
 
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			paymentMethods, _, err := c.Service.ListPaymentMethods(organizationID)
 			if err != nil {
 				return errors.Wrap(err, "Could not list Payment Methods")

internal/organizations/retrieve.go

@@ -43,6 +43,7 @@ metal organization get -i [organization-id]
 
 	`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			listOpts := c.Servicer.ListOptions(nil, nil)
 			if organizationID == "" {
 				orgs, _, err := c.Service.List(listOpts)

internal/organizations/update.go

@@ -38,6 +38,7 @@ metal organization update --id [organization_UUID] --name [new_name]
 
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			req := &packngo.OrganizationUpdateRequest{}
 
 			if name != "" {

internal/os/retrieve.go

@@ -33,6 +33,7 @@ func (c *Client) Retrieve() *cobra.Command {
 		Long: `Example:
   metal operating-systems get`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			oss, _, err := c.Service.List()
 			if err != nil {
 				return errors.Wrap(err, "Could not list OperatingSystems")

internal/plans/retrieve.go

@@ -36,6 +36,7 @@ func (c *Client) Retrieve() *cobra.Command {
   
   `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			plans, _, err := c.Service.List(c.Servicer.ListOptions(nil, nil))
 			if err != nil {
 				return errors.Wrap(err, "Could not list Plans")

internal/projects/create.go

@@ -43,6 +43,7 @@ metal project create --name [project_name]
   
   `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
 			req := packngo.ProjectCreateRequest{
 				Name: name,
 			}