Add arduino-flasher-cli tool (#376)

Author: MatteoPologruto

Taskfile.yml

@@ -320,3 +320,40 @@ tasks:
 
           EOF
           cat .licenses/arduino-router/NOTICE  >> debian/arduino-router/usr/share/doc/arduino-router/copyright
+
+  arduino-flasher-cli:build:
+    desc: "Build the arduino-flasher-cli locally"
+    dir: arduino-flasher-cli
+    vars:
+      VERSION: "{{.VERSION }}"
+    cmds:
+      - cmd: go build -ldflags "-X main.Version={{.VERSION}}" -v -o ../build/arduino-flasher-cli .
+        platforms: [linux, darwin]
+      - cmd: go build -ldflags "-X main.Version={{.VERSION}}" -v -o ../build/arduino-flasher-cli.exe .
+        platforms: [windows]
+
+  debian:release-server:start:
+    dir: arduino-flasher-cli
+    cmds:
+      - docker rm -f debian-static-server
+      - docker run --rm -d -v "$PWD/public:/usr/share/nginx/html:ro" -p 3001:80 --name debian-static-server nginx:alpine
+
+  flash:staging:
+    cmds:
+      - task: arduino-flasher-cli:build
+        vars:
+          VERSION: "{{.VERSION}}"
+      - task: flash:internal
+        vars:
+          CF_ACCESS_CLIENT_SECRET: "$(export AWS_PROFILE=arduino-staging && aws ssm get-parameter --with-decryption --name /devops/downloads/cloudflare_access_client_secret --query Parameter.Value --output text)"
+          CF_ACCESS_CLIENT_ID: "$(export AWS_PROFILE=arduino-staging && aws ssm get-parameter --with-decryption --name /devops/downloads/cloudflare_access_client_id --query Parameter.Value --output text)"
+          TARGET: latest
+
+  flash:internal:
+    internal: true
+    dir: build
+    cmds:
+      - cmd: CF_ACCESS_CLIENT_ID="{{.CF_ACCESS_CLIENT_ID}}" CF_ACCESS_CLIENT_SECRET="{{.CF_ACCESS_CLIENT_SECRET}}" ./arduino-flasher-cli flash {{.TARGET}}
+        platforms: [linux, darwin]
+      - cmd: CF_ACCESS_CLIENT_ID="{{.CF_ACCESS_CLIENT_ID}}" CF_ACCESS_CLIENT_SECRET="{{.CF_ACCESS_CLIENT_SECRET}}" ./arduino-flasher-cli.exe flash {{.TARGET}}
+        platforms: [windows]

arduino-flasher-cli/.gitignore

@@ -0,0 +1 @@
+public/

arduino-flasher-cli/flash.go

@@ -0,0 +1,89 @@
+package main
+
+import (
+	"arduino-flasher/updater"
+	"context"
+	"fmt"
+	"net/url"
+	"os"
+	"strings"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/bcmi-labs/orchestrator/cmd/feedback"
+	"github.com/bcmi-labs/orchestrator/cmd/i18n"
+	"github.com/spf13/cobra"
+)
+
+func newFlashCmd() *cobra.Command {
+	var forceYes bool
+	appCmd := &cobra.Command{
+		Use:   "flash",
+		Short: "Flash a Debian image on the board",
+		Long:  "Dowload the specified Debian image version and flash it on the board",
+		Example: " " + os.Args[0] + " flash latest\n" +
+			" " + os.Args[0] + " flash 20250915-173\n",
+		Args: cobra.ExactArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			runFlashCommand(cmd.Context(), args, forceYes)
+		},
+	}
+	appCmd.Flags().BoolVarP(&forceYes, "yes", "y", false, "Automatically confirm all prompts")
+	// TODO: add --clean-install flag or something similar to distinguish between keeping and purging the /home directory
+
+	return appCmd
+}
+
+func runFlashCommand(ctx context.Context, args []string, forceYes bool) {
+	version := args[0]
+
+	updateURL := os.Getenv("UPDATE_URL")
+	if updateURL == "" {
+		// TODO: change to prod
+		updateURL = "https://downloads.oniudra.cc"
+	}
+
+	parsedURL, err := url.Parse(updateURL)
+	if err != nil {
+		feedback.Fatal(i18n.Tr("invalid UPDATE_URL:", err), feedback.ErrBadArgument)
+	}
+
+	headers := map[string]string{}
+	clientID := os.Getenv("CF_ACCESS_CLIENT_ID")
+	clientSecret := os.Getenv("CF_ACCESS_CLIENT_SECRET")
+	if clientID != "" && clientSecret != "" {
+		headers["CF-Access-Client-Id"] = clientID
+		headers["CF-Access-Client-Secret"] = clientSecret
+	}
+
+	var client *updater.Client
+	if len(headers) == 2 {
+		client = updater.NewClient(parsedURL, "debian-im/Stable", updater.WithHeaders(headers))
+	} else {
+		client = updater.NewClient(parsedURL, "debian-im/Stable")
+	}
+
+	downloadedImagePath, updatedVersion, err := updater.DownloadImage(client, version, func(target string) (bool, error) {
+		feedback.Printf("Found Debian image version: %s", target)
+		feedback.Printf("Do you want to download it and flash it on the board? (yes/no)")
+
+		var yesInput string
+		_, err := fmt.Scanf("%s\n", &yesInput)
+		if err != nil {
+			return false, err
+		}
+		yes := strings.ToLower(yesInput) == "yes" || strings.ToLower(yesInput) == "y"
+		return yes, nil
+	}, forceYes)
+
+	if err != nil {
+		feedback.Fatal(i18n.Tr("error downloading the image: %v", err), feedback.ErrBadArgument)
+	}
+
+	if downloadedImagePath != "" {
+		defer paths.New(downloadedImagePath).RemoveAll()
+
+		if err := updater.FlashBoard(ctx, downloadedImagePath, updatedVersion); err != nil {
+			feedback.Fatal(i18n.Tr("error flashing the board: %v", err), feedback.ErrBadArgument)
+		}
+	}
+}

arduino-flasher-cli/go.mod

@@ -0,0 +1,22 @@
+module arduino-flasher
+
+go 1.25
+
+require (
+	github.com/arduino/go-paths-helper v1.14.0
+	github.com/bcmi-labs/orchestrator v0.3.0
+	github.com/codeclysm/extract/v4 v4.0.0
+	github.com/spf13/cobra v1.9.1
+	go.bug.st/cleanup v1.0.0
+)
+
+require (
+	github.com/h2non/filetype v1.1.3 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/juju/errors v1.0.0 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/spf13/pflag v1.0.7 // indirect
+	github.com/ulikunitz/xz v0.5.12 // indirect
+	golang.org/x/sys v0.35.0 // indirect
+)

arduino-flasher-cli/go.sum

@@ -0,0 +1,54 @@
+github.com/arduino/go-paths-helper v1.14.0 h1:b4C8KJa7CNz2XnzTWg97M3LAmzWSWrj+m/o5/skzv3Y=
+github.com/arduino/go-paths-helper v1.14.0/go.mod h1:dDodKn2ZX4iwuoBMapdDO+5d0oDLBeM4BS0xS4i40Ak=
+github.com/bcmi-labs/orchestrator v0.3.0 h1:lCsGiz1OlM8Bzflavaz1+9y1roUUkGfA4IKntm8HXl4=
+github.com/bcmi-labs/orchestrator v0.3.0/go.mod h1:D2NWi/sJtJ9/hDxaeotfftHi+dXbXXwDWsySXR8k3Pg=
+github.com/codeclysm/extract/v4 v4.0.0 h1:H87LFsUNaJTu2e/8p/oiuiUsOK/TaPQ5wxsjPnwPEIY=
+github.com/codeclysm/extract/v4 v4.0.0/go.mod h1:SFju1lj6as7FvUgalpSct7torJE0zttbJUWtryPRG6s=
+github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/h2non/filetype v1.1.3 h1:FKkx9QbD7HR/zjK1Ia5XiBsq9zdLi5Kf3zGyFTAFkGg=
+github.com/h2non/filetype v1.1.3/go.mod h1:319b3zT68BvV+WRj7cwy856M2ehB3HqNOt6sy1HndBY=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/juju/errors v1.0.0 h1:yiq7kjCLll1BiaRuNY53MGI0+EQ3rF6GB+wvboZDefM=
+github.com/juju/errors v1.0.0/go.mod h1:B5x9thDqx0wIMH3+aLIMP9HjItInYWObRovoCFM5Qe8=
+github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo=
+github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/leonelquinteros/gotext v1.7.2 h1:bDPndU8nt+/kRo1m4l/1OXiiy2v7Z7dfPQ9+YP7G1Mc=
+github.com/leonelquinteros/gotext v1.7.2/go.mod h1:9/haCkm5P7Jay1sxKDGJ5WIg4zkz8oZKw4ekNpALob8=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
+github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
+github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
+github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
+github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/spf13/pflag v1.0.7 h1:vN6T9TfwStFPFM5XzjsvmzZkLuaLX+HS+0SeFLRgU6M=
+github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.11.0 h1:ib4sjIrwZKxE5u/Japgo/7SJV3PvgjGiRNAvTVGqQl8=
+github.com/stretchr/testify v1.11.0/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
+github.com/ulikunitz/xz v0.5.12 h1:37Nm15o69RwBkXM0J6A5OlE67RZTfzUxTj8fB3dfcsc=
+github.com/ulikunitz/xz v0.5.12/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
+go.bug.st/cleanup v1.0.0 h1:XVj1HZxkBXeq3gMT7ijWUpHyIC1j8XAoNSyQ06CskgA=
+go.bug.st/cleanup v1.0.0/go.mod h1:EqVmTg2IBk4znLbPD28xne3abjsJftMdqqJEjhn70bk=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI=
+golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

arduino-flasher-cli/main.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+
+	"github.com/bcmi-labs/orchestrator/cmd/feedback"
+	"github.com/bcmi-labs/orchestrator/cmd/i18n"
+	"github.com/spf13/cobra"
+	"go.bug.st/cleanup"
+)
+
+// Version will be set a build time with -ldflags
+var Version string = "0.0.0-dev"
+var format string
+
+func main() {
+	rootCmd := &cobra.Command{
+		Use:   "arduino-flasher-cli",
+		Short: "A CLI to update and flash the Debian image",
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			format, ok := feedback.ParseOutputFormat(format)
+			if !ok {
+				feedback.Fatal(i18n.Tr("Invalid output format: %s", format), feedback.ErrBadArgument)
+			}
+			feedback.SetFormat(format)
+		},
+		SilenceUsage:  true,
+		SilenceErrors: true,
+	}
+
+	rootCmd.PersistentFlags().StringVar(&format, "format", "text", "Output format (text, json)")
+
+	rootCmd.AddCommand(
+		newFlashCmd(),
+		&cobra.Command{
+			Use:   "version",
+			Short: "Print the version number of Arduino Flasher CLI",
+			Run: func(cmd *cobra.Command, args []string) {
+				fmt.Println("Arduino Flasher CLI v" + Version)
+			},
+		})
+
+	ctx := context.Background()
+	ctx, _ = cleanup.InterruptableContext(ctx)
+	if err := rootCmd.ExecuteContext(ctx); err != nil {
+		slog.Error(err.Error())
+	}
+}

arduino-flasher-cli/updater/assets/qdl_Darwin

@@ -0,0 +1,116 @@
+package updater
+
+import (
+	"bytes"
+	"context"
+	"crypto/md5"
+	"encoding/hex"
+	"fmt"
+	"io"
+	"log/slog"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/bcmi-labs/orchestrator/cmd/feedback"
+	"github.com/codeclysm/extract/v4"
+)
+
+// TODO: add more fields to download other image versions
+type Manifest struct {
+	Latest struct {
+		Version string `json:"version"`
+		Url     string `json:"url"`
+		Md5sum  string `json:"md5sum"`
+	} `json:"latest"`
+}
+
+// DownloadConfirmCB is a function that is called when a Debian image is ready to be downloaded.
+type DownloadConfirmCB func(target string) (bool, error)
+
+func DownloadImage(client *Client, targetVersion string, upgradeConfirmCb DownloadConfirmCB, forceYes bool) (string, string, error) {
+	var err error
+
+	slog.Info("Checking for Debian image releases")
+	manifest, err := client.GetInfoManifest()
+	if err != nil {
+		return "", "", err
+	}
+
+	if targetVersion == "latest" {
+		targetVersion = manifest.Latest.Version
+	}
+
+	if !forceYes {
+		res, err := upgradeConfirmCb(targetVersion)
+		if err != nil {
+			return "", "", err
+		}
+		if !res {
+			slog.Info("Download not confirmed by user, exiting")
+			return "", "", nil
+		}
+	}
+
+	// Download the Debian image
+	var download io.ReadCloser
+	if targetVersion == manifest.Latest.Version {
+		slog.Info("Downloading Debian image", "version", manifest.Latest.Version)
+		download, err = client.FetchZip(manifest.Latest.Url)
+		if err != nil {
+			return "", "", fmt.Errorf("could not fetch Debian image: %w", err)
+		}
+	} else {
+		// TODO: check the json for the specific version and download it
+		return "", "", nil
+	}
+	defer download.Close()
+
+	// Download the zip
+	temp, err := paths.MkTempDir("", "flasher-updater-")
+	if err != nil {
+		return "", "", fmt.Errorf("could not create temporary download directory: %w", err)
+	}
+	tmpZip := temp.Join("update.tar.xz")
+	defer func() {
+		if err := tmpZip.Remove(); err != nil {
+			slog.Warn("Could not remove temp zip", "zip", tmpZip.String(), "error", err)
+		}
+	}()
+
+	tmpZipFile, err := tmpZip.Create()
+	if err != nil {
+		return "", "", err
+	}
+	defer tmpZipFile.Close()
+
+	md5 := md5.New()
+	if _, err := io.Copy(io.MultiWriter(md5, tmpZipFile), download); err != nil {
+		return "", "", err
+	}
+	tmpZipFile.Close()
+
+	// Check the hash
+	if md5Byte, err := hex.DecodeString(manifest.Latest.Md5sum); err != nil {
+		return "", "", fmt.Errorf("could not convert md5 from hex to bytes: %w", err)
+	} else if s := md5.Sum(nil); !bytes.Equal(s, md5Byte) {
+		return "", "", fmt.Errorf("bad hash: %x (expected %x)", s, md5Byte)
+	}
+
+	// Unzip the Debian image
+	slog.Info("Unzipping Debian image", "tmpDir", temp)
+	tmpZipFile, err = tmpZip.Open()
+	if err != nil {
+		return "", "", fmt.Errorf("could not open archive for unzip: %w", err)
+	}
+	defer tmpZipFile.Close()
+
+	if err := extract.Archive(context.Background(), tmpZipFile, temp.String(), func(s string) string {
+		feedback.Print(s)
+		return s
+	}); err != nil {
+		return "", "", fmt.Errorf("extracting archive: %w", err)
+	}
+
+	slog.Info("Download of Debian image completed", "path", temp)
+
+	return temp.String(), targetVersion, nil
+}