Add fully qualified resource reference type

k8s_references.go

@@ -19,6 +19,7 @@ package klog
 import (
 	"fmt"
 	"reflect"
+	"strings"
 
 	"github.com/go-logr/logr"
 )
@@ -156,3 +157,40 @@ func (ks kobjSlice) process() ([]interface{}, error) {
 	}
 	return objectRefs, nil
 }
+
+// ResourceRef is a full Kubernetes resource reference composed of Group, Version, Kind, Namespace and Name.
+type ResourceRef struct {
+	Group     string `json:"group,omitempty"`
+	Version   string `json:"version,omitempty"`
+	Kind      string `json:"kind,omitempty"`
+	Namespace string `json:"namespace,omitempty"`
+	Name      string `json:"name,omitempty"`
+}
+
+// KResourceRef returns ResourceRef from group, version, kind, namespace and name.
+func KResourceRef(group, version, kind, namespace, name string) ResourceRef {
+	return ResourceRef{
+		Group:     group,
+		Version:   version,
+		Kind:      kind,
+		Namespace: namespace,
+		Name:      name,
+	}
+}
+
+func (l ResourceRef) String() string {
+	var parts []string
+	for _, s := range []string{l.Group, l.Version, l.Kind, l.Namespace, l.Name} {
+		if strings.TrimSpace(s) != "" {
+			parts = append(parts, s)
+		}
+	}
+	return strings.Join(parts, "/")
+}
+
+// MarshalLog ensures that loggers with support for structured output will log
+// as a struct by removing the String method via a custom type.
+func (l ResourceRef) MarshalLog() interface{} {
+	type kResourceRefWithoutStringFunc ResourceRef
+	return kResourceRefWithoutStringFunc(l)
+}

klog_test.go

@@ -953,6 +953,138 @@ func TestKRef(t *testing.T) {
 	}
 }
 
+func TestKResourceRef(t *testing.T) {
+	tests := []struct {
+		testname  string
+		group     string
+		version   string
+		kind      string
+		name      string
+		namespace string
+		want      ResourceRef
+	}{
+		{
+			testname:  "with group, version, kind, namespace and name",
+			name:      "test-name",
+			namespace: "test-ns",
+			group:     "test-group",
+			version:   "test-version",
+			kind:      "test-kind",
+			want: ResourceRef{
+				Group:     "test-group",
+				Version:   "test-version",
+				Kind:      "test-kind",
+				Name:      "test-name",
+				Namespace: "test-ns",
+			},
+		},
+		{
+			testname:  "with group, version, namespace and name",
+			name:      "test-name",
+			namespace: "test-ns",
+			group:     "test-group",
+			version:   "test-version",
+			want: ResourceRef{
+				Group:     "test-group",
+				Version:   "test-version",
+				Name:      "test-name",
+				Namespace: "test-ns",
+			},
+		},
+		{
+			testname:  "with group, namespace and name",
+			name:      "test-name",
+			namespace: "test-ns",
+			group:     "test-group",
+			want: ResourceRef{
+				Group:     "test-group",
+				Name:      "test-name",
+				Namespace: "test-ns",
+			},
+		},
+		{
+			testname:  "with namespace and name",
+			name:      "test-name",
+			namespace: "test-ns",
+			want: ResourceRef{
+				Name:      "test-name",
+				Namespace: "test-ns",
+			},
+		},
+		{
+			testname: "with only name",
+			name:     "test-name",
+			want: ResourceRef{
+				Name: "test-name",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.testname, func(t *testing.T) {
+			if KResourceRef(tt.group, tt.version, tt.kind, tt.namespace, tt.name) != tt.want {
+				t.Errorf("expected %v, got %v", tt.want, KResourceRef(tt.group, tt.version, tt.kind, tt.namespace, tt.name))
+			}
+		})
+	}
+}
+
+func TestKResourceString(t *testing.T) {
+	tests := []struct {
+		testname  string
+		group     string
+		version   string
+		kind      string
+		name      string
+		namespace string
+		want      string
+	}{
+		{
+			testname:  "with group, version, kind, namespace and name",
+			group:     "test-group",
+			version:   "test-version",
+			kind:      "test-kind",
+			namespace: "test-ns",
+			name:      "test-name",
+			want:      "test-group/test-version/test-kind/test-ns/test-name",
+		},
+		{
+			testname:  "with group, version, namespace and name",
+			group:     "test-group",
+			version:   "test-version",
+			namespace: "test-ns",
+			name:      "test-name",
+			want:      "test-group/test-version/test-ns/test-name",
+		},
+		{
+			testname:  "with group, namespace and name",
+			group:     "test-group",
+			namespace: "test-ns",
+			name:      "test-name",
+			want:      "test-group/test-ns/test-name",
+		},
+		{
+			testname:  "with namespace and name",
+			namespace: "test-ns",
+			name:      "test-name",
+			want:      "test-ns/test-name",
+		},
+		{
+			testname: "with only name",
+			name:     "test-name",
+			want:     "test-name",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.testname, func(t *testing.T) {
+			if KResourceRef(tt.group, tt.version, tt.kind, tt.namespace, tt.name).String() != tt.want {
+				t.Errorf("expected %v, got %v", tt.want, KResourceRef(tt.group, tt.version, tt.kind, tt.namespace, tt.name))
+			}
+		})
+	}
+}
+
 // Test that InfoS and InfoSDepth work as advertised.
 func TestInfoS(t *testing.T) {
 	defer CaptureState().Restore()