test

Author: camilamacedo86

internal/operator-controller/rukpak/render/render_test.go

@@ -1,9 +1,17 @@
 package render_test
 
 import (
+	"cmp"
 	"errors"
 	"fmt"
+	"github.com/operator-framework/operator-controller/internal/operator-controller/rukpak/bundle/source"
+	"github.com/operator-framework/operator-controller/internal/operator-controller/rukpak/render/registryv1"
+	"os"
+	"path/filepath"
 	"reflect"
+	"sigs.k8s.io/yaml"
+	"slices"
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -267,3 +275,84 @@ func Test_BundleValidatorCallsAllValidationFnsInOrder(t *testing.T) {
 	require.NoError(t, val.Validate(nil))
 	require.Equal(t, "hi", actual)
 }
+
+// This test ensures consistent rendering behavior for registry+v1 bundles:
+// - Uses the bundles defined in the testdata directory
+// - Renders manifests using the registryv1 renderer
+// - Sorts rendered objects by Kind, Namespace, and Name to ensure deterministic output
+// - Writes the results to a temporary directory for inspection
+// - Ensures the rendering completes without error
+// - Automatically cleans up the generated files after the test completes
+//
+// This was introduced to prevent flaky diffs caused by non-deterministic manifest ordering.
+// Related issue: https://github.com/operator-framework/operator-controller/pull/1895
+func Test_RenderRegistryV1Bundle_GenerateAndAutoCleanup(t *testing.T) {
+	bundleRoot := "testdata/bundles"
+
+	testCases := []struct {
+		name             string
+		installNamespace string
+		watchNamespace   string
+		bundle           string
+		testCaseName     string
+	}{
+		{
+			name:             "AllNamespaces",
+			installNamespace: "argocd-system",
+			watchNamespace:   "",
+			bundle:           "argocd-operator.v0.6.0",
+			testCaseName:     "all-namespaces",
+		},
+		{
+			name:             "SingleNamespaces",
+			installNamespace: "argocd-system",
+			watchNamespace:   "argocd-watch",
+			bundle:           "argocd-operator.v0.6.0",
+			testCaseName:     "single-namespace",
+		},
+		{
+			name:             "OwnNamespaces",
+			installNamespace: "argocd-system",
+			watchNamespace:   "argocd-system",
+			bundle:           "argocd-operator.v0.6.0",
+			testCaseName:     "own-namespace",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			bundlePath := filepath.Join(bundleRoot, tc.bundle)
+			outputDir := filepath.Join(t.TempDir(), tc.bundle, tc.testCaseName)
+
+			fs := os.DirFS(bundlePath)
+			bundle, err := source.FromFS(fs).GetBundle()
+			require.NoError(t, err)
+
+			rendered, err := registryv1.Renderer.Render(bundle, tc.installNamespace,
+				render.WithTargetNamespaces(tc.watchNamespace))
+			require.NoError(t, err)
+
+			sorted := slices.SortedFunc(slices.Values(rendered), orderByKindNamespaceName)
+
+			require.NoError(t, os.MkdirAll(outputDir, os.ModePerm))
+
+			for idx, obj := range sorted {
+				kind := obj.GetObjectKind().GroupVersionKind().Kind
+				filename := fmt.Sprintf("%02d_%s_%s.yaml", idx, strings.ToLower(kind), obj.GetName())
+				filePath := filepath.Join(outputDir, filename)
+
+				data, err := yaml.Marshal(obj)
+				require.NoError(t, err)
+				require.NoError(t, os.WriteFile(filePath, data, 0600))
+			}
+		})
+	}
+}
+
+func orderByKindNamespaceName(a client.Object, b client.Object) int {
+	return cmp.Or(
+		cmp.Compare(a.GetObjectKind().GroupVersionKind().Kind, b.GetObjectKind().GroupVersionKind().Kind),
+		cmp.Compare(a.GetNamespace(), b.GetNamespace()),
+		cmp.Compare(a.GetName(), b.GetName()),
+	)
+}