Merge pull request kubernetes#85012 from alculquicondor/feat/predicate_factory

Add MetadataProducerFactory for predicates

Author: k8s-ci-robot

pkg/controller/daemon/daemon_controller.go

@@ -1318,7 +1318,7 @@ func NewPod(ds *apps.DaemonSet, nodeName string) *v1.Pod {
 //   - PodFitsHost: checks pod's NodeName against node
 //   - PodMatchNodeSelector: checks pod's NodeSelector and NodeAffinity against node
 //   - PodToleratesNodeTaints: exclude tainted node unless pod has specific toleration
-func checkNodeFitness(pod *v1.Pod, meta predicates.PredicateMetadata, nodeInfo *schedulernodeinfo.NodeInfo) (bool, []predicates.PredicateFailureReason, error) {
+func checkNodeFitness(pod *v1.Pod, meta predicates.Metadata, nodeInfo *schedulernodeinfo.NodeInfo) (bool, []predicates.PredicateFailureReason, error) {
 	var predicateFails []predicates.PredicateFailureReason
 	fit, reasons, err := predicates.PodFitsHost(pod, meta, nodeInfo)
 	if err != nil {

pkg/scheduler/algorithm/predicates/csi_volume_predicate.go

@@ -87,7 +87,7 @@ func getVolumeLimits(nodeInfo *schedulernodeinfo.NodeInfo, csiNode *storagev1bet
 }
 
 func (c *CSIMaxVolumeLimitChecker) attachableLimitPredicate(
-	pod *v1.Pod, meta PredicateMetadata, nodeInfo *schedulernodeinfo.NodeInfo) (bool, []PredicateFailureReason, error) {
+	pod *v1.Pod, meta Metadata, nodeInfo *schedulernodeinfo.NodeInfo) (bool, []PredicateFailureReason, error) {
 	// If the new pod doesn't have any volume attached to it, the predicate will always be true
 	if len(pod.Spec.Volumes) == 0 {
 		return true, nil, nil

pkg/scheduler/algorithm/predicates/csi_volume_predicate_test.go

@@ -458,7 +458,8 @@ func TestCSIVolumeCountPredicate(t *testing.T) {
 				getFakeCSIPVCLister(test.filterName, "csi-sc", test.driverNames...),
 				getFakeCSIStorageClassLister("csi-sc", test.driverNames[0]))
 
-			fits, reasons, err := pred(test.newPod, GetPredicateMetadata(test.newPod, nil), node)
+			factory := &MetadataProducerFactory{}
+			fits, reasons, err := pred(test.newPod, factory.GetPredicateMetadata(test.newPod, nil), node)
 			if err != nil {
 				t.Errorf("Using allocatable [%s]%s: unexpected error: %v", test.filterName, test.test, err)
 			}

pkg/scheduler/algorithm/predicates/max_attachable_volume_predicate_test.go

@@ -858,7 +858,8 @@ func TestVolumeCountConflicts(t *testing.T) {
 			getFakePVLister(test.filterName),
 			getFakePVCLister(test.filterName))
 
-		fits, reasons, err := pred(test.newPod, GetPredicateMetadata(test.newPod, nil), node)
+		factory := &MetadataProducerFactory{}
+		fits, reasons, err := pred(test.newPod, factory.GetPredicateMetadata(test.newPod, nil), node)
 		if err != nil {
 			t.Errorf("[%s]%s: unexpected error: %v", test.filterName, test.test, err)
 		}
@@ -880,7 +881,8 @@ func TestVolumeCountConflicts(t *testing.T) {
 			getFakeStorageClassLister(test.filterName),
 			getFakePVLister(test.filterName),
 			getFakePVCLister(test.filterName))
-		fits, reasons, err := pred(test.newPod, GetPredicateMetadata(test.newPod, nil), node)
+		factory := &MetadataProducerFactory{}
+		fits, reasons, err := pred(test.newPod, factory.GetPredicateMetadata(test.newPod, nil), node)
 		if err != nil {
 			t.Errorf("Using allocatable [%s]%s: unexpected error: %v", test.filterName, test.test, err)
 		}

pkg/scheduler/algorithm/predicates/metadata.go

@@ -35,15 +35,15 @@ import (
 	schedutil "k8s.io/kubernetes/pkg/scheduler/util"
 )
 
-// PredicateMetadata interface represents anything that can access a predicate metadata.
-type PredicateMetadata interface {
-	ShallowCopy() PredicateMetadata
+// Metadata interface represents anything that can access a predicate metadata.
+type Metadata interface {
+	ShallowCopy() Metadata
 	AddPod(addedPod *v1.Pod, node *v1.Node) error
 	RemovePod(deletedPod *v1.Pod, node *v1.Node) error
 }
 
-// PredicateMetadataProducer is a function that computes predicate metadata for a given pod.
-type PredicateMetadataProducer func(pod *v1.Pod, sharedLister schedulerlisters.SharedLister) PredicateMetadata
+// MetadataProducer is a function that computes predicate metadata for a given pod.
+type MetadataProducer func(pod *v1.Pod, sharedLister schedulerlisters.SharedLister) Metadata
 
 // AntiAffinityTerm's topology key value used in predicate metadata
 type topologyPair struct {
@@ -300,27 +300,27 @@ type predicateMetadata struct {
 	podFitsHostPortsMetadata *podFitsHostPortsMetadata
 }
 
-// Ensure that predicateMetadata implements algorithm.PredicateMetadata.
-var _ PredicateMetadata = &predicateMetadata{}
+// Ensure that predicateMetadata implements algorithm.Metadata.
+var _ Metadata = &predicateMetadata{}
 
 // predicateMetadataProducer function produces predicate metadata. It is stored in a global variable below
-// and used to modify the return values of PredicateMetadataProducer
+// and used to modify the return values of MetadataProducer
 type predicateMetadataProducer func(pm *predicateMetadata)
 
 var predicateMetadataProducers = make(map[string]predicateMetadataProducer)
 
-// RegisterPredicateMetadataProducer registers a PredicateMetadataProducer.
+// RegisterPredicateMetadataProducer registers a MetadataProducer.
 func RegisterPredicateMetadataProducer(predicateName string, precomp predicateMetadataProducer) {
 	predicateMetadataProducers[predicateName] = precomp
 }
 
-// EmptyPredicateMetadataProducer returns a no-op MetadataProducer type.
-func EmptyPredicateMetadataProducer(pod *v1.Pod, sharedLister schedulerlisters.SharedLister) PredicateMetadata {
+// EmptyMetadataProducer returns a no-op MetadataProducer type.
+func EmptyMetadataProducer(pod *v1.Pod, sharedLister schedulerlisters.SharedLister) Metadata {
 	return nil
 }
 
 // RegisterPredicateMetadataProducerWithExtendedResourceOptions registers a
-// PredicateMetadataProducer that creates predicate metadata with the provided
+// MetadataProducer that creates predicate metadata with the provided
 // options for extended resources.
 //
 // See the comments in "predicateMetadata" for the explanation of the options.
@@ -330,8 +330,11 @@ func RegisterPredicateMetadataProducerWithExtendedResourceOptions(ignoredExtende
 	})
 }
 
+// MetadataProducerFactory is a factory to produce Metadata.
+type MetadataProducerFactory struct{}
+
 // GetPredicateMetadata returns the predicateMetadata which will be used by various predicates.
-func GetPredicateMetadata(pod *v1.Pod, sharedLister schedulerlisters.SharedLister) PredicateMetadata {
+func (f *MetadataProducerFactory) GetPredicateMetadata(pod *v1.Pod, sharedLister schedulerlisters.SharedLister) Metadata {
 	// If we cannot compute metadata, just return nil
 	if pod == nil {
 		return nil
@@ -675,7 +678,7 @@ func (meta *predicateMetadata) AddPod(addedPod *v1.Pod, node *v1.Node) error {
 
 // ShallowCopy copies a metadata struct into a new struct and creates a copy of
 // its maps and slices, but it does not copy the contents of pointer values.
-func (meta *predicateMetadata) ShallowCopy() PredicateMetadata {
+func (meta *predicateMetadata) ShallowCopy() Metadata {
 	newPredMeta := &predicateMetadata{
 		pod:           meta.pod,
 		podBestEffort: meta.podBestEffort,
@@ -685,7 +688,7 @@ func (meta *predicateMetadata) ShallowCopy() PredicateMetadata {
 	newPredMeta.evenPodsSpreadMetadata = meta.evenPodsSpreadMetadata.clone()
 	newPredMeta.serviceAffinityMetadata = meta.serviceAffinityMetadata.clone()
 	newPredMeta.podFitsResourcesMetadata = meta.podFitsResourcesMetadata.clone()
-	return (PredicateMetadata)(newPredMeta)
+	return (Metadata)(newPredMeta)
 }
 
 type affinityTermProperties struct {

pkg/scheduler/algorithm/predicates/metadata_test.go

@@ -358,7 +358,8 @@ func TestPredicateMetadata_AddRemovePod(t *testing.T) {
 				s := nodeinfosnapshot.NewSnapshot(pods, test.nodes)
 				_, precompute := NewServiceAffinityPredicate(s.NodeInfos(), s.Pods(), fakelisters.ServiceLister(test.services), nil)
 				RegisterPredicateMetadataProducer("ServiceAffinityMetaProducer", precompute)
-				meta := GetPredicateMetadata(test.pendingPod, s)
+				factory := &MetadataProducerFactory{}
+				meta := factory.GetPredicateMetadata(test.pendingPod, s)
 				return meta.(*predicateMetadata), s.NodeInfoMap
 			}