apiserver/pkg/cel/openapi/maplist_test.go

/*
Copyright 2022 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package openapi

import (
	"reflect"
	"testing"

	"k8s.io/kube-openapi/pkg/validation/spec"
)

func TestMapList(t *testing.T) {
	for _, tc := range []struct {
		name          string
		sts           *spec.Schema
		items         []interface{}
		warmUpQueries []interface{}
		query         interface{}
		expected      interface{}
	}{
		{
			name: "default list type",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				}},
			query:    map[string]interface{}{},
			expected: nil,
		},
		{
			name: "non list type",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"map"},
				}},
			query:    map[string]interface{}{},
			expected: nil,
		},
		{
			name: "non-map list type",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType: listTypeSet,
				}}},
			query:    map[string]interface{}{},
			expected: nil,
		},
		{
			name: "no keys",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				}},
			query:    map[string]interface{}{},
			expected: nil,
		},
		{
			name: "single key",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType:    listTypeMap,
					extListMapKeys: []any{"k"},
				}}},
			items: []interface{}{
				map[string]interface{}{
					"k":  "a",
					"v1": "a",
				},
				map[string]interface{}{
					"k":  "b",
					"v1": "b",
				},
			},
			query: map[string]interface{}{
				"k":  "b",
				"v1": "B",
			},
			expected: map[string]interface{}{
				"k":  "b",
				"v1": "b",
			},
		},
		{
			name: "single key ignoring non-map query",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				}},
			items: []interface{}{
				map[string]interface{}{
					"k":  "a",
					"v1": "a",
				},
			},
			query:    42,
			expected: nil,
		},
		{
			name: "single key ignoring unkeyable query",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType:    listTypeMap,
					extListMapKeys: []any{"k"},
				}}},
			items: []interface{}{
				map[string]interface{}{
					"k":  "a",
					"v1": "a",
				},
			},
			query: map[string]interface{}{
				"k": map[string]interface{}{
					"keys": "must",
					"be":   "scalars",
				},
				"v1": "A",
			},
			expected: nil,
		},
		{
			name: "ignores item of invalid type",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType:    listTypeMap,
					extListMapKeys: []any{"k"},
				}}},
			items: []interface{}{
				map[string]interface{}{
					"k":  "a",
					"v1": "a",
				},
				5,
			},
			query: map[string]interface{}{
				"k":  "a",
				"v1": "A",
			},
			expected: map[string]interface{}{
				"k":  "a",
				"v1": "a",
			},
		},
		{
			name: "keep first entry when duplicated keys are encountered",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType:    listTypeMap,
					extListMapKeys: []any{"k"},
				}}},
			items: []interface{}{
				map[string]interface{}{
					"k":  "a",
					"v1": "a",
				},
				map[string]interface{}{
					"k":  "a",
					"v1": "b",
				},
			},
			query: map[string]interface{}{
				"k":  "a",
				"v1": "A",
			},
			expected: map[string]interface{}{
				"k":  "a",
				"v1": "a",
			},
		},
		{
			name: "keep first entry when duplicated multi-keys are encountered",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType:    listTypeMap,
					extListMapKeys: []any{"k1", "k2"},
				}}},
			items: []interface{}{
				map[string]interface{}{
					"k1": "a",
					"k2": "b",
					"v1": "a",
				},
				map[string]interface{}{
					"k1": "a",
					"k2": "b",
					"v1": "b",
				},
				map[string]interface{}{
					"k1": "x",
					"k2": "y",
					"v1": "z",
				},
			},
			warmUpQueries: []interface{}{
				map[string]interface{}{
					"k1": "x",
					"k2": "y",
				},
			},
			query: map[string]interface{}{
				"k1": "a",
				"k2": "b",
			},
			expected: map[string]interface{}{
				"k1": "a",
				"k2": "b",
				"v1": "a",
			},
		},
		{
			name: "multiple keys with defaults ignores item with nil value for key",
			sts: &spec.Schema{
				SchemaProps: spec.SchemaProps{
					Type: []string{"array"},
					Properties: map[string]spec.Schema{
						"kb": {SchemaProps: spec.SchemaProps{
							Default: true,
						}},
						"kf": {SchemaProps: spec.SchemaProps{
							Default: 2.0,
						}},
						"ki": {SchemaProps: spec.SchemaProps{
							Default: int64(64),
						}},
						"ks": {
							SchemaProps: spec.SchemaProps{
								Default: "hello",
							}},
					},
				},
				VendorExtensible: spec.VendorExtensible{Extensions: map[string]interface{}{
					extListType:    listTypeMap,
					extListMapKeys: []any{"kb", "kf", "ki", "ks"},
				}}},
			items: []interface{}{
				map[string]interface{}{
					"kb": nil,
					"kf": float64(2.0),
					"ki": int64(42),
					"ks": "hello",
					"v1": "a",
				},
				map[string]interface{}{
					"kb": false,
					"kf": float64(2.0),
					"ki": int64(42),
					"ks": "hello",
					"v1": "b",
				},
			},
			query: map[string]interface{}{
				"kb": false,
				"kf": float64(2.0),
				"ki": int64(42),
				"ks": "hello",
				"v1": "B",
			},
			expected: map[string]interface{}{
				"kb": false,
				"kf": float64(2.0),
				"ki": int64(42),
				"ks": "hello",
				"v1": "b",
			},
		},
	} {
		t.Run(tc.name, func(t *testing.T) {
			mapList := MakeMapList(tc.sts, tc.items)
			for _, warmUp := range tc.warmUpQueries {
				mapList.Get(warmUp)
			}
			actual := mapList.Get(tc.query)
			if !reflect.DeepEqual(tc.expected, actual) {
				t.Errorf("got: %v, expected %v", actual, tc.expected)
			}
		})
	}
}