Importable End-To-End Test Suite (#758)

* Rename VK to chewong for development purpose

* Rename basic_test.go to basic.go

* Add e2e.go and suite.go

* Disable tests in node.go

* End to end tests are now importable as a testing suite

* Remove 'test' from test files

* Add documentations

* Rename chewong back to virtual-kubelet

* Change 'Testing Suite' to 'Test Suite'

* Add the ability to skip certain testss

* Add unit tests for suite.go

* Add README.md for importable e2e test suite

* VK implementation has to be based on VK v1.0.0

* Stricter checks on validating test functions

* Move certain files back to internal folder

* Add WatchTimeout as a config field

* Add slight modifications

internal/test/e2e/framework/env.go

@@ -75,7 +75,7 @@ func (f *Framework) CreatePodObjectWithOptionalSecretKey(testName string) *corev
 
 // CreatePodObjectWithEnv creates a pod object whose name starts with "env-test-" and that uses the specified environment configuration for its first container.
 func (f *Framework) CreatePodObjectWithEnv(testName string, env []corev1.EnvVar) *corev1.Pod {
-	pod := f.CreateDummyPodObjectWithPrefix(testName, "env-test-", "foo")
+	pod := f.CreateDummyPodObjectWithPrefix(testName, "env-test", "foo")
 	pod.Spec.Containers[0].Env = env
 	return pod
 }

internal/test/e2e/framework/framework.go

@@ -1,6 +1,8 @@
 package framework
 
 import (
+	"time"
+
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
@@ -8,17 +10,19 @@ import (
 
 // Framework encapsulates the configuration for the current run, and provides helper methods to be used during testing.
 type Framework struct {
-	KubeClient kubernetes.Interface
-	Namespace  string
-	NodeName   string
+	KubeClient   kubernetes.Interface
+	Namespace    string
+	NodeName     string
+	WatchTimeout time.Duration
 }
 
 // NewTestingFramework returns a new instance of the testing framework.
-func NewTestingFramework(kubeconfig, namespace, nodeName string) *Framework {
+func NewTestingFramework(kubeconfig, namespace, nodeName string, watchTimeout time.Duration) *Framework {
 	return &Framework{
-		KubeClient: createKubeClient(kubeconfig),
-		Namespace:  namespace,
-		NodeName:   nodeName,
+		KubeClient:   createKubeClient(kubeconfig),
+		Namespace:    namespace,
+		NodeName:     nodeName,
+		WatchTimeout: watchTimeout,
 	}
 }
 

internal/test/e2e/framework/node.go

@@ -31,7 +31,7 @@ func (f *Framework) WaitUntilNodeCondition(fn watch.ConditionFunc) error {
 	}
 
 	// Watch for updates to the Pod resource until fn is satisfied, or until the timeout is reached.
-	ctx, cancel := context.WithTimeout(context.Background(), defaultWatchTimeout)
+	ctx, cancel := context.WithTimeout(context.Background(), f.WatchTimeout)
 	defer cancel()
 	last, err := watch.UntilWithSync(ctx, lw, &corev1.Node{}, nil, fn)
 	if err != nil {

internal/test/e2e/framework/pod.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 	"strings"
-	"time"
 
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -16,8 +15,6 @@ import (
 	podutil "k8s.io/kubernetes/pkg/api/v1/pod"
 )
 
-const defaultWatchTimeout = 2 * time.Minute
-
 // CreateDummyPodObjectWithPrefix creates a dujmmy pod object using the specified prefix as the value of .metadata.generateName.
 // A variable number of strings can be provided.
 // For each one of these strings, a container that uses the string as its image will be appended to the pod.
@@ -25,8 +22,7 @@ const defaultWatchTimeout = 2 * time.Minute
 func (f *Framework) CreateDummyPodObjectWithPrefix(testName string, prefix string, images ...string) *corev1.Pod {
 	// Safe the test name
 	if testName != "" {
-		testName = strings.Replace(testName, "/", "-", -1)
-		testName = strings.ToLower(testName)
+		testName = stripParentTestName(strings.ToLower(testName))
 		prefix = prefix + "-" + testName + "-"
 	}
 	enableServiceLink := false
@@ -88,7 +84,7 @@ func (f *Framework) WaitUntilPodCondition(namespace, name string, fn watch.Condi
 		},
 	}
 	// Watch for updates to the Pod resource until fn is satisfied, or until the timeout is reached.
-	ctx, cfn := context.WithTimeout(context.Background(), defaultWatchTimeout)
+	ctx, cfn := context.WithTimeout(context.Background(), f.WatchTimeout)
 	defer cfn()
 	last, err := watch.UntilWithSync(ctx, lw, &corev1.Pod{}, nil, fn)
 	if err != nil {
@@ -147,7 +143,7 @@ func (f *Framework) WaitUntilPodEventWithReason(pod *corev1.Pod, reason string)
 		},
 	}
 	// Watch for updates to the Event resource until fn is satisfied, or until the timeout is reached.
-	ctx, cfn := context.WithTimeout(context.Background(), defaultWatchTimeout)
+	ctx, cfn := context.WithTimeout(context.Background(), f.WatchTimeout)
 	defer cfn()
 	last, err := watch.UntilWithSync(ctx, lw, &corev1.Event{}, nil, func(event watchapi.Event) (b bool, e error) {
 		switch event.Type {
@@ -184,3 +180,15 @@ func (f *Framework) GetRunningPods() (*corev1.PodList, error) {
 
 	return result, err
 }
+
+// stripParentTestName strips out the parent's test name from the input (in the form of 'TestParent/TestChild').
+// Some test cases use their name as the pod name for testing purpose, and sometimes it might exceed 63
+// characters (Kubernetes's limit for pod name). This function ensures that we strip out the parent's
+// test name to decrease the length of the pod name
+func stripParentTestName(name string) string {
+	parts := strings.Split(name, "/")
+	if len(parts) == 1 {
+		return parts[0]
+	}
+	return parts[len(parts)-1]
+}