feat: add SortOptions support for kustomize resource ordering by yxxhero · Pull Request #189 · helmfile/chartify

yxxhero · 2026-05-14T22:41:17Z

Summary

Adds SortOptions type with Order field to control kustomize's resource sorting order (accepted values: "legacy", "fifo")
Validates SortOptions.Order early in Chartify() to reject invalid values with a clear error
Wires SortOptions through ChartifyOpts → KustomizeBuildOpts (kustomize-based apps) and PatchOpts (patch-based builds)
Writes sortOptions to the generated kustomization.yaml in both code paths (byte append, since kustomize has no edit set sortoptions command)
Fixes a pre-existing nilness lint warning (tautological condition: non-nil != nil)

Usage

opts := &chartify.ChartifyOpts{
    SortOptions: &chartify.SortOptions{Order: "fifo"},
}
chartDir, err := runner.Chartify("myrelease", "./mychart", opts)

This generates:

sortOptions:
  order: fifo

Closes #188

Add ability to set kustomize's sortOptions.order (e.g. "fifo") to control resource ordering. This reduces diff noise when applying patches by preserving the original resource order instead of using kustomize's default "legacy" sorting. Adds SortOptions to ChartifyOpts, KustomizeBuildOpts, KustomizeOpts, and PatchOpts. The sortOptions is written to the generated kustomization.yaml in both kustomize-based and patch-based code paths. Also fixes a pre-existing nilness lint warning (tautological condition). Closes #188 Signed-off-by: yxxhero <aiopsclub@163.com>

Copilot

Pull request overview

Adds a new SortOptions type (with Order) and threads it from ChartifyOpts through KustomizeBuildOpts and PatchOpts so users can control kustomize's sortOptions.order (e.g. fifo) in the generated kustomization.yaml. Resolves issue #188 to reduce diff noise from kustomize's default legacy resource ordering. Also includes a small drive-by lint fix in chartify.go and updates hardcoded hash expectations in tempdir_test.go (necessary because adding a field to ChartifyOpts changes the spew-based hash).

Changes:

Introduce SortOptions struct and add it to ChartifyOpts, KustomizeBuildOpts, KustomizeOpts, and PatchOpts.
Append sortOptions: to the generated kustomization.yaml in both KustomizeBuild and Patch code paths when set.
Remove tautological err != nil check in createDirForFile and refresh expected hashes in TestGenerateID.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
chartify.go	Adds `SortOptions` field on `ChartifyOpts` and forwards it into `KustomizeBuildOpts` / `PatchOpts`; cleans up tautological nil check.
kustomize.go	Defines `SortOptions`, adds it to `KustomizeOpts` and `KustomizeBuildOpts`, and appends serialized `sortOptions` to `kustomization.yaml` after kustomize edits.
patch.go	Adds `SortOptions` to `PatchOpts` and appends it to the inline `kustomization.yaml` content.
tempdir_test.go	Updates expected `GenerateID` hashes to reflect the new `ChartifyOpts.SortOptions` field affecting the spew-based hash.

+		if err != nil {
+			return "", fmt.Errorf("marshaling sortOptions: %w", err)
+		}
+		f, err := os.ReadFile(kustomizationPath)


+	// SortOptions configures kustomize's sortOptions for resource ordering.
+	// Use &SortOptions{Order: "fifo"} to preserve resource order and minimize diff noise.
+	// See https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/sortoptions/
+	SortOptions *SortOptions


+	if u.SortOptions != nil {
+		sortOptsBytes, err := yaml.Marshal(map[string]*SortOptions{"sortOptions": u.SortOptions})
+		if err != nil {
+			return fmt.Errorf("marshaling sortOptions: %w", err)
+		}
+		kustomizationYamlContent += string(sortOptsBytes)
+	}


- Extract duplicated sortOptions marshaling into marshalSortOptions helper used by both KustomizeBuild and Patch (review comment) - Use r.ReadFile instead of os.ReadFile for consistency with the Runner abstraction (review comment) - Add unit tests for marshalSortOptions and SortOptions behavior in generated kustomization.yaml (review comment) Signed-off-by: yxxhero <aiopsclub@163.com>

yxxhero · 2026-05-14T22:54:53Z

Addressed all three review comments in b78952e:

r.ReadFile consistency — Replaced os.ReadFile with r.ReadFile in kustomize.go to stay consistent with the Runner abstraction.
Test coverage — Added kustomize_test.go with tests for marshalSortOptions (nil, fifo, legacy) and TestKustomizationYamlWithSortOptions verifying sortOptions appears/disappears in generated kustomization.yaml.
Deduplicated marshaling — Extracted marshalSortOptions helper shared by both KustomizeBuild and Patch.

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

+	t.Run("nil returns no sortOptions content", func(t *testing.T) {
+		got, err := marshalSortOptions(nil)
+		require.NoError(t, err)
+		result := string(got)
+		require.Contains(t, result, "sortOptions: null\n")
+	})


+func TestKustomizationYamlWithSortOptions(t *testing.T) {
+	t.Run("Patch generates sortOptions in kustomization.yaml", func(t *testing.T) {
+		opts := &SortOptions{Order: "fifo"}
+		sortOptsBytes, err := marshalSortOptions(opts)
+		require.NoError(t, err)
+
+		kustomizationYamlContent := `kind: ""
+apiversion: ""
+resources:
+- templates/deployment.yaml
+patches:
+- path: strategicmergepatches/patch.0.yaml
+`
+		kustomizationYamlContent += string(sortOptsBytes)
+
+		require.True(t, strings.Contains(kustomizationYamlContent, "sortOptions:"))
+		require.True(t, strings.Contains(kustomizationYamlContent, "order: fifo"))
+	})
+
+	t.Run("Patch without SortOptions has no sortOptions in kustomization.yaml", func(t *testing.T) {
+		kustomizationYamlContent := `kind: ""
+apiversion: ""
+resources:
+- templates/deployment.yaml
+patches:
+- path: strategicmergepatches/patch.0.yaml
+`
+
+		require.False(t, strings.Contains(kustomizationYamlContent, "sortOptions:"))
+	})


+
+	t.Run("KustomizeBuild merges SortOptions from KustomizeBuildOpts", func(t *testing.T) {
+		u := &KustomizeBuildOpts{
+			SortOptions: &SortOptions{Order: "fifo"},
+		}
+		kustomizeOpts := KustomizeOpts{}
+		if u.SortOptions != nil {
+			kustomizeOpts.SortOptions = u.SortOptions
+		}
+		require.NotNil(t, kustomizeOpts.SortOptions)
+		require.Equal(t, "fifo", kustomizeOpts.SortOptions.Order)
+	})
+
+	t.Run("KustomizeBuild without SortOptions leaves kustomizeOpts.SortOptions nil", func(t *testing.T) {
+		u := &KustomizeBuildOpts{}
+		kustomizeOpts := KustomizeOpts{}
+		if u.SortOptions != nil {
+			kustomizeOpts.SortOptions = u.SortOptions
+		}
+		require.Nil(t, kustomizeOpts.SortOptions)
+	})


+	if kustomizeOpts.SortOptions != nil {
+		sortOptsBytes, err := marshalSortOptions(kustomizeOpts.SortOptions)
+		if err != nil {
+			return "", err
+		}
+		f, err := r.ReadFile(kustomizationPath)
+		if err != nil {
+			return "", fmt.Errorf("reading kustomization.yaml for sortOptions: %w", err)
+		}
+		if err := r.WriteFile(kustomizationPath, append(f, sortOptsBytes...), 0644); err != nil {
+			return "", err
+		}
+	}


+type SortOptions struct {
+	Order string `yaml:"order"`
+}


- Guard marshalSortOptions(nil) to return nil/empty instead of 'sortOptions: null' (review comment) - Add validate() on SortOptions.Order to reject invalid values early, accepted values: legacy, fifo (review comment) - Call validation from Chartify() before any kustomize operations - Rewrite tests to exercise real Runner.Patch code path via WriteFile capture, instead of inline string assertions (review comment) - Add comment explaining sortOptions uses byte append because kustomize has no 'edit set sortoptions' command (review comment) - Fix PR description to only list accepted values: legacy, fifo Signed-off-by: yxxhero <aiopsclub@163.com>

yxxhero · 2026-05-14T23:39:30Z

Addressed all second-round review comments in 65d008a:

marshalSortOptions(nil) now returns nil, nil instead of sortOptions: null\n. Updated test to assert empty bytes.
Added SortOptions.validate() that checks Order is one of legacy or fifo, returning a clear error with accepted values. Called early in Chartify() and inside marshalSortOptions().
Rewrote tests to exercise real Runner.Patch — both TestPatch_SortOptions subtests now create temp directories with real manifest files, call r.Patch() with a WriteFile wrapper that captures the generated kustomization.yaml, and assert on the captured content.
Added comment explaining that sortOptions is appended directly because kustomize has no edit set sortoptions command.
Fixed PR description to only list accepted values: legacy, fifo.

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

yxxhero requested a review from Copilot May 14, 2026 22:41

Copilot started reviewing on behalf of yxxhero May 14, 2026 22:41 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

yxxhero requested a review from Copilot May 14, 2026 22:57

Copilot started reviewing on behalf of yxxhero May 14, 2026 22:57 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

yxxhero requested a review from Copilot May 15, 2026 00:26

Copilot started reviewing on behalf of yxxhero May 15, 2026 00:26 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

yxxhero merged commit 9afce58 into master May 15, 2026
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add SortOptions support for kustomize resource ordering#189

feat: add SortOptions support for kustomize resource ordering#189
yxxhero merged 3 commits into
masterfrom
feat/sort-options

yxxhero commented May 14, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

yxxhero commented May 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

yxxhero commented May 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

yxxhero commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Usage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

yxxhero commented May 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

yxxhero commented May 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yxxhero commented May 14, 2026 •

edited

Loading