Merge pull request #1247 from merico-dev/test-ht

Refactor: Remove `types` Package(vars.go and error.go) in `backend` Package

Author: IronCore864

internal/pkg/backend/backend.go

@@ -1,12 +1,12 @@
 package backend
 
 import (
+	"fmt"
 	"strings"
 
 	"github.com/devstream-io/devstream/internal/pkg/backend/k8s"
 	"github.com/devstream-io/devstream/internal/pkg/backend/local"
 	"github.com/devstream-io/devstream/internal/pkg/backend/s3"
-	"github.com/devstream-io/devstream/internal/pkg/backend/types"
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 )
 
@@ -18,18 +18,27 @@ type Backend interface {
 	Write(data []byte) error
 }
 
+type Type string
+
+const (
+	LocalBackend    Type = "local"
+	S3Backend       Type = "s3"
+	K8sBackend      Type = "k8s"
+	K8sBackendAlias Type = "kubernetes"
+)
+
 // GetBackend will return a Backend by the given name.
 func GetBackend(state configmanager.State) (Backend, error) {
-	typeName := types.Type(strings.ToLower(state.Backend))
+	typeName := Type(strings.ToLower(string(state.Backend)))
 
 	switch typeName {
-	case types.Local:
+	case LocalBackend:
 		return local.NewLocal(state.Options.StateFile)
-	case types.S3:
+	case S3Backend:
 		return s3.NewS3Backend(state.Options.Bucket, state.Options.Region, state.Options.Key)
-	case types.K8s, types.K8sAlias:
+	case K8sBackend, K8sBackendAlias:
 		return k8s.NewBackend(state.Options.Namespace, state.Options.ConfigMap)
 	default:
-		return nil, types.NewInvalidBackendErr(state.Backend)
+		return nil, fmt.Errorf("the backend type < %s > is illegal", state.Backend)
 	}
 }

internal/pkg/backend/backend_test.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/devstream-io/devstream/internal/pkg/backend"
 	"github.com/devstream-io/devstream/internal/pkg/backend/local"
-	"github.com/devstream-io/devstream/internal/pkg/backend/types"
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 )
 
@@ -32,7 +31,6 @@ var _ = Describe("GetBackend", func() {
 			state := configmanager.State{Backend: "not_exist_plug"}
 			_, err := backend.GetBackend(state)
 			Expect(err).Error().Should(HaveOccurred())
-			Expect(types.IsInvalidBackendErr(err)).To(BeTrue())
 		})
 	})
 
@@ -41,7 +39,6 @@ var _ = Describe("GetBackend", func() {
 			state := configmanager.State{Backend: "s3"}
 			_, err := backend.GetBackend(state)
 			Expect(err).Error().Should(HaveOccurred())
-			Expect(types.IsBackendOptionErr(err)).To(BeTrue())
 		})
 	})
 })

internal/pkg/backend/s3/validate.go

@@ -3,7 +3,6 @@ package s3
 import (
 	"fmt"
 
-	"github.com/devstream-io/devstream/internal/pkg/backend/types"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
@@ -23,7 +22,7 @@ func validate(bucket, region, key string) error {
 		for _, err := range errs {
 			log.Error(err)
 		}
-		return types.NewBackendOptionErr(types.S3)
+		return fmt.Errorf("s3 Backend config error")
 	}
 
 	return nil

internal/pkg/backend/s3/validate_test.go

@@ -3,15 +3,12 @@ package s3
 import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-
-	"github.com/devstream-io/devstream/internal/pkg/backend/types"
 )
 
 var _ = Describe("validate", func() {
 	It("should return error s3 option not config", func() {
 		err := validate("", "", "")
 		Expect(err).Error().Should(HaveOccurred())
-		Expect(types.IsBackendOptionErr(err)).To(BeTrue())
 	})
 
 	It("should return true if config s3 valid", func() {

internal/pkg/backend/types/error.go

@@ -11,19 +11,7 @@ import (
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
 )
 
-var _ = Describe("LoadConfig", func() {
-	const (
-		mainConfigFile = "config.yaml"
-		varFile        = "var.yaml"
-		toolFile       = "tool.yaml"
-		appFile        = "app.yaml"
-		templateFile   = "template.yaml"
-		pluginDir      = "./plugins"
-	)
-
-	var tmpDir string
-	var mainConfig string
-	const appConfig = `apps:
+const appConfig = `apps:
   - name: service-A
     spec:
       language: python
@@ -60,7 +48,7 @@ var _ = Describe("LoadConfig", func() {
         vars: # optional, use to render vars in template（valid only if the cd.type is template）
           app: service-A
 `
-	const toolConfig = `tools:
+const toolConfig = `tools:
   - name: plugin1
     instanceID: default
     options:
@@ -71,11 +59,11 @@ var _ = Describe("LoadConfig", func() {
       key1: value1
       key2: [[ var2 ]]
 `
-	const varConfig = `var2: value-of-var2
+const varConfig = `var2: value-of-var2
 var3: dockerhub-overwrite
 argocdNamespace: argocd
 `
-	const templateConfig = `pipelineTemplates:
+const templateConfig = `pipelineTemplates:
   - name: ci-pipeline-1
     type: github-actions # corresponding to a plugin
     options:
@@ -98,19 +86,31 @@ argocdNamespace: argocd
         path: helm/[[ app ]]
         repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
 `
-	var (
-		state = &configmanager.State{
-			Backend: "local",
-			Options: configmanager.StateConfigOptions{
-				StateFile: "devstream.state",
-			},
-		}
 
-		expectedConfig = &configmanager.Config{
-			PluginDir: pluginDir,
-			State:     state,
-		}
-	)
+const (
+	mainConfigFile = "config.yaml"
+	varFile        = "var.yaml"
+	toolFile       = "tool.yaml"
+	appFile        = "app.yaml"
+	templateFile   = "template.yaml"
+	pluginDir      = "./plugins"
+)
+
+var _ = Describe("LoadConfig", func() {
+	var tmpDir string
+	var mainConfig string
+	var state = &configmanager.State{
+		Backend: "local",
+		Options: configmanager.StateConfigOptions{
+			StateFile: "devstream.state",
+		},
+	}
+
+	var expectedConfig = &configmanager.Config{
+		PluginDir: pluginDir,
+		State:     state,
+	}
+
 	BeforeEach(func() {
 		// create files
 		tmpDir = GinkgoT().TempDir()
@@ -125,6 +125,7 @@ argocdNamespace: argocd
 			Expect(err).Should(Succeed())
 		}
 	})
+
 	When("only with config file", func() {
 		BeforeEach(func() {
 			mainConfig = fmt.Sprintf(`# main config
@@ -271,6 +272,7 @@ var1: value-of-var1 # var1 is a global var
 			Expect(config.Tools[4]).Should(Equal(expectedTools5))
 		})
 	})
+
 	When("global file and configFile all has config", func() {
 		BeforeEach(func() {
 			mainConfig = fmt.Sprintf(`# main config
@@ -306,6 +308,7 @@ tools:
 			Expect(len(config.Tools)).Should(Equal(4))
 		})
 	})
+
 	When("with global config", func() {
 		BeforeEach(func() {
 			mainConfig = `
@@ -397,7 +400,6 @@ tools:
 			Expect(len(config.Tools)).Should(Equal(3))
 		})
 	})
-
 })
 
 var _ = Describe("Manager struct", func() {
@@ -434,6 +436,7 @@ tools:
 				Expect(err.Error()).Should(ContainSubstring("no such file or directory"))
 			})
 		})
+
 		When("GetGlobalVars failed", func() {
 			BeforeEach(func() {
 				err := os.WriteFile(fLoc, []byte(`
@@ -449,6 +452,7 @@ state:
 				Expect(err).Error().Should(HaveOccurred())
 			})
 		})
+
 		When("GetTools failed", func() {
 			BeforeEach(func() {
 				err := os.WriteFile(fLoc, []byte(`
@@ -464,6 +468,7 @@ state:
 				Expect(err).Error().Should(HaveOccurred())
 			})
 		})
+
 		When("getApps failed", func() {
 			BeforeEach(func() {
 				err := os.WriteFile(fLoc, []byte(`