Feat/327 cleanup operation (#616)

Co-authored-by: mirkoCrobu <mirkocrobu@NB-0531.localdomain>

Author: mirkoCrobu

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

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
 
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/internal/servicelocator"
@@ -22,6 +23,7 @@ func NewSystemCmd(cfg config.Configuration) *cobra.Command {
 
 	cmd.AddCommand(newDownloadImage(cfg))
 	cmd.AddCommand(newUpdateCmd())
+	cmd.AddCommand(newCleanUpCmd(cfg, servicelocator.GetDockerClient()))
 
 	return cmd
 }
@@ -116,3 +118,29 @@ func getFilterFunc(onlyArduino bool) func(p update.UpgradablePackage) bool {
 	}
 	return update.MatchAllPackages
 }
+
+func newCleanUpCmd(cfg config.Configuration, docker command.Cli) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "cleanup",
+		Short: "Removes unused and obsolete application images to free up disk space.",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, _ []string) error {
+
+			staticStore := servicelocator.GetStaticStore()
+
+			feedback.Printf("Running cleanup...")
+			result, err := orchestrator.SystemCleanupSoft(cmd.Context(), cfg, staticStore, docker)
+			if err != nil {
+				return err
+			}
+
+			if result > 0 {
+				feedback.Printf("Cleanup successful. Freed up %d bytes of disk space.", result)
+			} else {
+				feedback.Printf("No removable images found.")
+			}
+			return nil
+		},
+	}
+	return cmd
+}

internal/orchestrator/orchestrator.go

@@ -297,7 +297,7 @@ func getVideoDevices() map[int]string {
 	return deviceMap
 }
 
-func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
+func stopAppWithCmd(ctx context.Context, app app.ArduinoApp, cmd string) iter.Seq[StreamMessage] {
 	return func(yield func(StreamMessage) bool) {
 		ctx, cancel := context.WithCancel(ctx)
 		defer cancel()
@@ -324,7 +324,7 @@ func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
 			mainCompose := app.AppComposeFilePath()
 			// In case the app was never started
 			if mainCompose.Exist() {
-				process, err := paths.NewProcess(nil, "docker", "compose", "-f", mainCompose.String(), "stop", fmt.Sprintf("--timeout=%d", DefaultDockerStopTimeoutSeconds))
+				process, err := paths.NewProcess(nil, "docker", "compose", "-f", mainCompose.String(), cmd, fmt.Sprintf("--timeout=%d", DefaultDockerStopTimeoutSeconds))
 				if err != nil {
 					yield(StreamMessage{error: err})
 					return
@@ -341,6 +341,14 @@ func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
 	}
 }
 
+func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
+	return stopAppWithCmd(ctx, app, "stop")
+}
+
+func StopAndDestroyApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
+	return stopAppWithCmd(ctx, app, "down")
+}
+
 func StartDefaultApp(
 	ctx context.Context,
 	docker command.Cli,

internal/orchestrator/system.go

@@ -4,13 +4,16 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
+	"fmt"
 	"os"
 	"slices"
+	"strconv"
 	"strings"
 
 	"github.com/arduino/go-paths-helper"
 	"github.com/compose-spec/compose-go/v2/loader"
 	"github.com/compose-spec/compose-go/v2/types"
+	"github.com/docker/cli/cli/command"
 	"go.bug.st/f"
 
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
@@ -42,7 +45,9 @@ func SystemInit(ctx context.Context, cfg config.Configuration, staticStore *stor
 		feedback.Fatal(err.Error(), feedback.ErrBadArgument)
 		return nil
 	}
+
 	for _, container := range containersToPreinstall {
+
 		cmd, err := paths.NewProcess(nil, "docker", "pull", container)
 		if err != nil {
 			return err
@@ -57,11 +62,13 @@ func SystemInit(ctx context.Context, cfg config.Configuration, staticStore *stor
 }
 
 // listImagesAlreadyPulled
+// TODO make reference constant in a dedicated file as single source of truth
 func listImagesAlreadyPulled(ctx context.Context) ([]string, error) {
 	cmd, err := paths.NewProcess(nil,
 		"docker", "images", "--format", "json",
 		"-f", "reference=ghcr.io/bcmi-labs/*",
-		"-f", "reference=public.ecr.aws/*",
+		"-f", "reference=public.ecr.aws/arduino/app-bricks/*",
+		"-f", "reference=influxdb",
 	)
 	if err != nil {
 		return nil, err
@@ -135,3 +142,97 @@ func parseAllModelsRunnerImageTag(staticStore *store.StaticStore) ([]string, err
 
 	return f.Uniq(result), nil
 }
+
+func SystemCleanupSoft(ctx context.Context, cfg config.Configuration, staticStore *store.StaticStore, docker command.Cli) (int64, error) {
+	totalCleaned := int64(0)
+
+	containersMustStay, err := getRequiredImages(cfg, staticStore)
+	if err != nil {
+		return totalCleaned, err
+	}
+
+	allImages, err := listImagesAlreadyPulled(ctx)
+	if err != nil {
+		return totalCleaned, err
+	}
+
+	imagesToRemove := slices.DeleteFunc(allImages, func(v string) bool {
+		return slices.Contains(containersMustStay, v)
+	})
+
+	if len(imagesToRemove) == 0 {
+		return totalCleaned, nil
+	}
+
+	runningApp, err := getRunningApp(ctx, docker.Client())
+	if err != nil {
+		return totalCleaned, fmt.Errorf("failed to get running app: %w", err)
+	}
+	if runningApp != nil {
+		for item := range StopAndDestroyApp(ctx, *runningApp) {
+			if item.GetType() == ErrorType {
+				return totalCleaned, item.GetError()
+			}
+		}
+	}
+
+	for _, container := range imagesToRemove {
+		imageSize, err := removeImage(ctx, container)
+		if err != nil {
+			feedback.Printf("Warning: failed to remove image %s - %v", container, err)
+			continue
+		}
+		totalCleaned += imageSize
+	}
+	return totalCleaned, nil
+}
+
+func removeImage(ctx context.Context, imageName string) (int64, error) {
+	imageSize, err := getImageSize(imageName, ctx)
+	if err != nil {
+		return 0, fmt.Errorf("failed to get size of image %s: %w", imageName, err)
+	}
+
+	cmd, err := paths.NewProcess(nil, "docker", "rmi", "-f", imageName)
+	if err != nil {
+		return 0, fmt.Errorf("failed to create command to remove docker image %s: %w", imageName, err)
+	}
+
+	if err := cmd.RunWithinContext(ctx); err != nil {
+		return 0, fmt.Errorf("failed to remove image %s: %v", imageName, err)
+	}
+
+	return imageSize, nil
+}
+
+func getImageSize(container string, ctx context.Context) (int64, error) {
+	cmdImageSize, err := paths.NewProcess(nil, "docker", "image", "inspect", container, "--format", "{{.Size}}")
+	if err != nil {
+		return 0, err
+	}
+	containersize, err := cmdImageSize.RunAndCaptureCombinedOutput(ctx)
+	if err != nil {
+		return 0, err
+	}
+	trimmedOutput := bytes.TrimSpace(containersize)
+
+	sizeInt64, err := strconv.ParseInt(string(trimmedOutput), 10, 64)
+	if err != nil {
+		return 0, err
+	}
+
+	return sizeInt64, nil
+}
+
+// imgages required by the system
+func getRequiredImages(cfg config.Configuration, staticStore *store.StaticStore) ([]string, error) {
+	requiredImages := []string{cfg.PythonImage}
+
+	modelsRunnersContainers, err := parseAllModelsRunnerImageTag(staticStore)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse models runner images: %w", err)
+	}
+
+	requiredImages = append(requiredImages, modelsRunnersContainers...)
+	return requiredImages, nil
+}

internal/update/apt/service.go

@@ -72,7 +72,6 @@ func (s *Service) UpgradePackages(ctx context.Context, names []string) (<-chan u
 		defer cancel()
 
 		eventsCh <- update.Event{Type: update.StartEvent, Data: "Upgrade is starting"}
-
 		stream := runUpgradeCommand(ctx, names)
 		for line, err := range stream {
 			if err != nil {
@@ -86,6 +85,19 @@ func (s *Service) UpgradePackages(ctx context.Context, names []string) (<-chan u
 			}
 			eventsCh <- update.Event{Type: update.UpgradeLineEvent, Data: line}
 		}
+		// TEMPORARY PATCH: stopping and destroying docker containers and images since IDE does not implement it yet.
+		// TODO: Remove this workaround once IDE implements it.
+		// Tracking issue: https://github.com/bcmi-labs/orchestrator/issues/623
+		eventsCh <- update.Event{Type: update.UpgradeLineEvent, Data: "Stop and destroy docker containers and images ..."}
+		streamCleanup := cleanupDockerContainers(ctx)
+		for line, err := range streamCleanup {
+			if err != nil {
+				// TODO: maybe we should retun an error or a better feedback to the user?
+				// currently, we just log the error and continue considenring not blocking
+				slog.Error("Error stopping and destroying docker containers", "error", err)
+			}
+			eventsCh <- update.Event{Type: update.UpgradeLineEvent, Data: line}
+		}
 
 		// TEMPORARY PATCH: Install the latest docker images and show the logs to the users.
 		// TODO: Remove this workaround once docker image versions are no longer hardcoded in arduino-app-cli.
@@ -106,7 +118,6 @@ func (s *Service) UpgradePackages(ctx context.Context, names []string) (<-chan u
 			}
 			eventsCh <- update.Event{Type: update.UpgradeLineEvent, Data: line}
 		}
-
 		eventsCh <- update.Event{Type: update.RestartEvent, Data: "Upgrade completed. Restarting ..."}
 
 		err := restartServices(ctx)
@@ -203,6 +214,36 @@ func pullDockerImages(ctx context.Context) iter.Seq2[string, error] {
 	}
 }
 
+// Remove all stopped containers
+func cleanupDockerContainers(ctx context.Context) iter.Seq2[string, error] {
+	return func(yield func(string, error) bool) {
+		cmd, err := paths.NewProcess(nil, "arduino-app-cli", "system", "cleanup")
+		if err != nil {
+			_ = yield("", err)
+			return
+		}
+
+		stdout := orchestrator.NewCallbackWriter(func(line string) {
+			if !yield(line, nil) {
+				err := cmd.Kill()
+				if err != nil {
+					slog.Error("Failed to kill 'arduino-app-cli system cleanup' command", slog.String("error", err.Error()))
+				}
+				return
+			}
+		})
+
+		cmd.RedirectStderrTo(stdout)
+		cmd.RedirectStdoutTo(stdout)
+
+		err = cmd.RunWithinContext(ctx)
+		if err != nil {
+			_ = yield("", err)
+			return
+		}
+	}
+}
+
 // RestartServices restarts services that need to be restarted after an upgrade.
 // It uses the `needrestart` command to determine which services need to be restarted.
 // It returns an error if the command fails to start or if it fails to wait for the command to finish.