refactor config (#555)

Author: alessio-perugini

Taskfile.yml

@@ -348,7 +348,7 @@ tasks:
           mv "$OUTPUT_DIR"/arduino/app_bricks/static "$DST_DIR"
           rm -r "$OUTPUT_DIR" "$ZIP_NAME"
           # Bumps the default pinned latest base python image tag
-          sed -i "s#runnerVersion = \".*#runnerVersion = \"${semver_tag}\"#" cmd/arduino-app-cli/internal/servicelocator/servicelocator.go
+          sed -i "s#runnerVersion = \".*#runnerVersion = \"${semver_tag}\"#" internal/orchestrator/config/config.go
 
   update-deb-copyright:
     desc: Extract project and dependency licenses into asd copyright

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

@@ -49,7 +49,7 @@ func NewDaemonCmd(cfg config.Configuration, version string) *cobra.Command {
 				slog.Info("Try to pull latest docker images in background...")
 				err = orchestrator.SystemInit(
 					cmd.Context(),
-					servicelocator.GetUsedPythonImageTag(),
+					cfg.UsedPythonImageTag,
 					servicelocator.GetStaticStore(),
 				)
 				if err != nil {

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

@@ -3,11 +3,6 @@
 package servicelocator
 
 import (
-	"fmt"
-	"log/slog"
-	"os"
-	"path"
-	"strings"
 	"sync"
 
 	dockerCommand "github.com/docker/cli/cli/command"
@@ -31,9 +26,6 @@ func Init(cfg config.Configuration) {
 }
 
 var (
-	// Do not manually modify this, we keep it updated with the `task generate:bricks-and-models-index`
-	runnerVersion = "0.1.16"
-
 	GetBricksIndex = sync.OnceValue(func() *bricksindex.BricksIndex {
 		return f.Must(bricksindex.GenerateBricksIndexFromFile(GetStaticStore().GetAssetsFolder()))
 	})
@@ -43,14 +35,8 @@ var (
 	})
 
 	GetProvisioner = sync.OnceValue(func() *orchestrator.Provision {
-		pythonImage, usedPythonImageTag := getPythonImageAndTag()
-		slog.Debug("Using pythonImage", slog.String("image", pythonImage))
-
 		return f.Must(orchestrator.NewProvision(
 			GetDockerClient(),
-			pythonImage,
-			usedPythonImageTag,
-			runnerVersion,
 			globalConfig,
 		))
 	})
@@ -79,13 +65,8 @@ var (
 		return nil
 	}
 
-	GetUsedPythonImageTag = sync.OnceValue(func() string {
-		_, usedPythonImageTag := getPythonImageAndTag()
-		return usedPythonImageTag
-	})
-
 	GetStaticStore = sync.OnceValue(func() *store.StaticStore {
-		return store.NewStaticStore(globalConfig.AssetsDir().Join(GetUsedPythonImageTag()).String())
+		return store.NewStaticStore(globalConfig.AssetsDir().Join(globalConfig.UsedPythonImageTag).String())
 	})
 
 	GetBrickService = sync.OnceValue(func() *bricks.Service {
@@ -100,22 +81,3 @@ var (
 		return app.NewAppIDProvider(globalConfig)
 	})
 )
-
-func getPythonImageAndTag() (string, string) {
-	registryBase := os.Getenv("DOCKER_REGISTRY_BASE")
-	if registryBase == "" {
-		registryBase = "ghcr.io/bcmi-labs/"
-	}
-
-	// Python image: image name (repository) and optionally a tag.
-	pythonImageAndTag := os.Getenv("DOCKER_PYTHON_BASE_IMAGE")
-	if pythonImageAndTag == "" {
-		pythonImageAndTag = fmt.Sprintf("arduino/appslab-python-apps-base:%s", runnerVersion)
-	}
-	pythonImage := path.Join(registryBase, pythonImageAndTag)
-	var usedPythonImageTag string
-	if idx := strings.LastIndex(pythonImage, ":"); idx != -1 {
-		usedPythonImageTag = pythonImage[idx+1:]
-	}
-	return pythonImage, usedPythonImageTag
-}

cmd/arduino-app-cli/main.go

@@ -62,7 +62,7 @@ func run(configuration cfg.Configuration) error {
 		daemon.NewDaemonCmd(configuration, Version),
 		properties.NewPropertiesCmd(configuration),
 		config.NewConfigCmd(configuration),
-		system.NewSystemCmd(),
+		system.NewSystemCmd(configuration),
 		board.NewBoardCmd(),
 		version.NewVersionCmd(Version),
 	)

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

@@ -5,25 +5,26 @@ import (
 
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func NewSystemCmd() *cobra.Command {
+func NewSystemCmd(cfg config.Configuration) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:    "system",
 		Hidden: true,
 	}
 
-	cmd.AddCommand(newDownloadImage())
+	cmd.AddCommand(newDownloadImage(cfg))
 
 	return cmd
 }
 
-func newDownloadImage() *cobra.Command {
+func newDownloadImage(cfg config.Configuration) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:  "init",
 		Args: cobra.ExactArgs(0),
 		RunE: func(cmd *cobra.Command, _ []string) error {
-			return orchestrator.SystemInit(cmd.Context(), servicelocator.GetUsedPythonImageTag(), servicelocator.GetStaticStore())
+			return orchestrator.SystemInit(cmd.Context(), cfg.UsedPythonImageTag, servicelocator.GetStaticStore())
 		},
 	}
 

internal/orchestrator/config/config.go

@@ -1,18 +1,27 @@
 package config
 
 import (
+	"fmt"
 	"log/slog"
 	"os"
+	"path"
+	"strings"
 
 	"github.com/arduino/go-paths-helper"
 )
 
+// Do not manually modify this, we keep it updated with the `task generate:bricks-and-models-index`
+var runnerVersion = "0.1.16"
+
 type Configuration struct {
-	appsDir           *paths.Path
-	configDir         *paths.Path
-	dataDir           *paths.Path
-	routerSocketPath  *paths.Path
-	customEIModelsDir *paths.Path
+	appsDir            *paths.Path
+	configDir          *paths.Path
+	dataDir            *paths.Path
+	routerSocketPath   *paths.Path
+	customEIModelsDir  *paths.Path
+	PythonImage        string
+	UsedPythonImageTag string
+	RunnerVersion      string
 }
 
 func NewFromEnv() (Configuration, error) {
@@ -78,12 +87,18 @@ func NewFromEnv() (Configuration, error) {
 		}
 	}
 
+	pythonImage, usedPythonImageTag := getPythonImageAndTag()
+	slog.Debug("Using pythonImage", slog.String("image", pythonImage))
+
 	c := Configuration{
-		appsDir:           appsDir,
-		configDir:         configDir,
-		dataDir:           dataDir,
-		routerSocketPath:  routerSocket,
-		customEIModelsDir: customEIModelsDir,
+		appsDir:            appsDir,
+		configDir:          configDir,
+		dataDir:            dataDir,
+		routerSocketPath:   routerSocket,
+		customEIModelsDir:  customEIModelsDir,
+		PythonImage:        pythonImage,
+		UsedPythonImageTag: usedPythonImageTag,
+		RunnerVersion:      runnerVersion,
 	}
 	if err := c.init(); err != nil {
 		return Configuration{}, err
@@ -127,3 +142,22 @@ func (c *Configuration) RouterSocketPath() *paths.Path {
 func (c *Configuration) AssetsDir() *paths.Path {
 	return c.dataDir.Join("assets")
 }
+
+func getPythonImageAndTag() (string, string) {
+	registryBase := os.Getenv("DOCKER_REGISTRY_BASE")
+	if registryBase == "" {
+		registryBase = "ghcr.io/bcmi-labs/"
+	}
+
+	// Python image: image name (repository) and optionally a tag.
+	pythonImageAndTag := os.Getenv("DOCKER_PYTHON_BASE_IMAGE")
+	if pythonImageAndTag == "" {
+		pythonImageAndTag = fmt.Sprintf("arduino/appslab-python-apps-base:%s", runnerVersion)
+	}
+	pythonImage := path.Join(registryBase, pythonImageAndTag)
+	var usedPythonImageTag string
+	if idx := strings.LastIndex(pythonImage, ":"); idx != -1 {
+		usedPythonImageTag = pythonImage[idx+1:]
+	}
+	return pythonImage, usedPythonImageTag
+}

internal/orchestrator/provision.go

@@ -51,20 +51,17 @@ type Provision struct {
 
 func NewProvision(
 	docker command.Cli,
-	pythonImage string,
-	usedPythonImageTag string,
-	pinnedPythonImagTag string,
 	cfg config.Configuration,
 ) (*Provision, error) {
-	isDevelopmentMode := usedPythonImageTag != pinnedPythonImagTag
+	isDevelopmentMode := cfg.UsedPythonImageTag != cfg.RunnerVersion
 	if isDevelopmentMode {
-		dynamicProvisionDir := cfg.AssetsDir().Join(usedPythonImageTag)
+		dynamicProvisionDir := cfg.AssetsDir().Join(cfg.UsedPythonImageTag)
 		_ = dynamicProvisionDir.RemoveAll()
 		tmpProvisionDir, err := cfg.AssetsDir().MkTempDir("dynamic-provisioning")
 		if err != nil {
 			return nil, fmt.Errorf("failed to perform creation of dynamic provisioning dir: %w", err)
 		}
-		if err := dynamicProvisioning(context.Background(), docker.Client(), pythonImage, tmpProvisionDir.String()); err != nil {
+		if err := dynamicProvisioning(context.Background(), docker.Client(), cfg.PythonImage, tmpProvisionDir.String()); err != nil {
 			return nil, fmt.Errorf("failed to perform dynamic provisioning: %w", err)
 		}
 		if err := tmpProvisionDir.Rename(dynamicProvisionDir); err != nil {
@@ -74,7 +71,7 @@ func NewProvision(
 
 	return &Provision{
 		docker:      docker,
-		pythonImage: pythonImage,
+		pythonImage: cfg.PythonImage,
 	}, nil
 }