Add ota upload command

Author: polldo

cli/ota/ota.go

@@ -0,0 +1,17 @@
+package ota
+
+import (
+	"github.com/spf13/cobra"
+)
+
+func NewCommand() *cobra.Command {
+	otaCommand := &cobra.Command{
+		Use:   "ota",
+		Short: "Over The Air.",
+		Long:  "Over The Air firmware update.",
+	}
+
+	otaCommand.AddCommand(initUploadCommand())
+
+	return otaCommand
+}

cli/ota/upload.go

@@ -0,0 +1,45 @@
+package ota
+
+import (
+	"fmt"
+
+	"github.com/arduino/iot-cloud-cli/command/ota"
+	"github.com/spf13/cobra"
+)
+
+var uploadFlags struct {
+	deviceID string
+	file     string
+}
+
+func initUploadCommand() *cobra.Command {
+	uploadCommand := &cobra.Command{
+		Use:   "upload",
+		Short: "OTA upload",
+		Long:  "OTA upload on a device of Arduino IoT Cloud",
+		RunE:  runUploadCommand,
+	}
+
+	uploadCommand.Flags().StringVarP(&uploadFlags.deviceID, "device-id", "d", "", "Device ID")
+	uploadCommand.Flags().StringVarP(&uploadFlags.file, "file", "", "", "OTA file")
+
+	uploadCommand.MarkFlagRequired("device-id")
+	uploadCommand.MarkFlagRequired("file")
+	return uploadCommand
+}
+
+func runUploadCommand(cmd *cobra.Command, args []string) error {
+	fmt.Printf("Uploading binary %s to device %s\n", uploadFlags.file, uploadFlags.deviceID)
+
+	params := &ota.UploadParams{
+		DeviceID: uploadFlags.deviceID,
+		File:     uploadFlags.file,
+	}
+	err := ota.Upload(params)
+	if err != nil {
+		return err
+	}
+
+	fmt.Println("Upload successfully started")
+	return nil
+}

cli/root.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/arduino/iot-cloud-cli/cli/config"
 	"github.com/arduino/iot-cloud-cli/cli/device"
+	"github.com/arduino/iot-cloud-cli/cli/ota"
 	"github.com/arduino/iot-cloud-cli/cli/thing"
 	"github.com/spf13/cobra"
 )
@@ -15,6 +16,7 @@ func Execute() {
 	rootCmd.AddCommand(config.NewCommand())
 	rootCmd.AddCommand(device.NewCommand())
 	rootCmd.AddCommand(thing.NewCommand())
+	rootCmd.AddCommand(ota.NewCommand())
 
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Fprintln(os.Stderr, err)

command/ota/upload.go

@@ -0,0 +1,60 @@
+package ota
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+
+	"github.com/arduino/iot-cloud-cli/internal/config"
+	"github.com/arduino/iot-cloud-cli/internal/iot"
+)
+
+// UploadParams contains the parameters needed to
+// perform an OTA upload.
+type UploadParams struct {
+	DeviceID string
+	File     string
+}
+
+// Upload command is used to upload a firmware OTA,
+// on a device of Arduino IoT Cloud.
+func Upload(params *UploadParams) error {
+	conf, err := config.Retrieve()
+	if err != nil {
+		return err
+	}
+	iotClient, err := iot.NewClient(conf.Client, conf.Secret)
+	if err != nil {
+		return err
+	}
+
+	dev, err := iotClient.DeviceShow(params.DeviceID)
+	if err != nil {
+		return err
+	}
+
+	otaDir, err := ioutil.TempDir("", "")
+	if err != nil {
+		return fmt.Errorf("%s: %w", "cannot create temporary folder", err)
+	}
+	otaFile := filepath.Join(otaDir, "temp.ota")
+	defer os.RemoveAll(otaDir)
+
+	err = Generate(params.File, otaFile, dev.Fqbn)
+	if err != nil {
+		return fmt.Errorf("%s: %w", "cannot generate .ota file", err)
+	}
+
+	file, err := os.Open(otaFile)
+	if err != nil {
+		return fmt.Errorf("%s: %w", "cannot open ota file", err)
+	}
+
+	err = iotClient.DeviceOTA(params.DeviceID, file)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

internal/iot/client.go

@@ -3,6 +3,7 @@ package iot
 import (
 	"context"
 	"fmt"
+	"os"
 
 	"github.com/antihax/optional"
 	iotclient "github.com/arduino/iot-client-go"
@@ -14,6 +15,7 @@ type Client interface {
 	DeviceDelete(id string) error
 	DeviceList() ([]iotclient.ArduinoDevicev2, error)
 	DeviceShow(id string) (*iotclient.ArduinoDevicev2, error)
+	DeviceOTA(id string, file *os.File) error
 	CertificateCreate(id, csr string) (*iotclient.ArduinoCompressedv2, error)
 	ThingCreate(thing *iotclient.Thing, force bool) (string, error)
 	ThingUpdate(id string, thing *iotclient.Thing, force bool) error
@@ -89,6 +91,20 @@ func (cl *client) DeviceShow(id string) (*iotclient.ArduinoDevicev2, error) {
 	return &dev, nil
 }
 
+// DeviceOTA performs an OTA upload request to Arduino IoT Cloud, passing
+// the ID of the device to be updated and the actual file containing the OTA firmware.
+func (cl *client) DeviceOTA(id string, file *os.File) error {
+	opt := &iotclient.DevicesV2OtaUploadOpts{
+		ExpireInMins: optional.NewInt32(5),
+	}
+	_, err := cl.api.DevicesV2OtaApi.DevicesV2OtaUpload(cl.ctx, id, file, opt)
+	if err != nil {
+		err = fmt.Errorf("listing devices: %w", errorDetail(err))
+		return err
+	}
+	return nil
+}
+
 // CertificateCreate allows to upload a certificate on Arduino IoT Cloud.
 // It returns the certificate parameters populated by the cloud.
 func (cl *client) CertificateCreate(id, csr string) (*iotclient.ArduinoCompressedv2, error) {