Add the preservation supported flag

Author: martacarbone

pkg/flasherapi/flasherapi.go

@@ -16,45 +16,56 @@
 package flasherapi
 
 import (
+	"bufio"
 	"context"
+	"io"
 	"log/slog"
 	"strings"
 
 	"github.com/arduino/arduino-app-cli/pkg/board/remote"
 )
 
+const R0_IMAGE_VERSION_ID = "20250807-136"
+
 // GetOSImageVersion returns the version of the OS image used in the board.
 // It is used by the AppLab to enforce image version compatibility.
-func GetOSImageVersion(ctx context.Context, conn remote.RemoteConn) (string, error) {
-	const defaultVersion = "20250807-136"
+func GetOSImageVersion(ctx context.Context, conn remote.RemoteConn) string {
 
-	output, err := conn.GetCmd("cat /etc/buildinfo").Output(ctx)
+	f, err := conn.ReadFile("/etc/buildinfo")
 	if err != nil {
-		return defaultVersion, err
+		slog.Warn("Unable to read buildinfo file", "err", err, "using_default", R0_IMAGE_VERSION_ID)
+		return R0_IMAGE_VERSION_ID
 	}
+	defer f.Close()
 
-	if version, ok := ParseOSImageVersion(string(output)); ok {
-		slog.Info("find OS Image version", "version", version)
-		return version, nil
+	if version, ok := parseOSImageVersion(f); ok {
+		slog.Info("found OS Image version", "version", version)
+		return version
 	}
-	slog.Info("Unable to find OS Image version", "using default version", defaultVersion)
-	return defaultVersion, nil
+	slog.Warn("Unable to find OS Image version", "using_default", R0_IMAGE_VERSION_ID)
+	return R0_IMAGE_VERSION_ID
 }
 
-func ParseOSImageVersion(buildInfo string) (string, bool) {
-	for _, line := range strings.Split(buildInfo, "\n") {
-		line = strings.TrimSpace(line)
+func parseOSImageVersion(r io.Reader) (string, bool) {
+	scanner := bufio.NewScanner(r)
+	for scanner.Scan() {
+		line := strings.TrimSpace(scanner.Text())
 
 		key, value, ok := strings.Cut(line, "=")
 		if !ok || key != "BUILD_ID" {
 			continue
 		}
 
-		version := strings.Trim(value, "\"' ")
+		version := strings.Trim(value, `"' `)
 		if version != "" {
 			return version, true
 		}
 	}
+
+	if err := scanner.Err(); err != nil {
+		return "", false
+	}
+
 	return "", false
 }
 
@@ -64,77 +75,11 @@ type OSImageRelease struct {
 	Latest       bool
 }
 
-func ListAvailableOSImages() []OSImageRelease {
-	return []OSImageRelease{
-		{
-			ID:           "20251123-159",
-			VersionLabel: "r159 (2025-11-23)",
-			Latest:       true,
-		},
-	}
-}
-
-const R0_IMAGE_VERSION_ID = "20250807-136"
-
 // Calculates whether user partition preservation is supported,
 // according to the current and target OS image versions.
 //
 // Preservation is supported if both versions are not the R0 image.
-func IsUserPartitionPreservationSupported(ctx context.Context, conn remote.RemoteConn, targetImageVersion OSImageRelease) (bool, error) {
-	currentImageVersion, err := GetOSImageVersion(ctx, conn)
-	if err != nil {
-		return false, err
-	}
-	return !(targetImageVersion.ID == R0_IMAGE_VERSION_ID || currentImageVersion == R0_IMAGE_VERSION_ID), err
-}
-
-type FlashStep string
-
-const (
-	FlashStepPrecheck    FlashStep = "precheck"
-	FlashStepDetection   FlashStep = "detection"
-	FlashStepDownloading FlashStep = "downloading"
-	FlashStepExtracting  FlashStep = "extracting"
-	FlashStepFlashing    FlashStep = "flashing"
-)
-
-type FlashEvent struct {
-	Step            FlashStep
-	OverallProgress int    // percentage 0-100
-	Message         string // log message to show on the UI
-}
-
-func Flash(
-	ctx context.Context, // context to cancel to interrupt the flashing process
-	// conn remote.RemoteConn, // is this required for the flash process?
-	imageVersion OSImageRelease, // OS image version to flash
-	preserveUserPartition bool, // whether to preserve the user partition or not
-	eventCB func(event FlashEvent), // Callback, sends progress events to the caller
-) error {
-	// The disk space check is done before starting the flashing process.
-	return InsufficientDiskSpaceError{
-		RequiredSpaceMB:  2048,
-		AvailableSpaceMB: 1024,
-	}
-}
-
-// Errors returned by the Flash function above.
-// Assertions can be done on the caller side to show better error messages.
-
-type QDLFlashError struct {
-	Details string
-	Cause   error
-}
-
-type DownloadError struct {
-	Details string
-}
-
-type InsufficientDiskSpaceError struct {
-	RequiredSpaceMB  int64
-	AvailableSpaceMB int64
-}
-
-func (e InsufficientDiskSpaceError) Error() string {
-	return "insufficient disk space"
+func IsUserPartitionPreservationSupported(ctx context.Context, conn remote.RemoteConn, targetImageVersion OSImageRelease) bool {
+	currentImageVersion := GetOSImageVersion(ctx, conn)
+	return !(targetImageVersion.ID == R0_IMAGE_VERSION_ID || currentImageVersion == R0_IMAGE_VERSION_ID)
 }

pkg/flasherapi/flasherapi_test.go

@@ -1,6 +1,24 @@
+// This file is part of arduino-app-cli.
+//
+// Copyright 2025 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-app-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
 package flasherapi
 
-import "testing"
+import (
+	"strings"
+	"testing"
+)
 
 func TestParseOSImageVersion(t *testing.T) {
 	tests := []struct {
@@ -29,7 +47,7 @@ func TestParseOSImageVersion(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, ok := ParseOSImageVersion(tt.input)
+			got, ok := parseOSImageVersion(strings.NewReader(tt.input))
 			if ok != tt.found || got != tt.expected {
 				t.Fatalf("got (%q, %v), expected (%q, %v)", got, ok, tt.expected, tt.found)
 			}