refactor: decouple config (#535)

Author: alessio-perugini

.golangci.yml

@@ -16,6 +16,7 @@ linters:
     - unconvert
     - unparam
     - forbidigo
+    - gochecknoinits
   settings:
     forbidigo:
       forbid:

Taskfile.yml

@@ -347,7 +347,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}\"#" cmd/arduino-app-cli/internal/servicelocator/servicelocator.go
 
   update-deb-copyright:
     desc: Extract project and dependency licenses into asd copyright

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

@@ -5,31 +5,32 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
+	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/app"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func NewAppCmd() *cobra.Command {
+func NewAppCmd(cfg config.Configuration) *cobra.Command {
 	appCmd := &cobra.Command{
 		Use:   "app",
 		Short: "Manage Arduino Apps",
 		Long:  "A CLI tool to manage Arduino Apps, including starting, stopping, logging, and provisioning.",
 	}
 
-	appCmd.AddCommand(newCreateCmd())
-	appCmd.AddCommand(newStartCmd())
-	appCmd.AddCommand(newStopCmd())
-	appCmd.AddCommand(newRestartCmd())
-	appCmd.AddCommand(newLogsCmd())
-	appCmd.AddCommand(newListCmd())
+	appCmd.AddCommand(newCreateCmd(cfg))
+	appCmd.AddCommand(newStartCmd(cfg))
+	appCmd.AddCommand(newStopCmd(cfg))
+	appCmd.AddCommand(newRestartCmd(cfg))
+	appCmd.AddCommand(newLogsCmd(cfg))
+	appCmd.AddCommand(newListCmd(cfg))
 	appCmd.AddCommand(newPsCmd())
-	appCmd.AddCommand(newMonitorCmd())
+	appCmd.AddCommand(newMonitorCmd(cfg))
 
 	return appCmd
 }
 
 func Load(idOrPath string) (app.ArduinoApp, error) {
-	id, err := orchestrator.ParseID(idOrPath)
+	id, err := servicelocator.GetAppIDProvider().ParseID(idOrPath)
 	if err != nil {
 		return app.ArduinoApp{}, fmt.Errorf("invalid app path: %s", idOrPath)
 	}

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

@@ -11,32 +11,35 @@ import (
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 	"github.com/bcmi-labs/orchestrator/pkg/tablestyle"
 )
 
-func newListCmd() *cobra.Command {
+func newListCmd(cfg config.Configuration) *cobra.Command {
 	var showBrokenApps bool
 
 	cmd := &cobra.Command{
 		Use:   "list",
 		Short: "List all running Python apps",
 		Run: func(cmd *cobra.Command, args []string) {
-			listHandler(cmd.Context(), showBrokenApps)
+			listHandler(cmd.Context(), cfg, showBrokenApps)
 		},
 	}
 
 	cmd.Flags().BoolVarP(&showBrokenApps, "show-broken-apps", "", false, "Output a list of broken apps")
 	return cmd
 }
 
-func listHandler(ctx context.Context, showBrokenApps bool) {
+func listHandler(ctx context.Context, cfg config.Configuration, showBrokenApps bool) {
 	res, err := orchestrator.ListApps(ctx,
 		servicelocator.GetDockerClient(),
 		orchestrator.ListAppRequest{
 			ShowExamples:                   true,
 			ShowApps:                       true,
 			IncludeNonStandardLocationApps: true,
 		},
+		servicelocator.GetAppIDProvider(),
+		cfg,
 	)
 	if err != nil {
 		feedback.Fatal(err.Error(), feedback.ErrGeneric)

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

@@ -11,9 +11,10 @@ import (
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/app"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func newLogsCmd() *cobra.Command {
+func newLogsCmd(cfg config.Configuration) *cobra.Command {
 	var (
 		tail   uint64
 		follow bool
@@ -33,7 +34,7 @@ func newLogsCmd() *cobra.Command {
 			}
 			return logsHandler(cmd.Context(), app, &tail, follow, all)
 		},
-		ValidArgsFunction: completion.ApplicationNames(),
+		ValidArgsFunction: completion.ApplicationNames(cfg),
 	}
 	cmd.Flags().Uint64Var(&tail, "tail", 100, "Tail the last N logs")
 	cmd.Flags().BoolVar(&follow, "follow", false, "Follow the logs")

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

@@ -4,15 +4,16 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/completion"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func newMonitorCmd() *cobra.Command {
+func newMonitorCmd(cfg config.Configuration) *cobra.Command {
 	return &cobra.Command{
 		Use:   "monitor",
 		Short: "Monitor the Python app",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			panic("not implemented")
 		},
-		ValidArgsFunction: completion.ApplicationNames(),
+		ValidArgsFunction: completion.ApplicationNames(cfg),
 	}
 }

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

@@ -6,11 +6,13 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func newCreateCmd() *cobra.Command {
+func newCreateCmd(cfg config.Configuration) *cobra.Command {
 	var (
 		icon     string
 		bricks   []string
@@ -26,7 +28,7 @@ func newCreateCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cobra.MinimumNArgs(1)
 			name := args[0]
-			return createHandler(cmd.Context(), name, icon, noPyton, noSketch, fromApp)
+			return createHandler(cmd.Context(), cfg, name, icon, noPyton, noSketch, fromApp)
 		},
 	}
 
@@ -40,9 +42,9 @@ func newCreateCmd() *cobra.Command {
 	return cmd
 }
 
-func createHandler(ctx context.Context, name string, icon string, noPython, noSketch bool, fromApp string) error {
+func createHandler(ctx context.Context, cfg config.Configuration, name string, icon string, noPython, noSketch bool, fromApp string) error {
 	if fromApp != "" {
-		id, err := orchestrator.ParseID(fromApp)
+		id, err := servicelocator.GetAppIDProvider().ParseID(fromApp)
 		if err != nil {
 			feedback.Fatal(err.Error(), feedback.ErrBadArgument)
 			return nil
@@ -51,7 +53,7 @@ func createHandler(ctx context.Context, name string, icon string, noPython, noSk
 		resp, err := orchestrator.CloneApp(ctx, orchestrator.CloneAppRequest{
 			Name:   &name,
 			FromID: id,
-		})
+		}, servicelocator.GetAppIDProvider(), cfg)
 		if err != nil {
 			feedback.Fatal(err.Error(), feedback.ErrGeneric)
 			return nil
@@ -70,7 +72,7 @@ func createHandler(ctx context.Context, name string, icon string, noPython, noSk
 			Icon:       icon,
 			SkipPython: noPython,
 			SkipSketch: noSketch,
-		})
+		}, servicelocator.GetAppIDProvider(), cfg)
 		if err != nil {
 			feedback.Fatal(err.Error(), feedback.ErrGeneric)
 			return nil

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

@@ -7,9 +7,10 @@ import (
 
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/completion"
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func newRestartCmd() *cobra.Command {
+func newRestartCmd(cfg config.Configuration) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "restart app_path",
 		Short: "Restart or Start an Arduino app",
@@ -26,9 +27,9 @@ func newRestartCmd() *cobra.Command {
 			if err := stopHandler(cmd.Context(), app); err != nil {
 				feedback.Warning(fmt.Sprintf("failed to stop app: %s", err.Error()))
 			}
-			return startHandler(cmd.Context(), app)
+			return startHandler(cmd.Context(), cfg, app)
 		},
-		ValidArgsFunction: completion.ApplicationNames(),
+		ValidArgsFunction: completion.ApplicationNames(cfg),
 	}
 	return cmd
 }

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

@@ -11,9 +11,10 @@ import (
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/app"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func newStartCmd() *cobra.Command {
+func newStartCmd(cfg config.Configuration) *cobra.Command {
 	return &cobra.Command{
 		Use:   "start app_path",
 		Short: "Start an Arduino app",
@@ -26,13 +27,13 @@ func newStartCmd() *cobra.Command {
 			if err != nil {
 				return err
 			}
-			return startHandler(cmd.Context(), app)
+			return startHandler(cmd.Context(), cfg, app)
 		},
-		ValidArgsFunction: completion.ApplicationNames(),
+		ValidArgsFunction: completion.ApplicationNames(cfg),
 	}
 }
 
-func startHandler(ctx context.Context, app app.ArduinoApp) error {
+func startHandler(ctx context.Context, cfg config.Configuration, app app.ArduinoApp) error {
 	out, _, getResult := feedback.OutputStreams()
 
 	stream := orchestrator.StartApp(
@@ -42,6 +43,7 @@ func startHandler(ctx context.Context, app app.ArduinoApp) error {
 		servicelocator.GetModelsIndex(),
 		servicelocator.GetBricksIndex(),
 		app,
+		cfg,
 	)
 	for message := range stream {
 		switch message.GetType() {

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

@@ -10,9 +10,10 @@ import (
 	"github.com/bcmi-labs/orchestrator/cmd/feedback"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/app"
+	"github.com/bcmi-labs/orchestrator/internal/orchestrator/config"
 )
 
-func newStopCmd() *cobra.Command {
+func newStopCmd(cfg config.Configuration) *cobra.Command {
 	return &cobra.Command{
 		Use:   "stop app_path",
 		Short: "Stop an Arduino app",
@@ -27,7 +28,7 @@ func newStopCmd() *cobra.Command {
 			}
 			return stopHandler(cmd.Context(), app)
 		},
-		ValidArgsFunction: completion.ApplicationNames(),
+		ValidArgsFunction: completion.ApplicationNames(cfg),
 	}
 }