Merge pull request #1323 from merico-dev/refactor-scm-git-options

refactor: use git.RepoInfo for all git repo related config

Author: daniel-hutao

README.md

@@ -91,7 +91,7 @@ I am happy to tell you that we have, and we are constantly adding more possible
 so you are more than welcome to tell us what combinations you expect.
 
 - [GitOps Toolchain](https://docs.devstream.io/en/latest/best-practices/gitops/)
-- [GitLab, Jenkins and Harbor On Premise Toolchain (Chinese only for now)](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor.zh/)
+- [GitLab, Jenkins and Harbor On Premise Toolchain (Chinese only for now)](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor-java-springboot.zh/)
 
 ## Supported DevOps Tools
 

README_zh.md

@@ -92,7 +92,7 @@ DevStream支持许多工具的管理。你可以灵活地结合一些工具来
 我们非常欢迎你告诉我们你期望的组合。
 
 - [GitOps工具链](https://docs.devstream.io/en/latest/best-practices/gitops.zh/)
-- [用 DevStream 搭建 GitLab + Jenkins + Harbor 工具链，管理 Java Spring Boot 项目开发生命周期全流程](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor.zh/)
+- [用 DevStream 搭建 GitLab + Jenkins + Harbor 工具链，管理 Java Spring Boot 项目开发生命周期全流程](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor-java-springboot.zh/)
 
 ## 支持的DevOps工具
 

docs/best-practices/gjh-java-springboot-air-gapped-deployment.zh.md

@@ -37,11 +37,7 @@ sh -c "$(curl -fsSL https://download.devstream.io/download.sh)"
 curl -o dtm https://download.devstream.io/v0.10.2/dtm-linux-amd64
 ```
 
-注意：这里的版本、系统类型、CPU 架构等信息需要灵活调整。比如你用的是 arm64 的服务器，这里就需要将命令改成：
-
-```shell
-curl -o dtm https://download.devstream.io/v0.10.2/dtm-linux-arm64
-```
+注意：这里的版本、系统类型、CPU 架构等信息需要灵活调整。
 
 等 dtm 下载到你的 PC 后，你需要通过内网将其传输到某一台内部服务器上，移入包含在"$PATH"的目录里并赋予其可执行权限，比如在 Linux 上你可以执行如下命令完成这些操作：
 

docs/plugins/repo-scaffolding.md

@@ -108,13 +108,13 @@ tools:
     destinationRepo:
       owner: test_owner
       org: ""
-      repo: dtm-test-golang
+      name: dtm-test-golang
       branch: main
-      repoType: github
+      scmType: github
     sourceRepo:
       org: devstream-io
-      repo: dtm-scaffolding-golang
-      repoType: github
+      name: dtm-scaffolding-golang
+      scmType: github
     vars:
       imageRepo: dtm-test/golang-repo
 ```
@@ -131,13 +131,13 @@ tools:
     destinationRepo:
       owner: test_owner
       org: ""
-      repo: dtm-test-golang-cli
+      name: dtm-test-golang-cli
       branch: main
-      repoType: github
+      scmType: github
     sourceRepo:
       org: devstream-io
-      repo: dtm-scaffolding-golang-cli
-      repoType: github
+      name: dtm-scaffolding-golang-cli
+      scmType: github
 ```
 
 This config will create `dtm-test-golang-cli` repo for user test_owner in GitHub.
@@ -152,15 +152,15 @@ tools:
     destinationRepo:
       owner: test_owner
       org: ""
-      repo: dtm-test-java
+      name: dtm-test-java
       branch: main
       baseUrl: 127.0.0.1:30001
       visibility: public
-      repoType: gitlab
+      scmType: gitlab
     sourceRepo:
       org: spring-guides
-      repo: gs-spring-boot
-      repoType: github
+      name: gs-spring-boot
+      scmType: github
 ```
 
 this config will create `dtm-test-java` repo for user test_owner in GitHub.

docs/plugins/repo-scaffolding.zh.md

@@ -105,13 +105,13 @@ tools:
       destinationRepo:
         owner: test_owner
         org: ""
-        repo: dtm-test-golang
+        name: dtm-test-golang
         branch: main
-        repoType: github
+        scmType: github
       sourceRepo:
         org: devstream-io
-        repo: dtm-scaffolding-golang
-        repoType: github
+        name: dtm-scaffolding-golang
+        scmType: github
       vars:
         ImageRepo: dtm-test/golang-repo
 ```
@@ -128,13 +128,13 @@ tools:
       destinationRepo:
         owner: test_owner
         org: ""
-        repo: dtm-test-golang-cli
+        name: dtm-test-golang-cli
         branch: main
-        repoType: github
+        scmType: github
       sourceRepo:
         org: devstream-io
-        repo: dtm-scaffolding-golang-cli
-        repoType: github
+        name: dtm-scaffolding-golang-cli
+        scmType: github
 ```
 
 这个配置在 GitHub 为用于 test_owner 创建 `dtm-test-golang-cli` 仓库，它的生成是基于 `devstream-io/dtm-scaffolding-golang-cli` 官方 Golang CLI 脚手架仓库。
@@ -149,15 +149,15 @@ tools:
       destinationRepo:
         owner: test_owner
         org: ""
-        repo: dtm-test-java
+        name: dtm-test-java
         branch: main
         baseUrl: 127.0.0.1:30001
         visibility: public
-        repoType: gitlab
+        scmType: gitlab
       sourceRepo:
         org: spring-guides
-        repo: gs-spring-boot
-        repoType: github
+        name: gs-spring-boot
+        scmType: github
 ```
 
 这个配置会在 GitLab 为用户 test_owner 创建 `dtm-test-java` 仓库，使用的是 Spring 官方的 `spring-guides/gs-spring-boot` 仓库。

internal/pkg/configmanager/app.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 
 	"github.com/devstream-io/devstream/pkg/util/log"
-	"github.com/devstream-io/devstream/pkg/util/scm"
 	"github.com/devstream-io/devstream/pkg/util/scm/git"
 )
 
@@ -13,23 +12,17 @@ const (
 )
 
 type repoTemplate struct {
-	*scm.SCMInfo `yaml:",inline"`
-	Vars         RawOptions `yaml:"vars"`
+	*git.RepoInfo `yaml:",inline"`
+	Vars          RawOptions `yaml:"vars"`
 }
 
 type app struct {
 	Name         string        `yaml:"name" mapstructure:"name"`
 	Spec         *appSpec      `yaml:"spec" mapstructure:"spec"`
-	Repo         *scm.SCMInfo  `yaml:"repo" mapstructure:"repo"`
+	Repo         *git.RepoInfo `yaml:"repo" mapstructure:"repo"`
 	RepoTemplate *repoTemplate `yaml:"repoTemplate" mapstructure:"repoTemplate"`
 	CIRawConfigs []pipelineRaw `yaml:"ci" mapstructure:"ci"`
 	CDRawConfigs []pipelineRaw `yaml:"cd" mapstructure:"cd"`
-
-	// these two variables is used internal for convince
-	// repoInfo is generated from Repo field with setDefault method
-	repoInfo *git.RepoInfo `yaml:"-" mapstructure:"-"`
-	// repoTemplateInfo is generated from RepoTemplate field with setDefault method
-	repoTemplateInfo *git.RepoInfo `yaml:"-" mapstructure:"-"`
 }
 
 func (a *app) getTools(vars map[string]any, templateMap map[string]string) (Tools, error) {
@@ -54,7 +47,7 @@ func (a *app) getTools(vars map[string]any, templateMap map[string]string) (Tool
 	return tools, nil
 }
 
-// generateAppPipelineTool generate ci/cd tools from app config
+// generateCICDTools generate ci/cd tools from app config
 func (a *app) generateCICDTools(templateMap map[string]string, appVars map[string]any) (Tools, error) {
 	allPipelineRaw := append(a.CIRawConfigs, a.CDRawConfigs...)
 	var tools Tools
@@ -78,16 +71,16 @@ func (a *app) generateCICDTools(templateMap map[string]string, appVars map[strin
 
 // generateRepoTemplateTool will use repo-scaffolding plugin for app
 func (a *app) generateRepoTemplateTool() *Tool {
-	if a.repoTemplateInfo != nil {
+	if a.RepoTemplate != nil {
 		templateVars := make(RawOptions)
 		// templateRepo doesn't need auth info
 		if a.RepoTemplate.Vars == nil {
 			templateVars = make(RawOptions)
 		}
 		return newTool(
 			repoScaffoldingPluginName, a.Name, RawOptions{
-				"destinationRepo": RawOptions(a.repoInfo.Encode()),
-				"sourceRepo":      RawOptions(a.repoTemplateInfo.Encode()),
+				"destinationRepo": RawOptions(a.Repo.Encode()),
+				"sourceRepo":      RawOptions(a.RepoTemplate.Encode()),
 				"vars":            templateVars,
 			},
 		)
@@ -100,22 +93,8 @@ func (a *app) setDefault() error {
 	if a.Repo == nil {
 		return fmt.Errorf("configmanager[app] is invalid, repo field must be configured")
 	}
-	if a.Repo.Name == "" {
-		a.Repo.Name = a.Name
-	}
-	appRepo, err := a.Repo.BuildRepoInfo()
-	if err != nil {
-		return fmt.Errorf("configmanager[app] parse repo failed: %w", err)
-	}
-	a.repoInfo = appRepo
-	if a.RepoTemplate != nil {
-		// templateRepo doesn't need auth info
-		templateRepo, err := a.RepoTemplate.BuildRepoInfo()
-		if err != nil {
-			return fmt.Errorf("configmanager[app] parse repoTemplate failed: %w", err)
-		}
-		templateRepo.NeedAuth = false
-		a.repoTemplateInfo = templateRepo
+	if a.Repo.Repo == "" {
+		a.Repo.Repo = a.Name
 	}
 	return nil
 }
@@ -133,9 +112,8 @@ func (a *app) getRepoTemplateDependants() []string {
 // newPipelineGlobalOptionFromApp generate pipeline options used for pipeline option configuration
 func (a *app) newPipelineGlobalOptionFromApp() *pipelineGlobalOption {
 	return &pipelineGlobalOption{
-		RepoInfo: a.repoInfo,
-		AppSpec:  a.Spec,
-		Scm:      a.Repo,
-		AppName:  a.Name,
+		Repo:    a.Repo,
+		AppSpec: a.Spec,
+		AppName: a.Name,
 	}
 }

internal/pkg/configmanager/app_test.go

@@ -4,7 +4,7 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
-	"github.com/devstream-io/devstream/pkg/util/scm"
+	"github.com/devstream-io/devstream/pkg/util/scm/git"
 )
 
 var _ = Describe("app struct", func() {
@@ -33,7 +33,7 @@ var _ = Describe("app struct", func() {
 		When("ci/cd template is not valid", func() {
 			BeforeEach(func() {
 				a = &app{
-					Repo: &scm.SCMInfo{
+					Repo: &git.RepoInfo{
 						CloneURL: "http://test.com/test/test_app",
 					},
 					CIRawConfigs: []pipelineRaw{
@@ -54,7 +54,7 @@ var _ = Describe("app struct", func() {
 			BeforeEach(func() {
 				a = &app{
 					Name: appName,
-					Repo: &scm.SCMInfo{
+					Repo: &git.RepoInfo{
 						CloneURL: "http://test.com/test/test_app",
 					},
 				}
@@ -65,49 +65,13 @@ var _ = Describe("app struct", func() {
 				Expect(len(tools)).Should(Equal(0))
 			})
 		})
-		When("repo url is not valid", func() {
-			BeforeEach(func() {
-				a = &app{
-					Name: appName,
-					Repo: &scm.SCMInfo{
-						CloneURL: "not_valid_url",
-					},
-				}
-			})
-			It("should return empty tools", func() {
-				_, err := a.getTools(vars, templateMap)
-				Expect(err).Should(HaveOccurred())
-				Expect(err.Error()).Should(ContainSubstring("configmanager[app] parse repo failed"))
-			})
-		})
-		When("template repo url is not valid", func() {
-			BeforeEach(func() {
-				a = &app{
-					Name: appName,
-					RepoTemplate: &repoTemplate{
-						SCMInfo: &scm.SCMInfo{
-							CloneURL: "not_valid_url",
-						},
-					},
-					Repo: &scm.SCMInfo{
-						CloneURL: "http://test.com/test/test_app",
-					},
-				}
-			})
-			It("should return empty tools", func() {
-				_, err := a.getTools(vars, templateMap)
-				Expect(err).Should(HaveOccurred())
-				Expect(err.Error()).Should(ContainSubstring("configmanager[app] parse repoTemplate failed"))
-			})
-		})
-
 	})
 
 	Context("generateCICDTools method", func() {
 		When("template type not exist", func() {
 			BeforeEach(func() {
 				a = &app{
-					Repo: &scm.SCMInfo{
+					Repo: &git.RepoInfo{
 						CloneURL: "http://test.com/test/test_app",
 					},
 					CIRawConfigs: []pipelineRaw{

internal/pkg/configmanager/configmanager_test.go

@@ -6,6 +6,8 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+
+	"github.com/devstream-io/devstream/pkg/util/scm/git"
 )
 
 var _ = Describe("Manager struct", func() {
@@ -32,7 +34,6 @@ apps:
   repo:
     scmType: github
     owner: devstream-io
-    org: devstream-io # choose between owner and org
     url: github.com/devstream-io/service-a # optional，if url is specified，we can infer scm/owner/org/name from url
     apiURL: gitlab.com/some/path/to/your/api # optional, if you want to create a repo from repo template
   # if repoTemplate is not empty，we could help user to create repo from scaffoldingRepo
@@ -148,10 +149,9 @@ pipelineTemplates:
 				"scm": RawOptions{
 					"apiURL":  "gitlab.com/some/path/to/your/api",
 					"owner":   "devstream-io",
-					"org":     "devstream-io",
 					"name":    "service-a",
 					"scmType": "github",
-					"url":     "https://github.com/devstream-io/service-a",
+					"url":     git.ScmURL("github.com/devstream-io/service-a"),
 				},
 			},
 		}
@@ -191,19 +191,18 @@ pipelineTemplates:
 			Options: RawOptions{
 				"instanceID": "service-a",
 				"destinationRepo": RawOptions{
-					"needAuth": true,
-					"org":      "devstream-io",
-					"repo":     "service-a",
-					"branch":   "main",
-					"repoType": "github",
-					"url":      "github.com/devstream-io/service-a",
+					"owner":   "devstream-io",
+					"name":    "service-a",
+					"scmType": "github",
+					"apiURL":  "gitlab.com/some/path/to/your/api",
+					"url":     git.ScmURL("github.com/devstream-io/service-a"),
 				},
 				"sourceRepo": RawOptions{
-					"repoType": "github",
-					"url":      "github.com/devstream-io/dtm-scaffolding-golang",
-					"org":      "devstream-io",
-					"repo":     "dtm-scaffolding-golang",
-					"branch":   "main",
+					"scmType": "github",
+					"url":     git.ScmURL("github.com/devstream-io/dtm-scaffolding-golang"),
+					"owner":   "devstream-io",
+					"name":    "dtm-scaffolding-golang",
+					"org":     "devstream-io",
 				},
 				"vars": RawOptions{},
 			},