Skip to content

refactor(diff): extract secret handling to preHandleSecrets #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 25, 2025
Merged

refactor(diff): extract secret handling to preHandleSecrets #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
129dcb6
refactor(diff): extract secret handling to preHandleSecrets
yxxhero May 24, 2025
f3e073d
Update diff/diff_test.go
yxxhero May 25, 2025
5602233
fix more test
yxxhero May 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 23 additions & 34 deletions diff/diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,16 +239,9 @@ func doDiff(report *Report, key string, oldContent *manifest.MappingResult, newC
}
}

// redactSecrets redacts secrets from the diff output.
func redactSecrets(old, new *manifest.MappingResult) {
func preHandleSecrets(old, new *manifest.MappingResult) (v1.Secret, v1.Secret, error, error) {
var oldSecretDecodeErr, newSecretDecodeErr error
if (old != nil && old.Kind != "Secret") || (new != nil && new.Kind != "Secret") {
return
}
serializer := json.NewYAMLSerializer(json.DefaultMetaFactory, scheme.Scheme,
scheme.Scheme)
var oldSecret, newSecret v1.Secret

if old != nil {
oldSecretDecodeErr = yaml.NewYAMLToJSONDecoder(bytes.NewBufferString(old.Content)).Decode(&oldSecret)
if oldSecretDecodeErr != nil {
Expand Down Expand Up @@ -279,6 +272,17 @@ func redactSecrets(old, new *manifest.MappingResult) {
}
}
}
return oldSecret, newSecret, oldSecretDecodeErr, newSecretDecodeErr
}

// redactSecrets redacts secrets from the diff output.
func redactSecrets(old, new *manifest.MappingResult) {
if (old != nil && old.Kind != "Secret") || (new != nil && new.Kind != "Secret") {
return
}
serializer := json.NewYAMLSerializer(json.DefaultMetaFactory, scheme.Scheme, scheme.Scheme)

oldSecret, newSecret, oldSecretDecodeErr, newSecretDecodeErr := preHandleSecrets(old, new)

if old != nil && oldSecretDecodeErr == nil {
oldSecret.StringData = make(map[string]string, len(oldSecret.Data))
Expand Down Expand Up @@ -324,38 +328,23 @@ func redactSecrets(old, new *manifest.MappingResult) {

// decodeSecrets decodes secrets from the diff output.
func decodeSecrets(old, new *manifest.MappingResult) {
var oldSecretDecodeErr, newSecretDecodeErr error
if (old != nil && old.Kind != "Secret") || (new != nil && new.Kind != "Secret") {
return
}
serializer := json.NewYAMLSerializer(json.DefaultMetaFactory, scheme.Scheme,
scheme.Scheme)
var oldSecret, newSecret v1.Secret
serializer := json.NewYAMLSerializer(json.DefaultMetaFactory, scheme.Scheme, scheme.Scheme)

if old != nil {
oldSecretDecodeErr = yaml.NewYAMLToJSONDecoder(bytes.NewBufferString(old.Content)).Decode(&oldSecret)
if oldSecretDecodeErr != nil {
old.Content = fmt.Sprintf("Error parsing old secret: %s", oldSecretDecodeErr)
} else {
if len(oldSecret.Data) > 0 && oldSecret.StringData == nil {
oldSecret.StringData = make(map[string]string, len(oldSecret.Data))
}
for k, v := range oldSecret.Data {
oldSecret.StringData[k] = string(v)
}
oldSecret, newSecret, oldSecretDecodeErr, newSecretDecodeErr := preHandleSecrets(old, new)

if old != nil && oldSecretDecodeErr == nil {
oldSecret.StringData = make(map[string]string, len(oldSecret.Data))
for k, v := range oldSecret.Data {
oldSecret.StringData[k] = string(v)
}
}
if new != nil {
newSecretDecodeErr = yaml.NewYAMLToJSONDecoder(bytes.NewBufferString(new.Content)).Decode(&newSecret)
if newSecretDecodeErr != nil {
new.Content = fmt.Sprintf("Error parsing new secret: %s", newSecretDecodeErr)
} else {
if len(newSecret.Data) > 0 && newSecret.StringData == nil {
newSecret.StringData = make(map[string]string, len(newSecret.StringData))
}
for k, v := range newSecret.Data {
newSecret.StringData[k] = string(v)
}
if new != nil && newSecretDecodeErr == nil {
newSecret.StringData = make(map[string]string, len(newSecret.Data))
for k, v := range newSecret.Data {
newSecret.StringData[k] = string(v)
}
}

Expand Down
42 changes: 42 additions & 0 deletions diff/diff_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,6 +943,48 @@ stringData:
require.Contains(t, new.Content, "key1: value1changed")
require.Contains(t, new.Content, "key2: value2")
})
t.Run("decodeSecrets with stringData and data ensuring that stringData always precedes/overrides data on Secrets", func(t *testing.T) {
old := &manifest.MappingResult{
Name: "default, foo, Secret (v1)",
Kind: "Secret",
Content: `
apiVersion: v1
kind: Secret
metadata:
name: foo
type: Opaque
stringData:
key1: value1.stringdata
key2: value2.stringdata
data:
key2: dmFsdWUyLmRhdGE=
key3: dmFsdWUzLmRhdGE=
`,
}
new := &manifest.MappingResult{
Name: "default, foo, Secret (v1)",
Kind: "Secret",
Content: `
apiVersion: v1
kind: Secret
metadata:
name: foo
type: Opaque
stringData:
key1: value1changed.stringdata
key2: value2.stringdata
data:
key3: dmFsdWUzLmRhdGE=
`,
}
decodeSecrets(old, new)
require.Contains(t, old.Content, "key1: value1.stringdata")
require.Contains(t, old.Content, "key2: value2.stringdata")
require.Contains(t, old.Content, "key3: value3.data")
require.Contains(t, new.Content, "key1: value1changed.stringdata")
require.Contains(t, new.Content, "key2: value2.stringdata")
require.Contains(t, new.Content, "key3: value3.data")
})

t.Run("decodeSecrets with invalid base64", func(t *testing.T) {
old := &manifest.MappingResult{
Expand Down
Loading