Restructure abstract method handling in plugin

Signed-off-by: Toni Finger <[email protected]>

Author: tonifinger

Tests/kaas/plugin/interface.py

@@ -1,11 +1,4 @@
 from abc import abstractmethod
-from typing import final
-import os
-import os.path
-import shutil
-import logging
-
-logger = logging.getLogger("interface")
 
 
 class KubernetesClusterPlugin():
@@ -15,64 +8,19 @@ class KubernetesClusterPlugin():
     plugins must be derived as child classes
     """
 
-    kubeconfig = None
-    cluster_name = None
-    k8s_api_client = None
-    working_directory = None
-
-    @final
-    def __init__(self, config_file=None):
-        logger.info(f"Init provider plug-in of type {self.__class__.__name__}")
-        self.config = config_file
-        logger.debug(self.config)
-        self.working_directory = os.getcwd()
-        logger.debug(f"Working from {self.working_directory}")
-
     @abstractmethod
-    def _create_cluster(self, cluster_name) -> (str, int):
+    def create_cluster(self, cluster_name="scs-cluster", version=None, kubeconfig_filepath=None) -> (str):
         """
-        Create a Kubernetes cluster to test aggainst.
+        This method is to be called to create a k8s cluster
         :param: cluster_name:
-        :return: kubeconfig: kubeconfig of the cluster used for testing
+        :param: version:
+        :param: kubeconfig_filepath:
+        :return: kubeconfig_filepath
         """
-        pass
 
     @abstractmethod
-    def _delete_cluster(self, cluster_name) -> (str, int):
-        """
-        Delete the Kubernetes cluster.
-        :param: cluster_name:
-        :return: None
-        """
-        pass
-
-    @final
-    def create(self, name="scs-cluster", version=None, kubeconfig_filepath=None):
-        """
-        This method is to be called to create a k8s cluster
-        :param: kubernetes_version:
-        :return: uuid
-        """
-        self.cluster_name = name
-        self.cluster_version = version
-
-        self._create_cluster()
-
-        if kubeconfig_filepath:
-            shutil.move(self.kubeconfig, kubeconfig_filepath)
-        else:
-            kubeconfig_filepath = str(self.kubeconfig)
-
-        return kubeconfig_filepath
-
-    @final
-    def delete(self, cluster_name=None):
+    def delete_cluster(self, cluster_name=None):
         """
         This method is to be called in order to unprovision a cluster
         :param: cluster_uuid:
         """
-        self.cluster_name = cluster_name
-        try:
-            self._delete_cluster()
-        except Exception as e:
-            logging.exception(e)

Tests/kaas/plugin/plugin_kind.py

@@ -1,29 +1,50 @@
+import shutil
+import os
+import os.path
 from interface import KubernetesClusterPlugin
 from pytest_kind import KindCluster
+import logging
+logger = logging.getLogger("plugin_kind")
 
 
 class PluginKind(KubernetesClusterPlugin):
     """
     Plugin to handle the provisioning of kubernetes cluster for
     conformance testing purpose with the use of Kind
     """
+    def __init__(self, config_file=None):
+        logger.info(f"Init provider plug-in of type {self.__class__.__name__}")
+        self.config = config_file
+        logger.debug(self.config)
+        self.working_directory = os.getcwd()
+        logger.debug(f"Working from {self.working_directory}")
 
-    def _create_cluster(self):
-        cluster_version = self.cluster_version
+    def create_cluster(self, cluster_name="scs-cluster", version=None, kubeconfig_filepath=None):
+        """
+        This method is to be called to create a k8s cluster
+        :param: kubernetes_version:
+        :return: kubeconfig_filepath
+        """
+        cluster_version = version
         if cluster_version == '1.29':
             cluster_version = 'v1.29.8'
         elif cluster_version == '1.30':
             cluster_version = 'v1.30.4'
         elif cluster_version == '1.31' or cluster_version == 'default':
             cluster_version = 'v1.31.1'
         cluster_image = f"kindest/node:{cluster_version}"
-        self.cluster = KindCluster(name=self.cluster_name, image=cluster_image)
+        self.cluster = KindCluster(name=cluster_name, image=cluster_image)
         if self.config is None:
             self.cluster.create()
         else:
             self.cluster.create(self.config)
         self.kubeconfig = str(self.cluster.kubeconfig_path.resolve())
+        if kubeconfig_filepath:
+            shutil.move(self.kubeconfig, kubeconfig_filepath)
+        else:
+            kubeconfig_filepath = str(self.kubeconfig)
+        return kubeconfig_filepath
 
-    def _delete_cluster(self):
-        self.cluster = KindCluster(self.cluster_name)
+    def delete_cluster(self, cluster_name=None):
+        self.cluster = KindCluster(cluster_name)
         self.cluster.delete()

Tests/kaas/plugin/run_plugin.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 import logging
 import os.path
-
 import click
 import yaml
 
+
 from plugin_kind import PluginKind
 from plugin_static import PluginStatic
 
@@ -24,12 +24,12 @@ def init_plugin(plugin_kind, config=None):
 
 def run_plugin_create(plugin_kind, plugin_config, clusterspec_cluster, clusterspec):
     plugin = init_plugin(plugin_kind, plugin_config)
-    plugin.create(clusterspec_cluster, clusterspec[clusterspec_cluster]['branch'], os.path.abspath(clusterspec[clusterspec_cluster]['kubeconfig']))
+    plugin.create_cluster(clusterspec_cluster, clusterspec[clusterspec_cluster]['branch'], os.path.abspath(clusterspec[clusterspec_cluster]['kubeconfig']))
 
 
 def run_plugin_delete(plugin_kind, plugin_config, clusterspec_cluster, clusterspec):
     plugin = init_plugin(plugin_kind, plugin_config)
-    plugin.delete(clusterspec_cluster)
+    plugin.delete_cluster(clusterspec_cluster)
 
 
 def load_spec(clusterspec_path):