Merge branch 'devops/fix-helm-config-sequence' into 'master'

Devops/fix helm config sequence

See merge request technology/utils/cicd/argocd-helm-envsubst-plugin!17

Author: hextrust-marcuscheng

.gitlab-ci.yml

@@ -1,6 +1,6 @@
 include:
   - project: technology/utils/cicd/gitlab-ci-pipeline-templates
-    ref: v2.10.12
+    ref: v2.16.0
     file:
       - workflow.gitlab-ci.yml
       - docker.buildx.gitlab-ci.yml

Makefile

@@ -22,4 +22,7 @@ helm-build:
 	go run main.go build --path asset-master-service --repository-path repositories.yaml
 
 helm-render:
-	go run main.go render --path asset-master-service
+	go run main.go render --path asset-master-service
+
+test:
+	go test ./... -v

internal/build_test.go

@@ -8,9 +8,12 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"sort"
 	"strings"
 	"time"
 
+	"regexp"
+
 	"gopkg.in/yaml.v2"
 )
 
@@ -20,6 +23,11 @@ var (
 	argocdEnvVarPrefix      = "ARGOCD_ENV"
 )
 
+type ConfigFileSeq struct {
+	Seq  int
+	Name string
+}
+
 type Renderer struct {
 	debugLogFilePath string
 }
@@ -47,7 +55,7 @@ func (renderer *Renderer) RenderTemplate(helmChartPath string, debugLogFilePath
 
 	useExternalHelmChartPathIfSet()
 
-	configFileNames := renderer.findHelmConfigs()
+	configFileNames := renderer.FindHelmConfigs()
 	if len(configFileNames) > 0 {
 		for _, name := range configFileNames {
 			args = append(args, "-f")
@@ -97,31 +105,50 @@ func (renderer *Renderer) RenderTemplate(helmChartPath string, debugLogFilePath
 	fmt.Println(out.String())
 }
 
-func (renderer *Renderer) findHelmConfigs() []string {
+func (renderer *Renderer) FindHelmConfigs() []string {
 	// Default to values.yaml
-	files := []string{"values.yaml"}
+	files := []ConfigFileSeq{
+		{
+			Seq:  0,
+			Name: "values.yaml",
+		},
+	}
 	root := "config/"
 	environment := os.Getenv("ARGOCD_ENV_ENVIRONMENT")
 	cluster := os.Getenv("ARGOCD_ENV_CLUSTER")
+	helmConfigFilePatterns := []string{
+		"values.yaml",
+		root + environment + ".yaml",
+		root + cluster + "_" + environment + ".yaml",
+	}
 	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			// log.Fatalf("Config folder not found: %v", err)
 			return nil
 		}
-		// e.g. config/dev.yaml
-		if !info.IsDir() && path == root+environment+".yaml" {
-			files = append(files, path)
-		}
-		// e.g. config/operator_dev.yaml
-		if !info.IsDir() && path == root+cluster+"_"+environment+".yaml" {
-			files = append(files, path)
+		for seq, pattern := range helmConfigFilePatterns {
+			if match, _ := regexp.MatchString(pattern, path); match {
+				files = append(files, ConfigFileSeq{Seq: seq, Name: path})
+			}
 		}
 		return nil
 	})
 	if err != nil {
 		log.Fatalf("Find config file in dir error: %v", err)
 	}
-	return files
+
+	// sort
+	sort.Slice(files, func(i, j int) bool {
+		return files[i].Seq < files[j].Seq
+	})
+
+	// convert array of struct to array of string
+	sortedFiles := []string{}
+	for _, file := range files {
+		sortedFiles = append(sortedFiles, file.Name)
+	}
+
+	return sortedFiles
 }
 
 func (renderer *Renderer) getArgocdEnvList() []string {

internal/render.go

@@ -0,0 +1,54 @@
+package internal_test
+
+import (
+	"fmt"
+	"os"
+	"reflect"
+	"testing"
+
+	"gitlab.int.hextech.io/technology/utils/cicd/argocd-helm-envsubst-plugin/internal"
+)
+
+const (
+	TEST_ARGOCD_ENV_ENVIRONMENT = "prod"
+	TEST_ARGOCD_ENV_CLUSTER     = "blockchain"
+)
+
+func setup(t *testing.T) {
+	if err := os.Mkdir("config", os.ModePerm); err != nil {
+		t.Fatal(err)
+	}
+	if _, err := os.Create(fmt.Sprintf("config/%s_%s.yaml", TEST_ARGOCD_ENV_CLUSTER, TEST_ARGOCD_ENV_ENVIRONMENT)); err != nil {
+		t.Fatal(err)
+	}
+	if _, err := os.Create(fmt.Sprintf("config/%s.yaml", TEST_ARGOCD_ENV_ENVIRONMENT)); err != nil {
+		t.Fatal(err)
+	}
+
+	os.Setenv("ARGOCD_ENV_ENVIRONMENT", TEST_ARGOCD_ENV_ENVIRONMENT)
+	os.Setenv("ARGOCD_ENV_CLUSTER", TEST_ARGOCD_ENV_CLUSTER)
+}
+
+func teardown(t *testing.T) {
+	if err := os.RemoveAll("config"); err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestFindHelmConfigs(t *testing.T) {
+	setup(t)
+	defer teardown(t)
+
+	r := internal.NewRenderer()
+
+	expect := []string{
+		"values.yaml",
+		fmt.Sprintf("config/%s.yaml", TEST_ARGOCD_ENV_ENVIRONMENT),
+		fmt.Sprintf("config/%s_%s.yaml", TEST_ARGOCD_ENV_CLUSTER, TEST_ARGOCD_ENV_ENVIRONMENT),
+	}
+	actual := r.FindHelmConfigs()
+
+	if !reflect.DeepEqual(actual, expect) {
+		t.Errorf("Expected %s do not match actual %s", expect, actual)
+	}
+}