[v2][non-kube] site create command and CLI adaptation

cmd/skupper/main.go

@@ -4,8 +4,8 @@ Copyright © 2024 Skupper Team <[email protected]>
 package main
 
 import (
+	"github.com/skupperproject/skupper/internal/cmd/skupper/common/utils"
 	"github.com/skupperproject/skupper/internal/cmd/skupper/root"
-	"github.com/skupperproject/skupper/internal/cmd/skupper/utils"
 )
 
 func main() {

internal/cmd/generate-doc/main.go

@@ -2,10 +2,10 @@ package main
 
 import (
 	"fmt"
+	"github.com/skupperproject/skupper/internal/cmd/skupper/common/utils"
 	"os"
 
 	"github.com/skupperproject/skupper/internal/cmd/skupper/root"
-	"github.com/skupperproject/skupper/internal/cmd/skupper/utils"
 	"github.com/spf13/cobra/doc"
 )
 

internal/cmd/skupper/common/command.go

@@ -0,0 +1,64 @@
+package common
+
+import (
+	"fmt"
+	"github.com/skupperproject/skupper/api/types"
+	"github.com/skupperproject/skupper/internal/cmd/skupper/common/utils"
+	"github.com/spf13/cobra"
+)
+
+type SkupperCommand interface {
+	NewClient(cobraCommand *cobra.Command, args []string)
+	ValidateInput(args []string) []error
+	InputToOptions()
+	Run() error
+	WaitUntil() error
+}
+
+type SkupperCmdDescription struct {
+	Use     string
+	Short   string
+	Long    string
+	Example string
+}
+
+func ConfigureCobraCommand(configuredPlatform types.Platform, description SkupperCmdDescription, kubeImpl SkupperCommand, nonKubeImpl SkupperCommand) *cobra.Command {
+	var skupperCommand SkupperCommand
+	var platform string
+
+	cmd := cobra.Command{
+		Use:     description.Use,
+		Short:   description.Short,
+		Long:    description.Long,
+		Example: description.Example,
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+
+			platform = string(configuredPlatform)
+			if cmd.Flag("platform") != nil && cmd.Flag("platform").Value.String() != "" {
+				platform = cmd.Flag("platform").Value.String()
+			}
+
+			switch platform {
+			case "kubernetes":
+				skupperCommand = kubeImpl
+			case "podman", "docker", "systemd":
+				skupperCommand = nonKubeImpl
+			default:
+				return fmt.Errorf("platform %q not supported", platform)
+			}
+
+			skupperCommand.NewClient(cmd, args)
+			return nil
+		},
+		Run: func(cmd *cobra.Command, args []string) {
+			utils.HandleErrorList(skupperCommand.ValidateInput(args))
+			skupperCommand.InputToOptions()
+			utils.HandleError(skupperCommand.Run())
+		},
+		PostRun: func(cmd *cobra.Command, args []string) {
+			utils.HandleError(skupperCommand.WaitUntil())
+		},
+	}
+
+	return &cmd
+}

internal/cmd/skupper/common/command_test.go

@@ -0,0 +1,137 @@
+package common
+
+import (
+	"github.com/skupperproject/skupper/api/types"
+	"github.com/spf13/cobra"
+	"gotest.tools/assert"
+	"testing"
+)
+
+type MockSkupperCommand struct {
+	CalledNewClient      bool
+	CalledValidateInput  bool
+	CalledInputToOptions bool
+	CalledRun            bool
+	CalledWaitUntil      bool
+}
+
+func (m *MockSkupperCommand) NewClient(cmd *cobra.Command, args []string) {
+	m.CalledNewClient = true
+}
+
+func (m *MockSkupperCommand) ValidateInput(args []string) []error {
+	m.CalledValidateInput = true
+	return nil
+}
+
+func (m *MockSkupperCommand) InputToOptions() {
+	m.CalledInputToOptions = true
+}
+
+func (m *MockSkupperCommand) Run() error {
+	m.CalledRun = true
+	return nil
+}
+
+func (m *MockSkupperCommand) WaitUntil() error {
+	m.CalledWaitUntil = true
+	return nil
+}
+
+func TestConfigureCobraCommand(t *testing.T) {
+	t.Run("Test with kubernetes platform", func(t *testing.T) {
+		kubeCmd := &MockSkupperCommand{}
+		nonKubeCmd := &MockSkupperCommand{}
+		desc := SkupperCmdDescription{
+			Use:     "testuse",
+			Short:   "testshort",
+			Long:    "testlong",
+			Example: "testexample",
+		}
+
+		result := ConfigureCobraCommand(types.PlatformKubernetes, desc, kubeCmd, nonKubeCmd)
+
+		// After executing the returned cobra.Command,
+		// the corresponding methods on the correct SkupperCommand should have been called
+		err := result.Execute()
+		assert.Check(t, err)
+
+		assert.Check(t, kubeCmd.CalledNewClient)
+		assert.Check(t, kubeCmd.CalledValidateInput)
+		assert.Check(t, kubeCmd.CalledInputToOptions)
+		assert.Check(t, kubeCmd.CalledRun)
+		assert.Check(t, kubeCmd.CalledWaitUntil)
+
+		// Ensure nonKubeCmd wasn't called
+		assert.Check(t, !nonKubeCmd.CalledNewClient)
+		assert.Check(t, !nonKubeCmd.CalledValidateInput)
+		assert.Check(t, !nonKubeCmd.CalledInputToOptions)
+		assert.Check(t, !nonKubeCmd.CalledRun)
+		assert.Check(t, !nonKubeCmd.CalledWaitUntil)
+	})
+
+	t.Run("Test with non kubernetes platform", func(t *testing.T) {
+		kubeCmd := &MockSkupperCommand{}
+		nonKubeCmd := &MockSkupperCommand{}
+		desc := SkupperCmdDescription{
+			Use:     "testuse",
+			Short:   "testshort",
+			Long:    "testlong",
+			Example: "testexample",
+		}
+
+		var selectedPlatform string
+		result := ConfigureCobraCommand(types.PlatformKubernetes, desc, kubeCmd, nonKubeCmd)
+		result.Flags().StringVarP(&selectedPlatform, FlagNamePlatform, "p", "docker", FlagDescPlatform)
+
+		// After executing the returned cobra.Command,
+		// the corresponding methods on the correct SkupperCommand should have been called
+		err := result.Execute()
+		assert.Check(t, err)
+
+		// Ensure KubeCmd wasn't called
+		assert.Check(t, !kubeCmd.CalledNewClient)
+		assert.Check(t, !kubeCmd.CalledValidateInput)
+		assert.Check(t, !kubeCmd.CalledInputToOptions)
+		assert.Check(t, !kubeCmd.CalledRun)
+		assert.Check(t, !kubeCmd.CalledWaitUntil)
+
+		assert.Check(t, nonKubeCmd.CalledNewClient)
+		assert.Check(t, nonKubeCmd.CalledValidateInput)
+		assert.Check(t, nonKubeCmd.CalledInputToOptions)
+		assert.Check(t, nonKubeCmd.CalledRun)
+		assert.Check(t, nonKubeCmd.CalledWaitUntil)
+	})
+
+	t.Run("Test with unsupported platform", func(t *testing.T) {
+		kubeCmd := &MockSkupperCommand{}
+		nonKubeCmd := &MockSkupperCommand{}
+		desc := SkupperCmdDescription{
+			Use:     "testuse",
+			Short:   "testshort",
+			Long:    "testlong",
+			Example: "testexample",
+		}
+
+		var selectedPlatform string
+		result := ConfigureCobraCommand(types.PlatformKubernetes, desc, kubeCmd, nonKubeCmd)
+		result.Flags().StringVarP(&selectedPlatform, FlagNamePlatform, "p", "unsupported", FlagDescPlatform)
+
+		// After executing the returned cobra.Command,
+		// the corresponding methods on the correct SkupperCommand should have been called
+		err := result.Execute()
+		assert.Check(t, err.Error() == "platform \"unsupported\" not supported")
+
+		assert.Check(t, !kubeCmd.CalledNewClient)
+		assert.Check(t, !kubeCmd.CalledValidateInput)
+		assert.Check(t, !kubeCmd.CalledInputToOptions)
+		assert.Check(t, !kubeCmd.CalledRun)
+		assert.Check(t, !kubeCmd.CalledWaitUntil)
+
+		assert.Check(t, !nonKubeCmd.CalledNewClient)
+		assert.Check(t, !nonKubeCmd.CalledValidateInput)
+		assert.Check(t, !nonKubeCmd.CalledInputToOptions)
+		assert.Check(t, !nonKubeCmd.CalledRun)
+		assert.Check(t, !nonKubeCmd.CalledWaitUntil)
+	})
+}

internal/cmd/skupper/utils/constants.go → internal/cmd/skupper/common/constants.go

@@ -1,7 +1,8 @@
-package utils
+package common
 
 var (
 	LinkAccessTypes = []string{"route", "loadbalancer", "default"}
 	OutputTypes     = []string{"json", "yaml"}
 	ListenerTypes   = []string{"tcp"}
+	ConnectorTypes  = []string{"tcp"}
 )