Files
argo-cd/test/e2e/kustomize_test.go
2026-02-12 09:29:40 -05:00

377 lines
12 KiB
Go

package e2e
import (
"strconv"
"testing"
"github.com/argoproj/argo-cd/gitops-engine/pkg/health"
. "github.com/argoproj/argo-cd/gitops-engine/pkg/sync/common"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
. "github.com/argoproj/argo-cd/v3/pkg/apis/application/v1alpha1"
"github.com/argoproj/argo-cd/v3/test/e2e/fixture"
. "github.com/argoproj/argo-cd/v3/test/e2e/fixture/app"
"github.com/argoproj/argo-cd/v3/util/errors"
)
func TestKustomize2AppSource(t *testing.T) {
ctx := Given(t)
patchLabelMatchesFor := func(kind string) func(app *Application) {
return func(_ *Application) {
name := "k2-patched-guestbook-ui-deploy1"
labelValue, err := fixture.Run(
"", "kubectl", "-n="+ctx.DeploymentNamespace(),
"get", kind, name,
"-ojsonpath={.metadata.labels.patched-by}")
require.NoError(t, err)
assert.Equal(t, "argo-cd", labelValue, "wrong value of 'patched-by' label of %s %s", kind, name)
}
}
ctx.
Path(guestbookPath).
NamePrefix("k2-").
NameSuffix("-deploy1").
When().
CreateApp().
Then().
Expect(SyncStatusIs(SyncStatusCodeOutOfSync)).
When().
PatchApp(`[
{
"op": "replace",
"path": "/spec/source/kustomize/namePrefix",
"value": "k2-patched-"
},
{
"op": "add",
"path": "/spec/source/kustomize/commonLabels",
"value": {
"patched-by": "argo-cd"
}
}
]`).
Then().
Expect(Success("")).
When().
Sync().
Then().
Expect(Success("")).
Expect(OperationPhaseIs(OperationSucceeded)).
Expect(SyncStatusIs(SyncStatusCodeSynced)).
Expect(HealthIs(health.HealthStatusHealthy)).
And(patchLabelMatchesFor("Service")).
And(patchLabelMatchesFor("Deployment"))
}
// when we have a config map generator, AND the ignore annotation, it is ignored in the app's sync status
func TestSyncStatusOptionIgnore(t *testing.T) {
var oldMap string
Given(t).
Path("kustomize-cm-gen").
When().
CreateApp().
Sync().
Then().
Expect(OperationPhaseIs(OperationSucceeded)).
Expect(SyncStatusIs(SyncStatusCodeSynced)).
Expect(HealthIs(health.HealthStatusHealthy)).
And(func(app *Application) {
resourceStatus := app.Status.Resources[0]
assert.Contains(t, resourceStatus.Name, "my-map-")
assert.Equal(t, SyncStatusCodeSynced, resourceStatus.Status)
oldMap = resourceStatus.Name
}).
When().
// we now force generation of a second CM
PatchFile("kustomization.yaml", `[{"op": "replace", "path": "/configMapGenerator/0/literals/0", "value": "foo=baz"}]`).
Refresh(RefreshTypeHard).
Then().
// this is standard logging from the command - tough one - true statement
When().
Sync().
Then().
Expect(OperationPhaseIs(OperationSucceeded)).
// this is a key check - we expect the app to be healthy because, even though we have a resources that needs
// pruning, because it is annotated with IgnoreExtraneous it should not contribute to the sync status
Expect(SyncStatusIs(SyncStatusCodeSynced)).
Expect(HealthIs(health.HealthStatusHealthy)).
And(func(app *Application) {
assert.Len(t, app.Status.Resources, 2)
for _, resourceStatus := range app.Status.Resources {
// new map in-sync
if resourceStatus.Name != oldMap {
assert.Contains(t, resourceStatus.Name, "my-map-")
// make sure we've a new map with changed name
assert.Equal(t, SyncStatusCodeSynced, resourceStatus.Status)
} else {
assert.Equal(t, SyncStatusCodeOutOfSync, resourceStatus.Status)
}
}
})
}
// make sure we can create an app which has a SSH remote base
func TestKustomizeSSHRemoteBase(t *testing.T) {
Given(t).
// not the best test, as we should have two remote repos both with the same SSH private key
SSHInsecureRepoURLAdded(true).
RepoURLType(fixture.RepoURLTypeSSH).
Path(fixture.LocalOrRemotePath("ssh-kustomize-base")).
When().
CreateApp().
Sync().
Then().
Expect(OperationPhaseIs(OperationSucceeded)).
Expect(ResourceSyncStatusIs("ConfigMap", "my-map", SyncStatusCodeSynced))
}
// make sure we can create an app which has a SSH remote base
func TestKustomizeDeclarativeInvalidApp(t *testing.T) {
Given(t).
Path("invalid-kustomize").
When().
Declarative("declarative-apps/app.yaml").
Then().
Expect(Success("")).
Expect(HealthIs(health.HealthStatusHealthy)).
Expect(SyncStatusIs(SyncStatusCodeUnknown)).
Expect(Condition(ApplicationConditionComparisonError, "invalid-kustomize/does-not-exist.yaml: no such file or directory"))
}
// Flag --load_restrictor is no longer supported in Kustomize 4
func TestKustomizeBuildOptionsLoadRestrictor(t *testing.T) {
Given(t).
Path(guestbookPath).
And(func() {
errors.NewHandler(t).FailOnErr(fixture.Run("", "kubectl", "patch", "cm", "argocd-cm",
"-n", fixture.TestNamespace(),
"-p", `{ "data": { "kustomize.buildOptions": "--load-restrictor LoadRestrictionsNone" } }`))
}).
When().
PatchFile("kustomization.yaml", `[{"op": "replace", "path": "/resources/1", "value": "../guestbook_local/guestbook-ui-svc.yaml"}]`).
CreateApp().
Sync().
Then().
Expect(OperationPhaseIs(OperationSucceeded)).
Expect(HealthIs(health.HealthStatusHealthy)).
Expect(SyncStatusIs(SyncStatusCodeSynced)).
Given().
And(func() {
errors.NewHandler(t).FailOnErr(fixture.Run("", "kubectl", "patch", "cm", "argocd-cm",
"-n", fixture.TestNamespace(),
"-p", `{ "data": { "kustomize.buildOptions": "" } }`))
})
}
// make sure we we can invoke the CLI to replace images
func TestKustomizeImages(t *testing.T) {
Given(t).
Path("kustomize").
When().
CreateApp().
// pass two flags to check the multi flag logic works
AppSet("--kustomize-image", "alpine:foo", "--kustomize-image", "alpine:bar").
Then().
And(func(app *Application) {
assert.Contains(t, app.Spec.GetSource().Kustomize.Images, KustomizeImage("alpine:bar"))
})
}
// make sure we we can invoke the CLI to replace replicas and actual deployment is set to correct value
func TestKustomizeReplicas2AppSource(t *testing.T) {
ctx := Given(t)
deploymentName := "guestbook-ui"
deploymentReplicas := 2
checkReplicasFor := func(kind string) func(app *Application) {
return func(_ *Application) {
name := deploymentName
replicas, err := fixture.Run(
"", "kubectl", "-n="+ctx.DeploymentNamespace(),
"get", kind, name,
"-ojsonpath={.spec.replicas}")
require.NoError(t, err)
assert.Equal(t, strconv.Itoa(deploymentReplicas), replicas, "wrong value of replicas %s %s", kind, name)
}
}
ctx.
Path("guestbook").
When().
CreateApp().
AppSet("--kustomize-replica", deploymentName+"=2").
Then().
And(func(app *Application) {
assert.Equal(t, deploymentName, app.Spec.Source.Kustomize.Replicas[0].Name)
}).
And(func(app *Application) {
assert.Equal(t, deploymentReplicas, int(app.Spec.Source.Kustomize.Replicas[0].Count.IntVal))
}). // check Kustomize CLI
Expect(Success("")).
When().
Sync().
Then().
Expect(Success("")).
Expect(OperationPhaseIs(OperationSucceeded)).
Expect(SyncStatusIs(SyncStatusCodeSynced)).
Expect(HealthIs(health.HealthStatusHealthy)).
And(checkReplicasFor("Deployment"))
}
// make sure we we can invoke the CLI to set namesuffix
func TestKustomizeNameSuffix(t *testing.T) {
Given(t).
Path("kustomize").
When().
CreateApp().
AppSet("--namesuffix", "-suf").
Then().
And(func(app *Application) {
assert.Contains(t, app.Spec.GetSource().Kustomize.NameSuffix, "-suf")
})
}
// make sure we we can invoke the CLI to set and unset namesuffix and kustomize-image
func TestKustomizeUnsetOverride(t *testing.T) {
Given(t).
Path("kustomize").
When().
CreateApp().
AppSet("--namesuffix", "-suf").
Then().
And(func(app *Application) {
assert.Contains(t, app.Spec.GetSource().Kustomize.NameSuffix, "-suf")
}).
When().
AppUnSet("--namesuffix").
Then().
And(func(app *Application) {
assert.Nil(t, app.Spec.GetSource().Kustomize)
}).
When().
AppSet("--kustomize-image", "alpine:foo", "--kustomize-image", "alpine:bar").
Then().
And(func(app *Application) {
assert.Contains(t, app.Spec.GetSource().Kustomize.Images, KustomizeImage("alpine:bar"))
}).
When().
// AppUnSet("--kustomize-image=alpine").
AppUnSet("--kustomize-image", "alpine", "--kustomize-image", "alpine").
Then().
And(func(app *Application) {
assert.Nil(t, app.Spec.GetSource().Kustomize)
})
}
// make sure we we can invoke the CLI to set and unset Deployment
func TestKustomizeUnsetOverrideDeployment(t *testing.T) {
deploymentName := "guestbook-ui"
deploymentReplicas := int32(2)
Given(t).
Path("guestbook").
When(). // Replicas
CreateApp().
AppSet("--kustomize-replica", deploymentName+"=2").
Then().
And(func(app *Application) {
assert.Equal(t, deploymentName, app.Spec.Source.Kustomize.Replicas[0].Name)
}).
And(func(app *Application) {
assert.Equal(t, deploymentReplicas, app.Spec.Source.Kustomize.Replicas[0].Count.IntVal)
}).
When().
AppUnSet("--kustomize-replica", deploymentName).
Then().
And(func(app *Application) {
assert.Nil(t, app.Spec.Source.Kustomize)
})
}
// make sure kube-version gets passed down to resources
func TestKustomizeKubeVersion(t *testing.T) {
ctx := Given(t)
ctx.Path("kustomize-kube-version").
And(func() {
errors.NewHandler(t).FailOnErr(fixture.Run("", "kubectl", "patch", "cm", "argocd-cm",
"-n", fixture.TestNamespace(),
"-p", `{ "data": { "kustomize.buildOptions": "--enable-helm" } }`))
}).
When().
CreateApp().
Sync().
Then().
Expect(SyncStatusIs(SyncStatusCodeSynced)).
And(func(_ *Application) {
kubeVersion := errors.NewHandler(t).FailOnErr(fixture.Run(".", "kubectl", "-n", ctx.DeploymentNamespace(), "get", "cm", "my-map",
"-o", "jsonpath={.data.kubeVersion}")).(string)
// Capabilities.KubeVersion defaults to 1.9.0, we assume here you are running a later version
assert.LessOrEqual(t, fixture.GetVersions(t).ServerVersion.Format("v%s.%s"), kubeVersion)
}).
When().
// Make sure override works.
AppSet("--kustomize-kube-version", "999.999.999").
Sync().
Then().
Expect(SyncStatusIs(SyncStatusCodeSynced)).
And(func(_ *Application) {
assert.Equal(t, "v999.999.999", errors.NewHandler(t).FailOnErr(fixture.Run(".", "kubectl", "-n", ctx.DeploymentNamespace(), "get", "cm", "my-map",
"-o", "jsonpath={.data.kubeVersion}")).(string))
})
}
// make sure api versions gets passed down to resources
func TestKustomizeApiVersions(t *testing.T) {
ctx := Given(t)
ctx.Path("kustomize-api-versions").
And(func() {
errors.NewHandler(t).FailOnErr(fixture.Run("", "kubectl", "patch", "cm", "argocd-cm",
"-n", fixture.TestNamespace(),
"-p", `{ "data": { "kustomize.buildOptions": "--enable-helm" } }`))
}).
When().
CreateApp().
Sync().
Then().
Expect(SyncStatusIs(SyncStatusCodeSynced)).
And(func(_ *Application) {
apiVersions := errors.NewHandler(t).FailOnErr(fixture.Run(".", "kubectl", "-n", ctx.DeploymentNamespace(), "get", "cm", "my-map",
"-o", "jsonpath={.data.apiVersions}")).(string)
// The v1 API shouldn't be going anywhere.
assert.Contains(t, apiVersions, "v1")
}).
When().
// Make sure override works.
AppSet("--kustomize-api-versions", "v1/MyTestResource").
Sync().
Then().
Expect(SyncStatusIs(SyncStatusCodeSynced)).
And(func(_ *Application) {
apiVersions := errors.NewHandler(t).FailOnErr(fixture.Run(".", "kubectl", "-n", ctx.DeploymentNamespace(), "get", "cm", "my-map",
"-o", "jsonpath={.data.apiVersions}")).(string)
assert.Contains(t, apiVersions, "v1/MyTestResource")
})
}
func TestKustomizeNamespaceOverride(t *testing.T) {
Given(t).
Path("kustomize-kube-version").
And(func() {
errors.NewHandler(t).FailOnErr(fixture.Run("", "kubectl", "patch", "cm", "argocd-cm",
"-n", fixture.TestNamespace(),
"-p", `{ "data": { "kustomize.buildOptions": "--enable-helm" } }`))
}).
When().
CreateApp().
Sync().
Then().
Expect(SyncStatusIs(SyncStatusCodeSynced)).
When().
AppSet("--kustomize-namespace", "does-not-exist").
Then().
// The app should stay in synced status as per https://github.com/kubernetes-sigs/kustomize/pull/5940
// the transformer will not update a helm generated namespace.
Expect(SyncStatusIs(SyncStatusCodeSynced))
}