Merge pull request #1255 from merico-dev/feat-github-actions-language

feat: pipeline support language default config

Author: daniel-hutao

internal/pkg/plugin/installer/ci/cifile/server/githubci.go

@@ -28,7 +28,7 @@ func (g *GitHubWorkflow) FilterCIFilesFunc() file.DirFIleFilterFunc {
 		if isDir {
 			return false
 		}
-		return strings.Contains(filePath, "workflows")
+		return strings.Contains(filePath, "yml") || strings.Contains(filePath, "yaml")
 	}
 }
 

internal/pkg/plugin/installer/ci/step/general.go

@@ -10,16 +10,16 @@ import (
 )
 
 type test struct {
-	Enable                *bool  `mapstructure:"enable"`
-	Command               string `mapstructure:"command"`
-	ContainerName         string `mapstructure:"containerName"`
-	CoverageCommand       string `mapstructure:"coverageCommand"`
-	CoverageStatusCommand string `mapstructure:"CoverageStatusCommand"`
+	Enable                *bool    `mapstructure:"enable"`
+	Command               []string `mapstructure:"command"`
+	ContainerName         string   `mapstructure:"containerName"`
+	CoverageCommand       string   `mapstructure:"coverageCommand"`
+	CoverageStatusCommand string   `mapstructure:"CoverageStatusCommand"`
 }
 
 type GeneralStepConfig struct {
-	Language *Language `mapstructure:"language"`
-	Test     *test     `mapstructure:"test"`
+	Language language `mapstructure:"language"`
+	Test     test     `mapstructure:"test"`
 }
 
 // GetJenkinsPlugins return jenkins plugins info
@@ -37,12 +37,12 @@ func (g *GeneralStepConfig) ConfigSCM(client scm.ClientOperation) error {
 }
 
 func (g *GeneralStepConfig) SetDefault() {
-	if g.Language != nil && g.Language.Name == "" {
+	if g.Language.Name == "" {
 		return
 	}
 	generalDefaultOpts := g.Language.getGeneralDefaultOption()
 	if g.Test.Enable != types.Bool(false) {
-		if err := mergo.Merge(g.Test, generalDefaultOpts); err != nil {
+		if err := mergo.Merge(&g.Test, generalDefaultOpts.testOption); err != nil {
 			log.Warnf("step general merge default config failed: %+v", err)
 		}
 	}

internal/pkg/plugin/installer/ci/step/general_test.go

@@ -1,25 +1,20 @@
-package step_test
+package step
 
 import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
-	"github.com/devstream-io/devstream/internal/pkg/plugin/installer/ci/step"
 	"github.com/devstream-io/devstream/pkg/util/jenkins"
 	"github.com/devstream-io/devstream/pkg/util/scm"
 )
 
 var _ = Describe("GeneralStepConfig struct", func() {
 	var (
-		c          *step.GeneralStepConfig
+		c          *GeneralStepConfig
 		mockClient *jenkins.MockClient
 	)
 	BeforeEach(func() {
-		c = &step.GeneralStepConfig{
-			Language: &step.Language{
-				Name: "test",
-			},
-		}
+		c = &GeneralStepConfig{}
 	})
 	Context("GetJenkinsPlugins method", func() {
 		It("should return empty plugins", func() {
@@ -41,4 +36,29 @@ var _ = Describe("GeneralStepConfig struct", func() {
 			Expect(err).Error().ShouldNot(HaveOccurred())
 		})
 	})
+	Context("SetDefault method", func() {
+		When("language is empty", func() {
+			BeforeEach(func() {
+				c.Language = language{}
+			})
+			It("should return GeneralStepConfig", func() {
+				c.SetDefault()
+				Expect(c.Test.Enable).Should(BeNil())
+			})
+		})
+		When("language is valid", func() {
+			BeforeEach(func() {
+				c.Language = language{
+					Name: "go",
+				}
+			})
+			It("should set test options", func() {
+				goTestOption, exist := languageDefaultOptionMap["go"]
+				Expect(exist).Should(BeTrue())
+				Expect(goTestOption).ShouldNot(BeNil())
+				c.SetDefault()
+				Expect(c.Test).Should(Equal(*goTestOption.testOption))
+			})
+		})
+	})
 })

internal/pkg/plugin/installer/ci/step/language.go

@@ -6,9 +6,10 @@ import (
 	"github.com/devstream-io/devstream/pkg/util/types"
 )
 
-type Language struct {
-	Name    string `mapstructure:"name"`
-	Version string `mapstructure:"version"`
+type language struct {
+	Name      string `mapstructure:"name"`
+	Version   string `mapstructure:"version"`
+	FrameWork string `mapstructure:"frameWork"`
 }
 
 type generalDefaultOption struct {
@@ -18,15 +19,15 @@ type generalDefaultOption struct {
 var languageDefaultOptionMap = map[string]*generalDefaultOption{
 	"java": {
 		testOption: &test{
-			Command:       "mvn -B test",
+			Command:       []string{"mvn -B test"},
 			ContainerName: "maven:3.8.1-jdk-8",
 			Enable:        types.Bool(true),
 		},
 	},
-	"golang": {
+	"go": {
 		testOption: &test{
 			Enable:          types.Bool(true),
-			Command:         "go test ./...",
+			Command:         []string{"go test ./..."},
 			CoverageCommand: "go tool cover -func=coverage.out >> coverage.cov",
 			CoverageStatusCommand: `cat coverage.cov
 body=$(cat coverage.cov)
@@ -36,9 +37,29 @@ body="${body//$'\r'/'%0D'}"
 echo ::set-output name=body::$body`,
 		},
 	},
+	"python": {
+		testOption: &test{
+			Command: []string{
+				"python -m pip install --upgrade pip",
+				"pip install -r requirements.txt",
+				"python3 -m unittest",
+			},
+			Enable: types.Bool(true),
+		},
+	},
+	"nodejs": {
+		testOption: &test{
+			Command: []string{
+				"npm ci",
+				"npm run build --if-present",
+				"npm test",
+			},
+			Enable: types.Bool(true),
+		},
+	},
 }
 
-func (l *Language) getGeneralDefaultOption() *generalDefaultOption {
+func (l *language) getGeneralDefaultOption() *generalDefaultOption {
 	lang := strings.TrimSpace(strings.ToLower(l.Name))
 	return languageDefaultOptionMap[lang]
 }

internal/pkg/plugin/installer/ci/step/language_test.go

@@ -0,0 +1,47 @@
+package step
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Language struct", func() {
+	var (
+		l *language
+	)
+	When("lanuage is go", func() {
+		BeforeEach(func() {
+			l = &language{
+				Name: "go",
+			}
+		})
+		It("should return go default config", func() {
+			defaultConfig := l.getGeneralDefaultOption()
+			Expect(defaultConfig).ShouldNot(BeNil())
+			Expect(defaultConfig.testOption.Command).Should(Equal([]string{"go test ./..."}))
+		})
+	})
+	When("lanuage is java", func() {
+		BeforeEach(func() {
+			l = &language{
+				Name: "java",
+			}
+		})
+		It("should return java default config", func() {
+			defaultConfig := l.getGeneralDefaultOption()
+			Expect(defaultConfig).ShouldNot(BeNil())
+			Expect(defaultConfig.testOption.Command).Should(Equal([]string{"mvn -B test"}))
+		})
+	})
+	When("language is not exist", func() {
+		BeforeEach(func() {
+			l = &language{
+				Name: "not_exist",
+			}
+		})
+		It("should return go default config", func() {
+			defaultConfig := l.getGeneralDefaultOption()
+			Expect(defaultConfig).Should(BeNil())
+		})
+	})
+})

internal/pkg/show/config/plugins/github-actions.yaml

@@ -15,6 +15,10 @@ tools:
     pipeline:
       # workFlowfilePath is the location of workflows, it can be remote or local
       configLocation: https://github.com/devstream-io/devstream/main/staging/dtm-github-action-example/general
+      general:
+        language:
+          name: LANGUAGE # go/java/nodejs/python...
+          version: VERSION # language version
       imageRepo:
         # image repo URL for pulling/pushing
         url: http://harbor.example.com:80

pkg/util/template/render.go

@@ -17,7 +17,7 @@ func Render(name, templateStr string, variable any, funcMaps ...template.FuncMap
 
 	t, err := t.Parse(templateStr)
 	if err != nil {
-		log.Debugf("Template parse file failed: %s.", err)
+		log.Warnf("Template parse file failed: %s.", err)
 		return "", err
 	}