Merge remote-tracking branch 'origin/main' into app-specification

Author: cmaglie

.github/workflows/test-update.yml

@@ -0,0 +1,29 @@
+name: test the system update flow
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-update:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Run dep package update test
+        env:
+          GH_TOKEN: ${{ secrets.ARDUINOBOT_TOKEN }}
+        run: |
+          go tool task test:update

Taskfile.yml

@@ -50,9 +50,13 @@ tasks:
 
   test:internal:
     cmds:
-      - go build ./cmd/arduino-app-cli # needed for e2e tests
+      - go build ./cmd/arduino-app-cli
       - task: generate
-      - go test ./internal/... ./cmd/... -v -race {{ .CLI_ARGS }}
+      - go test $(go list ./internal/... ./cmd/... | grep -v internal/e2e/updatetest) -v -race {{ .CLI_ARGS }}
+
+  test:update:
+    cmds:
+      - go test --timeout 30m -v ./internal/e2e/updatetest
 
   test:pkg:
     desc: Run only tests in the pkg directory
@@ -102,9 +106,10 @@ tasks:
     deps:
       - build-deb:clone-examples
     cmds:
-      - docker build --build-arg BINARY_NAME=arduino-app-cli --build-arg DEB_NAME=arduino-app-cli --build-arg VERSION={{ .VERSION }} --build-arg ARCH={{ .ARCH }} --build-arg RELEASE={{ .RELEASE }} --output=./build -f debian/Dockerfile .
+      - docker build --build-arg BINARY_NAME=arduino-app-cli --build-arg DEB_NAME=arduino-app-cli --build-arg VERSION={{ .VERSION }} --build-arg ARCH={{ .ARCH }} --build-arg RELEASE={{ .RELEASE }} --output={{ .OUTPUT }} -f debian/Dockerfile .
     vars:
       ARCH: '{{.ARCH | default "arm64"}}'
+      OUTPUT: '{{.OUTPUT | default "./build"}}'
 
   build-deb:clone-examples:
     desc: "Clones the examples repo directly into the debian structure"
@@ -114,7 +119,7 @@ tasks:
           echo "Runner version set as: {{ .EXAMPLE_VERSION }}"
           TMP_PATH="$(mktemp -d)"
           DEST_PATH="debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli/"
-          echo "Cloning arduino/app-bricks-example into temporary directory ${TMP_PATH}..."
+          echo "Cloning arduino/app-bricks-examples into temporary directory ${TMP_PATH}..."
           git clone --depth 1 --branch "{{ .EXAMPLE_VERSION }}" https://github.com/arduino/app-bricks-examples "${TMP_PATH}"
           rm -rf "${DEST_PATH}/examples"
           mkdir -p "${DEST_PATH}"
@@ -190,7 +195,7 @@ tasks:
           TMP_PATH="$(mktemp -d)"
 
           echo "Cloning examples into temporary directory ${TMP_PATH}..."
-          git clone --depth 1 https://github.com/arduino/app-bricks-example.git "${TMP_PATH}"
+          git clone --depth 1 https://github.com/arduino/app-bricks-examples.git "${TMP_PATH}"
 
           echo "Installing examples to ${DEST_PATH}examples"
           rm -rf "${DEST_PATH}examples"

cmd/arduino-app-cli/app/app.go

@@ -38,8 +38,8 @@ func NewAppCmd(cfg config.Configuration) *cobra.Command {
 	appCmd.AddCommand(newRestartCmd(cfg))
 	appCmd.AddCommand(newLogsCmd(cfg))
 	appCmd.AddCommand(newListCmd(cfg))
-	appCmd.AddCommand(newPsCmd())
 	appCmd.AddCommand(newMonitorCmd(cfg))
+	appCmd.AddCommand(newCacheCleanCmd(cfg))
 
 	return appCmd
 }

cmd/arduino-app-cli/app/clean.go

@@ -0,0 +1,65 @@
+package app
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/spf13/cobra"
+
+	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/completion"
+	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/internal/servicelocator"
+	"github.com/arduino/arduino-app-cli/cmd/feedback"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/app"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
+)
+
+func newCacheCleanCmd(cfg config.Configuration) *cobra.Command {
+	var forceClean bool
+	appCmd := &cobra.Command{
+		Use:   "clean-cache <app-id>",
+		Short: "Delete app cache",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			app, err := Load(args[0])
+			if err != nil {
+				return err
+			}
+			return cacheCleanHandler(cmd.Context(), app, forceClean)
+		},
+		ValidArgsFunction: completion.ApplicationNames(cfg),
+	}
+	appCmd.Flags().BoolVarP(&forceClean, "force", "", false, "Forcefully clean the cache even if the app is running")
+
+	return appCmd
+}
+
+func cacheCleanHandler(ctx context.Context, app app.ArduinoApp, forceClean bool) error {
+	err := orchestrator.CleanAppCache(
+		ctx,
+		servicelocator.GetDockerClient(),
+		app,
+		orchestrator.CleanAppCacheRequest{ForceClean: forceClean},
+	)
+	if err != nil {
+		feedback.Fatal(err.Error(), feedback.ErrGeneric)
+	}
+	feedback.PrintResult(cacheCleanResult{
+		AppName: app.Name,
+		Path:    app.ProvisioningStateDir().String(),
+	})
+	return nil
+}
+
+type cacheCleanResult struct {
+	AppName string `json:"appName"`
+	Path    string `json:"path"`
+}
+
+func (r cacheCleanResult) String() string {
+	return fmt.Sprintf("✓ Cache of %q App cleaned", r.AppName)
+}
+
+func (r cacheCleanResult) Data() interface{} {
+	return r
+}

cmd/arduino-app-cli/app/ps.go

@@ -16,10 +16,18 @@
 package app
 
 import (
+	"context"
+	"fmt"
+
 	"github.com/spf13/cobra"
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
 
 	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/completion"
+	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/arduino/arduino-app-cli/cmd/feedback"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/app"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
 )
 
@@ -32,17 +40,63 @@ func newRestartCmd(cfg config.Configuration) *cobra.Command {
 			if len(args) == 0 {
 				return cmd.Help()
 			}
-			app, err := Load(args[0])
+			appToStart, err := Load(args[0])
 			if err != nil {
 				feedback.Fatal(err.Error(), feedback.ErrBadArgument)
-				return nil
-			}
-			if err := stopHandler(cmd.Context(), app); err != nil {
-				feedback.Warnf("failed to stop app: %s", err.Error())
 			}
-			return startHandler(cmd.Context(), cfg, app)
+			return restartHandler(cmd.Context(), cfg, appToStart)
 		},
 		ValidArgsFunction: completion.ApplicationNames(cfg),
 	}
 	return cmd
 }
+
+func restartHandler(ctx context.Context, cfg config.Configuration, app app.ArduinoApp) error {
+	out, _, getResult := feedback.OutputStreams()
+
+	stream := orchestrator.RestartApp(
+		ctx,
+		servicelocator.GetDockerClient(),
+		servicelocator.GetProvisioner(),
+		servicelocator.GetModelsIndex(),
+		servicelocator.GetBricksIndex(),
+		app,
+		cfg,
+		servicelocator.GetStaticStore(),
+	)
+	for message := range stream {
+		switch message.GetType() {
+		case orchestrator.ProgressType:
+			fmt.Fprintf(out, "Progress[%s]: %.0f%%\n", message.GetProgress().Name, message.GetProgress().Progress)
+		case orchestrator.InfoType:
+			fmt.Fprintln(out, "[INFO]", message.GetData())
+		case orchestrator.ErrorType:
+			errMesg := cases.Title(language.AmericanEnglish).String(message.GetError().Error())
+			feedback.Fatal(fmt.Sprintf("[ERROR] %s", errMesg), feedback.ErrGeneric)
+			return nil
+		}
+	}
+
+	outputResult := getResult()
+	feedback.PrintResult(restartAppResult{
+		AppName: app.Name,
+		Status:  "restarted",
+		Output:  outputResult,
+	})
+
+	return nil
+}
+
+type restartAppResult struct {
+	AppName string                        `json:"app_name"`
+	Status  string                        `json:"status"`
+	Output  *feedback.OutputStreamsResult `json:"output,omitempty"`
+}
+
+func (r restartAppResult) String() string {
+	return fmt.Sprintf("✓ App %q restarted successfully", r.AppName)
+}
+
+func (r restartAppResult) Data() interface{} {
+	return r
+}

cmd/arduino-app-cli/app/restart.go

@@ -17,16 +17,18 @@ package brick
 
 import (
 	"github.com/spf13/cobra"
+
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
 )
 
-func NewBrickCmd() *cobra.Command {
+func NewBrickCmd(cfg config.Configuration) *cobra.Command {
 	appCmd := &cobra.Command{
 		Use:   "brick",
 		Short: "Manage Arduino Bricks",
 	}
 
 	appCmd.AddCommand(newBricksListCmd())
-	appCmd.AddCommand(newBricksDetailsCmd())
+	appCmd.AddCommand(newBricksDetailsCmd(cfg))
 
 	return appCmd
 }

cmd/arduino-app-cli/brick/bricks.go

@@ -22,24 +22,28 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/completion"
 	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/arduino/arduino-app-cli/cmd/feedback"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricks"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
 )
 
-func newBricksDetailsCmd() *cobra.Command {
+func newBricksDetailsCmd(cfg config.Configuration) *cobra.Command {
 	return &cobra.Command{
 		Use:   "details",
 		Short: "Details of a specific brick",
 		Args:  cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
-			bricksDetailsHandler(args[0])
+			bricksDetailsHandler(args[0], cfg)
 		},
+		ValidArgsFunction: completion.BrickIDs(),
 	}
 }
 
-func bricksDetailsHandler(id string) {
-	res, err := servicelocator.GetBrickService().BricksDetails(id)
+func bricksDetailsHandler(id string, cfg config.Configuration) {
+	res, err := servicelocator.GetBrickService().BricksDetails(id, servicelocator.GetAppIDProvider(),
+		cfg)
 	if err != nil {
 		if errors.Is(err, bricks.ErrBrickNotFound) {
 			feedback.Fatal(err.Error(), feedback.ErrBadArgument)

cmd/arduino-app-cli/brick/details.go

@@ -24,6 +24,7 @@ import (
 	"github.com/arduino/arduino-app-cli/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/arduino/arduino-app-cli/cmd/feedback"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricks"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
 )
 
@@ -97,3 +98,24 @@ func ApplicationNamesWithFilterFunc(cfg config.Configuration, filter func(apps o
 		return res, cobra.ShellCompDirectiveNoFileComp
 	}
 }
+
+func BrickIDs() cobra.CompletionFunc {
+	return BrickIDsWithFilterFunc(func(_ bricks.BrickListItem) bool { return true })
+}
+
+func BrickIDsWithFilterFunc(filter func(apps bricks.BrickListItem) bool) cobra.CompletionFunc {
+	return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		brickList, err := servicelocator.GetBrickService().List()
+		if err != nil {
+			return nil, cobra.ShellCompDirectiveError
+		}
+
+		var res []string
+		for _, brick := range brickList.Bricks {
+			if filter(brick) {
+				res = append(res, brick.ID)
+			}
+		}
+		return res, cobra.ShellCompDirectiveNoFileComp
+	}
+}

cmd/arduino-app-cli/completion/completion.go

@@ -29,7 +29,7 @@ import (
 func NewConfigCmd(cfg config.Configuration) *cobra.Command {
 	appCmd := &cobra.Command{
 		Use:   "config",
-		Short: "Manage arduino-app-cli config",
+		Short: "Manage Arduino App CLI config",
 	}
 
 	appCmd.AddCommand(newConfigGetCmd(cfg))