Mark ephemeral pods created as part of kanister functions with JobID label

pkg/function/kube_task.go

@@ -16,6 +16,7 @@ package function
 
 import (
 	"context"
+	"path"
 	"time"
 
 	"github.com/pkg/errors"
@@ -33,7 +34,9 @@ import (
 )
 
 const (
-	jobPrefix = "kanister-job-"
+	jobPrefix   = "kanister-job-"
+	jobIDSuffix = "JobID"
+
 	// KubeTaskFuncName gives the function name
 	KubeTaskFuncName       = "KubeTask"
 	KubeTaskNamespaceArg   = "namespace"
@@ -64,7 +67,11 @@ func kubeTask(ctx context.Context, cli kubernetes.Interface, namespace, image st
 		Command:      command,
 		PodOverride:  podOverride,
 	}
-
+	// Mark labels to pods with prefix `kanister.io`. Add the jobID as reference to the origin for the pod.
+	ok, val := kube.ValidateLabelKeyIsPresentFromContext(ctx, consts.LabelPrefix)
+	if ok {
+		kube.AddLabelsToPodOptions(options, path.Join(consts.LabelPrefix, jobIDSuffix), val)
+	}
 	pr := kube.NewPodRunner(cli, options)
 	podFunc := kubeTaskPodFunc()
 	return pr.Run(ctx, podFunc)

pkg/kube/pod_runner_test.go

@@ -17,12 +17,17 @@ package kube
 import (
 	"context"
 	"os"
+	"path"
 
+	"github.com/pkg/errors"
 	. "gopkg.in/check.v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/kubernetes/fake"
 	"k8s.io/client-go/testing"
+
+	"github.com/kanisterio/kanister/pkg/consts"
+	"github.com/kanisterio/kanister/pkg/field"
 )
 
 type PodRunnerTestSuite struct{}
@@ -109,9 +114,65 @@ func (s *PodRunnerTestSuite) TestPodRunnerForSuccessCase(c *C) {
 	cancel()
 }
 
+// TestPodRunnerWithJobIDDebugLabelForSuccessCase: This test adds a debug entry (kanister.io/JobID) into the context and verifies the
+// pod got created with corresponding label using the entry or not.
+func (s *PodRunnerTestSuite) TestPodRunnerWithJobIDDebugLabelForSuccessCase(c *C) {
+	randomUUID := "xyz123"
+	ctx, cancel := context.WithCancel(context.Background())
+	ctx = field.Context(ctx, path.Join(consts.LabelPrefix, "JobID"), randomUUID)
+	cli := fake.NewSimpleClientset()
+	cli.PrependReactor("create", "pods", func(action testing.Action) (handled bool, ret runtime.Object, err error) {
+		return false, nil, nil
+	})
+	cli.PrependReactor("get", "pods", func(action testing.Action) (handled bool, ret runtime.Object, err error) {
+		p := &corev1.Pod{
+			Status: corev1.PodStatus{
+				Phase: corev1.PodRunning,
+			},
+		}
+		return true, p, nil
+	})
+	po := &PodOptions{
+		Namespace: podRunnerNS,
+		Name:      podName,
+		Command:   []string{"sh", "-c", "tail -f /dev/null"},
+	}
+	deleted := make(chan struct{})
+	cli.PrependReactor("delete", "pods", func(action testing.Action) (handled bool, ret runtime.Object, err error) {
+		c.Log("Pod deleted due to Context Cancelled")
+		close(deleted)
+		return true, nil, nil
+	})
+	var targetKey = path.Join(consts.LabelPrefix, "JobID")
+	AddLabelsToPodOptions(po, targetKey, randomUUID)
+	pr := NewPodRunner(cli, po)
+	errorCh := make(chan error)
+	go func() {
+		_, err := pr.Run(ctx, afterPodRunTestKeyPresentFunc(targetKey, randomUUID, deleted))
+		errorCh <- err
+	}()
+	deleted <- struct{}{}
+	c.Assert(<-errorCh, IsNil)
+	cancel()
+}
+
 func makePodRunnerTestFunc(ch chan struct{}) func(ctx context.Context, pc PodController) (map[string]interface{}, error) {
 	return func(ctx context.Context, pc PodController) (map[string]interface{}, error) {
 		<-ch
 		return nil, nil
 	}
 }
+
+func afterPodRunTestKeyPresentFunc(labelKey, labelValue string, ch chan struct{}) func(ctx context.Context, pc PodController) (map[string]interface{}, error) {
+	return func(ctx context.Context, pc PodController) (map[string]interface{}, error) {
+		<-ch
+		value, ok := pc.Pod().Labels[labelKey]
+		if !ok {
+			return nil, errors.New("Key not present")
+		}
+		if value != labelValue {
+			return nil, errors.New("Value mismatch")
+		}
+		return nil, nil
+	}
+}

pkg/kube/utils.go

@@ -17,10 +17,13 @@ package kube
 import (
 	"context"
 	"fmt"
+	"strings"
 
 	osversioned "github.com/openshift/client-go/apps/clientset/versioned"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/client-go/kubernetes"
+
+	"github.com/kanisterio/kanister/pkg/field"
 )
 
 const (
@@ -171,3 +174,30 @@ func PVCContainsReadOnlyAccessMode(pvc *corev1.PersistentVolumeClaim) bool {
 
 	return false
 }
+
+// AddLabelsToPodOptions adds additional label selector to `PodOptions`.
+func AddLabelsToPodOptions(
+	options *PodOptions,
+	targetKey,
+	targetValue string,
+) {
+	if options.Labels == nil {
+		options.Labels = make(map[string]string)
+	}
+	options.Labels[targetKey] = targetValue
+}
+
+// ValidateLabelKeyIsPresentFromContext: This is a helper validation function used to validate the presence of a
+// label key. Result of this is used to add target label selector to the pod.
+func ValidateLabelKeyIsPresentFromContext(ctx context.Context, keyPrefix string) (bool, string) {
+	fields := field.FromContext(ctx)
+	if fields == nil {
+		return false, ""
+	}
+	for _, f := range fields.Fields() {
+		if strings.HasPrefix(f.Key(), keyPrefix) {
+			return true, f.Value().(string)
+		}
+	}
+	return false, ""
+}