Merge branch 'main' into fix-todolistid-empty

Author: IronCore864

docs/best_practices/gitops.md

@@ -2,11 +2,21 @@
 
 ## Plugins needed
 
-1. github-repo-scaffolding-golang 
-2. jira-github
-3. githubactions-golang
-4. argocd
-5. argocdapp
+1. [github-repo-scaffolding-golang](../plugins/github-repo-scaffolding-golang_plugin.md)
+2. [jira-github](../plugins/jira-github-integ_plugin.md)
+3. [githubactions-golang](../plugins/githubactions-golang_plugin.md)
+4. [argocd](../plugins/argocd_plugin.md)
+5. [argocdapp](../plugins/argocdapp_plugin.md)
+
+The dependencies of these plugins are(`a -> b` means for `a depends on b`):
+
+- `jira-github` -> `github-repo-scaffolding-golang`
+- `githubactions-golang` -> `github-repo-scaffolding-golang`
+- `argocdapp` -> `argocd`
+
+Note: These dependencies are not consistent, such as when the repo operated by `jira-github` and `github-repo-scaffolding-golang` are not the same, the dependencies disappear.
+
+We should use the `dependency` according to the actual usage situation.
 
 ## Download DevStream (`dtm`)
 

docs/plugins/argocdapp_plugin.md

@@ -3,10 +3,12 @@
 This plugin creates an [ArgoCD Application](https://argo-cd.readthedocs.io/en/stable/core_concepts/) custom resource.
 
 **Notes:**
-- ArgoCD itself must have been already installed before the usage of this plugin. To install ArgoCD, use the [argocd plugin](https://github.com/merico-dev/stream/blob/main/docs/argocd_plugin.md).
+- ArgoCD itself must have been already installed before the usage of this plugin.
+  To install ArgoCD, use the [argocd plugin](../plugins/argocd_plugin.md).
+  Or you can use both plugins(argocd+argocdapp) at the same time.
+  See [GitOps Toolchain](../best_practices/gitops.md) for more info.
 - Currently, only the Helm chart is supported when creating the ArgoCD application.
-- At the moment, DevStream doesn't support dependency or concurrency yet. So, in the config file, the ArgoCD app plugin must be placed _after_ the ArgoCD plugin if you want to install ArgoCD first then create the ArgoCD application.
-
+- Modify the file accordingly. Especially remember to modify `ARGOCD_TOOL_NAME`.
 ## 2 Usage:
 
 ```yaml
@@ -18,8 +20,8 @@ tools:
     # version of the plugin
     # checkout the version from the GitHub releases
     version: 0.2.0
-  # optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
-  dependsOn: [ "TOOL1_NAME.TOOL1_KIND", "TOOL2_NAME.TOOL2_KIND" ]
+  # if specified, dtm will make sure the dependency is applied first before handling this tool.
+  dependsOn: [ "ARGOCD_TOOL_NAME.argocd" ]
   # options for the plugin
   options:
     # information on the ArgoCD Application

examples/gitops.yaml

@@ -24,6 +24,8 @@ tools:
     # version of the plugin
     # checkout the version from the GitHub releases
     version: 0.2.0
+  # optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
+  dependsOn: [ "go-webapp-repo.github-repo-scaffolding-golang" ]
   # options for the plugin
   options:
     # the repo's owner
@@ -45,6 +47,8 @@ tools:
     # version of the plugin
     # checkout the version from the GitHub releases
     version: 0.2.0
+  # optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
+  dependsOn: [ "go-webapp-repo.github-repo-scaffolding-golang" ]
   # options for the plugin
   options:
     # the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
@@ -79,7 +83,7 @@ tools:
       enable: False
       # dockerhub image repo; please change the value below.
       repo: YOUR_DOCKERHUB_IMAGE_REPO_NAME
-- name: argocd
+- name: argocd-dev
   plugin:
     # name of the plugin
     kind: argocd
@@ -115,6 +119,8 @@ tools:
     # version of the plugin
     # checkout the version from the GitHub releases
     version: 0.2.0
+  # if specified, dtm will make sure the dependency is applied first before handling this tool.
+  dependsOn: [ "argocd-dev.argocd" ]
   # options for the plugin
   options:
     # information on the ArgoCD application

go.mod

@@ -129,7 +129,6 @@ require (
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
-	github.com/onsi/ginkgo v1.16.5 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/opencontainers/image-spec v1.0.1 // indirect
 	github.com/patrickmn/go-cache v2.1.0+incompatible // indirect

go.sum

@@ -965,9 +965,8 @@ github.com/onsi/ginkgo v1.10.3/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+
 github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk=
 github.com/onsi/ginkgo v1.14.0/go.mod h1:iSB4RoI2tjJc9BBv4NKIKWKya62Rps+oPG/Lv9klQyY=
 github.com/onsi/ginkgo v1.14.1/go.mod h1:iSB4RoI2tjJc9BBv4NKIKWKya62Rps+oPG/Lv9klQyY=
+github.com/onsi/ginkgo v1.16.4 h1:29JGrr5oVBm5ulCWet69zQkzWipVXIol6ygQUe/EzNc=
 github.com/onsi/ginkgo v1.16.4/go.mod h1:dX+/inL/fNMqNlz0e9LfyB9TswhZpCVdJM/Z6Vvnwo0=
-github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE=
-github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU=
 github.com/onsi/ginkgo/v2 v2.0.0 h1:CcuG/HvWNkkaqCUpJifQY8z7qEMBJya6aLPx6ftGyjQ=
 github.com/onsi/ginkgo/v2 v2.0.0/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c=
 github.com/onsi/gomega v0.0.0-20151007035656-2152b45fa28a/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA=

internal/pkg/plugin/argocd/create.go

@@ -6,12 +6,12 @@ import (
 	"github.com/mitchellh/mapstructure"
 
 	. "github.com/merico-dev/stream/internal/pkg/plugin/common/helm"
-	"github.com/merico-dev/stream/pkg/util/helm"
 	"github.com/merico-dev/stream/pkg/util/log"
 )
 
 // Create creates ArgoCD with provided options.
 func Create(options map[string]interface{}) (map[string]interface{}, error) {
+	// 1. decode options
 	var param Param
 	if err := mapstructure.Decode(options, &param); err != nil {
 		return nil, err
@@ -24,6 +24,7 @@ func Create(options map[string]interface{}) (map[string]interface{}, error) {
 		return nil, fmt.Errorf("params are illegal")
 	}
 
+	// 2. deal with ns
 	if err := DealWithNsWhenInstall(&param); err != nil {
 		return nil, err
 	}
@@ -39,18 +40,12 @@ func Create(options map[string]interface{}) (map[string]interface{}, error) {
 		log.Debugf("Deal with namespace when interruption succeeded.")
 	}()
 
-	var h *helm.Helm
-	h, retErr = helm.NewHelm(param.GetHelmParam())
-	if retErr != nil {
-		return nil, retErr
-	}
-
-	log.Info("Creating or updating argocd helm chart ...")
-	if retErr = h.InstallOrUpgradeChart(); retErr != nil {
-		log.Debugf("Failed to install or upgrade the Chart: %s.", retErr)
+	// 3. install or upgrade
+	if retErr = InstallOrUpgradeChart(&param); retErr != nil {
 		return nil, retErr
 	}
 
+	// 4. fill the return map
 	retMap := GetStaticState().ToStringInterfaceMap()
 	log.Debugf("Return map: %v", retMap)
 

internal/pkg/plugin/argocd/state.go

@@ -3,8 +3,9 @@ package argocd
 import "github.com/merico-dev/stream/pkg/util/helm"
 
 var DefaultDeploymentList = []string{
-	"argocd-application-controller",
+	"argocd-applicationset-controller",
 	"argocd-dex-server",
+	"argocd-notifications-controller",
 	"argocd-redis",
 	"argocd-repo-server",
 	"argocd-server",

internal/pkg/plugin/argocd/update.go

@@ -1,18 +1,36 @@
 package argocd
 
 import (
-	"time"
+	"fmt"
 
+	"github.com/mitchellh/mapstructure"
+
+	. "github.com/merico-dev/stream/internal/pkg/plugin/common/helm"
 	"github.com/merico-dev/stream/pkg/util/log"
 )
 
 func Update(options map[string]interface{}) (map[string]interface{}, error) {
-	_, err := Delete(options)
-	if err != nil {
-		log.Errorf("Failed to delete the ArgoCD: %s.", err)
+	// 1. decode options
+	var param Param
+	if err := mapstructure.Decode(options, &param); err != nil {
 		return nil, err
 	}
 
-	<-time.NewTicker(3 * time.Second).C
-	return Create(options)
+	if errs := validate(&param); len(errs) != 0 {
+		for _, e := range errs {
+			log.Errorf("Param error: %s.", e)
+		}
+		return nil, fmt.Errorf("params are illegal")
+	}
+
+	// 2. install or upgrade
+	if err := InstallOrUpgradeChart(&param); err != nil {
+		return nil, err
+	}
+
+	// 3. fill the return map
+	retMap := GetStaticState().ToStringInterfaceMap()
+	log.Debugf("Return map: %v", retMap)
+
+	return retMap, nil
 }

internal/pkg/plugin/common/helm/helm.go

@@ -32,6 +32,20 @@ func (p *Param) GetHelmParam() *helm.HelmParam {
 	}
 }
 
+func InstallOrUpgradeChart(param *Param) error {
+	h, err := helm.NewHelm(param.GetHelmParam())
+	if err != nil {
+		return err
+	}
+
+	log.Info("Creating or updating helm chart ...")
+	if err := h.InstallOrUpgradeChart(); err != nil {
+		log.Debugf("Failed to install or upgrade the chart: %s.", err)
+		return err
+	}
+	return nil
+}
+
 func DealWithNsWhenInstall(param *Param) error {
 	if !param.CreateNamespace {
 		log.Debugf("There's no need to delete the namespace for the create_namespace == false in the config file.")

internal/pkg/plugin/jenkins/create.go

@@ -6,12 +6,12 @@ import (
 	"github.com/mitchellh/mapstructure"
 
 	. "github.com/merico-dev/stream/internal/pkg/plugin/common/helm"
-	"github.com/merico-dev/stream/pkg/util/helm"
 	"github.com/merico-dev/stream/pkg/util/log"
 )
 
 // Create creates jenkins with provided options.
 func Create(options map[string]interface{}) (map[string]interface{}, error) {
+	// 1. decode options
 	var param Param
 	if err := mapstructure.Decode(options, &param); err != nil {
 		return nil, err
@@ -24,6 +24,7 @@ func Create(options map[string]interface{}) (map[string]interface{}, error) {
 		return nil, fmt.Errorf("params are illegal")
 	}
 
+	// 2. deal with ns
 	if err := DealWithNsWhenInstall(&param); err != nil {
 		return nil, err
 	}
@@ -44,24 +45,18 @@ func Create(options map[string]interface{}) (map[string]interface{}, error) {
 		}
 	}()
 
-	var h *helm.Helm
-	h, retErr = helm.NewHelm(param.GetHelmParam())
-	if retErr != nil {
-		return nil, retErr
-	}
-
-	// pre-create
+	// 3. pre-create
 	if retErr = preCreate(); retErr != nil {
 		log.Errorf("The pre-create logic failed: %s.", retErr)
 		return nil, retErr
 	}
 
-	log.Info("Installing or updating jenkins helm chart ...")
-	if retErr = h.InstallOrUpgradeChart(); retErr != nil {
-		log.Debugf("Failed to install or upgrade the Chart: %s.", retErr)
+	// 4. install or upgrade
+	if retErr = InstallOrUpgradeChart(&param); retErr != nil {
 		return nil, retErr
 	}
 
+	// 5. fill the return map
 	releaseName := param.Chart.ReleaseName
 	retMap := GetStaticState(releaseName).ToStringInterfaceMap()
 	log.Debugf("Return map: %v.", retMap)