mirror of
https://github.com/hanzoai/deploy.git
synced 2026-10-07 08:44:50 +00:00
zeekayandHanzo Dev
1ab6e799c1
go.mod still declared `module github.com/hanzoai/deploy` after the repo was renamed. A Go module path is not cosmetic — it is the resolvable location. So `go get github.com/hanzoai/cd` could not work, and anything importing this module had to spell a name that no longer exists at that address. The build log of v3.6.0 is where it surfaced: the compiler was still emitting github.com/hanzoai/deploy/cmd/cd/commands. 3541 import paths across 690 .go, 19 .proto, 4 .yaml, 3 .sh, 2 .mod, Procfile and Makefile. Plus the 62 ghcr.io/hanzoai/deploy image references, moved to ghcr.io/hanzoai/cd to match hanzo.yml's build target — a distinct string from the module path, replaced separately so neither could clobber the other. go mod tidy clean, CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build ./... clean. Co-authored-by: Hanzo Dev <[email protected]>
330 lines
10 KiB
Go
330 lines
10 KiB
Go
package normalizers
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
|
"sigs.k8s.io/yaml"
|
|
|
|
"github.com/hanzoai/cd/pkg/apis/application/v1alpha1"
|
|
"github.com/hanzoai/cd/test"
|
|
)
|
|
|
|
func TestNormalizeObjectWithMatchedGroupKind(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Group: "apps",
|
|
Kind: "Deployment",
|
|
JSONPointers: []string{"/not-matching-path", "/spec/template/spec/containers"},
|
|
}}, make(map[string]v1alpha1.ResourceOverride), IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
|
|
_, has, err := unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "containers")
|
|
require.NoError(t, err)
|
|
assert.True(t, has)
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
_, has, err = unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "containers")
|
|
require.NoError(t, err)
|
|
assert.False(t, has)
|
|
|
|
err = normalizer.Normalize(nil)
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestNormalizeNoMatchedGroupKinds(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Group: "",
|
|
Kind: "Service",
|
|
JSONPointers: []string{"/spec"},
|
|
}}, make(map[string]v1alpha1.ResourceOverride), IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
|
|
_, hasSpec, err := unstructured.NestedMap(deployment.Object, "spec")
|
|
require.NoError(t, err)
|
|
assert.True(t, hasSpec)
|
|
}
|
|
|
|
func TestNormalizeMatchedResourceOverrides(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{}, map[string]v1alpha1.ResourceOverride{
|
|
"apps/Deployment": {
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{JSONPointers: []string{"/spec/template/spec/containers"}},
|
|
},
|
|
}, IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
|
|
_, has, err := unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "containers")
|
|
require.NoError(t, err)
|
|
assert.True(t, has)
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
_, has, err = unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "containers")
|
|
require.NoError(t, err)
|
|
assert.False(t, has)
|
|
}
|
|
|
|
const testCRDYAML = `
|
|
apiVersion: apiextensions.k8s.io/v1
|
|
kind: CustomResourceDefinition
|
|
metadata:
|
|
name: certificates.cert-manager.io
|
|
spec:
|
|
conversion:
|
|
strategy: None
|
|
group: cert-manager.io
|
|
names:
|
|
kind: Certificate
|
|
listKind: CertificateList
|
|
plural: certificates
|
|
shortNames:
|
|
- cert
|
|
- certs
|
|
singular: certificate
|
|
scope: Namespaced
|
|
version: v1alpha1
|
|
versions:
|
|
- name: v1alpha1
|
|
served: true
|
|
storage: true
|
|
schema:
|
|
openAPIV3Schema:
|
|
type: object
|
|
properties:
|
|
json:
|
|
x-kubernetes-preserve-unknown-fields: true`
|
|
|
|
func TestNormalizeMissingJsonPointer(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{}, map[string]v1alpha1.ResourceOverride{
|
|
"apps/Deployment": {
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{JSONPointers: []string{"/garbage"}},
|
|
},
|
|
"apiextensions.k8s.io/CustomResourceDefinition": {
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{JSONPointers: []string{"/spec/additionalPrinterColumns/0/priority"}},
|
|
},
|
|
}, IgnoreNormalizerOpts{})
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
|
|
crd := unstructured.Unstructured{}
|
|
err = yaml.Unmarshal([]byte(testCRDYAML), &crd)
|
|
require.NoError(t, err)
|
|
|
|
err = normalizer.Normalize(&crd)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func TestNormalizeGlobMatch(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{}, map[string]v1alpha1.ResourceOverride{
|
|
"*/*": {
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{JSONPointers: []string{"/spec/template/spec/containers"}},
|
|
},
|
|
}, IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
|
|
_, has, err := unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "containers")
|
|
require.NoError(t, err)
|
|
assert.True(t, has)
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
_, has, err = unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "containers")
|
|
require.NoError(t, err)
|
|
assert.False(t, has)
|
|
}
|
|
|
|
func TestNormalizeJQPathExpression(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Group: "apps",
|
|
Kind: "Deployment",
|
|
JQPathExpressions: []string{".spec.template.spec.initContainers[] | select(.name == \"init-container-0\")"},
|
|
}}, make(map[string]v1alpha1.ResourceOverride), IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
|
|
var initContainers []any
|
|
initContainers = append(initContainers, map[string]any{"name": "init-container-0"})
|
|
initContainers = append(initContainers, map[string]any{"name": "init-container-1"})
|
|
err = unstructured.SetNestedSlice(deployment.Object, initContainers, "spec", "template", "spec", "initContainers")
|
|
require.NoError(t, err)
|
|
|
|
actualInitContainers, has, err := unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "initContainers")
|
|
require.NoError(t, err)
|
|
assert.True(t, has)
|
|
assert.Len(t, actualInitContainers, 2)
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
actualInitContainers, has, err = unstructured.NestedSlice(deployment.Object, "spec", "template", "spec", "initContainers")
|
|
require.NoError(t, err)
|
|
assert.True(t, has)
|
|
assert.Len(t, actualInitContainers, 1)
|
|
|
|
actualInitContainerName, has, err := unstructured.NestedString(actualInitContainers[0].(map[string]any), "name")
|
|
require.NoError(t, err)
|
|
assert.True(t, has)
|
|
assert.Equal(t, "init-container-1", actualInitContainerName)
|
|
}
|
|
|
|
func TestNormalizeIllegalJQPathExpression(t *testing.T) {
|
|
t.Parallel()
|
|
_, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Group: "apps",
|
|
Kind: "Deployment",
|
|
JQPathExpressions: []string{".spec.template.spec.containers[] | select(.name == \"missing-quote)"},
|
|
// JSONPointers: []string{"no-starting-slash"},
|
|
}}, make(map[string]v1alpha1.ResourceOverride), IgnoreNormalizerOpts{})
|
|
|
|
require.Error(t, err)
|
|
}
|
|
|
|
func TestNormalizeJQPathExpressionWithError(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Group: "apps",
|
|
Kind: "Deployment",
|
|
JQPathExpressions: []string{".spec.fakeField.foo[]"},
|
|
}}, make(map[string]v1alpha1.ResourceOverride), IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
deployment := test.NewDeployment()
|
|
originalDeployment, err := deployment.MarshalJSON()
|
|
require.NoError(t, err)
|
|
|
|
err = normalizer.Normalize(deployment)
|
|
require.NoError(t, err)
|
|
|
|
normalizedDeployment, err := deployment.MarshalJSON()
|
|
require.NoError(t, err)
|
|
assert.Equal(t, originalDeployment, normalizedDeployment)
|
|
}
|
|
|
|
func TestNormalizeExpectedErrorAreSilenced(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{}, map[string]v1alpha1.ResourceOverride{
|
|
"*/*": {
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{
|
|
JSONPointers: []string{"/invalid", "/invalid/json/path"},
|
|
},
|
|
},
|
|
}, IgnoreNormalizerOpts{})
|
|
require.NoError(t, err)
|
|
|
|
ignoreNormalizer := normalizer.(*ignoreNormalizer)
|
|
assert.Len(t, ignoreNormalizer.patches, 2)
|
|
jsonPatch := ignoreNormalizer.patches[0]
|
|
jqPatch := ignoreNormalizer.patches[1]
|
|
|
|
deployment := test.NewDeployment()
|
|
deploymentData, err := json.Marshal(deployment)
|
|
require.NoError(t, err)
|
|
|
|
// Error: "error in remove for path: '/invalid': Unable to remove nonexistent key: invalid: missing value"
|
|
_, err = jsonPatch.Apply(deploymentData)
|
|
assert.False(t, shouldLogError(err))
|
|
|
|
// Error: "remove operation does not apply: doc is missing path: \"/invalid/json/path\": missing value"
|
|
_, err = jqPatch.Apply(deploymentData)
|
|
assert.False(t, shouldLogError(err))
|
|
|
|
assert.True(t, shouldLogError(errors.New("An error that should not be ignored")))
|
|
}
|
|
|
|
func TestJqPathExpressionFailWithTimeout(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{}, map[string]v1alpha1.ResourceOverride{
|
|
"*/*": {
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{
|
|
JQPathExpressions: []string{"until(true==false; [.] + [1])"},
|
|
},
|
|
},
|
|
}, IgnoreNormalizerOpts{})
|
|
require.NoError(t, err)
|
|
|
|
ignoreNormalizer := normalizer.(*ignoreNormalizer)
|
|
assert.Len(t, ignoreNormalizer.patches, 1)
|
|
jqPatch := ignoreNormalizer.patches[0]
|
|
|
|
deployment := test.NewDeployment()
|
|
deploymentData, err := json.Marshal(deployment)
|
|
require.NoError(t, err)
|
|
|
|
_, err = jqPatch.Apply(deploymentData)
|
|
assert.ErrorContains(t, err, "JQ patch execution timed out")
|
|
}
|
|
|
|
func TestJQPathExpressionReturnsHelpfulError(t *testing.T) {
|
|
t.Parallel()
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Kind: "ConfigMap",
|
|
// This is a really wild expression, but it does trigger the desired error.
|
|
JQPathExpressions: []string{`.nothing) | .data["config.yaml"] |= (fromjson | del(.auth) | tojson`},
|
|
}}, nil, IgnoreNormalizerOpts{})
|
|
|
|
require.NoError(t, err)
|
|
|
|
configMap := test.NewConfigMap()
|
|
require.NoError(t, err)
|
|
|
|
out := test.CaptureLogEntries(func() {
|
|
err = normalizer.Normalize(configMap)
|
|
require.NoError(t, err)
|
|
})
|
|
assert.Contains(t, out, "fromjson cannot be applied")
|
|
}
|
|
|
|
func TestNormalizeFailureLogIncludesResourceContext(t *testing.T) {
|
|
t.Parallel()
|
|
// When a normalization patch fails with a non-silenced error, the log entry
|
|
// must identify which resource was being normalized so operators can act on it.
|
|
// Regression test for https://github.com/argoproj/argo-cd/issues/14148.
|
|
normalizer, err := NewIgnoreNormalizer([]v1alpha1.ResourceIgnoreDifferences{{
|
|
Kind: "ConfigMap",
|
|
JQPathExpressions: []string{`.nothing) | .data["config.yaml"] |= (fromjson | del(.auth) | tojson`},
|
|
}}, nil, IgnoreNormalizerOpts{})
|
|
require.NoError(t, err)
|
|
|
|
configMap := test.NewConfigMap()
|
|
|
|
out := test.CaptureLogEntries(func() {
|
|
err = normalizer.Normalize(configMap)
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
assert.Contains(t, out, "Failed to apply normalization patch")
|
|
assert.Contains(t, out, "kind=ConfigMap")
|
|
assert.Contains(t, out, "name=my-configmap")
|
|
}
|