refactor: reposcaffolding plugin use encode logic

Signed-off-by: Meng JiaFeng <[email protected]>

Author: steinliber

internal/pkg/plugin/installer/reposcaffolding/installer.go

@@ -0,0 +1,44 @@
+package util
+
+import (
+	"fmt"
+	"reflect"
+
+	"github.com/mitchellh/mapstructure"
+
+	"github.com/devstream-io/devstream/internal/pkg/configmanager"
+	"github.com/devstream-io/devstream/pkg/util/mapz"
+	"github.com/devstream-io/devstream/pkg/util/scm/git"
+)
+
+func DecodePlugin(rawOptions configmanager.RawOptions, pluginData any) error {
+	// 1. create a new decode with pluginDecoder config
+	decoder, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
+		DecodeHook: pluginDecoder,
+		Result:     pluginData,
+	})
+	if err != nil {
+		return fmt.Errorf("create plugin decoder failed: %w", err)
+	}
+	// 2. decode rawOptions to structData
+	if err := decoder.Decode(rawOptions); err != nil {
+		return fmt.Errorf("decode plugin option failed: %w", err)
+	}
+	return nil
+}
+
+func pluginDecoder(f reflect.Type, t reflect.Type, data interface{}) (interface{}, error) {
+	switch t {
+	// set git.RepoInfo default value
+	case reflect.TypeOf(&git.RepoInfo{}):
+		repoData := new(git.RepoInfo)
+		if err := mapstructure.Decode(data, repoData); err != nil {
+			return nil, err
+		}
+		if err := repoData.SetDefault(); err != nil {
+			return nil, err
+		}
+		return mapz.DecodeStructToMap(repoData)
+	}
+	return data, nil
+}

internal/pkg/plugin/installer/reposcaffolding/validate.go

@@ -0,0 +1,66 @@
+package util_test
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/devstream-io/devstream/internal/pkg/configmanager"
+	"github.com/devstream-io/devstream/internal/pkg/plugin/installer/util"
+	"github.com/devstream-io/devstream/pkg/util/scm/git"
+)
+
+var _ = Describe("DecodePlugin func", func() {
+	var (
+		plugData *mockStruct
+		rawData  configmanager.RawOptions
+	)
+	When("decoder is not valid", func() {
+		BeforeEach(func() {
+			plugData = nil
+		})
+		It("should return error", func() {
+			err := util.DecodePlugin(rawData, plugData)
+			Expect(err).Should(HaveOccurred())
+			Expect(err.Error()).Should(ContainSubstring("create plugin decoder failed"))
+		})
+	})
+	When("options is not valid", func() {
+		BeforeEach(func() {
+			plugData = new(mockStruct)
+			rawData = map[string]any{
+				"scm": map[string]any{"key": "not_exist"},
+			}
+		})
+		It("should return error", func() {
+			err := util.DecodePlugin(rawData, plugData)
+			Expect(err).Should(HaveOccurred())
+			Expect(err.Error()).Should(ContainSubstring("decode plugin option failed"))
+		})
+	})
+
+	When("all params are valid", func() {
+		BeforeEach(func() {
+			plugData = new(mockStruct)
+			rawData = map[string]any{
+				"scm": map[string]any{
+					"url": "github.com/test/test_repo",
+				},
+			}
+		})
+
+		It("should set default value", func() {
+			err := util.DecodePlugin(rawData, plugData)
+			Expect(err).ShouldNot(HaveOccurred())
+			Expect(plugData).Should(Equal(&mockStruct{
+				Scm: &git.RepoInfo{
+					Owner:    "test",
+					Repo:     "test_repo",
+					Branch:   "main",
+					RepoType: "github",
+					CloneURL: "github.com/test/test_repo",
+					NeedAuth: false,
+				},
+			}))
+		})
+	})
+})

internal/pkg/plugin/installer/util/decode.go

@@ -0,0 +1,24 @@
+package util_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/devstream-io/devstream/pkg/util/scm/git"
+)
+
+func TestCommon(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Plugin Installer Util Suite")
+}
+
+type mockStruct struct {
+	Scm        *git.RepoInfo `mapstructure:"scm"`
+	DeepStruct deepStruct    `mapstructure:"deepStruct"`
+}
+
+type deepStruct struct {
+	DeepStr string `mapstructure:"deepStr" validate:"required"`
+}

internal/pkg/plugin/installer/util/decode_test.go

@@ -3,7 +3,6 @@ package reposcaffolding
 import (
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 	"github.com/devstream-io/devstream/internal/pkg/plugin/installer"
-	"github.com/devstream-io/devstream/internal/pkg/plugin/installer/reposcaffolding"
 	"github.com/devstream-io/devstream/internal/pkg/statemanager"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -12,12 +11,12 @@ func Create(options configmanager.RawOptions) (statemanager.ResourceStatus, erro
 	// Initialize Operator with Operations
 	operator := &installer.Operator{
 		PreExecuteOperations: installer.PreExecuteOperations{
-			reposcaffolding.Validate,
+			validate,
 		},
 		ExecuteOperations: installer.ExecuteOperations{
-			reposcaffolding.InstallRepo,
+			installRepo,
 		},
-		GetStatusOperation: reposcaffolding.GetDynamicStatus,
+		GetStatusOperation: getDynamicStatus,
 	}
 
 	// Execute all Operations in Operator

internal/pkg/plugin/installer/util/util_suite_test.go

@@ -3,17 +3,16 @@ package reposcaffolding
 import (
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 	"github.com/devstream-io/devstream/internal/pkg/plugin/installer"
-	"github.com/devstream-io/devstream/internal/pkg/plugin/installer/reposcaffolding"
 )
 
 func Delete(options configmanager.RawOptions) (bool, error) {
 	// Initialize Operator with Operations
 	operator := &installer.Operator{
 		PreExecuteOperations: installer.PreExecuteOperations{
-			reposcaffolding.Validate,
+			validate,
 		},
 		ExecuteOperations: installer.ExecuteOperations{
-			reposcaffolding.DeleteRepo,
+			deleteRepo,
 		},
 	}
 	_, err := operator.Execute(options)

internal/pkg/plugin/reposcaffolding/create.go

@@ -1,27 +1,16 @@
 package reposcaffolding
 
 import (
-	"github.com/mitchellh/mapstructure"
-
-	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 	"github.com/devstream-io/devstream/pkg/util/scm/git"
 )
 
-type Options struct {
+type options struct {
 	SourceRepo      *git.RepoInfo `validate:"required" mapstructure:"sourceRepo"`
 	DestinationRepo *git.RepoInfo `validate:"required" mapstructure:"destinationRepo"`
 	Vars            map[string]interface{}
 }
 
-func NewOptions(options configmanager.RawOptions) (*Options, error) {
-	var opts Options
-	if err := mapstructure.Decode(options, &opts); err != nil {
-		return nil, err
-	}
-	return &opts, nil
-}
-
-func (opts *Options) renderTplConfig() map[string]interface{} {
+func (opts *options) renderTplConfig() map[string]interface{} {
 	// default render value from repo
 	renderConfig := map[string]any{
 		"AppName": opts.DestinationRepo.GetRepoName(),

internal/pkg/plugin/reposcaffolding/delete.go

@@ -4,16 +4,15 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
-	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 	"github.com/devstream-io/devstream/pkg/util/scm/git"
 )
 
 var _ = Describe("Options struct", func() {
 	var (
-		opts *Options
+		opts *options
 	)
 	BeforeEach(func() {
-		opts = &Options{
+		opts = &options{
 			SourceRepo: &git.RepoInfo{
 				Repo:     "source_repo",
 				Owner:    "source_owner",
@@ -26,33 +25,6 @@ var _ = Describe("Options struct", func() {
 			},
 		}
 	})
-	Context("NewOptions method", func() {
-		var (
-			rawOptions configmanager.RawOptions
-		)
-		BeforeEach(func() {
-			rawOptions = configmanager.RawOptions{
-				"sourceRepo": map[string]string{
-					"owner":   "test_user",
-					"name":    "test_repo",
-					"scmType": "github",
-				},
-				"destinationRepo": map[string]string{
-					"owner":   "dst_user",
-					"name":    "dst_repo",
-					"scmType": "github",
-				},
-			}
-		})
-		It("should work normal", func() {
-			opts, err := NewOptions(rawOptions)
-			Expect(err).Error().ShouldNot(HaveOccurred())
-			Expect(opts.SourceRepo.Owner).Should(Equal("test_user"))
-			Expect(opts.SourceRepo.Repo).Should(Equal("test_repo"))
-			Expect(opts.DestinationRepo.Owner).Should(Equal("dst_user"))
-			Expect(opts.DestinationRepo.Repo).Should(Equal("dst_repo"))
-		})
-	})
 
 	Context("renderTplConfig method", func() {
 		var (

…ugin/installer/reposcaffolding/option.go …nal/pkg/plugin/reposcaffolding/option.gointernal/pkg/plugin/installer/reposcaffolding/option.go renamed to internal/pkg/plugin/reposcaffolding/option.go internal/pkg/plugin/installer/reposcaffolding/option.go renamed to internal/pkg/plugin/reposcaffolding/option.go

@@ -3,17 +3,16 @@ package reposcaffolding
 import (
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 	"github.com/devstream-io/devstream/internal/pkg/plugin/installer"
-	"github.com/devstream-io/devstream/internal/pkg/plugin/installer/reposcaffolding"
 	"github.com/devstream-io/devstream/internal/pkg/statemanager"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
 func Read(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	operator := &installer.Operator{
 		PreExecuteOperations: installer.PreExecuteOperations{
-			reposcaffolding.Validate,
+			validate,
 		},
-		GetStatusOperation: reposcaffolding.GetDynamicStatus,
+		GetStatusOperation: getDynamicStatus,
 	}
 
 	status, err := operator.Execute(options)