Merge pull request #950 from steinliber/refactor-unify-template-processor

refactor: unify template file processor

Author: IronCore864

internal/pkg/plugin/argocdapp/argocdapp.go

@@ -1,27 +1,8 @@
 package argocdapp
 
-var argoCDAppTemplate = `---
-apiVersion: argoproj.io/v1alpha1
-kind: Application
-metadata:
-  name: {{.app.name}}
-  namespace: {{.app.namespace}}
-  finalizers:
-    - resources-finalizer.argocd.argoproj.io
-spec:
-  destination:
-    namespace: {{.destination.namespace}}
-    server: {{.destination.server}}
-  project: default
-  source:
-    helm:
-      valueFiles:
-      - {{.source.valuefile}}
-    path: {{.source.path}}
-    repoURL: {{.source.repoURL}}
-    targetRevision: HEAD
-  syncPolicy:
-    automated:
-      prune: true
-      selfHeal: true
-`
+import (
+	_ "embed"
+)
+
+//go:embed tpl/argocd.tpl.yaml
+var templateFileLoc string

internal/pkg/plugin/argocdapp/create.go

@@ -3,6 +3,7 @@ package argocdapp
 import (
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller/kubectl"
+	"github.com/devstream-io/devstream/pkg/util/file"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
@@ -14,7 +15,9 @@ func Create(options map[string]interface{}) (map[string]interface{}, error) {
 			validate,
 		},
 		ExecuteOperations: []plugininstaller.BaseOperation{
-			kubectl.ProcessByContent("create", "", argoCDAppTemplate),
+			kubectl.ProcessByContent(
+				"create", file.NewTemplate().FromContent(templateFileLoc),
+			),
 		},
 		GetStatusOperation: getStaticState,
 	}

internal/pkg/plugin/argocdapp/delete.go

@@ -3,6 +3,7 @@ package argocdapp
 import (
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller/kubectl"
+	"github.com/devstream-io/devstream/pkg/util/file"
 )
 
 func Delete(options map[string]interface{}) (bool, error) {
@@ -12,7 +13,9 @@ func Delete(options map[string]interface{}) (bool, error) {
 			validate,
 		},
 		ExecuteOperations: []plugininstaller.BaseOperation{
-			kubectl.ProcessByContent("delete", "", argoCDAppTemplate),
+			kubectl.ProcessByContent(
+				"delete", file.NewTemplate().FromContent(templateFileLoc),
+			),
 		},
 	}
 

internal/pkg/plugin/argocdapp/tpl/argocd.tpl.yaml

@@ -0,0 +1,24 @@
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  name: "[[ .app.name ]]"
+  namespace: "[[ .app.namespace ]]"
+  finalizers:
+    - resources-finalizer.argocd.argoproj.io
+spec:
+  destination:
+    namespace: "[[ .destination.namespace ]]"
+    server: "[[ .destination.server ]]"
+  project: default
+  source:
+    helm:
+      valueFiles:
+      - "[[ .source.valuefile ]]"
+    path: "[[ .source.path ]]"
+    repoURL: "[[ .source.repoURL ]]"
+    targetRevision: HEAD
+  syncPolicy:
+    automated:
+      prune: true
+      selfHeal: true
+

internal/pkg/plugin/devlake/create.go

@@ -3,14 +3,17 @@ package devlake
 import (
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller/kubectl"
+	"github.com/devstream-io/devstream/pkg/util/file"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
 func Create(options map[string]interface{}) (map[string]interface{}, error) {
 	// 1. config install operations
 	runner := &plugininstaller.Runner{
 		ExecuteOperations: []plugininstaller.BaseOperation{
-			kubectl.ProcessByContent("create", devLakeInstallYAMLDownloadURL, ""),
+			kubectl.ProcessByContent(
+				"create", file.NewTemplate().FromRemote(devLakeInstallYAMLDownloadURL),
+			),
 		},
 		GetStatusOperation: getStaticState,
 	}

internal/pkg/plugin/devlake/delete.go

@@ -3,13 +3,16 @@ package devlake
 import (
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller/kubectl"
+	"github.com/devstream-io/devstream/pkg/util/file"
 )
 
 func Delete(options map[string]interface{}) (bool, error) {
 	// 1. config delete operations
 	runner := &plugininstaller.Runner{
 		ExecuteOperations: []plugininstaller.BaseOperation{
-			kubectl.ProcessByContent("delete", devLakeInstallYAMLDownloadURL, ""),
+			kubectl.ProcessByContent(
+				"delete", file.NewTemplate().FromRemote(devLakeInstallYAMLDownloadURL),
+			),
 		},
 	}
 

internal/pkg/plugininstaller/kubectl/installer.go

@@ -2,28 +2,20 @@ package kubectl
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+	"github.com/devstream-io/devstream/pkg/util/file"
 	"github.com/devstream-io/devstream/pkg/util/kubectl"
-	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
 // InstallByDownload will download file for apply
-func ProcessByContent(action, downloadUrl, content string) plugininstaller.BaseOperation {
+func ProcessByContent(action string, templateConfig *file.TemplateConfig) plugininstaller.BaseOperation {
 	return func(options plugininstaller.RawOptions) error {
 		// generate k8s config file for apply
-		configFileName, err := createKubectlFile(downloadUrl, content, options)
+		configFileName, err := templateConfig.RenderFile("kubectl", options).Run()
 		if err != nil {
 			return err
 		}
-
-		defer func() {
-			err := os.Remove(configFileName)
-			if err != nil {
-				log.Debugf("kubectl delete temp file failed: %s", err)
-			}
-		}()
 		// kubectl apply -f
 		switch action {
 		case "create":

internal/pkg/plugininstaller/kubectl/utils.go

@@ -2,11 +2,8 @@ package reposcaffolding
 
 import (
 	"fmt"
-	"os"
-	"path/filepath"
 
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
-	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
 // InstallRepo will install repo by opts config
@@ -16,33 +13,20 @@ func InstallRepo(options plugininstaller.RawOptions) error {
 		return err
 	}
 
-	// 1. Create temp dir
-	dirName, err := os.MkdirTemp("", "")
+	// 1. Create and render repo get from given url
+	dirPath, err := opts.CreateAndRenderLocalRepo()
 	if err != nil {
 		return err
 	}
-	defer func() {
-		if err := os.RemoveAll(dirName); err != nil {
-			log.Errorf("Failed to clear workpath %s: %s.", dirName, err)
-		}
-	}()
 
-	// 2. Create and render repo get from given url
-	err = opts.CreateAndRenderLocalRepo(dirName)
-	if err != nil {
-		return err
-	}
-
-	dstRepo := opts.DestinationRepo
 	// 2. Push local repo to remote
-	repoLoc := filepath.Join(dirName, opts.DestinationRepo.Repo)
-	switch dstRepo.RepoType {
+	switch opts.DestinationRepo.RepoType {
 	case "github":
-		err = opts.PushToRemoteGithub(repoLoc)
+		err = opts.PushToRemoteGithub(dirPath)
 	case "gitlab":
-		err = opts.PushToRemoteGitlab(repoLoc)
+		err = opts.PushToRemoteGitlab(dirPath)
 	default:
-		err = fmt.Errorf("scaffolding not support repo destination: %s", dstRepo.RepoType)
+		err = fmt.Errorf("scaffolding not support repo destination: %s", opts.DestinationRepo.RepoType)
 	}
 	if err != nil {
 		return err
@@ -62,7 +46,7 @@ func DeleteRepo(options plugininstaller.RawOptions) error {
 	switch dstRepo.RepoType {
 	case "github":
 		// 1. create ghClient
-		ghClient, err := opts.DestinationRepo.CreateGithubClient(true)
+		ghClient, err := dstRepo.CreateGithubClient(true)
 		if err != nil {
 			return err
 		}

internal/pkg/plugininstaller/reposcaffolding/installer.go

@@ -1,17 +1,19 @@
 package reposcaffolding
 
 import (
+	"path/filepath"
+
 	"github.com/mitchellh/mapstructure"
 
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
 	"github.com/devstream-io/devstream/internal/pkg/plugininstaller/common"
+	"github.com/devstream-io/devstream/pkg/util/file"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
 const (
-	transitBranch      = "init-with-devstream"
-	defaultCommitMsg   = "init with devstream"
-	appNamePlaceHolder = "_app_name_"
+	transitBranch    = "init-with-devstream"
+	defaultCommitMsg = "init with devstream"
 )
 
 type Options struct {
@@ -36,18 +38,25 @@ func (opts *Options) Encode() (map[string]interface{}, error) {
 	return options, nil
 }
 
-func (opts *Options) CreateAndRenderLocalRepo(workpath string) error {
-	// 1. download template scaffolding repo
-	err := opts.SourceRepo.DownloadRepo(workpath)
+// CreateAndRenderLocalRepo will download repo from source repo and render it locally
+func (opts *Options) CreateAndRenderLocalRepo() (string, error) {
+	// 1. get download url
+	githubCodeZipDownloadURL, err := opts.SourceRepo.getDownloadURL()
 	if err != nil {
-		return err
+		log.Debugf("reposcaffolding get download url failed: %s", err)
+		return "", err
 	}
-	// 2. walk iter repo files to render template
-	if err := walkLocalRepoPath(workpath, opts); err != nil {
-		log.Debugf("create local repo failed walk: %s.", err)
-		return err
+	// 2. download zip file and unzip this file then render folders
+	projectDir, err := file.NewTemplate().FromRemote(githubCodeZipDownloadURL).UnzipFile().RenderRepoDIr(
+		opts.DestinationRepo.Repo, opts.renderTplConfig(),
+	).Run()
+	if err != nil {
+		log.Debugf("reposcaffolding process file error: %s", err)
+		return "", err
 	}
-	return nil
+	// 3. join download path and repo name to get repo path
+	repoDirName := opts.SourceRepo.getRepoName()
+	return filepath.Join(projectDir, repoDirName), nil
 }
 
 // PushToRemoteGitLab push local repo to remote gitlab repo