Merge pull request #101817 from cndoit18/add-events-expansion

Add fieldSelector builder function to events.

staging/src/k8s.io/client-go/tools/events/helper.go

@@ -0,0 +1,64 @@
+/*
+Copyright 2021 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 events
+
+import (
+	"fmt"
+
+	corev1 "k8s.io/api/core/v1"
+	eventsv1 "k8s.io/api/events/v1"
+	eventsv1beta1 "k8s.io/api/events/v1beta1"
+	"k8s.io/apimachinery/pkg/fields"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+var mapping = map[schema.GroupVersion]string{
+	eventsv1.SchemeGroupVersion:      "regarding",
+	eventsv1beta1.SchemeGroupVersion: "regarding",
+	corev1.SchemeGroupVersion:        "involvedObject",
+}
+
+// GetFieldSelector returns the appropriate field selector based on the API version being used to communicate with the server.
+// The returned field selector can be used with List and Watch to filter desired events.
+func GetFieldSelector(eventsGroupVersion schema.GroupVersion, regardingGroupVersionKind schema.GroupVersionKind, regardingName string, regardingUID types.UID) (fields.Selector, error) {
+	field := fields.Set{}
+
+	if _, ok := mapping[eventsGroupVersion]; !ok {
+		return nil, fmt.Errorf("unknown version %v", eventsGroupVersion)
+	}
+	prefix := mapping[eventsGroupVersion]
+
+	if len(regardingName) > 0 {
+		field[prefix+".name"] = regardingName
+	}
+
+	if len(regardingGroupVersionKind.Kind) > 0 {
+		field[prefix+".kind"] = regardingGroupVersionKind.Kind
+	}
+
+	regardingGroupVersion := regardingGroupVersionKind.GroupVersion()
+	if !regardingGroupVersion.Empty() {
+		field[prefix+".apiVersion"] = regardingGroupVersion.String()
+	}
+
+	if len(regardingUID) > 0 {
+		field[prefix+".uid"] = string(regardingUID)
+	}
+
+	return field.AsSelector(), nil
+}

staging/src/k8s.io/client-go/tools/events/helper_test.go

@@ -0,0 +1,151 @@
+/*
+Copyright 2021 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 events
+
+import (
+	"testing"
+
+	corev1 "k8s.io/api/core/v1"
+	eventsv1 "k8s.io/api/events/v1"
+	eventsv1beta1 "k8s.io/api/events/v1beta1"
+	"k8s.io/apimachinery/pkg/fields"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+func TestGetFieldSelector(t *testing.T) {
+	tests := []struct {
+		desc                      string
+		eventsGroupVersion        schema.GroupVersion
+		regardingName             string
+		regardingGroupVersionKind schema.GroupVersionKind
+		regardingUID              types.UID
+		expected                  fields.Set
+		expectedErr               bool
+	}{
+		{
+			desc:                      "events.k8s.io/v1beta1 event with empty parameters",
+			eventsGroupVersion:        eventsv1beta1.SchemeGroupVersion,
+			regardingName:             "",
+			regardingGroupVersionKind: schema.GroupVersionKind{},
+			regardingUID:              "",
+			expected:                  fields.Set{},
+			expectedErr:               false,
+		},
+		{
+			desc:               "events.k8s.io/v1beta1 event with non-empty parameters",
+			eventsGroupVersion: eventsv1beta1.SchemeGroupVersion,
+			regardingName:      "test-deployment",
+			regardingGroupVersionKind: schema.GroupVersionKind{
+				Kind:    "Deployment",
+				Group:   "apps",
+				Version: "v1",
+			},
+			regardingUID: "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			expected: fields.Set{
+				"regarding.name":       "test-deployment",
+				"regarding.kind":       "Deployment",
+				"regarding.apiVersion": "apps/v1",
+				"regarding.uid":        "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			},
+			expectedErr: false,
+		},
+		{
+			desc:                      "events.k8s.io/v1 event with empty parameters",
+			eventsGroupVersion:        eventsv1.SchemeGroupVersion,
+			regardingName:             "",
+			regardingGroupVersionKind: schema.GroupVersionKind{},
+			regardingUID:              "",
+			expected:                  fields.Set{},
+			expectedErr:               false,
+		},
+		{
+			desc:               "events.k8s.io/v1 event with non-empty parameters",
+			eventsGroupVersion: eventsv1.SchemeGroupVersion,
+			regardingName:      "test-deployment",
+			regardingGroupVersionKind: schema.GroupVersionKind{
+				Kind:    "Deployment",
+				Group:   "apps",
+				Version: "v1",
+			},
+			regardingUID: "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			expected: fields.Set{
+				"regarding.name":       "test-deployment",
+				"regarding.kind":       "Deployment",
+				"regarding.apiVersion": "apps/v1",
+				"regarding.uid":        "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			},
+			expectedErr: false,
+		},
+		{
+			desc:                      "v1 event with non-empty parameters",
+			eventsGroupVersion:        corev1.SchemeGroupVersion,
+			regardingName:             "",
+			regardingGroupVersionKind: schema.GroupVersionKind{},
+			regardingUID:              "",
+			expected:                  fields.Set{},
+			expectedErr:               false,
+		},
+		{
+			desc:               "v1 event with non-empty parameters",
+			eventsGroupVersion: corev1.SchemeGroupVersion,
+			regardingName:      "test-deployment",
+			regardingGroupVersionKind: schema.GroupVersionKind{
+				Kind:    "Deployment",
+				Group:   "apps",
+				Version: "v1",
+			},
+			regardingUID: "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			expected: fields.Set{
+				"involvedObject.name":       "test-deployment",
+				"involvedObject.kind":       "Deployment",
+				"involvedObject.apiVersion": "apps/v1",
+				"involvedObject.uid":        "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			},
+			expectedErr: false,
+		},
+		{
+			desc:               "unknown group version",
+			eventsGroupVersion: schema.GroupVersion{Group: corev1.GroupName, Version: "v1alpha1"},
+			regardingName:      "test-deployment",
+			regardingGroupVersionKind: schema.GroupVersionKind{
+				Kind:    "Deployment",
+				Group:   "apps",
+				Version: "v1",
+			},
+			regardingUID: "2c55cad7-ee4e-11e9-abe1-525400e7bc6b",
+			expected:     nil,
+			expectedErr:  true,
+		},
+	}
+
+	for _, test := range tests {
+		result, err := GetFieldSelector(test.eventsGroupVersion, test.regardingGroupVersionKind, test.regardingName, test.regardingUID)
+		if !test.expectedErr && err != nil {
+			t.Errorf("Unable to get field selector with %v", err)
+		}
+		if test.expectedErr && err == nil {
+			t.Errorf("Expect error but got nil")
+		}
+		if test.expected == nil && result != nil {
+			t.Errorf("Test %s expected <nil>, but got %v", test.desc, result)
+		}
+		if result != nil && !result.Matches(test.expected) {
+			t.Errorf("Test %s expected %v, but got %v", test.desc, test.expected.AsSelector(), result)
+		}
+	}
+}