github.com/freiheit-com/kuberpult@v1.24.2-0.20240328135542-315d5630abe6/services/cd-service/pkg/argocd/render_test.go

/*This file is part of kuberpult.

Kuberpult is free software: you can redistribute it and/or modify
it under the terms of the Expat(MIT) License as published by
the Free Software Foundation.

Kuberpult is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
MIT License for more details.

You should have received a copy of the MIT License
along with kuberpult. If not, see <https://directory.fsf.org/wiki/License:Expat>.

Copyright 2023 freiheit.com*/

package argocd

import (
	"testing"

	"github.com/freiheit-com/kuberpult/pkg/ptr"
	"github.com/freiheit-com/kuberpult/services/cd-service/pkg/argocd/v1alpha1"
	"github.com/freiheit-com/kuberpult/services/cd-service/pkg/config"
	"github.com/google/go-cmp/cmp"
	godebug "github.com/kylelemons/godebug/diff"
)

func TestRender(t *testing.T) {
	tcs := []struct {
		Name           string
		Destination    v1alpha1.ApplicationDestination
		ExpectedResult string
	}{
		{
			Name:        "deploy",
			Destination: v1alpha1.ApplicationDestination{},
			ExpectedResult: `apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd.argoproj.io/manifest-generate-paths: /environments/dev/applications/app1/manifests
    com.freiheit.kuberpult/application: app1
    com.freiheit.kuberpult/environment: dev
    com.freiheit.kuberpult/team: ""
  finalizers:
  - resources-finalizer.argocd.argoproj.io
  labels:
    com.freiheit.kuberpult/team: ""
  name: dev-app1
spec:
  destination: {}
  ignoreDifferences:
  - group: a.b
    jqPathExpressions:
    - c
    - d
    kind: bar
    managedFieldsManagers:
    - e
    - f
    name: foo
  project: dev
  source:
    path: environments/dev/applications/app1/manifests
    repoURL: example.com/github
    targetRevision: main
  syncPolicy:
    automated:
      allowEmpty: true
      prune: true
      selfHeal: true
    syncOptions:
    - ApplyOutOfSyncOnly=true
`,
		},
		{
			Name:        "undeploy",
			Destination: v1alpha1.ApplicationDestination{},
			ExpectedResult: `apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd.argoproj.io/manifest-generate-paths: /environments/dev/applications/app1/manifests
    com.freiheit.kuberpult/application: app1
    com.freiheit.kuberpult/environment: dev
    com.freiheit.kuberpult/team: ""
  finalizers:
  - resources-finalizer.argocd.argoproj.io
  labels:
    com.freiheit.kuberpult/team: ""
  name: dev-app1
spec:
  destination: {}
  ignoreDifferences:
  - group: a.b
    jqPathExpressions:
    - c
    - d
    kind: bar
    managedFieldsManagers:
    - e
    - f
    name: foo
  project: dev
  source:
    path: environments/dev/applications/app1/manifests
    repoURL: example.com/github
    targetRevision: main
  syncPolicy:
    automated:
      allowEmpty: true
      prune: true
      selfHeal: true
    syncOptions:
    - ApplyOutOfSyncOnly=true
`,
		},
		{
			Name: "namespace test",
			Destination: v1alpha1.ApplicationDestination{
				Namespace: "foo",
			},
			ExpectedResult: `apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd.argoproj.io/manifest-generate-paths: /environments/dev/applications/app1/manifests
    com.freiheit.kuberpult/application: app1
    com.freiheit.kuberpult/environment: dev
    com.freiheit.kuberpult/team: ""
  finalizers:
  - resources-finalizer.argocd.argoproj.io
  labels:
    com.freiheit.kuberpult/team: ""
  name: dev-app1
spec:
  destination:
    namespace: foo
  ignoreDifferences:
  - group: a.b
    jqPathExpressions:
    - c
    - d
    kind: bar
    managedFieldsManagers:
    - e
    - f
    name: foo
  project: dev
  source:
    path: environments/dev/applications/app1/manifests
    repoURL: example.com/github
    targetRevision: main
  syncPolicy:
    automated:
      allowEmpty: true
      prune: true
      selfHeal: true
    syncOptions:
    - ApplyOutOfSyncOnly=true
`,
		},
	}
	for _, tc := range tcs {
		tc := tc
		t.Run(tc.Name, func(t *testing.T) {
			t.Parallel()
			var (
				annotations       = map[string]string{}
				ignoreDifferences = []v1alpha1.ResourceIgnoreDifferences{
					{
						Group:                 "a.b",
						Kind:                  "bar",
						Name:                  "foo",
						JqPathExpressions:     []string{"c", "d"},
						ManagedFieldsManagers: []string{"e", "f"},
					},
				}
				destination = tc.Destination
				GitUrl      = "example.com/github"
				gitBranch   = "main"
				env         = "dev"
				appData     = AppData{
					AppName: "app1",
				}
				syncOptions = []string{"ApplyOutOfSyncOnly=true"}
			)

			actualResult, err := RenderAppEnv(GitUrl, gitBranch, annotations, env, appData, destination, ignoreDifferences, syncOptions)
			if err != nil {
				t.Fatal(err)
			}
			if actualResult != tc.ExpectedResult {
				t.Fatalf("unexpected argocd manifest:\ndiff:\n%s\n\n", godebug.Diff(tc.ExpectedResult, actualResult))
			}
		})
	}
}

func TestRenderV1Alpha1(t *testing.T) {
	tests := []struct {
		name    string
		config  config.EnvironmentConfig
		appData []AppData
		want    string
		wantErr bool
	}{
		{
			name: "without sync window",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					SyncWindows: nil,
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - {}
  sourceRepos:
  - '*'
`,
		},
		{
			name: "with sync window without apps",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					SyncWindows: []config.ArgoCdSyncWindow{
						{
							Schedule: "not a valid crontab entry",
							Duration: "invalid duration",
							Kind:     "neither deny nor allow",
							Apps:     nil,
						},
					},
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - {}
  sourceRepos:
  - '*'
  syncWindows:
  - applications:
    - '*'
    duration: invalid duration
    kind: neither deny nor allow
    manualSync: true
    schedule: not a valid crontab entry
`,
		},
		{
			name: "with sync window with apps",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					SyncWindows: []config.ArgoCdSyncWindow{
						{
							Schedule: "not a valid crontab entry",
							Duration: "invalid duration",
							Kind:     "neither deny nor allow",
							Apps: []string{
								"app*",
							},
						},
					},
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - {}
  sourceRepos:
  - '*'
  syncWindows:
  - applications:
    - app*
    duration: invalid duration
    kind: neither deny nor allow
    manualSync: true
    schedule: not a valid crontab entry
`,
		},
		{
			name: "namespace unset with app",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					Destination: config.ArgoCdDestination{
						Namespace:            nil,
						AppProjectNamespace:  ptr.FromString("bar1"),
						ApplicationNamespace: ptr.FromString("bar2"),
					},
				},
			},
			appData: []AppData{
				{
					AppName: "app1",
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - namespace: bar1
  sourceRepos:
  - '*'
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd.argoproj.io/manifest-generate-paths: /environments/test-env/applications/app1/manifests
    com.freiheit.kuberpult/application: app1
    com.freiheit.kuberpult/environment: test-env
    com.freiheit.kuberpult/team: ""
  finalizers:
  - resources-finalizer.argocd.argoproj.io
  labels:
    com.freiheit.kuberpult/team: ""
  name: test-env-app1
spec:
  destination:
    namespace: bar2
  project: test-env
  source:
    path: environments/test-env/applications/app1/manifests
    repoURL: https://git.example.com/
    targetRevision: branch-name
  syncPolicy:
    automated:
      allowEmpty: true
      prune: true
      selfHeal: true
`,
		},
		{
			name: "only set namespace for appProject",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					Destination: config.ArgoCdDestination{
						Namespace:            nil,
						AppProjectNamespace:  ptr.FromString("bar1"),
						ApplicationNamespace: nil,
					},
				},
			},
			appData: []AppData{
				{
					AppName: "app1",
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - namespace: bar1
  sourceRepos:
  - '*'
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd.argoproj.io/manifest-generate-paths: /environments/test-env/applications/app1/manifests
    com.freiheit.kuberpult/application: app1
    com.freiheit.kuberpult/environment: test-env
    com.freiheit.kuberpult/team: ""
  finalizers:
  - resources-finalizer.argocd.argoproj.io
  labels:
    com.freiheit.kuberpult/team: ""
  name: test-env-app1
spec:
  destination: {}
  project: test-env
  source:
    path: environments/test-env/applications/app1/manifests
    repoURL: https://git.example.com/
    targetRevision: branch-name
  syncPolicy:
    automated:
      allowEmpty: true
      prune: true
      selfHeal: true
`,
		},
		{
			name: "namespace unset",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					Destination: config.ArgoCdDestination{
						Namespace:            nil,
						AppProjectNamespace:  ptr.FromString("bar1"),
						ApplicationNamespace: ptr.FromString("bar2"),
					},
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - namespace: bar1
  sourceRepos:
  - '*'
`,
		},
		{
			name: "namespace precedence",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					Destination: config.ArgoCdDestination{
						Namespace:            ptr.FromString("foo"),
						AppProjectNamespace:  ptr.FromString("bar1"),
						ApplicationNamespace: ptr.FromString("bar2"),
					},
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - namespace: foo
  sourceRepos:
  - '*'
`,
		},
		{
			name: "only namespace set",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					Destination: config.ArgoCdDestination{
						Namespace:            ptr.FromString("foo"),
						AppProjectNamespace:  nil,
						ApplicationNamespace: nil,
					},
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - namespace: foo
  sourceRepos:
  - '*'
`,
		},
		{
			name: "with team name",
			config: config.EnvironmentConfig{
				ArgoCd: &config.EnvironmentConfigArgoCd{
					Destination: config.ArgoCdDestination{
						Namespace:            nil,
						AppProjectNamespace:  ptr.FromString("bar1"),
						ApplicationNamespace: nil,
					},
				},
			},
			appData: []AppData{
				{
					AppName:  "app1",
					TeamName: "some-team",
				},
			},
			want: `apiVersion: argoproj.io/v1alpha1
kind: AppProject
metadata:
  name: test-env
spec:
  description: test-env
  destinations:
  - namespace: bar1
  sourceRepos:
  - '*'
---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  annotations:
    argocd.argoproj.io/manifest-generate-paths: /environments/test-env/applications/app1/manifests
    com.freiheit.kuberpult/application: app1
    com.freiheit.kuberpult/environment: test-env
    com.freiheit.kuberpult/team: some-team
  finalizers:
  - resources-finalizer.argocd.argoproj.io
  labels:
    com.freiheit.kuberpult/team: some-team
  name: test-env-app1
spec:
  destination: {}
  project: test-env
  source:
    path: environments/test-env/applications/app1/manifests
    repoURL: https://git.example.com/
    targetRevision: branch-name
  syncPolicy:
    automated:
      allowEmpty: true
      prune: true
      selfHeal: true
`,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			const (
				gitUrl    = "https://git.example.com/"
				gitBranch = "branch-name"
				env       = "test-env"
			)
			got, err := RenderV1Alpha1(gitUrl, gitBranch, tt.config, env, tt.appData)
			if (err != nil) != tt.wantErr {
				t.Errorf("error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if d := cmp.Diff(tt.want, string(got)); d != "" {
				t.Errorf("mismatch: %s", d)
			}
		})
	}
}