Merge pull request #1389 from merico-dev/refactor-scm-config-use-env

feat: use config field instead of env

Author: aFlyBird0

examples/apps.yaml

@@ -19,13 +19,15 @@ apps:
     framework: django
   repo:
     url: github.com/[[ GITHUB_USER ]]/myapp1
+    token: [[ env GITHUB_TOKEN ]]
   repoTemplate:
     url: github.com/devstream-io/dtm-repo-scaffolding-python-flask
   ci:
   - type: github-actions
     options:
       imageRepo:
         user: [[ DOCKERHUB_USER ]]
+        password: [[ env IMAGE_REPO_PASSWORD ]]
   cd:
   - type: argocdapp
 - name: myapp2
@@ -34,12 +36,14 @@ apps:
     framework: gin
   repo:
     url: github.com/[[ GITHUB_USER ]]/myapp2
+    token: [[ env GITHUB_TOKEN ]]
   repoTemplate:
     url: github.com/devstream-io/dtm-repo-scaffolding-golang-gin
   ci:
   - type: github-actions
     options:
       imageRepo:
         user: [[ DOCKERHUB_USER ]]
+        password: [[ env IMAGE_REPO_PASSWORD ]]
   cd:
   - type: argocdapp

examples/gitops.yaml

@@ -17,6 +17,7 @@ tools:
       name: [[ app ]]
       branch: main
       scmType: github
+      token: [[ env GITHUB_TOKEN ]]
     sourceRepo:
       org: devstream-io
       name: dtm-repo-scaffolding-python-flask
@@ -29,13 +30,15 @@ tools:
       owner: [[ githubUser ]]
       name:  [[ app ]]
       scmType: github
+      token: [[ env GITHUB_TOKEN ]]
     pipeline:
       configLocation: https://raw.githubusercontent.com/devstream-io/dtm-pipeline-templates/main/github-actions/workflows/main.yml
       language:
         name: python
         framework: flask
       imageRepo:
         user: [[ dockerUser ]]
+        password: [[ env IMAGE_REPO_PASSWORD ]]
 - name: helm-installer
   instanceID: argocd
 - name: argocdapp
@@ -52,5 +55,6 @@ tools:
       valuefile: values.yaml
       path: helm/[[ app ]]
       repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
+      token: [[ env GITHUB_TOKEN ]]
     imageRepo:
       user: [[ dockerUser ]]

examples/quickstart.yaml

@@ -17,6 +17,7 @@ tools:
       name: go-webapp-devstream-demo
       branch: main
       scmType: github
+      token: [[ env GITHUB_TOKEN ]]
     sourceRepo:
       org: devstream-io
       name: dtm-repo-scaffolding-golang-gin
@@ -30,10 +31,12 @@ tools:
       name: go-webapp-devstream-demo
       branch: main
       scmType: github
+      token: [[ env GITHUB_TOKEN ]]
     pipeline:
       configLocation: https://raw.githubusercontent.com/devstream-io/dtm-pipeline-templates/main/github-actions/workflows/main.yml
       language:
         name: go
         framework: gin
       imageRepo:
         user: [[ ImageRepoUser ]]
+        password: [[ env IMAGE_REPO_PASSWORD ]]

internal/pkg/configmanager/pipelineDefault.go

@@ -84,6 +84,7 @@ func pipelineArgocdAppGenerator(options RawOptions, globalVars *pipelineGlobalOp
 		if _, repoURLExist := sourceMap["repoURL"]; !repoURLExist {
 			sourceMap["repoURL"] = globalVars.Repo.GetCloneURL()
 			sourceMap["repoBranch"] = globalVars.Repo.Branch
+			sourceMap["token"] = globalVars.Repo.Token
 		}
 		options["source"] = sourceMap
 	} else {
@@ -92,6 +93,7 @@ func pipelineArgocdAppGenerator(options RawOptions, globalVars *pipelineGlobalOp
 			"path":       fmt.Sprintf("helm/%s", globalVars.AppName),
 			"repoURL":    string(globalVars.Repo.GetCloneURL()),
 			"repoBranch": globalVars.Repo.Branch,
+			"token":      globalVars.Repo.Token,
 		}
 	}
 	// config imageRepo default options

internal/pkg/configmanager/pipelineDefault_test.go

@@ -90,6 +90,7 @@ var _ = Describe("pipelineArgocdAppGenerator func", func() {
 				"path":       "helm/test_app",
 				"repoURL":    "https://scm.test.com",
 				"repoBranch": "testBranch",
+				"token":      "",
 			},
 			"imageRepo": RawOptions{
 				"owner": "test_user",

internal/pkg/plugin/argocdapp/argocdapp.go

@@ -25,6 +25,7 @@ func pushArgocdConfigFiles(rawOptions configmanager.RawOptions) error {
 	repoInfo := &git.RepoInfo{
 		CloneURL: git.ScmURL(opts.Source.RepoURL),
 		Branch:   opts.Source.RepoBranch,
+		Token:    opts.Source.Token,
 	}
 	scmClient, err := scm.NewClientWithAuth(repoInfo)
 	if err != nil {

internal/pkg/plugin/argocdapp/options.go

@@ -47,6 +47,7 @@ type source struct {
 	Path       string `mapstructure:"path" validate:"required"`
 	RepoURL    string `mapstructure:"repoURL" validate:"required"`
 	RepoBranch string `mapstructure:"repoBranch"`
+	Token      string `mapstructure:"token"`
 }
 
 // / newOptions create options by raw options

internal/pkg/plugin/gitlabci/options_test.go

@@ -54,8 +54,9 @@ var _ = Describe("action struct", func() {
 				"ImageRepoDockerSecret": "image-repo-auth",
 				"RepoType":              "gitlab",
 				"imageRepo": map[string]interface{}{
-					"url":  "exmaple.com",
-					"user": "test_user",
+					"url":      "exmaple.com",
+					"user":     "test_user",
+					"password": "",
 				},
 				"dingTalk":            nilDingTalkConfig,
 				"DingTalkSecretKey":   "DINGTALK_SECURITY_VALUE",

internal/pkg/plugin/installer/ci/ci_test.go

@@ -52,8 +52,9 @@ var _ = Describe("PipelineConfig struct", func() {
 				"ImageRepoSecret":       "IMAGE_REPO_SECRET",
 				"ImageRepoDockerSecret": "image-repo-auth",
 				"imageRepo": map[string]interface{}{
-					"url":  "exmaple.com",
-					"user": "test_user",
+					"url":      "exmaple.com",
+					"user":     "test_user",
+					"password": "",
 				},
 				"dingTalk":            nilDingTalkConfig,
 				"DingTalkSecretKey":   "DINGTALK_SECURITY_VALUE",
@@ -94,8 +95,9 @@ var _ = Describe("PipelineConfig struct", func() {
 			"StepGlobalVars":        "",
 			"RepoType":              "gitlab",
 			"imageRepo": map[string]interface{}{
-				"url":  "exmaple.com",
-				"user": "test_user",
+				"url":      "exmaple.com",
+				"user":     "test_user",
+				"password": "",
 			},
 			"dingTalk":           emptyDingtalk,
 			"sonarqube":          emptySonar,

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

@@ -1,12 +1,9 @@
 package step
 
 import (
-	"os"
-
 	"github.com/devstream-io/devstream/pkg/util/jenkins"
 	"github.com/devstream-io/devstream/pkg/util/log"
 	"github.com/devstream-io/devstream/pkg/util/scm"
-	"github.com/devstream-io/devstream/pkg/util/scm/github"
 )
 
 const (
@@ -15,6 +12,7 @@ const (
 
 type GithubStepConfig struct {
 	RepoOwner string `mapstructure:"repoOwner"`
+	Token     string `mapstructure:"token"`
 }
 
 func (g *GithubStepConfig) GetJenkinsPlugins() []*jenkins.JenkinsPlugin {
@@ -31,7 +29,7 @@ func (g *GithubStepConfig) ConfigJenkins(jenkinsClient jenkins.JenkinsAPI) (*jen
 	err := jenkinsClient.CreatePasswordCredential(
 		githubCredentialName,
 		g.RepoOwner,
-		os.Getenv(github.TokenEnvKey),
+		g.Token,
 	)
 	if err != nil {
 		log.Debugf("jenkins preinstall github credentials failed: %s", err)
@@ -52,5 +50,6 @@ func (g *GithubStepConfig) ConfigSCM(client scm.ClientOperation) error {
 func newGithubStep(config *StepGlobalOption) *GithubStepConfig {
 	return &GithubStepConfig{
 		RepoOwner: config.RepoInfo.GetRepoOwner(),
+		Token:     config.RepoInfo.Token,
 	}
 }