pod: add basic unit tests

This PR adds unit tests to the basic pod functions (NewBuilder, Pull, Create, Delete, Get, Exists) and refactors the existing tests in the package to be more in line with those from other packages.

Author: klaskosk

pkg/pod/list_test.go

@@ -1,6 +1,7 @@
 package pod
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -10,76 +11,86 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
-func TestWaitForAllPodsInNamespacesHealthy(t *testing.T) {
+func TestPodWaitForAllPodsInNamespacesHealthy(t *testing.T) {
+	generateTestPod := func(namespace string, conditionType corev1.PodConditionType) *corev1.Pod {
+		pod := buildDummyPodWithPhaseAndCondition(corev1.PodRunning, conditionType, false)
+		pod.Namespace = namespace
+
+		return pod
+	}
+
 	testCases := []struct {
 		namespaces               []string
 		includeSucceeded         bool
 		skipRedinessCheck        bool
 		ignoreRestartPolicyNever bool
 		ignoreNamespaces         []string
-		expectedErrMsg           string
+		pods                     []runtime.Object
+		expectedError            error
 	}{
 		{
 			namespaces:               []string{"ns1"},
 			includeSucceeded:         true,
 			skipRedinessCheck:        true,
 			ignoreRestartPolicyNever: true,
 			ignoreNamespaces:         []string{},
-			expectedErrMsg:           "",
+			pods: []runtime.Object{
+				generateTestPod("ns1", corev1.PodReady), generateTestPod("ns2", corev1.PodInitialized)},
+			expectedError: nil,
 		},
 		{
 			namespaces:               []string{"ns1"},
 			includeSucceeded:         true,
 			skipRedinessCheck:        false,
 			ignoreRestartPolicyNever: true,
 			ignoreNamespaces:         []string{},
-			expectedErrMsg:           "",
+			pods:                     []runtime.Object{generateTestPod("ns1", corev1.PodReady)},
+			expectedError:            nil,
 		},
 		{
 			namespaces:               []string{"ns2"},
 			includeSucceeded:         true,
 			skipRedinessCheck:        false,
 			ignoreRestartPolicyNever: true,
 			ignoreNamespaces:         []string{},
-			expectedErrMsg:           "context deadline exceeded",
+			pods:                     []runtime.Object{generateTestPod("ns2", corev1.PodInitialized)},
+			expectedError:            context.DeadlineExceeded,
 		},
 		{
 			namespaces:               []string{},
 			includeSucceeded:         true,
 			skipRedinessCheck:        false,
 			ignoreRestartPolicyNever: true,
 			ignoreNamespaces:         []string{},
-			expectedErrMsg:           "context deadline exceeded",
+			pods: []runtime.Object{
+				generateTestPod("ns1", corev1.PodReady), generateTestPod("ns2", corev1.PodInitialized)},
+			expectedError: context.DeadlineExceeded,
 		},
 		{
 			namespaces:               []string{},
 			includeSucceeded:         true,
 			skipRedinessCheck:        false,
 			ignoreRestartPolicyNever: true,
 			ignoreNamespaces:         []string{"ns2"},
-			expectedErrMsg:           "",
+			pods:                     []runtime.Object{generateTestPod("ns1", corev1.PodReady)},
+			expectedError:            nil,
 		},
 	}
 
-	var runtimeObjects []runtime.Object
-	runtimeObjects = append(runtimeObjects, generateTestPod("test1", "ns1", corev1.PodRunning, corev1.PodReady, false))
-	runtimeObjects = append(runtimeObjects, generateTestPod("test2", "ns1", corev1.PodRunning, corev1.PodReady, false))
-	runtimeObjects = append(runtimeObjects, generateTestPod("test3", "ns1", corev1.PodRunning, corev1.PodReady, false))
-	runtimeObjects = append(runtimeObjects, generateTestPod("test4", "ns1", corev1.PodRunning, corev1.PodReady, false))
-	runtimeObjects = append(runtimeObjects, generateTestPod("test5", "ns1", corev1.PodRunning, corev1.PodReady, false))
-	runtimeObjects = append(runtimeObjects, generateTestPod("test1", "ns2", corev1.PodRunning, corev1.PodReady, false))
-	runtimeObjects = append(runtimeObjects, generateTestPod("test2", "ns2", corev1.PodRunning, corev1.PodInitialized,
-		false))
-
-	testSettings := clients.GetTestClients(clients.TestClientParams{
-		K8sMockObjects: runtimeObjects,
-	})
-
 	for _, testCase := range testCases {
-		err := WaitForAllPodsInNamespacesHealthy(testSettings, testCase.namespaces, 2*time.Second, testCase.includeSucceeded,
+		testSettings := clients.GetTestClients(clients.TestClientParams{
+			K8sMockObjects: testCase.pods,
+		})
+
+		err := WaitForAllPodsInNamespacesHealthy(
+			testSettings,
+			testCase.namespaces,
+			time.Second,
+			testCase.includeSucceeded,
 			testCase.skipRedinessCheck,
-			testCase.ignoreRestartPolicyNever, testCase.ignoreNamespaces)
+			testCase.ignoreRestartPolicyNever,
+			testCase.ignoreNamespaces)
 
-		assert.Equal(t, testCase.expectedErrMsg, getErrorString(err))
+		assert.Equal(t, testCase.expectedError, err)
 	}
 }

pkg/pod/pod.go

@@ -64,19 +64,25 @@ func NewBuilder(apiClient *clients.Settings, name, nsname, image string) *Builde
 	if name == "" {
 		glog.V(100).Infof("The name of the pod is empty")
 
-		builder.errorMsg = "pod's name is empty"
+		builder.errorMsg = "pod 'name' cannot be empty"
+
+		return builder
 	}
 
 	if nsname == "" {
 		glog.V(100).Infof("The namespace of the pod is empty")
 
-		builder.errorMsg = "namespace's name is empty"
+		builder.errorMsg = "pod 'namespace' cannot be empty"
+
+		return builder
 	}
 
 	if image == "" {
 		glog.V(100).Infof("The image of the pod is empty")
 
-		builder.errorMsg = "pod's image is empty"
+		builder.errorMsg = "pod 'image' cannot be empty"
+
+		return builder
 	}
 
 	defaultContainer, err := NewContainerBuilder("test", image, []string{"/bin/bash", "-c", "sleep INF"}).GetContainerCfg()
@@ -85,6 +91,8 @@ func NewBuilder(apiClient *clients.Settings, name, nsname, image string) *Builde
 		glog.V(100).Infof("Failed to define the default container settings")
 
 		builder.errorMsg = err.Error()
+
+		return builder
 	}
 
 	builder.Definition.Spec.Containers = append(builder.Definition.Spec.Containers, *defaultContainer)
@@ -115,17 +123,13 @@ func Pull(apiClient *clients.Settings, name, nsname string) (*Builder, error) {
 	if name == "" {
 		glog.V(100).Infof("The name of the pod is empty")
 
-		builder.errorMsg = "pod 'name' cannot be empty"
+		return nil, fmt.Errorf("pod 'name' cannot be empty")
 	}
 
 	if nsname == "" {
 		glog.V(100).Infof("The namespace of the pod is empty")
 
-		builder.errorMsg = "pod 'namespace' cannot be empty"
-	}
-
-	if builder.errorMsg != "" {
-		return nil, fmt.Errorf("faield to pull pod object due to the following error: %s", builder.errorMsg)
+		return nil, fmt.Errorf("pod 'namespace' cannot be empty")
 	}
 
 	if !builder.Exists() {
@@ -402,8 +406,8 @@ func (builder *Builder) WaitUntilDeleted(timeout time.Duration) error {
 
 	err := wait.PollUntilContextTimeout(
 		context.TODO(), time.Second, timeout, false, func(ctx context.Context) (bool, error) {
-			_, err := builder.apiClient.Pods(builder.Definition.Namespace).Get(
-				context.TODO(), builder.Definition.Name, metav1.GetOptions{})
+			_, err := builder.apiClient.Pods(builder.Object.Namespace).Get(
+				context.TODO(), builder.Object.Name, metav1.GetOptions{})
 			if err == nil {
 				glog.V(100).Infof("pod %s/%s still present", builder.Definition.Namespace, builder.Definition.Name)