From faa6193f34f7dac775328fbacb2f957370482024 Mon Sep 17 00:00:00 2001
From: Marek Siarkowicz <siarkowicz@google.com>
Date: Tue, 11 Jun 2024 14:29:51 +0200
Subject: [PATCH] Add tests for how recursive parameter works with object
 prefixes

---
 .../pkg/storage/cacher/cacher_test.go         |  5 ++
 .../apiserver/pkg/storage/etcd3/store_test.go |  5 ++
 .../pkg/storage/testing/store_tests.go        | 79 +++++++++++++++++++
 3 files changed, 89 insertions(+)

diff --git a/staging/src/k8s.io/apiserver/pkg/storage/cacher/cacher_test.go b/staging/src/k8s.io/apiserver/pkg/storage/cacher/cacher_test.go
index cdd318a9d00..5df73019b90 100644
--- a/staging/src/k8s.io/apiserver/pkg/storage/cacher/cacher_test.go
+++ b/staging/src/k8s.io/apiserver/pkg/storage/cacher/cacher_test.go
@@ -208,6 +208,11 @@ func TestGetListNonRecursiveWithConsistentListFromCache(t *testing.T) {
 	storagetesting.RunTestGetListNonRecursive(ctx, t, compactStorage(cacher, server.V3Client), cacher)
 }
 
+func TestGetListRecursivePrefix(t *testing.T) {
+	ctx, store, _ := testSetup(t)
+	storagetesting.RunTestGetListRecursivePrefix(ctx, t, store)
+}
+
 func checkStorageCalls(t *testing.T, pageSize, estimatedProcessedObjects uint64) {
 	// No-op function for now, since cacher passes pagination calls to underlying storage.
 }
diff --git a/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go b/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go
index c87e3ff9afc..2b596c0e52c 100644
--- a/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go
+++ b/staging/src/k8s.io/apiserver/pkg/storage/etcd3/store_test.go
@@ -166,6 +166,11 @@ func TestGetListNonRecursive(t *testing.T) {
 	storagetesting.RunTestGetListNonRecursive(ctx, t, compactStorage(client), store)
 }
 
+func TestGetListRecursivePrefix(t *testing.T) {
+	ctx, store, _ := testSetup(t)
+	storagetesting.RunTestGetListRecursivePrefix(ctx, t, store)
+}
+
 type storeWithPrefixTransformer struct {
 	*store
 }
diff --git a/staging/src/k8s.io/apiserver/pkg/storage/testing/store_tests.go b/staging/src/k8s.io/apiserver/pkg/storage/testing/store_tests.go
index e30f4262649..2a9d6ff3efb 100644
--- a/staging/src/k8s.io/apiserver/pkg/storage/testing/store_tests.go
+++ b/staging/src/k8s.io/apiserver/pkg/storage/testing/store_tests.go
@@ -1573,6 +1573,85 @@ func RunTestGetListNonRecursive(ctx context.Context, t *testing.T, compaction Co
 	}
 }
 
+// RunTestGetListRecursivePrefix tests how recursive parameter works for object keys that are prefixes of each other.
+func RunTestGetListRecursivePrefix(ctx context.Context, t *testing.T, store storage.Interface) {
+	fooKey, fooObj := testPropagateStore(ctx, t, store, &example.Pod{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "test-ns"}})
+	fooBarKey, fooBarObj := testPropagateStore(ctx, t, store, &example.Pod{ObjectMeta: metav1.ObjectMeta{Name: "foobar", Namespace: "test-ns"}})
+	_, otherNamespaceObj := testPropagateStore(ctx, t, store, &example.Pod{ObjectMeta: metav1.ObjectMeta{Name: "baz", Namespace: "test-ns2"}})
+
+	tests := []struct {
+		name        string
+		key         string
+		recursive   bool
+		expectedOut []example.Pod
+	}{
+		{
+			name:        "NonRecursive on resource prefix doesn't return any objects",
+			key:         "/pods/",
+			recursive:   false,
+			expectedOut: []example.Pod{},
+		},
+		{
+			name:        "Recursive on resource prefix returns all objects",
+			key:         "/pods/",
+			recursive:   true,
+			expectedOut: []example.Pod{*fooObj, *fooBarObj, *otherNamespaceObj},
+		},
+		{
+			name:        "NonRecursive on namespace prefix doesn't return any objects",
+			key:         "/pods/test-ns/",
+			recursive:   false,
+			expectedOut: []example.Pod{},
+		},
+		{
+			name:        "Recursive on resource prefix returns objects in the namespace",
+			key:         "/pods/test-ns/",
+			recursive:   true,
+			expectedOut: []example.Pod{*fooObj, *fooBarObj},
+		},
+		{
+			name:        "NonRecursive on object key (prefix) returns object and no other objects with the same prefix",
+			key:         fooKey,
+			recursive:   false,
+			expectedOut: []example.Pod{*fooObj},
+		},
+		{
+			name:        "Recursive on object key (prefix) doesn't return anything",
+			key:         fooKey,
+			recursive:   true,
+			expectedOut: []example.Pod{},
+		},
+		{
+			name:        "NonRecursive on object key (no-prefix) return object",
+			key:         fooBarKey,
+			recursive:   false,
+			expectedOut: []example.Pod{*fooBarObj},
+		},
+		{
+			name:        "Recursive on object key (no-prefix) doesn't return anything",
+			key:         fooBarKey,
+			recursive:   true,
+			expectedOut: []example.Pod{},
+		},
+	}
+
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			out := &example.PodList{}
+			storageOpts := storage.ListOptions{
+				Recursive: tt.recursive,
+				Predicate: storage.Everything,
+			}
+			err := store.GetList(ctx, tt.key, storageOpts, out)
+			if err != nil {
+				t.Fatalf("GetList failed: %v", err)
+			}
+			expectNoDiff(t, "incorrect list pods", tt.expectedOut, out.Items)
+		})
+	}
+}
+
 type CallsValidation func(t *testing.T, pageSize, estimatedProcessedObjects uint64)
 
 func RunTestListContinuation(ctx context.Context, t *testing.T, store storage.Interface, validation CallsValidation) {