|
| 1 | +// This file is part of arduino-cloud-cli. |
| 2 | +// |
| 3 | +// Copyright (C) 2021 ARDUINO SA (http://www.arduino.cc/) |
| 4 | +// |
| 5 | +// This program is free software: you can redistribute it and/or modify |
| 6 | +// it under the terms of the GNU Affero General Public License as published |
| 7 | +// by the Free Software Foundation, either version 3 of the License, or |
| 8 | +// (at your option) any later version. |
| 9 | +// |
| 10 | +// This program is distributed in the hope that it will be useful, |
| 11 | +// but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | +// GNU Affero General Public License for more details. |
| 14 | +// |
| 15 | +// You should have received a copy of the GNU Affero General Public License |
| 16 | +// along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 17 | + |
| 18 | +package ota |
| 19 | + |
| 20 | +import ( |
| 21 | + "errors" |
| 22 | + "fmt" |
| 23 | + "io/ioutil" |
| 24 | + "os" |
| 25 | + "path/filepath" |
| 26 | + |
| 27 | + "github.com/arduino/arduino-cloud-cli/internal/config" |
| 28 | + "github.com/arduino/arduino-cloud-cli/internal/iot" |
| 29 | + iotclient "github.com/arduino/iot-client-go" |
| 30 | +) |
| 31 | + |
| 32 | +const ( |
| 33 | + numConcurrentUploads = 10 |
| 34 | +) |
| 35 | + |
| 36 | +// MassUploadParams contains the parameters needed to |
| 37 | +// perform a Mass OTA upload. |
| 38 | +type MassUploadParams struct { |
| 39 | + DeviceIDs []string |
| 40 | + Tags map[string]string |
| 41 | + File string |
| 42 | + Deferred bool |
| 43 | + FQBN string |
| 44 | +} |
| 45 | + |
| 46 | +// Result of an ota upload on a device |
| 47 | +type Result struct { |
| 48 | + ID string |
| 49 | + Err error |
| 50 | +} |
| 51 | + |
| 52 | +// MassUpload command is used to mass upload a firmware OTA, |
| 53 | +// on devices of Arduino IoT Cloud. |
| 54 | +func MassUpload(params *MassUploadParams) ([]Result, error) { |
| 55 | + if params.DeviceIDs == nil && params.Tags == nil { |
| 56 | + return nil, errors.New("provide either DeviceIDs or Tags") |
| 57 | + } else if params.DeviceIDs != nil && params.Tags != nil { |
| 58 | + return nil, errors.New("cannot use both DeviceIDs and Tags. only one of them should be not nil") |
| 59 | + } |
| 60 | + |
| 61 | + // Generate .ota file |
| 62 | + otaDir, err := ioutil.TempDir("", "") |
| 63 | + if err != nil { |
| 64 | + return nil, fmt.Errorf("%s: %w", "cannot create temporary folder", err) |
| 65 | + } |
| 66 | + otaFile := filepath.Join(otaDir, "temp.ota") |
| 67 | + defer os.RemoveAll(otaDir) |
| 68 | + |
| 69 | + err = Generate(params.File, otaFile, params.FQBN) |
| 70 | + if err != nil { |
| 71 | + return nil, fmt.Errorf("%s: %w", "cannot generate .ota file", err) |
| 72 | + } |
| 73 | + |
| 74 | + conf, err := config.Retrieve() |
| 75 | + if err != nil { |
| 76 | + return nil, err |
| 77 | + } |
| 78 | + iotClient, err := iot.NewClient(conf.Client, conf.Secret) |
| 79 | + if err != nil { |
| 80 | + return nil, err |
| 81 | + } |
| 82 | + |
| 83 | + // Prepare the list of device-ids to update |
| 84 | + d, err := idsGivenTags(iotClient, params.Tags) |
| 85 | + if err != nil { |
| 86 | + return nil, err |
| 87 | + } |
| 88 | + d = append(params.DeviceIDs, d...) |
| 89 | + valid, invalid, err := validateDevices(iotClient, d, params.FQBN) |
| 90 | + if err != nil { |
| 91 | + return nil, fmt.Errorf("failed to validate devices: %w", err) |
| 92 | + } |
| 93 | + if len(valid) == 0 { |
| 94 | + return invalid, nil |
| 95 | + } |
| 96 | + |
| 97 | + expiration := otaExpirationMins |
| 98 | + if params.Deferred { |
| 99 | + expiration = otaDeferredExpirationMins |
| 100 | + } |
| 101 | + |
| 102 | + res := run(iotClient, valid, otaFile, expiration) |
| 103 | + res = append(res, invalid...) |
| 104 | + return res, nil |
| 105 | +} |
| 106 | + |
| 107 | +func idsGivenTags(iotClient iot.Client, tags map[string]string) ([]string, error) { |
| 108 | + if tags == nil { |
| 109 | + return nil, nil |
| 110 | + } |
| 111 | + devs, err := iotClient.DeviceList(tags) |
| 112 | + if err != nil { |
| 113 | + return nil, fmt.Errorf("%s: %w", "cannot retrieve devices from cloud", err) |
| 114 | + } |
| 115 | + devices := make([]string, 0, len(devs)) |
| 116 | + for _, d := range devs { |
| 117 | + devices = append(devices, d.Id) |
| 118 | + } |
| 119 | + return devices, nil |
| 120 | +} |
| 121 | + |
| 122 | +func validateDevices(iotClient iot.Client, ids []string, fqbn string) (valid []string, invalid []Result, err error) { |
| 123 | + devs, err := iotClient.DeviceList(nil) |
| 124 | + if err != nil { |
| 125 | + return nil, nil, fmt.Errorf("%s: %w", "cannot retrieve devices from cloud", err) |
| 126 | + } |
| 127 | + |
| 128 | + for _, id := range ids { |
| 129 | + var found *iotclient.ArduinoDevicev2 |
| 130 | + for _, d := range devs { |
| 131 | + if d.Id == id { |
| 132 | + found = &d |
| 133 | + break |
| 134 | + } |
| 135 | + } |
| 136 | + // Device not found on the cloud |
| 137 | + if found == nil { |
| 138 | + inv := Result{ID: id, Err: fmt.Errorf("not found")} |
| 139 | + invalid = append(invalid, inv) |
| 140 | + continue |
| 141 | + } |
| 142 | + // Device FQBN doesn't match the passed one |
| 143 | + if found.Fqbn != fqbn { |
| 144 | + inv := Result{ID: id, Err: fmt.Errorf("has FQBN '%s' instead of '%s'", found.Fqbn, fqbn)} |
| 145 | + invalid = append(invalid, inv) |
| 146 | + continue |
| 147 | + } |
| 148 | + valid = append(valid, id) |
| 149 | + } |
| 150 | + return valid, invalid, nil |
| 151 | +} |
| 152 | + |
| 153 | +func run(iotClient iot.Client, ids []string, otaFile string, expiration int) []Result { |
| 154 | + type job struct { |
| 155 | + id string |
| 156 | + file *os.File |
| 157 | + } |
| 158 | + jobs := make(chan job, len(ids)) |
| 159 | + |
| 160 | + resCh := make(chan Result, len(ids)) |
| 161 | + results := make([]Result, 0, len(ids)) |
| 162 | + |
| 163 | + for _, id := range ids { |
| 164 | + file, err := os.Open(otaFile) |
| 165 | + if err != nil { |
| 166 | + r := Result{ID: id, Err: fmt.Errorf("cannot open ota file")} |
| 167 | + results = append(results, r) |
| 168 | + continue |
| 169 | + } |
| 170 | + jobs <- job{id: id, file: file} |
| 171 | + } |
| 172 | + close(jobs) |
| 173 | + |
| 174 | + for i := 0; i < numConcurrentUploads; i++ { |
| 175 | + go func() { |
| 176 | + for job := range jobs { |
| 177 | + err := iotClient.DeviceOTA(job.id, job.file, expiration) |
| 178 | + resCh <- Result{ID: job.id, Err: err} |
| 179 | + } |
| 180 | + }() |
| 181 | + } |
| 182 | + |
| 183 | + for range ids { |
| 184 | + r := <-resCh |
| 185 | + results = append(results, r) |
| 186 | + } |
| 187 | + return results |
| 188 | +} |
0 commit comments