node: Add UIDBasedProvider wrapper for legacy PodLifecycleHandler methods

Author: saleemrashid

node/lifecycle_test.go

@@ -242,7 +242,7 @@ func (s *system) start(ctx context.Context) error {
 	return s.pc.Err()
 }
 
-func wireUpSystem(ctx context.Context, provider PodLifecycleHandler, f testFunction) error {
+func wireUpSystem(ctx context.Context, provider PodUIDLifecycleHandler, f testFunction) error {
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
@@ -266,7 +266,7 @@ func wireUpSystem(ctx context.Context, provider PodLifecycleHandler, f testFunct
 	return wireUpSystemWithClient(ctx, provider, client, f)
 }
 
-func wireUpSystemWithClient(ctx context.Context, provider PodLifecycleHandler, client kubernetes.Interface, f testFunction) error {
+func wireUpSystemWithClient(ctx context.Context, provider PodUIDLifecycleHandler, client kubernetes.Interface, f testFunction) error {
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
@@ -293,7 +293,7 @@ func wireUpSystemWithClient(ctx context.Context, provider PodLifecycleHandler, c
 			PodClient:         client.CoreV1(),
 			PodInformer:       podInformer,
 			EventRecorder:     fakeRecorder,
-			Provider:          provider,
+			Provider:          UIDBasedProvider(provider),
 			ConfigMapInformer: configMapInformer,
 			SecretInformer:    secretInformer,
 			ServiceInformer:   serviceInformer,

node/mock_test.go

@@ -18,7 +18,6 @@ const (
 )
 
 var (
-	_ PodLifecycleHandler    = (*mockProvider)(nil)
 	_ PodUIDLifecycleHandler = (*mockProvider)(nil)
 )
 
@@ -177,10 +176,6 @@ func (p *mockProvider) DeletePod(ctx context.Context, pod *v1.Pod) (err error) {
 	return nil
 }
 
-func (p *mockProvider) GetPod(ctx context.Context, namespace, name string) (pod *v1.Pod, err error) {
-	panic("GetPod not called when GetPodByUID implemented")
-}
-
 // GetPodByUID returns a pod by name that is stored in memory.
 func (p *mockProvider) GetPodByUID(ctx context.Context, namespace, name string, uid types.UID) (pod *v1.Pod, err error) {
 	log.G(ctx).Infof("receive GetPodByUID %q", name)
@@ -196,10 +191,6 @@ func (p *mockProvider) GetPodByUID(ctx context.Context, namespace, name string,
 	return nil, errdefs.NotFoundf("pod \"%s/%s\" is not known to the provider", namespace, name)
 }
 
-func (p *mockProvider) GetPodStatus(ctx context.Context, namespace, name string) (pod *v1.PodStatus, err error) {
-	panic("GetPodStatus not called when GetPodStatusByUID implemented")
-}
-
 // GetPodStatusByUID returns the status of a pod by name that is "running".
 // returns nil if a pod by that name is not found.
 func (p *mockProvider) GetPodStatusByUID(ctx context.Context, namespace, name string, uid types.UID) (*v1.PodStatus, error) {
@@ -279,7 +270,7 @@ func (p *mockProviderAsync) NotifyPods(ctx context.Context, notifier func(*v1.Po
 }
 
 type testingProvider interface {
-	PodLifecycleHandler
+	PodUIDLifecycleHandler
 	setErrorOnDelete(error)
 	getAttemptedDeletes() *waitableInt
 	getDeletes() *waitableInt

node/pod_test.go

@@ -54,7 +54,7 @@ func newTestController() *TestController {
 		PodClient:         fk8s.CoreV1(),
 		PodInformer:       iFactory.Core().V1().Pods(),
 		EventRecorder:     testutil.FakeEventRecorder(5),
-		Provider:          p,
+		Provider:          UIDBasedProvider(p),
 		ConfigMapInformer: iFactory.Core().V1().ConfigMaps(),
 		SecretInformer:    iFactory.Core().V1().Secrets(),
 		ServiceInformer:   iFactory.Core().V1().Services(),

node/podcontroller.go

@@ -38,6 +38,9 @@ import (
 	"k8s.io/client-go/util/workqueue"
 )
 
+// podLifecycleHandler contains the methods shared between PodUIDLifecycleHandler and the legacy
+// PodLifecycleHandler. In the future, when PodLifecycleHandler is replaced with PodUIDLifecycleHandler,
+// this common interface can be incorporated directly into PodUIDLifecycleHandler.
 type podLifecycleHandler interface {
 	// CreatePod takes a Kubernetes Pod and deploys it within the provider.
 	CreatePod(ctx context.Context, pod *corev1.Pod) error

node/uid.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	corev1 "k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 )
 
@@ -37,7 +38,7 @@ func (k *podUIDKey) String() string {
 }
 
 // uidProviderWrapper wraps a legacy PodLifecycleHandler to handle GetPodByUID/GetPodStatusByUID,
-// by ignoring the pod UID and using only the pod namespace/name.
+// by ignoring the pod UID and calling GetPod/GetPodStatus using only the pod namespace/name.
 type uidProviderWrapper struct {
 	PodLifecycleHandler
 }
@@ -51,3 +52,26 @@ func (p *uidProviderWrapper) GetPodByUID(ctx context.Context, namespace, name st
 func (p *uidProviderWrapper) GetPodStatusByUID(ctx context.Context, namespace, name string, uid types.UID) (*corev1.PodStatus, error) {
 	return p.GetPodStatus(ctx, namespace, name)
 }
+
+// uidBasedProvider wraps a PodUIDLifecycleHandler to implement PodLifecycleHandler, by stubbing
+// the legacy GetPod/GetPodStatus methods. These methods are never called if the provider implements
+// PodUIDLifecycleHandler, but are required to be implemented as PodControllerConfig takes a
+// PodLifecycleHandler. In the future, PodControllerConfig will take an asyncProvider, and this will
+// no longer be necessary.
+type uidBasedProvider struct {
+	PodUIDLifecycleHandler
+}
+
+// UIDBasedProvider wraps a PodUIDLifecycleHandler into a PodLifecycleHandler that can be used in
+// PodControllerConfig.
+func UIDBasedProvider(p PodUIDLifecycleHandler) PodLifecycleHandler {
+	return &uidBasedProvider{PodUIDLifecycleHandler: p}
+}
+
+func (p *uidBasedProvider) GetPod(ctx context.Context, namespace, name string) (*v1.Pod, error) {
+	panic("GetPod should never be called when GetPodByUID is implemented")
+}
+
+func (p *uidBasedProvider) GetPodStatus(ctx context.Context, namespace, name string) (*v1.PodStatus, error) {
+	panic("GetPodStatus should never be called when GetPodStatusByUID is implemented")
+}