fix: change func name

Signed-off-by: Meng JiaFeng <jiafeng.meng@merico.dev>

Author: steinliber

internal/pkg/configmanager/app.go

@@ -25,8 +25,8 @@ type (
 	}
 )
 
-// getAppTools return app tools
-func getAppTools(appStr string, globalVars map[string]any, templateMap map[string]string) (Tools, error) {
+// getToolsFromApp return app tools
+func getToolsFromApp(appStr string, globalVars map[string]any, templateMap map[string]string) (Tools, error) {
 	//1. render appStr with globalVars
 	appRenderStr, err := renderConfigWithVariables(appStr, globalVars)
 	if err != nil {
@@ -39,14 +39,14 @@ func getAppTools(appStr string, globalVars map[string]any, templateMap map[strin
 		return nil, fmt.Errorf("app parse yaml failed: %w", err)
 	}
 	rawData.setDefault()
-	appVars := mapz.MergeMaps(globalVars, rawData.Spec)
+	appVars := mapz.Merge(globalVars, rawData.Spec)
 	// 3. generate app repo and tempalte repo from scmInfo
 	repoScaffoldingTool, err := rawData.getRepoTemplateTool(appVars)
 	if err != nil {
 		return nil, fmt.Errorf("app[%s] get repo failed: %w", rawData.Name, err)
 	}
 	// 4. get ci/cd pipelineTemplates
-	tools, err := rawData.getPipelineTools(templateMap, appVars)
+	tools, err := rawData.generateCICDToolsFromAppConfig(templateMap, appVars)
 	if err != nil {
 		return nil, fmt.Errorf("app[%s] get pipeline tools failed: %w", rawData.Name, err)
 	}
@@ -57,7 +57,7 @@ func getAppTools(appStr string, globalVars map[string]any, templateMap map[strin
 }
 
 // getAppPipelineTool generate ci/cd tools from app config
-func (a *appRaw) getPipelineTools(templateMap map[string]string, appVars map[string]any) (Tools, error) {
+func (a *appRaw) generateCICDToolsFromAppConfig(templateMap map[string]string, appVars map[string]any) (Tools, error) {
 	allPipelineRaw := append(a.CIRawConfigs, a.CDRawConfigs...)
 	var tools Tools
 	for _, p := range allPipelineRaw {
@@ -69,7 +69,7 @@ func (a *appRaw) getPipelineTools(templateMap map[string]string, appVars map[str
 		if err != nil {
 			return nil, err
 		}
-		pipelineTool.DependsOn = a.getRepoTemplateDepends()
+		pipelineTool.DependsOn = a.getRepoTemplateDependants()
 		tools = append(tools, *pipelineTool)
 	}
 	return tools, nil
@@ -108,7 +108,7 @@ func (a *appRaw) setDefault() {
 }
 
 // since all plugin depends on code is deployed, get dependsOn for repoTemplate
-func (a *appRaw) getRepoTemplateDepends() []string {
+func (a *appRaw) getRepoTemplateDependants() []string {
 	var dependsOn []string
 	// if a.RepoTemplate is configured, pipeline need to wait reposcaffolding finished
 	if a.RepoTemplate != nil {

internal/pkg/configmanager/app_test.go

@@ -7,7 +7,7 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/scm"
 )
 
-var _ = Describe("getAppTools func", func() {
+var _ = Describe("getToolsFromApp func", func() {
 	var (
 		appStr      string
 		globalVars  map[string]any
@@ -25,7 +25,7 @@ var _ = Describe("getAppTools func", func() {
 			}
 		})
 		It("should return err", func() {
-			_, err := getAppTools(appStr, globalVars, templateMap)
+			_, err := getToolsFromApp(appStr, globalVars, templateMap)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("app render globalVars failed"))
 		})
@@ -35,7 +35,7 @@ var _ = Describe("getAppTools func", func() {
 			appStr = "fsdfsd{123213}"
 		})
 		It("should return error", func() {
-			_, err := getAppTools(appStr, globalVars, templateMap)
+			_, err := getToolsFromApp(appStr, globalVars, templateMap)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("app parse yaml failed"))
 		})
@@ -51,7 +51,7 @@ ci:
   templateName:`
 		})
 		It("should return error", func() {
-			_, err := getAppTools(appStr, globalVars, templateMap)
+			_, err := getToolsFromApp(appStr, globalVars, templateMap)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("app[test] get pipeline tools failed"))
 		})
@@ -65,7 +65,7 @@ cd:
   templateName:`
 		})
 		It("should return error", func() {
-			_, err := getAppTools(appStr, globalVars, templateMap)
+			_, err := getToolsFromApp(appStr, globalVars, templateMap)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("app.repo field can't be empty"))
 		})
@@ -81,7 +81,7 @@ cd:
   templateName:`
 		})
 		It("should return error", func() {
-			_, err := getAppTools(appStr, globalVars, templateMap)
+			_, err := getToolsFromApp(appStr, globalVars, templateMap)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("app[test] get pipeline tools failed"))
 		})
@@ -184,7 +184,7 @@ options:
 					"instanceID": "service-A",
 				},
 			}
-			tools, err := getAppTools(appStr, globalVars, templateMap)
+			tools, err := getToolsFromApp(appStr, globalVars, templateMap)
 			Expect(err).Error().ShouldNot(HaveOccurred())
 			Expect(tools).ShouldNot(BeNil())
 			Expect(len(tools)).Should(Equal(3))
@@ -222,7 +222,7 @@ var _ = Describe("appRaw struct", func() {
 			})
 		})
 	})
-	Context("getPipelineTools method", func() {
+	Context("generateCICDToolsFromAppConfig method", func() {
 		When("config is not valid", func() {
 			BeforeEach(func() {
 				rawConfig = []pipelineRaw{
@@ -234,7 +234,7 @@ var _ = Describe("appRaw struct", func() {
 				a.CIRawConfigs = rawConfig
 			})
 			It("should return error", func() {
-				_, err := a.getPipelineTools(templateMap, globalVars)
+				_, err := a.generateCICDToolsFromAppConfig(templateMap, globalVars)
 				Expect(err).Error().Should(HaveOccurred())
 				Expect(err.Error()).Should(ContainSubstring(".templateName is required"))
 			})
@@ -252,7 +252,7 @@ var _ = Describe("appRaw struct", func() {
 				a.CIRawConfigs = rawConfig
 			})
 			It("should return pipeline array", func() {
-				p, err := a.getPipelineTools(templateMap, globalVars)
+				p, err := a.generateCICDToolsFromAppConfig(templateMap, globalVars)
 				Expect(err).Error().ShouldNot(HaveOccurred())
 				Expect(len(p)).Should(Equal(2))
 				Expect(p[0].Name).Should(Equal("github-actions"))

internal/pkg/configmanager/config.go

@@ -27,8 +27,8 @@ type (
 		Tools     Tools `yaml:"tools"`
 		State     *State
 	}
-	// ConfigRaw is used to describe original raw configs read from files
-	ConfigRaw struct {
+	// RawConfig is used to describe original raw configs read from files
+	RawConfig struct {
 		VarFile           configFileLoc `yaml:"varFile" mapstructure:"varFile"`
 		ToolFile          configFileLoc `yaml:"toolFile" mapstructure:"toolFile"`
 		AppFile           configFileLoc `yaml:"appFile" mapstructure:"appFile"`
@@ -70,8 +70,8 @@ func (c *Config) validate() error {
 	return nil
 }
 
-// newConfigRaw generate new ConfigRaw options
-func newConfigRaw(configFileLocation string) (*ConfigRaw, error) {
+// newRawConfig generate new RawConfig options
+func newRawConfig(configFileLocation string) (*RawConfig, error) {
 	// 1. get baseDir from configFile
 	baseDir, err := file.GetFileAbsDirPath(configFileLocation)
 	if err != nil {
@@ -87,15 +87,15 @@ func newConfigRaw(configFileLocation string) (*ConfigRaw, error) {
 	// otherwise yaml.Unmarshal can only read the content before the first "---"
 	configBytes = bytes.Replace(configBytes, []byte("---"), []byte("\n"), -1)
 
-	// 3. decode total yaml files to get ConfigRaw
-	var configRaw ConfigRaw
-	if err := yaml.Unmarshal(configBytes, &configRaw); err != nil && !errors.Is(err, io.EOF) {
+	// 3. decode total yaml files to get RawConfig
+	var RawConfig RawConfig
+	if err := yaml.Unmarshal(configBytes, &RawConfig); err != nil && !errors.Is(err, io.EOF) {
 		log.Errorf("Please verify the format of your config. Error: %s.", err)
 		return nil, err
 	}
-	configRaw.configFileBaseDir = baseDir
-	configRaw.globalBytes = configBytes
-	return &configRaw, nil
+	RawConfig.configFileBaseDir = baseDir
+	RawConfig.globalBytes = configBytes
+	return &RawConfig, nil
 }
 
 // loadConfigFile get config file content by location
@@ -112,7 +112,7 @@ func loadConfigFile(fileLoc string) ([]byte, error) {
 }
 
 // getGlobalVars will get global variables from GlobalVars field and varFile content
-func (r *ConfigRaw) getGlobalVars() (map[string]any, error) {
+func (r *RawConfig) getGlobalVars() (map[string]any, error) {
 	valueContent, err := r.VarFile.getContentBytes(r.configFileBaseDir)
 	if err != nil {
 		return nil, err
@@ -127,9 +127,9 @@ func (r *ConfigRaw) getGlobalVars() (map[string]any, error) {
 	return globalVars, nil
 }
 
-// UnmarshalYAML is used for ConfigRaw
+// UnmarshalYAML is used for RawConfig
 // it will put variables fields in globalVars field
-func (r *ConfigRaw) UnmarshalYAML(value *yaml.Node) error {
+func (r *RawConfig) UnmarshalYAML(value *yaml.Node) error {
 	configMap := make(map[string]any)
 	if err := value.Decode(configMap); err != nil {
 		return err
@@ -138,7 +138,7 @@ func (r *ConfigRaw) UnmarshalYAML(value *yaml.Node) error {
 }
 
 // getApps will get Apps from appStr config
-func (r *ConfigRaw) getAppsTools(globalVars map[string]any) (Tools, error) {
+func (r *RawConfig) getAppsTools(globalVars map[string]any) (Tools, error) {
 	// 1. get tools config str
 	yamlPath := "$.apps[*]"
 	fileBytes, err := r.AppFile.getContentBytes(r.configFileBaseDir)
@@ -158,7 +158,7 @@ func (r *ConfigRaw) getAppsTools(globalVars map[string]any) (Tools, error) {
 	// 3. render app with pipelineTemplate and globalVars
 	var tools Tools
 	for _, appConfigStr := range appArray {
-		appTools, err := getAppTools(appConfigStr, globalVars, templateMap)
+		appTools, err := getToolsFromApp(appConfigStr, globalVars, templateMap)
 		if err != nil {
 			return nil, err
 		}
@@ -168,7 +168,7 @@ func (r *ConfigRaw) getAppsTools(globalVars map[string]any) (Tools, error) {
 }
 
 // getTools get Tools from tool config
-func (r *ConfigRaw) getTools(globalVars map[string]any) (Tools, error) {
+func (r *RawConfig) getTools(globalVars map[string]any) (Tools, error) {
 	// 1. get tools config str
 	yamlPath := "$.tools[*]"
 	fileBytes, err := r.ToolFile.getContentBytes(r.configFileBaseDir)
@@ -197,7 +197,7 @@ func (r *ConfigRaw) getTools(globalVars map[string]any) (Tools, error) {
 }
 
 // getPipelineTemplatesMap generate template name/rawString map
-func (r *ConfigRaw) getPipelineTemplatesMap() (map[string]string, error) {
+func (r *RawConfig) getPipelineTemplatesMap() (map[string]string, error) {
 	yamlPath := "$.pipelineTemplates[*]"
 	fileBytes, err := r.TemplateFile.getContentBytes(r.configFileBaseDir)
 	if err != nil {
@@ -225,7 +225,7 @@ func (f configFileLoc) getContentBytes(baseDir string) ([]byte, error) {
 		return []byte{}, nil
 	}
 	// refer other config file path by directory of main config file
-	fileAbs, err := file.GenAbsFilePath(baseDir, string(f))
+	fileAbs, err := file.GenerateAbsFilePath(baseDir, string(f))
 	if err != nil {
 		return nil, err
 	}

internal/pkg/configmanager/config_test.go

@@ -22,7 +22,7 @@ var _ = Describe("Config struct", func() {
 	})
 })
 
-var _ = Describe("newConfigRaw func", func() {
+var _ = Describe("newRawConfig func", func() {
 	var (
 		fLoc    string
 		baseDir string
@@ -38,7 +38,7 @@ var _ = Describe("newConfigRaw func", func() {
 			fLoc = "not_exist"
 		})
 		It("should return err", func() {
-			_, err := newConfigRaw(fLoc)
+			_, err := newRawConfig(fLoc)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("no such file or directory"))
 		})
@@ -49,22 +49,22 @@ var _ = Describe("newConfigRaw func", func() {
 			Expect(err).Error().ShouldNot(HaveOccurred())
 		})
 		It("should return err", func() {
-			_, err := newConfigRaw(fLoc)
+			_, err := newRawConfig(fLoc)
 			Expect(err).Error().Should(HaveOccurred())
 			Expect(err.Error()).Should(ContainSubstring("cannot unmarshal"))
 		})
 	})
 })
 
-var _ = Describe("ConfigRaw struct", func() {
+var _ = Describe("RawConfig struct", func() {
 	var (
-		r          *ConfigRaw
+		r          *RawConfig
 		baseDir    string
 		fLoc       string
 		globalVars map[string]any
 	)
 	BeforeEach(func() {
-		r = &ConfigRaw{}
+		r = &RawConfig{}
 		baseDir = GinkgoT().TempDir()
 		f, err := os.CreateTemp(baseDir, "test")
 		Expect(err).Error().ShouldNot(HaveOccurred())

internal/pkg/configmanager/manager.go

@@ -13,31 +13,31 @@ func NewManager(configFileName string) *Manager {
 // LoadConfig reads an input file as a general config.
 // It will return "non-nil, err" or "nil, err".
 func (m *Manager) LoadConfig() (*Config, error) {
-	// 1. get new ConfigRaw from ConfigFile
-	configRaw, err := newConfigRaw(m.ConfigFile)
+	// 1. get new RawConfig from ConfigFile
+	RawConfig, err := newRawConfig(m.ConfigFile)
 	if err != nil {
 		return nil, err
 	}
 	// 2. get all globals vars
-	globalVars, err := configRaw.getGlobalVars()
+	globalVars, err := RawConfig.getGlobalVars()
 	if err != nil {
 		return nil, err
 	}
-	// 3. get Apps from ConfigRaw
-	appTools, err := configRaw.getAppsTools(globalVars)
+	// 3. get Apps from RawConfig
+	appTools, err := RawConfig.getAppsTools(globalVars)
 	if err != nil {
 		return nil, err
 	}
 
-	// 4. get Tools from ConfigRaw
-	tools, err := configRaw.getTools(globalVars)
+	// 4. get Tools from RawConfig
+	tools, err := RawConfig.getTools(globalVars)
 	if err != nil {
 		return nil, err
 	}
 	tools = append(tools, appTools...)
 	config := &Config{
-		PluginDir: configRaw.PluginDir,
-		State:     configRaw.State,
+		PluginDir: RawConfig.PluginDir,
+		State:     RawConfig.State,
 		Tools:     tools,
 	}
 	//5. validate config is valid

internal/pkg/configmanager/manager_test.go

@@ -424,7 +424,7 @@ tools:
 	})
 
 	Context("LoadConfig method", func() {
-		When("get configRaw failed", func() {
+		When("get RawConfig failed", func() {
 			BeforeEach(func() {
 				m.ConfigFile = "not_exist"
 			})

internal/pkg/configmanager/pipelineTemplate.go

@@ -90,7 +90,7 @@ func (p *pipelineRaw) newPipelineFromTemplate(templateMap map[string]string, glo
 		return nil, fmt.Errorf("%s not found in pipelineTemplates", p.TemplateName)
 	}
 
-	allVars := mapz.MergeMaps(globalVars, p.Vars)
+	allVars := mapz.Merge(globalVars, p.Vars)
 	templateRenderdStr, err := renderConfigWithVariables(templateStr, allVars)
 	if err != nil {
 		return nil, fmt.Errorf("%s render pipelineTemplate failed: %+w", p.TemplateName, err)

pkg/util/file/file.go

@@ -45,8 +45,8 @@ func CopyFile(srcFile, dstFile string) (err error) {
 	return dFile.Sync()
 }
 
-// GenAbsFilePath return all the path with a given file name
-func GenAbsFilePath(baseDir, file string) (string, error) {
+// GenerateAbsFilePath return all the path with a given file name
+func GenerateAbsFilePath(baseDir, file string) (string, error) {
 	file = filepath.Join(baseDir, file)
 
 	fileExist := func(path string) bool {

pkg/util/file/file_test.go

@@ -40,15 +40,15 @@ var _ = Describe("CopyFile func", func() {
 	})
 })
 
-var _ = Describe("GenAbsFilePath func", func() {
+var _ = Describe("GenerateAbsFilePath func", func() {
 	var baseDir, fileName string
 	When("file not exist", func() {
 		BeforeEach(func() {
 			baseDir = "not_exist"
 			fileName = "not_exist"
 		})
 		It("should return err", func() {
-			_, err := file.GenAbsFilePath(baseDir, fileName)
+			_, err := file.GenerateAbsFilePath(baseDir, fileName)
 			Expect(err).Error().Should(HaveOccurred())
 		})
 	})
@@ -60,7 +60,7 @@ var _ = Describe("GenAbsFilePath func", func() {
 			fileName = filepath.Base(testFile.Name())
 		})
 		It("should return absPath", func() {
-			path, err := file.GenAbsFilePath(baseDir, fileName)
+			path, err := file.GenerateAbsFilePath(baseDir, fileName)
 			Expect(err).Error().ShouldNot(HaveOccurred())
 			Expect(path).Should(Equal(filepath.Join(baseDir, fileName)))
 		})