Add tests to verify we can filter and sort on implicitly-indexed arrays. (#883)

Author: ericpromislow

pkg/sqlcache/informer/listoption_indexer_test.go

@@ -1512,8 +1512,8 @@ func TestNewListOptionIndexerTypeGuidance(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.description, func(t *testing.T) {
 			loi, dbPath, err := makeListOptionIndexer(t.Context(), gvk, test.opts, false, namespaceList)
-			defer cleanTempFiles(dbPath)
 			require.NoError(t, err)
+			defer cleanTempFiles(dbPath)
 
 			for _, item := range itemList.Items {
 				err = loi.Add(&item)
@@ -1553,6 +1553,261 @@ func TestNewListOptionIndexerTypeGuidance(t *testing.T) {
 	}
 }
 
+// Tests to verify we can sort on say pods on `spec.containers.image[i]`
+func TestSortPodsOnArrayAccess(t *testing.T) {
+	ctx := context.Background()
+	podGVK := schema.GroupVersionKind{
+		Group:   "",
+		Version: "v1",
+		Kind:    "Pod",
+	}
+	make_pod_obj := func(name, image1, image2 string) map[string]any {
+		containers := make(map[string]any)
+		if image2 != "" {
+			containers["image"] = image1 + "|" + image2
+		} else {
+			containers["image"] = image1
+		}
+		return map[string]any{
+			"metadata": map[string]any{
+				"name":      name,
+				"namespace": "ns-a",
+			},
+			"spec": map[string]any{
+				"containers": containers,
+			},
+		}
+	}
+	canoe_twix_ritter := make_pod_obj("canoe", "twix", "ritter")
+	catamaran_flake_none := make_pod_obj("catamaran", "flake", "")
+	clipper_butterfinger_payday := make_pod_obj("clipper", "butterfinger", "payday")
+	ferry_twix_yorkie := make_pod_obj("ferry", "twix", "yorkie")
+	hydrofoil_coffeecrisp_ritter := make_pod_obj("hydrofoil", "coffeecrisp", "ritter")
+	kayak_butterfinger_rocher := make_pod_obj("kayak", "butterfinger", "rocher")
+	raft_almondjoy_ragusa := make_pod_obj("raft", "almondjoy", "ragusa")
+	schooner_twix_mounds := make_pod_obj("schooner", "twix", "mounds")
+	sloop_snickers_toblerone := make_pod_obj("sloop", "snickers", "toblerone")
+	trawler_butterfinger_aero := make_pod_obj("trawler", "butterfinger", "aero")
+
+	allObjects := []map[string]any{
+		canoe_twix_ritter,
+		catamaran_flake_none,
+		clipper_butterfinger_payday,
+		ferry_twix_yorkie,
+		hydrofoil_coffeecrisp_ritter,
+		kayak_butterfinger_rocher,
+		raft_almondjoy_ragusa,
+		schooner_twix_mounds,
+		sloop_snickers_toblerone,
+		trawler_butterfinger_aero,
+	}
+	ns_a := map[string]any{
+		"metadata": map[string]any{
+			"name": "ns-a",
+		},
+	}
+	ns_b := map[string]any{
+		"metadata": map[string]any{
+			"name": "ns-b",
+		},
+	}
+
+	itemList := makeList(t, allObjects...)
+	namespaceList := makeList(t, ns_a, ns_b)
+	fields := [][]string{
+		{"spec", "containers", "image"},
+	}
+
+	type testCase struct {
+		description   string
+		listOptions   sqltypes.ListOptions
+		expectedList  *unstructured.UnstructuredList
+		expectedTotal int
+	}
+
+	tests := make([]testCase, 0)
+	tests = append(tests, testCase{
+		description: "can select for a specific first image",
+		listOptions: sqltypes.ListOptions{
+			Filters: []sqltypes.OrFilter{
+				{
+					[]sqltypes.Filter{
+						{
+							Field:   []string{"spec", "containers", "image", "0"},
+							Matches: []string{"butterfinger"},
+							Op:      sqltypes.Eq,
+						},
+					},
+				},
+			},
+			SortList: sqltypes.SortList{
+				SortDirectives: []sqltypes.Sort{
+					{
+						Fields: []string{"metadata", "name"},
+						Order:  sqltypes.ASC,
+					},
+				},
+			},
+		},
+		expectedList:  makeList(t, clipper_butterfinger_payday, kayak_butterfinger_rocher, trawler_butterfinger_aero),
+		expectedTotal: 3,
+	})
+	tests = append(tests, testCase{
+		description: "can select for a specific second image",
+		listOptions: sqltypes.ListOptions{
+			Filters: []sqltypes.OrFilter{
+				{
+					[]sqltypes.Filter{
+						{
+							Field:   []string{"spec", "containers", "image", "1"},
+							Matches: []string{"toblerone"},
+							Op:      sqltypes.Eq,
+						},
+					},
+				},
+			},
+			SortList: sqltypes.SortList{
+				SortDirectives: []sqltypes.Sort{
+					{
+						Fields: []string{"metadata", "name"},
+						Order:  sqltypes.ASC,
+					},
+				},
+			},
+		},
+		expectedList:  makeList(t, sloop_snickers_toblerone),
+		expectedTotal: 1,
+	})
+	tests = append(tests, testCase{
+		description: "can sort on the first image",
+		listOptions: sqltypes.ListOptions{
+			SortList: sqltypes.SortList{
+				SortDirectives: []sqltypes.Sort{
+					{
+						Fields: []string{"spec", "containers", "image", "0"},
+						Order:  sqltypes.ASC,
+					},
+					{
+						Fields: []string{"metadata", "name"},
+						Order:  sqltypes.ASC,
+					},
+				},
+			},
+		},
+		expectedList: makeList(t,
+			raft_almondjoy_ragusa,
+			clipper_butterfinger_payday,
+			kayak_butterfinger_rocher,
+			trawler_butterfinger_aero,
+			hydrofoil_coffeecrisp_ritter,
+			catamaran_flake_none,
+			sloop_snickers_toblerone,
+			canoe_twix_ritter,
+			ferry_twix_yorkie,
+			schooner_twix_mounds,
+		),
+		expectedTotal: len(allObjects),
+	})
+	tests = append(tests, testCase{
+		description: "can select for any second image",
+		listOptions: sqltypes.ListOptions{
+			Filters: []sqltypes.OrFilter{
+				{
+					[]sqltypes.Filter{
+						{
+							Field:   []string{"spec", "containers", "image", "1"},
+							Matches: []string{""},
+							Op:      sqltypes.NotEq,
+						},
+					},
+				},
+			},
+			SortList: sqltypes.SortList{
+				SortDirectives: []sqltypes.Sort{
+					{
+						Fields: []string{"metadata", "name"},
+						Order:  sqltypes.ASC,
+					},
+				},
+			},
+		},
+		expectedList: makeList(t, canoe_twix_ritter,
+			clipper_butterfinger_payday,
+			ferry_twix_yorkie,
+			hydrofoil_coffeecrisp_ritter,
+			kayak_butterfinger_rocher,
+			raft_almondjoy_ragusa,
+			schooner_twix_mounds,
+			sloop_snickers_toblerone,
+			trawler_butterfinger_aero,
+		),
+		expectedTotal: 9,
+	})
+	tests = append(tests, testCase{
+		description: "can sort on the second image (when present)",
+		listOptions: sqltypes.ListOptions{
+			Filters: []sqltypes.OrFilter{
+				{
+					[]sqltypes.Filter{
+						{
+							Field:   []string{"spec", "containers", "image", "1"},
+							Matches: []string{""},
+							Op:      sqltypes.NotEq,
+						},
+					},
+				},
+			},
+			SortList: sqltypes.SortList{
+				SortDirectives: []sqltypes.Sort{
+					{
+						Fields: []string{"spec", "containers", "image", "1"},
+						Order:  sqltypes.ASC,
+					},
+					{
+						Fields: []string{"metadata", "name"},
+						Order:  sqltypes.ASC,
+					},
+				},
+			},
+		},
+		expectedList: makeList(t,
+			trawler_butterfinger_aero,
+			schooner_twix_mounds,
+			clipper_butterfinger_payday,
+			raft_almondjoy_ragusa,
+			canoe_twix_ritter,
+			hydrofoil_coffeecrisp_ritter,
+			kayak_butterfinger_rocher,
+			sloop_snickers_toblerone,
+			ferry_twix_yorkie,
+		),
+		expectedTotal: 9,
+	})
+
+	t.Parallel()
+	for _, test := range tests {
+		t.Run(test.description, func(t *testing.T) {
+			opts := ListOptionIndexerOptions{
+				Fields:       fields,
+				IsNamespaced: true,
+			}
+			loi, dbPath, err := makeListOptionIndexer(ctx, podGVK, opts, false, namespaceList)
+			require.NoError(t, err)
+			defer cleanTempFiles(dbPath)
+
+			for _, item := range itemList.Items {
+				err = loi.Add(&item)
+				require.NoError(t, err)
+			}
+			list, total, _, err := loi.ListByOptions(ctx, &test.listOptions, []partition.Partition{{All: true}}, "")
+			require.NoError(t, err)
+
+			assert.Equal(t, test.expectedTotal, total)
+			assert.Equal(t, test.expectedList, list)
+		})
+	}
+}
+
 func TestDropAll(t *testing.T) {
 	ctx := t.Context()