Skip to content

fix: Allow patches with empty files with multiple newlines or comments #5771

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 5 commits into from
Mar 17, 2025
Merged

fix: Allow patches with empty files with multiple newlines or comments #5771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1e3d875
fix: Add test, when an empty patch file is given, it should not fail
jchanam Sep 27, 2024
5952169
fix: Add code so there's no error given if an empty file is given as …
jchanam Sep 27, 2024
bfd408c
chore: Generate plugin with pluginator
jchanam Nov 19, 2024
6e60747
chore: fix tests
jchanam Dec 26, 2024
bec1276
Add t.helper() at start of test function
jchanam Jan 17, 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
5 changes: 3 additions & 2 deletions api/internal/builtins/PatchTransformer.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions plugin/builtin/patchtransformer/PatchTransformer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ func (p *plugin) Config(h *resmap.PluginHelpers, c []byte) error {
patchesSM, errSM := h.ResmapFactory().RF().SliceFromBytes([]byte(p.patchText))
patchesJson, errJson := jsonPatchFromBytes([]byte(p.patchText))

if (errSM == nil && errJson == nil) ||
(patchesSM != nil && patchesJson != nil) {
if ((errSM == nil && errJson == nil) ||
(patchesSM != nil && patchesJson != nil)) &&
(len(patchesSM) > 0 && len(patchesJson) > 0) {
return fmt.Errorf(
"illegally qualifies as both an SM and JSON patch: %s",
p.patchSource)
Expand Down
51 changes: 51 additions & 0 deletions plugin/builtin/patchtransformer/PatchTransformer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1108,3 +1108,54 @@ spec:
name: test-deployment
`)
}

func TestPatchTransformerPatchEmpty(t *testing.T) {
th := kusttest_test.MakeEnhancedHarness(t).
PrepBuiltin("PatchTransformer")
defer th.Reset()

th.WriteF("patch.yaml", `
`)

th.RunTransformerAndCheckError(`
apiVersion: builtin
kind: PatchTransformer
metadata:
name: notImportantHere
path: patch.yaml
target:
name: myDeploy
`, someDeploymentResources, func(t *testing.T, err error) {
t.Helper()
if err != nil {
t.Fatalf("unexpected error")
}
})
}

func TestPatchTransformerPatchEmptyOnlyComments(t *testing.T) {
th := kusttest_test.MakeEnhancedHarness(t).
PrepBuiltin("PatchTransformer")
defer th.Reset()

th.WriteF("patch.yaml", `
# File with only comments

# Is a virtually empty yaml
`)

th.RunTransformerAndCheckError(`
apiVersion: builtin
kind: PatchTransformer
metadata:
name: notImportantHere
path: patch.yaml
target:
name: myDeploy
`, someDeploymentResources, func(t *testing.T, err error) {
t.Helper()
if err != nil {
t.Fatalf("unexpected error")
}
})
}
Loading