test: add some uts for configmanager

Signed-off-by: Daniel Hu <[email protected]>

Author: daniel-hutao

cmd/plugin/argocdapp/main.go

@@ -13,22 +13,22 @@ const NAME = "argocdapp"
 // Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
-// Create implements the installation of an ArgoCD app.
+// Create implements the create of an argocdapp.
 func (p Plugin) Create(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return argocdapp.Create(options)
 }
 
-// Update implements the installation of an ArgoCD app.
+// Update implements the update of an argocdapp.
 func (p Plugin) Update(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return argocdapp.Update(options)
 }
 
-// Read implements the healthy check of ArgoCD app.
+// Read implements the read of argocdapp.
 func (p Plugin) Read(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return argocdapp.Read(options)
 }
 
-// Delete Deletes the installation of an ArgoCD app.
+// Delete implements the delete of argocdapp.
 func (p Plugin) Delete(options configmanager.RawOptions) (bool, error) {
 	return argocdapp.Delete(options)
 }

cmd/plugin/github-actions/main.go

@@ -13,22 +13,22 @@ const NAME = "github-actions"
 // Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
-// Create implements the installation of some GitHub Actions workflows.
+// Create implements the create of github-actions.
 func (p Plugin) Create(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return general.Create(options)
 }
 
-// Update implements the installation of some GitHub Actions workflows.
+// Update implements the update of github-actions.
 func (p Plugin) Update(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return general.Update(options)
 }
 
-// Read implements the healthy check of GitHub Actions workflows.
+// Read implements the read of github-actions.
 func (p Plugin) Read(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return general.Read(options)
 }
 
-// Delete implements the installation of some GitHub Actions workflows.
+// Delete implements the delete of github-actions.
 func (p Plugin) Delete(options configmanager.RawOptions) (bool, error) {
 	return general.Delete(options)
 }

cmd/plugin/githubactions-golang/main.go

@@ -13,22 +13,22 @@ const NAME = "githubactions-golang"
 // Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
-// Create implements the installation of some GitHub Actions workflows.
+// Create implements the create of githubactions-golang.
 func (p Plugin) Create(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return golang.Create(options)
 }
 
-// Update implements the installation of some GitHub Actions workflows.
+// Update implements the update of githubactions-golang.
 func (p Plugin) Update(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return golang.Update(options)
 }
 
-// Read implements the healthy check of GitHub Actions workflows.
+// Read implements the read of githubactions-golang.
 func (p Plugin) Read(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return golang.Read(options)
 }
 
-// Delete implements the installation of some GitHub Actions workflows.
+// Delete implements the delete of githubactions-golang.
 func (p Plugin) Delete(options configmanager.RawOptions) (bool, error) {
 	return golang.Delete(options)
 }

cmd/plugin/githubactions-nodejs/main.go

@@ -13,22 +13,22 @@ const NAME = "githubactions-nodejs"
 // Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
-// Create implements the installation of some GitHub Actions workflows.
+// Create implements the create of githubactions-nodejs.
 func (p Plugin) Create(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return nodejs.Create(options)
 }
 
-// Update implements the installation of some GitHub Actions workflows.
+// Update implements the update of githubactions-nodejs.
 func (p Plugin) Update(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return nodejs.Update(options)
 }
 
-// Read implements the healthy check of GitHub Actions workflows.
+// Read implements the read of githubactions-nodejs.
 func (p Plugin) Read(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return nodejs.Read(options)
 }
 
-// Delete implements the installation of some GitHub Actions workflows.
+// Delete implements the delete of githubactions-nodejs.
 func (p Plugin) Delete(options configmanager.RawOptions) (bool, error) {
 	return nodejs.Delete(options)
 }

cmd/plugin/githubactions-python/main.go

@@ -13,22 +13,22 @@ const NAME = "githubactions-python"
 // Plugin is the type used by DevStream core. It's a string.
 type Plugin string
 
-// Create implements the installation of some GitHub Actions workflows.
+// Create implements the create of some githubactions-python.
 func (p Plugin) Create(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return python.Create(options)
 }
 
-// Update implements the installation of some GitHub Actions workflows.
+// Update implements the update of some githubactions-python.
 func (p Plugin) Update(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return python.Update(options)
 }
 
-// Read implements the healthy check of GitHub Actions workflows.
+// Read implements the read of githubactions-python.
 func (p Plugin) Read(options configmanager.RawOptions) (statemanager.ResourceStatus, error) {
 	return python.Read(options)
 }
 
-// Delete implements the installation of some GitHub Actions workflows.
+// Delete implements the delete of some githubactions-python.
 func (p Plugin) Delete(options configmanager.RawOptions) (bool, error) {
 	return python.Delete(options)
 }

internal/pkg/configmanager/configmanager_test.go

@@ -93,8 +93,9 @@ pipelineTemplates:
       repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
 `
 
+var tmpWorkDir string
+
 var _ = Describe("LoadConfig", func() {
-	var tmpWorkDir string
 
 	tool1 := &Tool{
 		Name:       "plugin1",
@@ -270,6 +271,28 @@ var _ = Describe("LoadConfig", func() {
 	})
 })
 
+var _ = Describe("getConfigFromFile", func() {
+	BeforeEach(func() {
+		tmpWorkDir = GinkgoT().TempDir()
+		err := os.WriteFile(filepath.Join(tmpWorkDir, "config.yaml"), []byte(configFileStr), 0644)
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	When("get config from file", func() {
+		It("should return a config", func() {
+			mgr := NewManager(filepath.Join(tmpWorkDir, "config.yaml"))
+			cfg, err := mgr.getConfigFromFile()
+			Expect(err).NotTo(HaveOccurred())
+			Expect(cfg.Config.State.Backend).To(Equal("local"))
+			Expect(cfg.Vars["foo1"]).To(Equal("bar1"))
+			Expect(len(cfg.Apps)).To(Equal(1))
+			Expect(cfg.Apps[0].Name).To(Equal("service-a"))
+			Expect(len(cfg.Tools)).To(Equal(2))
+			Expect(cfg.Tools[1].Name).To(Equal("plugin2"))
+		})
+	})
+})
+
 var _ = Describe("escapeBrackets", func() {
 	When("escape brackets", func() {
 		It("should works right", func() {

internal/pkg/configmanager/tool.go

@@ -55,15 +55,15 @@ func (t *Tool) String() string {
 
 type Tools []*Tool
 
-func (ts Tools) validateAll() error {
+func (tools Tools) validateAll() error {
 	var errs []error
-	errs = append(errs, ts.validate()...)
-	errs = append(errs, ts.validateDependency()...)
+	errs = append(errs, tools.validate()...)
+	errs = append(errs, tools.validateDependsOnConfig()...)
 	return multierr.Combine(errs...)
 }
 
-func (ts Tools) validate() (errs []error) {
-	for _, tool := range ts {
+func (tools Tools) validate() (errs []error) {
+	for _, tool := range tools {
 		errs = append(errs, tool.validate()...)
 	}
 	return
@@ -116,36 +116,36 @@ func (t *Tool) GetPluginMD5FileNameWithOSAndArch(os, arch string) string {
 	return t.GetPluginNameWithOSAndArch(os, arch) + ".md5"
 }
 
-func (ts Tools) validateDependency() []error {
-	errors := make([]error, 0)
+// validateDependsOnConfig is used to validate all tools' DependsOn config
+func (tools Tools) validateDependsOnConfig() (retErrs []error) {
+	retErrs = make([]error, 0)
+	toolKeySet := make(map[string]struct{})
 
-	// config "set" (map)
-	toolMap := make(map[string]bool)
-	// creating the set
-	for _, tool := range ts {
-		toolMap[tool.KeyWithNameAndInstanceID()] = true
+	// record all tools' key with name.instanceID
+	for _, tool := range tools {
+		toolKeySet[tool.KeyWithNameAndInstanceID()] = struct{}{}
 	}
 
-	for _, tool := range ts {
-		// no dependency, pass
+	validateOneTool := func(tool *Tool) (errs []error) {
+		errs = make([]error, 0)
 		if len(tool.DependsOn) == 0 {
-			continue
+			return
 		}
-
-		// for each dependency
-		for _, dependency := range tool.DependsOn {
-			// skip empty string
-			dependency = strings.TrimSpace(dependency)
-			if dependency == "" {
+		for _, d := range tool.DependsOn {
+			if strings.TrimSpace(d) == "" {
 				continue
 			}
 
-			// generate an error if the dependency isn't in the config set,
-			if _, ok := toolMap[dependency]; !ok {
-				errors = append(errors, fmt.Errorf("tool %s's dependency %s doesn't exist in the config", tool.InstanceID, dependency))
+			if _, ok := toolKeySet[d]; !ok {
+				errs = append(errs, fmt.Errorf("t %s's DependsOn %s doesn't exist", tool.InstanceID, d))
 			}
 		}
+		return
+	}
+
+	for _, t := range tools {
+		retErrs = append(retErrs, validateOneTool(t)...)
 	}
 
-	return errors
+	return
 }

internal/pkg/configmanager/tool_test.go

@@ -8,41 +8,62 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-var _ = Describe("Dependency", func() {
-	Context("singe dep", func() {
-		tools := Tools{
-			{InstanceID: "argocd", Name: "argocd"},
-			{InstanceID: "argocdapp", Name: "argocdapp", DependsOn: []string{"argocd.argocd"}},
-		}
-		errors := tools.validateDependency()
-		Expect(len(errors)).To(Equal(0))
-	})
+var tools Tools
 
-	Context("dep not exist", func() {
-		tools := Tools{
-			{InstanceID: "argocdapp", Name: "argocdapp", DependsOn: []string{"argocd.argocd"}},
-		}
-		errors := tools.validateDependency()
-		Expect(len(errors)).To(Equal(1))
+var _ = Describe("validateDependsOnConfig", func() {
+	When("empty dep", func() {
+		BeforeEach(func() {
+			tools = Tools{
+				{InstanceID: "ins-1", Name: "plugin1"},
+				{InstanceID: "ins-2", Name: "plugin2"},
+			}
+		})
+		It("should not have errors", func() {
+			errs := tools.validateDependsOnConfig()
+			Expect(len(errs)).To(Equal(0))
+		})
 	})
 
-	Context("multi-dep", func() {
-		tools := Tools{
-			{InstanceID: "argocd", Name: "argocd"},
-			{InstanceID: "repo", Name: "github"},
-			{InstanceID: "argocdapp", Name: "argocdapp", DependsOn: []string{"argocd.argocd", "github.repo"}},
-		}
-		errors := tools.validateDependency()
-		Expect(len(errors)).To(Equal(0))
+	When("singe dep", func() {
+		BeforeEach(func() {
+			tools = Tools{
+				{InstanceID: "ins-1", Name: "plugin1"},
+				{InstanceID: "ins-2", Name: "plugin2"},
+			}
+		})
+		It("should not have errors", func() {
+			tools[1].DependsOn = []string{"plugin1.ins-1"}
+			errs := tools.validateDependsOnConfig()
+			Expect(len(errs)).To(Equal(0))
+		})
+		It("should has some errors", func() {
+			tools[1].DependsOn = []string{"plugin1.ins-2"}
+			errs := tools.validateDependsOnConfig()
+			Expect(len(errs)).To(Equal(1))
+		})
 	})
 
-	Context("empty dep", func() {
-		tools := Tools{
-			{InstanceID: "argocd", Name: "argocd"},
-			{InstanceID: "argocdapp", Name: "argocdapp", DependsOn: []string{}},
-		}
-		errors := tools.validateDependency()
-		Expect(len(errors)).To(Equal(0))
+	When("multi-dep", func() {
+		BeforeEach(func() {
+			tools = Tools{
+				{InstanceID: "ins-1", Name: "plugin1"},
+				{InstanceID: "ins-2", Name: "plugin2"},
+				{InstanceID: "ins-3", Name: "plugin3"},
+			}
+		})
+		It("should not have errors", func() {
+			tools[2].DependsOn = []string{"plugin1.ins-1"}
+			tools[2].DependsOn = []string{"plugin2.ins-2"}
+			tools[1].DependsOn = []string{"plugin1.ins-1"}
+			errs := tools.validateDependsOnConfig()
+			Expect(len(errs)).To(Equal(0))
+		})
+		It("should has some errors", func() {
+			tools[1].DependsOn = []string{"plugin1.ins-3"}
+			tools[2].DependsOn = []string{"plugin1.ins-2", "plugin2.ins-1"}
+			errs := tools.validateDependsOnConfig()
+			Expect(len(errs)).To(Equal(3))
+		})
 	})
 })
 

internal/pkg/pluginengine/change.go

@@ -30,7 +30,7 @@ func (c *Change) String() string {
 		c.ActionName, c.Tool.Name, c.Tool.InstanceID)
 }
 
-// execute changes in the plan in batch.
+// execute changes the plan in batch.
 // If any error occurs, it will stop executing the next batches and return the error.
 func execute(smgr statemanager.Manager, changes []*Change, reverse bool) map[string]error {
 	errorsMap := make(map[string]error)