nrt: test: use common pseudo-conformance tests for all the impls

Use the new common GetCachedNRTCopy tests for all the cache
implementations, which must conform to the common API for the
common test cases. Cache-specific testcases will be implemented
in the cache-specific test code, but the common parts are better
served with shared tests.

Signed-off-by: Francesco Romani <[email protected]>

Author: ffromani

pkg/noderesourcetopology/cache/discardreserved_test.go

@@ -25,65 +25,35 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
+	podlisterv1 "k8s.io/client-go/listers/core/v1"
 
-	tu "sigs.k8s.io/scheduler-plugins/test/util"
+	ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-func TestDiscardReservedNodesGetNRTCopy(t *testing.T) {
-	fakeClient, err := tu.NewFakeClient()
-	if err != nil {
-		t.Fatal(err)
-	}
+func TestDiscardReservedNodesGetCachedNRTCopy(t *testing.T) {
+	testNodeName := "worker-node-1"
+	nrt := makeTestNRT(testNodeName)
 
-	ctx := context.Background()
-	nrtCache := NewDiscardReserved(fakeClient)
-	var nrtObj *topologyv1alpha2.NodeResourceTopology
-	nrtObj, _ = nrtCache.GetCachedNRTCopy(ctx, "node1", &corev1.Pod{})
-	if nrtObj != nil {
-		t.Fatalf("non-empty object from empty cache")
-	}
-
-	nodeTopologies := []*topologyv1alpha2.NodeResourceTopology{
+	testCases := []testCaseGetCachedNRTCopy{
 		{
-			ObjectMeta:       metav1.ObjectMeta{Name: "node1"},
-			TopologyPolicies: []string{string(topologyv1alpha2.SingleNUMANodeContainerLevel)},
-			Zones: topologyv1alpha2.ZoneList{
-				{
-					Name: "node-0",
-					Type: "Node",
-					Resources: topologyv1alpha2.ResourceInfoList{
-						MakeTopologyResInfo(cpu, "20", "4"),
-						MakeTopologyResInfo(memory, "8Gi", "8Gi"),
-						MakeTopologyResInfo(nicResourceName, "30", "10"),
-					},
-				},
-				{
-					Name: "node-1",
-					Type: "Node",
-					Resources: topologyv1alpha2.ResourceInfoList{
-						MakeTopologyResInfo(cpu, "30", "8"),
-						MakeTopologyResInfo(memory, "8Gi", "8Gi"),
-						MakeTopologyResInfo(nicResourceName, "30", "10"),
-					},
-				},
+			name: "data present with foreign pods",
+			nodeTopologies: []*topologyv1alpha2.NodeResourceTopology{
+				nrt,
 			},
+			nodeName:       testNodeName,
+			hasForeignPods: true,
+			expectedNRT:    nrt,
+			expectedOK:     true,
 		},
 	}
-	for _, obj := range nodeTopologies {
-		if err := fakeClient.Create(ctx, obj.DeepCopy()); err != nil {
-			t.Fatal(err)
-		}
-	}
 
-	nrtObj, ok := nrtCache.GetCachedNRTCopy(ctx, "node1", &corev1.Pod{})
-	if !isNRTEqual(nrtObj, nodeTopologies[0]) {
-		t.Fatalf("unexpected object from cache\ngot: %s\nexpected: %s\n",
-			dumpNRT(nrtObj), dumpNRT(nodeTopologies[0]))
-	}
-
-	if !ok {
-		t.Fatalf("expecting GetCachedNRTCopy to return true not false")
-	}
+	checkGetCachedNRTCopy(
+		t,
+		func(client ctrlclient.Client, _ podlisterv1.PodLister) (Interface, error) {
+			return NewDiscardReserved(client), nil
+		},
+		testCases...,
+	)
 }
 
 func TestDiscardReservedNodesGetNRTCopyFails(t *testing.T) {

pkg/noderesourcetopology/cache/overreserve_test.go

@@ -18,7 +18,6 @@ package cache
 
 import (
 	"context"
-	"encoding/json"
 	"reflect"
 	"sort"
 	"testing"
@@ -207,57 +206,30 @@ func TestDirtyNodesUnmarkedOnReserve(t *testing.T) {
 	}
 }
 
-func TestGetCachedNRTCopy(t *testing.T) {
-	fakeClient, err := tu.NewFakeClient()
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	fakePodLister := &fakePodLister{}
-
-	nrtCache := mustOverReserve(t, fakeClient, fakePodLister)
+func TestOverreserveGetCachedNRTCopy(t *testing.T) {
+	testNodeName := "worker-node-1"
+	nrt := makeTestNRT(testNodeName)
 
-	ctx := context.Background()
-	var nrtObj *topologyv1alpha2.NodeResourceTopology
-	nrtObj, _ = nrtCache.GetCachedNRTCopy(ctx, "node1", &corev1.Pod{})
-	if nrtObj != nil {
-		t.Fatalf("non-empty object from empty cache")
-	}
-
-	nodeTopologies := []*topologyv1alpha2.NodeResourceTopology{
+	testCases := []testCaseGetCachedNRTCopy{
 		{
-			ObjectMeta:       metav1.ObjectMeta{Name: "node1"},
-			TopologyPolicies: []string{string(topologyv1alpha2.SingleNUMANodeContainerLevel)},
-			Zones: topologyv1alpha2.ZoneList{
-				{
-					Name: "node-0",
-					Type: "Node",
-					Resources: topologyv1alpha2.ResourceInfoList{
-						MakeTopologyResInfo(cpu, "20", "4"),
-						MakeTopologyResInfo(memory, "8Gi", "8Gi"),
-						MakeTopologyResInfo(nicResourceName, "30", "10"),
-					},
-				},
-				{
-					Name: "node-1",
-					Type: "Node",
-					Resources: topologyv1alpha2.ResourceInfoList{
-						MakeTopologyResInfo(cpu, "30", "8"),
-						MakeTopologyResInfo(memory, "8Gi", "8Gi"),
-						MakeTopologyResInfo(nicResourceName, "30", "10"),
-					},
-				},
+			name: "data present with foreign pods",
+			nodeTopologies: []*topologyv1alpha2.NodeResourceTopology{
+				nrt,
 			},
+			nodeName:       testNodeName,
+			hasForeignPods: true,
+			expectedNRT:    nil,
+			expectedOK:     false,
 		},
 	}
-	for _, obj := range nodeTopologies {
-		nrtCache.Store().Update(obj)
-	}
 
-	nrtObj, _ = nrtCache.GetCachedNRTCopy(ctx, "node1", &corev1.Pod{})
-	if !reflect.DeepEqual(nrtObj, nodeTopologies[0]) {
-		t.Fatalf("unexpected object from cache\ngot: %s\nexpected: %s\n", dumpNRT(nrtObj), dumpNRT(nodeTopologies[0]))
-	}
+	checkGetCachedNRTCopy(
+		t,
+		func(client ctrlclient.Client, podLister podlisterv1.PodLister) (Interface, error) {
+			return NewOverReserve(nil, client, podLister)
+		},
+		testCases...,
+	)
 }
 
 func TestGetCachedNRTCopyReserve(t *testing.T) {
@@ -751,51 +723,6 @@ func TestNodeWithForeignPods(t *testing.T) {
 	}
 }
 
-func dumpNRT(nrtObj *topologyv1alpha2.NodeResourceTopology) string {
-	nrtJson, err := json.MarshalIndent(nrtObj, "", " ")
-	if err != nil {
-		return "marshallingError"
-	}
-	return string(nrtJson)
-}
-
-func MakeTopologyResInfo(name, capacity, available string) topologyv1alpha2.ResourceInfo {
-	return topologyv1alpha2.ResourceInfo{
-		Name:      name,
-		Capacity:  resource.MustParse(capacity),
-		Available: resource.MustParse(available),
-	}
-}
-
-func makeDefaultTestTopology() []*topologyv1alpha2.NodeResourceTopology {
-	return []*topologyv1alpha2.NodeResourceTopology{
-		{
-			ObjectMeta:       metav1.ObjectMeta{Name: "node1"},
-			TopologyPolicies: []string{string(topologyv1alpha2.SingleNUMANodeContainerLevel)},
-			Zones: topologyv1alpha2.ZoneList{
-				{
-					Name: "node-0",
-					Type: "Node",
-					Resources: topologyv1alpha2.ResourceInfoList{
-						MakeTopologyResInfo(cpu, "32", "30"),
-						MakeTopologyResInfo(memory, "64Gi", "60Gi"),
-						MakeTopologyResInfo(nicResourceName, "16", "16"),
-					},
-				},
-				{
-					Name: "node-1",
-					Type: "Node",
-					Resources: topologyv1alpha2.ResourceInfoList{
-						MakeTopologyResInfo(cpu, "32", "30"),
-						MakeTopologyResInfo(memory, "64Gi", "60Gi"),
-						MakeTopologyResInfo(nicResourceName, "16", "16"),
-					},
-				},
-			},
-		},
-	}
-}
-
 func mustOverReserve(t *testing.T, client ctrlclient.Client, podLister podlisterv1.PodLister) *OverReserve {
 	obj, err := NewOverReserve(nil, client, podLister)
 	if err != nil {

pkg/noderesourcetopology/cache/passthrough_test.go

@@ -0,0 +1,51 @@
+/*
+Copyright 2023 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 cache
+
+import (
+	"testing"
+
+	topologyv1alpha2 "github.com/k8stopologyawareschedwg/noderesourcetopology-api/pkg/apis/topology/v1alpha2"
+	podlisterv1 "k8s.io/client-go/listers/core/v1"
+	ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+func TestPassthroughGetCachedNRTCopy(t *testing.T) {
+	testNodeName := "worker-node-1"
+	nrt := makeTestNRT(testNodeName)
+
+	testCases := []testCaseGetCachedNRTCopy{
+		{
+			name: "data present with foreign pods",
+			nodeTopologies: []*topologyv1alpha2.NodeResourceTopology{
+				nrt,
+			},
+			nodeName:       testNodeName,
+			hasForeignPods: true,
+			expectedNRT:    nrt,
+			expectedOK:     true,
+		},
+	}
+
+	checkGetCachedNRTCopy(
+		t,
+		func(client ctrlclient.Client, _ podlisterv1.PodLister) (Interface, error) {
+			return NewPassthrough(client), nil
+		},
+		testCases...,
+	)
+}