refactor: helm-installer to make code more clear

Signed-off-by: Bird <[email protected]>

Author: aFlyBird0

internal/pkg/plugin/helminstaller/defaults/argocd.go

@@ -8,7 +8,7 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-var toolArgoCD = "argocd"
+const toolArgoCD = "argocd"
 
 var DefaultConfigWithArgoCD = helm.Options{
 	Chart: helmCommon.Chart{
@@ -28,8 +28,7 @@ var DefaultConfigWithArgoCD = helm.Options{
 }
 
 func init() {
-	DefaultOptionsMap[toolArgoCD] = &DefaultConfigWithArgoCD
-	StatusGetterFuncMap[toolArgoCD] = GetArgoCDStatus
+	RegisterDefaultHelmAppInstance(toolArgoCD, &DefaultConfigWithArgoCD, GetArgoCDStatus)
 }
 
 func GetArgoCDStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {

internal/pkg/plugin/helminstaller/defaults/artifactory.go

@@ -8,7 +8,7 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-var toolArtifactory = "artifactory"
+const toolArtifactory = "artifactory"
 
 var DefaultConfigWithArtifactory = helm.Options{
 	Chart: helmCommon.Chart{
@@ -28,8 +28,7 @@ var DefaultConfigWithArtifactory = helm.Options{
 }
 
 func init() {
-	DefaultOptionsMap[toolArtifactory] = &DefaultConfigWithArtifactory
-	StatusGetterFuncMap[toolArtifactory] = GetArtifactoryStatus
+	RegisterDefaultHelmAppInstance(toolArtifactory, &DefaultConfigWithArtifactory, GetArtifactoryStatus)
 }
 
 func GetArtifactoryStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {

internal/pkg/plugin/helminstaller/defaults/defaultconfig.go

@@ -0,0 +1,13 @@
+package defaults_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestDefaults(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Defaults Suite")
+}

internal/pkg/plugin/helminstaller/defaults/defaults_suite_test.go

@@ -11,9 +11,10 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-const DevLakeSvcName = "devlake-lake"
-
-var toolDevLake = "devlake"
+const (
+	DevLakeSvcName = "devlake-lake"
+	toolDevLake    = "devlake"
+)
 
 var DefaultConfigWithDevLake = helm.Options{
 	Chart: helmCommon.Chart{
@@ -33,8 +34,7 @@ var DefaultConfigWithDevLake = helm.Options{
 }
 
 func init() {
-	DefaultOptionsMap[toolDevLake] = &DefaultConfigWithDevLake
-	StatusGetterFuncMap[toolDevLake] = GetDevLakeStatus
+	RegisterDefaultHelmAppInstance(toolDevLake, &DefaultConfigWithDevLake, GetDevLakeStatus)
 }
 
 func GetDevLakeStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {

internal/pkg/plugin/helminstaller/defaults/devlake.go

@@ -8,7 +8,7 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-var toolHarbor = "harbor"
+const toolHarbor = "harbor"
 
 var DefaultConfigWithHarbor = helm.Options{
 	Chart: helmCommon.Chart{
@@ -28,8 +28,7 @@ var DefaultConfigWithHarbor = helm.Options{
 }
 
 func init() {
-	DefaultOptionsMap[toolHarbor] = &DefaultConfigWithHarbor
-	StatusGetterFuncMap[toolHarbor] = GetHarborStatus
+	RegisterDefaultHelmAppInstance(toolHarbor, &DefaultConfigWithHarbor, GetHarborStatus)
 }
 
 func GetHarborStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {

internal/pkg/plugin/helminstaller/defaults/harbor.go

@@ -0,0 +1,52 @@
+package defaults
+
+import (
+	"strings"
+	"sync"
+
+	"github.com/devstream-io/devstream/internal/pkg/plugin/installer"
+	"github.com/devstream-io/devstream/internal/pkg/plugin/installer/helm"
+)
+
+type HelmAppInstance struct {
+	Name         string
+	HelmOptions  *helm.Options
+	StatusGetter installer.StatusGetterOperation
+}
+
+var (
+	helmAppInstances map[string]*HelmAppInstance
+	once             sync.Once
+)
+
+func RegisterDefaultHelmAppInstance(name string, options *helm.Options, statusGetter installer.StatusGetterOperation) {
+	// make sure the map is initialized only once
+	once.Do(func() {
+		helmAppInstances = make(map[string]*HelmAppInstance)
+	})
+
+	helmAppInstances[name] = &HelmAppInstance{
+		Name:         name,
+		HelmOptions:  options,
+		StatusGetter: statusGetter,
+	}
+}
+
+// GetDefaultHelmAppInstanceByInstanceID will return the default helm app instance
+// by matching the prefix of given instanceID and the list of helm app instances names.
+// It will return the longest matched name if there are multiple matched names, and return nil if no matched name is found.
+// e.g. instanceID="argocd-config-001", "argocd" and "argocd-config" both are supported helm charts,
+// then the HelmAppInstance named "argocd-config" will be returned.
+func GetDefaultHelmAppInstanceByInstanceID(instanceID string) *HelmAppInstance {
+	longestMatchedName := ""
+	for curNameToMatch := range helmAppInstances {
+		if strings.HasPrefix(instanceID, curNameToMatch) && len(curNameToMatch) > len(longestMatchedName) {
+			longestMatchedName = curNameToMatch
+		}
+	}
+
+	if longestMatchedName != "" {
+		return helmAppInstances[longestMatchedName]
+	}
+	return nil
+}

internal/pkg/plugin/helminstaller/defaults/instance.go

@@ -0,0 +1,60 @@
+package defaults
+
+import (
+	"reflect"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("instance test", func() {
+	var (
+		instanceID string
+		instance   *HelmAppInstance
+	)
+
+	// main logic to get the default instance
+	JustBeforeEach(func() {
+		instance = GetDefaultHelmAppInstanceByInstanceID(instanceID)
+	})
+
+	Context("GetDefaultHelmAppInstanceByInstanceID", func() {
+		When("instanceID is not exists", func() {
+			BeforeEach(func() {
+				instanceID = "not-exists"
+			})
+			It("should return nil", func() {
+				// main logic is in JustBeforeEach
+				Expect(instance).To(BeNil())
+			})
+		})
+
+		When("instanceID is exists(argocd)", func() {
+			JustAfterEach(func() {
+				Expect(instance).NotTo(BeNil())
+				Expect(instance.Name).To(Equal("argocd"))
+				Expect(*instance.HelmOptions).To(Equal(DefaultConfigWithArgoCD))
+				pointer1 := reflect.ValueOf(instance.StatusGetter).Pointer()
+				pointer2 := reflect.ValueOf(GetArgoCDStatus).Pointer()
+				Expect(pointer1).To(Equal(pointer2))
+			})
+			When(`instanceID is the same as "argocd"`, func() {
+				BeforeEach(func() {
+					instanceID = "argocd"
+				})
+				It("should return instance", func() {
+					// main logic is in JustAfterEach
+				})
+			})
+
+			When(`instanceID has prefix "argocd"`, func() {
+				BeforeEach(func() {
+					instanceID = "argocd-001"
+				})
+				It("should return instance", func() {
+					// main logic is in JustAfterEach
+				})
+			})
+		})
+	})
+})

internal/pkg/plugin/helminstaller/defaults/instance_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-var toolJenkins = "jenkins"
+const toolJenkins = "jenkins"
 
 var DefaultConfigWithJenkins = helm.Options{
 	Chart: helmCommon.Chart{
@@ -31,8 +31,7 @@ var DefaultConfigWithJenkins = helm.Options{
 }
 
 func init() {
-	DefaultOptionsMap[toolJenkins] = &DefaultConfigWithJenkins
-	StatusGetterFuncMap[toolJenkins] = GetJenkinsStatus
+	RegisterDefaultHelmAppInstance(toolJenkins, &DefaultConfigWithJenkins, GetJenkinsStatus)
 }
 
 func GetJenkinsStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {

internal/pkg/plugin/helminstaller/defaults/jenkins.go

@@ -8,7 +8,7 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-var toolKubePrometheus = "kube-prometheus"
+const toolKubePrometheus = "kube-prometheus"
 
 var DefaultConfigWithKubePrometheus = helm.Options{
 	Chart: helmCommon.Chart{
@@ -28,8 +28,7 @@ var DefaultConfigWithKubePrometheus = helm.Options{
 }
 
 func init() {
-	DefaultOptionsMap[toolKubePrometheus] = &DefaultConfigWithKubePrometheus
-	StatusGetterFuncMap[toolKubePrometheus] = GetKubePrometheusStatus
+	RegisterDefaultHelmAppInstance(toolKubePrometheus, &DefaultConfigWithKubePrometheus, GetKubePrometheusStatus)
 }
 
 func GetKubePrometheusStatus(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {