Merge pull request #105 from openebs/sts_functions

add utils for statefulset pods

Author: rohan2794

common/k8stest/util_pod.go

@@ -20,6 +20,7 @@ import (
 	coreV1 "k8s.io/api/core/v1"
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/api/core/v1"
+	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 )
@@ -770,3 +771,43 @@ func UnsuppressMayastorPodOnNode(nodeName string, timeout int) error {
 	err = WaitForPodRunningOnNode(IoEnginePodRegexp, common.NSMayastor(), nodeName, timeout)
 	return err
 }
+
+func CheckPodExists(podName string, namespace string) (bool, error) {
+	// Fetch the pod using the GetPod function
+	podAPI := gTestEnv.KubeInt.CoreV1().Pods
+	_, err := podAPI(namespace).Get(context.TODO(), podName, metaV1.GetOptions{})
+	if err != nil {
+		// If the error indicates that the pod is not found, it has been deleted successfully
+		if k8serrors.IsNotFound(err) {
+			return false, nil
+		}
+		// If it's another error, return it
+		return false, fmt.Errorf("failed to check if pod %s in namespace %s is present, error: %v", podName, namespace, err)
+	}
+	return true, nil
+}
+
+func WaitForPodDeletion(podName string, namespace string, podDeletionTimeoutSecs time.Duration) (bool, error) {
+
+	startTime := time.Now()
+
+	for {
+		exists, err := CheckPodExists(podName, namespace)
+		if err != nil {
+			return false, err
+		}
+		if !exists {
+			return true, nil
+		}
+
+		// If the timeout is reached, exit the loop
+		if time.Since(startTime) >= podDeletionTimeoutSecs {
+			break
+		}
+		// Sleep for a short interval before retrying
+		time.Sleep(1 * time.Second)
+	}
+
+	// If the pod still exists after the timeout, return false
+	return false, fmt.Errorf("timeout reached: pod %s in namespace %s was not deleted within %v", podName, namespace, podDeletionTimeoutSecs)
+}

common/k8stest/util_sts.go

@@ -452,3 +452,60 @@ func StsExists(statefulSetName string, namespace string) (bool, error) {
 	}
 	return false, err
 }
+
+func GetSts(statefulSetName string, namespace string) (*appsv1.StatefulSet, error) {
+	sts, err := gTestEnv.KubeInt.AppsV1().StatefulSets(namespace).Get(
+		context.TODO(),
+		statefulSetName,
+		metaV1.GetOptions{},
+	)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get statefulset %s in namespace %s: %v", statefulSetName, namespace, err)
+	}
+	return sts, nil
+}
+
+func ListSts(namespace string) ([]appsv1.StatefulSet, error) {
+	stsList, err := gTestEnv.KubeInt.AppsV1().StatefulSets(namespace).List(
+		context.TODO(),
+		metaV1.ListOptions{},
+	)
+	if err != nil {
+		return nil, fmt.Errorf("failed to list statefulsets in namespace %s: %v", namespace, err)
+	}
+	return stsList.Items, nil
+}
+
+func GetStsPodNames(statefulSetName string, namespace string) ([]string, error) {
+	// Get the StatefulSet to ensure it exists
+	_, err := GetSts(statefulSetName, namespace)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get statefulset %s in namespace %s: %v", statefulSetName, namespace, err)
+	}
+
+	// List all pods in the namespace
+	podList, err := ListPod(namespace)
+	if err != nil {
+		return nil, fmt.Errorf("failed to list pods in namespace %s: %v", namespace, err)
+	}
+
+	// Filter pods based on owner references
+	var podNames []string
+	for _, pod := range podList.Items {
+		for _, owner := range pod.OwnerReferences {
+			// Check if the owner is the target StatefulSet
+			if owner.Kind == "StatefulSet" && owner.Name == statefulSetName {
+				podNames = append(podNames, pod.Name)
+				break
+			}
+		}
+	}
+
+	// If no pods were found, return a specific error
+	if len(podNames) == 0 {
+		return nil, fmt.Errorf("no pods found for statefulset %s in namespace %s", statefulSetName, namespace)
+	}
+
+	// Return the list of pod names
+	return podNames, nil
+}