CLOUDP-90175: cleanup all resources (#624)

Author: FlorentinaSimlinger

scripts/dev/e2e.py

@@ -11,6 +11,9 @@
 import yaml
 
 TEST_POD_NAME = "e2e-test"
+TEST_CLUSTER_ROLE_NAME = "e2e-test"
+TEST_CLUSTER_ROLE_BINDING_NAME = "e2e-test"
+TEST_SERVICE_ACCOUNT_NAME = "e2e-test"
 
 
 def load_yaml_from_file(path: str) -> Dict:
@@ -32,27 +35,29 @@ def _load_test_role_binding() -> Dict:
 
 def _prepare_test_environment(config_file: str) -> None:
     """
-    _prepare_testrunner_environment ensures the ServiceAccount,
-    Role and ClusterRole and bindings are created for the test runner.
+    _prepare_test_environment ensures that the old test pod is deleted
+    and that namespace, cluster role, cluster role binding and service account
+    are created for the test pod.
     """
     rbacv1 = client.RbacAuthorizationV1Api()
     corev1 = client.CoreV1Api()
     dev_config = load_config(config_file)
 
+    _delete_test_pod(config_file)
+
     print("Creating Namespace")
     k8s_conditions.ignore_if_already_exists(
         lambda: corev1.create_namespace(
             client.V1Namespace(metadata=dict(name=dev_config.namespace))
         )
     )
-    _delete_test_pod(config_file)
 
-    print("Creating Role")
+    print("Creating Cluster Role")
     k8s_conditions.ignore_if_already_exists(
         lambda: rbacv1.create_cluster_role(_load_test_role())
     )
 
-    print("Creating Role Binding")
+    print("Creating Cluster Role Binding")
     role_binding = _load_test_role_binding()
     # set namespace specified in config.json
     role_binding["subjects"][0]["namespace"] = dev_config.namespace
@@ -61,26 +66,14 @@ def _prepare_test_environment(config_file: str) -> None:
         lambda: rbacv1.create_cluster_role_binding(role_binding)
     )
 
-    print("Creating ServiceAccount")
+    print("Creating Service Account")
     k8s_conditions.ignore_if_already_exists(
         lambda: corev1.create_namespaced_service_account(
             dev_config.namespace, _load_test_service_account()
         )
     )
 
 
-def _delete_test_pod(config_file: str) -> None:
-    """
-    _delete_testrunner_pod deletes the test runner pod
-    if it already exists.
-    """
-    dev_config = load_config(config_file)
-    corev1 = client.CoreV1Api()
-    k8s_conditions.ignore_if_doesnt_exist(
-        lambda: corev1.delete_namespaced_pod(TEST_POD_NAME, dev_config.namespace)
-    )
-
-
 def create_test_pod(args: argparse.Namespace, dev_config: DevConfig) -> None:
     corev1 = client.CoreV1Api()
     test_pod = {
@@ -158,7 +151,7 @@ def create_test_pod(args: argparse.Namespace, dev_config: DevConfig) -> None:
         timeout=60,
         exceptions_to_ignore=ApiException,
     ):
-        raise Exception("Could not create test_runner pod!")
+        raise Exception("Could not create test pod!")
 
 
 def wait_for_pod_to_be_running(
@@ -178,6 +171,41 @@ def wait_for_pod_to_be_running(
     print("Pod is running")
 
 
+def _delete_test_environment(config_file: str) -> None:
+    """
+    _delete_test_environment ensures that the cluster role, cluster role binding and service account
+    for the test pod are deleted.
+    """
+    rbacv1 = client.RbacAuthorizationV1Api()
+    corev1 = client.CoreV1Api()
+    dev_config = load_config(config_file)
+
+    k8s_conditions.ignore_if_doesnt_exist(
+        lambda: rbacv1.delete_cluster_role(TEST_CLUSTER_ROLE_NAME)
+    )
+
+    k8s_conditions.ignore_if_doesnt_exist(
+        lambda: rbacv1.delete_cluster_role_binding(TEST_CLUSTER_ROLE_BINDING_NAME)
+    )
+
+    k8s_conditions.ignore_if_doesnt_exist(
+        lambda: corev1.delete_namespaced_service_account(
+            TEST_SERVICE_ACCOUNT_NAME, dev_config.namespace
+        )
+    )
+
+
+def _delete_test_pod(config_file: str) -> None:
+    """
+    _delete_test_pod deletes the test pod.
+    """
+    dev_config = load_config(config_file)
+    corev1 = client.CoreV1Api()
+    k8s_conditions.ignore_if_doesnt_exist(
+        lambda: corev1.delete_namespaced_pod(TEST_POD_NAME, dev_config.namespace)
+    )
+
+
 def parse_args() -> argparse.Namespace:
     parser = argparse.ArgumentParser()
     parser.add_argument("--test", help="Name of the test to run")
@@ -246,6 +274,7 @@ def main() -> int:
         exceptions_to_ignore=ApiException,
     ):
         return 1
+    _delete_test_environment(args.config_file)
     return 0
 
 

test/e2e/setup/setup.go

@@ -46,7 +46,7 @@ func Setup(t *testing.T) *e2eutil.Context {
 		t.Fatal(err)
 	}
 
-	if err := deployOperator(); err != nil {
+	if err := deployOperator(ctx); err != nil {
 		t.Fatal(err)
 	}
 
@@ -130,7 +130,8 @@ func deployDir() string {
 	return envvar.GetEnvOrDefault(deployDirEnv, "/workspace/config/manager")
 }
 
-func deployOperator() error {
+func deployOperator(ctx *e2eutil.Context) error {
+
 	testConfig := loadTestConfigFromEnv()
 
 	e2eutil.OperatorNamespace = testConfig.namespace
@@ -141,24 +142,24 @@ func deployOperator() error {
 	}
 	fmt.Printf("Setting namespace to watch to %s\n", watchNamespace)
 
-	if err := buildKubernetesResourceFromYamlFile(path.Join(roleDir(), "role.yaml"), &rbacv1.Role{}, withNamespace(testConfig.namespace)); err != nil {
+	if err := buildKubernetesResourceFromYamlFile(ctx, path.Join(roleDir(), "role.yaml"), &rbacv1.Role{}, withNamespace(testConfig.namespace)); err != nil {
 		return errors.Errorf("error building operator role: %s", err)
 	}
 	fmt.Println("Successfully created the operator Role")
 
-	if err := buildKubernetesResourceFromYamlFile(path.Join(roleDir(), "service_account.yaml"), &corev1.ServiceAccount{}, withNamespace(testConfig.namespace)); err != nil {
+	if err := buildKubernetesResourceFromYamlFile(ctx, path.Join(roleDir(), "service_account.yaml"), &corev1.ServiceAccount{}, withNamespace(testConfig.namespace)); err != nil {
 		return errors.Errorf("error building operator service account: %s", err)
 	}
 	fmt.Println("Successfully created the operator Service Account")
 
-	if err := buildKubernetesResourceFromYamlFile(path.Join(roleDir(), "role_binding.yaml"), &rbacv1.RoleBinding{}, withNamespace(testConfig.namespace)); err != nil {
+	if err := buildKubernetesResourceFromYamlFile(ctx, path.Join(roleDir(), "role_binding.yaml"), &rbacv1.RoleBinding{}, withNamespace(testConfig.namespace)); err != nil {
 		return errors.Errorf("error building operator role binding: %s", err)
 	}
 	fmt.Println("Successfully created the operator Role Binding")
 
 	dep := &appsv1.Deployment{}
 
-	if err := buildKubernetesResourceFromYamlFile(path.Join(deployDir(), "manager.yaml"),
+	if err := buildKubernetesResourceFromYamlFile(ctx, path.Join(deployDir(), "manager.yaml"),
 		dep,
 		withNamespace(testConfig.namespace),
 		withOperatorImage(testConfig.operatorImage),
@@ -201,7 +202,7 @@ func hasDeploymentRequiredReplicas(dep *appsv1.Deployment) wait.ConditionFunc {
 
 // buildKubernetesResourceFromYamlFile will create the kubernetes resource defined in yamlFilePath. All of the functional options
 // provided will be applied before creation.
-func buildKubernetesResourceFromYamlFile(yamlFilePath string, obj client.Object, options ...func(obj runtime.Object)) error {
+func buildKubernetesResourceFromYamlFile(ctx *e2eutil.Context, yamlFilePath string, obj client.Object, options ...func(obj runtime.Object)) error {
 	data, err := ioutil.ReadFile(yamlFilePath)
 	if err != nil {
 		return errors.Errorf("error reading file: %s", err)
@@ -215,7 +216,7 @@ func buildKubernetesResourceFromYamlFile(yamlFilePath string, obj client.Object,
 		opt(obj)
 	}
 
-	return createOrUpdate(obj)
+	return createOrUpdate(ctx, obj)
 }
 
 // marshalRuntimeObjectFromYAMLBytes accepts the bytes of a yaml resource
@@ -228,8 +229,8 @@ func marshalRuntimeObjectFromYAMLBytes(bytes []byte, obj runtime.Object) error {
 	return json.Unmarshal(jsonBytes, &obj)
 }
 
-func createOrUpdate(obj client.Object) error {
-	if err := e2eutil.TestClient.Create(context.TODO(), obj, &e2eutil.CleanupOptions{}); err != nil {
+func createOrUpdate(ctx *e2eutil.Context, obj client.Object) error {
+	if err := e2eutil.TestClient.Create(context.TODO(), obj, &e2eutil.CleanupOptions{TestContext: ctx}); err != nil {
 		if apiErrors.IsAlreadyExists(err) {
 			return e2eutil.TestClient.Update(context.TODO(), obj)
 		}