Adding S3 TUI builder (#563)

Fixes #532

Author: safaci2000

cli/tools/context.go

@@ -26,6 +26,7 @@ func newContextCmd() simplecobra.Commander {
 			newDeleteContext(),
 			newContext(),
 			newSetContext(),
+			newS3Cmd(),
 		},
 		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, r *domain.RootCommand, args []string) error {
 			return cd.CobraCommand.Help()

cli/tools/org_preferences.go

@@ -86,7 +86,6 @@ func newGetOrgPreferenceCmd() simplecobra.Commander {
 		Long:      "get current org preferences",
 		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {},
 		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain.RootCommand, args []string) error {
-
 			pref, err := rootCmd.GrafanaSvc().GetOrgPreferences()
 			if err != nil {
 				log.Fatal(err.Error())

cli/tools/s3.go

@@ -0,0 +1,111 @@
+package tools
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/bep/simplecobra"
+	"github.com/esnet/gdg/cli/domain"
+	"github.com/esnet/gdg/internal/adapter/storage"
+	"github.com/esnet/gdg/internal/config"
+	"github.com/jedib0t/go-pretty/v6/table"
+	"github.com/spf13/cobra"
+)
+
+func newS3Cmd() simplecobra.Commander {
+	return &domain.SimpleCommand{
+		NameP: "s3",
+		Short: "Manage custom S3-compatible storage engine configurations",
+		Long:  "Create, list, and delete custom S3-compatible storage engine configs. For AWS S3, GCS, or Azure, the wizard prints the relevant documentation URL instead.",
+		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {
+			cmd.Aliases = []string{"storage"}
+		},
+		CommandsList: []simplecobra.Commander{
+			newS3NewCmd(),
+			newS3ListCmd(),
+			newS3DeleteCmd(),
+		},
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, r *domain.RootCommand, args []string) error {
+			return cd.CobraCommand.Help()
+		},
+	}
+}
+
+func newS3NewCmd() simplecobra.Commander {
+	return &domain.SimpleCommand{
+		NameP: "new",
+		Short: "Launch the TUI wizard to create a new cloud storage engine config",
+		Long:  "Interactively configure a custom S3-compatible storage engine (Minio, Ceph, etc.). For AWS S3, GCS, or Azure, prints the relevant auth documentation URL.",
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, r *domain.RootCommand, args []string) error {
+			config.NewCustomS3Config(r.ConfigSvc())
+			return nil
+		},
+	}
+}
+
+func newS3ListCmd() simplecobra.Commander {
+	return &domain.SimpleCommand{
+		NameP: "list",
+		Short: "List all configured storage engines",
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, r *domain.RootCommand, args []string) error {
+			engines := config.ListS3Configs(r.ConfigSvc())
+			if len(engines) == 0 {
+				fmt.Println("No storage engines configured.")
+				return nil
+			}
+
+			// Build a reverse index: storage label → context names that reference it
+			assignedTo := make(map[string][]string)
+			for ctxName, ctx := range r.ConfigSvc().GetContexts() {
+				if ctx.Storage != "" {
+					assignedTo[ctx.Storage] = append(assignedTo[ctx.Storage], ctxName)
+				}
+			}
+
+			r.TableObj.AppendHeader(table.Row{
+				"label", "cloud_type", "endpoint", "bucket", "region", "prefix", "init_bucket", "ssl", "assigned_contexts",
+			})
+
+			for label, cfg := range engines {
+				assigned := "-"
+				if refs := assignedTo[label]; len(refs) > 0 {
+					assigned = strings.Join(refs, ", ")
+				}
+				r.TableObj.AppendRow(table.Row{
+					label,
+					cfg[storage.CloudType],
+					cfg[storage.Endpoint],
+					cfg[storage.BucketName],
+					cfg[storage.Region],
+					cfg[storage.Prefix],
+					cfg[storage.InitBucket],
+					cfg["ssl_enabled"],
+					assigned,
+				})
+			}
+
+			r.Render(cd.CobraCommand, engines)
+			return nil
+		},
+	}
+}
+
+func newS3DeleteCmd() simplecobra.Commander {
+	return &domain.SimpleCommand{
+		NameP: "delete",
+		Short: "delete <label>",
+		Long:  "Delete a named storage engine config and its credentials file from the secure location.",
+		InitCFunc: func(cd *simplecobra.Commandeer, r *domain.RootCommand) error {
+			cd.CobraCommand.Aliases = []string{"del"}
+			return nil
+		},
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, r *domain.RootCommand, args []string) error {
+			if len(args) < 1 {
+				return cd.CobraCommand.Help()
+			}
+			config.DeleteS3Config(r.ConfigSvc(), args[0])
+			return nil
+		},
+	}
+}

cli/tools/s3_test.go

@@ -0,0 +1,83 @@
+package tools_test
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/esnet/gdg/cli"
+	"github.com/esnet/gdg/cli/domain"
+	"github.com/esnet/gdg/internal/ports/mocks"
+	"github.com/esnet/gdg/pkg/test_tooling"
+	"github.com/stretchr/testify/assert"
+)
+
+// TestS3ListShowsEngines exercises "gdg tools contexts s3 list" against the
+// testing.yml config (which defines a "test" storage engine) and verifies that
+// the table output contains the expected column headers and engine data.
+func TestS3ListShowsEngines(t *testing.T) {
+	rootSvc := cli.NewRootService()
+	execMe := func(_ *mocks.GrafanaService, optionMockSvc func() domain.RootOption) error {
+		return cli.Execute(rootSvc, []string{"tools", "contexts", "s3", "list"}, optionMockSvc())
+	}
+	outStr, closeReader := test_tooling.SetupAndExecuteMockingServices(t, execMe)
+	defer closeReader()
+
+	lower := strings.ToLower(outStr)
+
+	// Column headers (go-pretty StyleLight uppercases them, so compare lowercase)
+	assert.Contains(t, lower, "label")
+	assert.Contains(t, lower, "cloud_type")
+	assert.Contains(t, lower, "endpoint")
+	assert.Contains(t, lower, "bucket")
+
+	// Data from testing.yml storage_engine.test
+	assert.Contains(t, outStr, "test")
+	assert.Contains(t, outStr, "http://localhost:9000")
+}
+
+// TestS3ListViaStorageAlias verifies that the "storage" alias on the s3 command
+// and the "ctx" alias on the contexts command both resolve correctly.
+func TestS3ListViaStorageAlias(t *testing.T) {
+	rootSvc := cli.NewRootService()
+	execMe := func(_ *mocks.GrafanaService, optionMockSvc func() domain.RootOption) error {
+		return cli.Execute(rootSvc, []string{"tools", "ctx", "storage", "list"}, optionMockSvc())
+	}
+	outStr, closeReader := test_tooling.SetupAndExecuteMockingServices(t, execMe)
+	defer closeReader()
+
+	// Aliases should produce the same table as the canonical command
+	assert.Contains(t, strings.ToLower(outStr), "label")
+	assert.Contains(t, outStr, "http://localhost:9000")
+}
+
+// TestS3ParentShowsHelp verifies that running "gdg tools contexts s3" with no
+// subcommand prints the help listing all three child commands.
+func TestS3ParentShowsHelp(t *testing.T) {
+	rootSvc := cli.NewRootService()
+	execMe := func(_ *mocks.GrafanaService, optionMockSvc func() domain.RootOption) error {
+		return cli.Execute(rootSvc, []string{"tools", "contexts", "s3"}, optionMockSvc())
+	}
+	outStr, closeReader := test_tooling.SetupAndExecuteMockingServices(t, execMe)
+	defer closeReader()
+
+	lower := strings.ToLower(outStr)
+	assert.Contains(t, lower, "new")
+	assert.Contains(t, lower, "list")
+	assert.Contains(t, lower, "delete")
+}
+
+// TestS3DeleteNoArgsShowsHelp verifies that running "gdg tools contexts s3 delete"
+// without a label argument prints the command's usage help rather than returning an error.
+func TestS3DeleteNoArgsShowsHelp(t *testing.T) {
+	rootSvc := cli.NewRootService()
+	execMe := func(_ *mocks.GrafanaService, optionMockSvc func() domain.RootOption) error {
+		return cli.Execute(rootSvc, []string{"tools", "contexts", "s3", "delete"}, optionMockSvc())
+	}
+	outStr, closeReader := test_tooling.SetupAndExecuteMockingServices(t, execMe)
+	defer closeReader()
+
+	lower := strings.ToLower(outStr)
+	// Cobra help output always includes "usage" and the command name
+	assert.Contains(t, lower, "usage")
+	assert.Contains(t, lower, "delete")
+}