Skip to content

Adding more test coverage for mass upload use case #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 30 additions & 14 deletions command/ota/massupload.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"context"
"errors"
"fmt"
"github.com/sirupsen/logrus"
"os"
"path/filepath"

Expand Down Expand Up @@ -54,6 +55,27 @@ type Result struct {
OtaStatus otaapi.Ota
}

func buildOtaFile(params *MassUploadParams) (string, string, error) {
var otaFile string
var otaDir string
var err error
if params.DoNotApplyHeader {
otaFile = params.File
} else {
otaDir, err = os.MkdirTemp("", "")
if err != nil {
return "", "", fmt.Errorf("%s: %w", "cannot create temporary folder", err)
}
otaFile = filepath.Join(otaDir, "temp.ota")

err = Generate(params.File, otaFile, params.FQBN)
if err != nil {
return "", "", fmt.Errorf("%s: %w", "cannot generate .ota file", err)
}
}
return otaFile, otaDir, nil
}

// MassUpload command is used to mass upload a firmware OTA,
// on devices of Arduino IoT Cloud.
func MassUpload(ctx context.Context, params *MassUploadParams, cred *config.Credentials) ([]Result, error) {
Expand All @@ -64,6 +86,7 @@ func MassUpload(ctx context.Context, params *MassUploadParams, cred *config.Cred
}

// Generate .ota file
logrus.Infoln("Uploading binary", params.File)
_, err := os.Stat(params.File)
if err != nil {
return nil, fmt.Errorf("file %s does not exists: %w", params.File, err)
Expand All @@ -78,21 +101,12 @@ func MassUpload(ctx context.Context, params *MassUploadParams, cred *config.Cred
}

// Generate .ota file
var otaFile string
if params.DoNotApplyHeader {
otaFile = params.File
} else {
otaDir, err := os.MkdirTemp("", "")
if err != nil {
return nil, fmt.Errorf("%s: %w", "cannot create temporary folder", err)
}
otaFile := filepath.Join(otaDir, "temp.ota")
otaFile, otaDir, err := buildOtaFile(params)
if err != nil {
return nil, err
}
if otaDir != "" {
defer os.RemoveAll(otaDir)

err = Generate(params.File, otaFile, params.FQBN)
if err != nil {
return nil, fmt.Errorf("%s: %w", "cannot generate .ota file", err)
}
}

iotClient, err := iot.NewClient(cred)
Expand Down Expand Up @@ -196,6 +210,7 @@ func run(ctx context.Context, uploader otaUploader, otapi otaStatusGetter, ids [
for _, id := range ids {
file, err := os.Open(otaFile)
if err != nil {
logrus.Error("cannot open ota file:", otaFile)
r := Result{ID: id, Err: fmt.Errorf("cannot open ota file")}
results = append(results, r)
continue
Expand All @@ -205,6 +220,7 @@ func run(ctx context.Context, uploader otaUploader, otapi otaStatusGetter, ids [
}
close(jobs)

logrus.Infoln("Uploading firmware to devices...")
for i := 0; i < numConcurrentUploads; i++ {
go func() {
for job := range jobs {
Expand Down
29 changes: 29 additions & 0 deletions command/ota/massupload_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ import (
otaapi "github.com/arduino/arduino-cloud-cli/internal/ota-api"
iotclient "github.com/arduino/iot-client-go"
"github.com/gofrs/uuid"
"github.com/stretchr/testify/assert"
)

const testFilename = "testdata/empty.bin"
const cloudFirmwareFilename = "testdata/cloud.bin"

type deviceUploaderTest struct {
deviceOTA func(ctx context.Context, id string, file *os.File, expireMins int) error
Expand Down Expand Up @@ -119,3 +121,30 @@ func TestValidateDevices(t *testing.T) {
t.Errorf("expected 2 invalid devices, but found %d: %v", len(i), i)
}
}

func TestValidateBuildOtaFile(t *testing.T) {

file, tmp, err := buildOtaFile(&MassUploadParams{
File: cloudFirmwareFilename,
DoNotApplyHeader: false,
FQBN: "arduino:samd:nano_33_iot",
})
assert.Nil(t, err)
assert.NotNil(t, file)
assert.True(t, strings.HasSuffix(file, "temp.ota"))
assert.NotEmpty(t, tmp)
defer os.RemoveAll(tmp)
}

func TestValidateBuildOtaFile_whenNoHeaderIsRequested(t *testing.T) {

file, tmp, err := buildOtaFile(&MassUploadParams{
File: cloudFirmwareFilename,
DoNotApplyHeader: true,
FQBN: "arduino:samd:nano_33_iot",
})
assert.Nil(t, err)
assert.NotNil(t, file)
assert.Equal(t, cloudFirmwareFilename, file)
assert.Empty(t, tmp)
}
Binary file added command/ota/testdata/cloud.bin
Binary file not shown.
Loading