Replace KubernetesAnsibleModule class with dummy class (#227)

* Make an AnsibleMixin parent class for every module * Replace KubernetesAnsibleModule class with dummy class * Modified k8s_log * k8s_exec refactor * k8s_info refactor * k8s_service refactor * k8s_scale refactor * Fix integration tests * Add a warning about the deprecation of KubernetesAnsibleModule * Add a dummy class for backward compatibility Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2026-04-27 08:36:27 +00:00 · 2020-09-16 20:35:05 +05:30
parent 28dcf76cfb
commit 51cadb7150
6 changed files with 154 additions and 102 deletions
--- a/plugins/modules/k8s_exec.py
+++ b/plugins/modules/k8s_exec.py
@@ -109,18 +109,18 @@ result:

 import copy
 import shlex
-import traceback

 try:
    import yaml
-    IMP_YAML = True
 except ImportError:
-    IMP_YAML_ERR = traceback.format_exc()
-    IMP_YAML = False
+    # ImportError are managed by the common module already.
+    pass

-from ansible.module_utils.basic import missing_required_lib
-from ansible_collections.community.kubernetes.plugins.module_utils.common import KubernetesAnsibleModule
-from ansible_collections.community.kubernetes.plugins.module_utils.common import AUTH_ARG_SPEC
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+from ansible_collections.community.kubernetes.plugins.module_utils.common import (
+    K8sAnsibleMixin, AUTH_ARG_SPEC
+)

 try:
    from kubernetes.client.apis import core_v1_api
@@ -130,7 +130,18 @@ except ImportError:
    pass


-class KubernetesExecCommand(KubernetesAnsibleModule):
+class KubernetesExecCommand(K8sAnsibleMixin):
+
+    def __init__(self):
+        module = AnsibleModule(
+            argument_spec=self.argspec,
+            supports_check_mode=True,
+        )
+        self.module = module
+        self.params = self.module.params
+        self.fail_json = self.module.fail_json
+        super(KubernetesExecCommand, self).__init__()
+
    @property
    def argspec(self):
        spec = copy.deepcopy(AUTH_ARG_SPEC)
@@ -140,52 +151,54 @@ class KubernetesExecCommand(KubernetesAnsibleModule):
        spec['command'] = dict(type='str', required=True)
        return spec

+    def execute_module(self):
+        # Load kubernetes.client.Configuration
+        self.get_api_client()
+        api = core_v1_api.CoreV1Api()
+
+        # hack because passing the container as None breaks things
+        optional_kwargs = {}
+        if self.params.get('container'):
+            optional_kwargs['container'] = self.params['container']
+        try:
+            resp = stream(
+                api.connect_get_namespaced_pod_exec,
+                self.params["pod"],
+                self.params["namespace"],
+                command=shlex.split(self.params["command"]),
+                stdout=True,
+                stderr=True,
+                stdin=False,
+                tty=False,
+                _preload_content=False, **optional_kwargs)
+        except Exception as e:
+            self.module.fail_json(msg="Failed to execute on pod %s"
+                                      " due to : %s" % (self.params.get('pod'), to_native(e)))
+        stdout, stderr, rc = [], [], 0
+        while resp.is_open():
+            resp.update(timeout=1)
+            if resp.peek_stdout():
+                stdout.append(resp.read_stdout())
+            if resp.peek_stderr():
+                stderr.append(resp.read_stderr())
+        err = resp.read_channel(3)
+        err = yaml.safe_load(err)
+        if err['status'] == 'Success':
+            rc = 0
+        else:
+            rc = int(err['details']['causes'][0]['message'])
+
+        self.module.exit_json(
+            # Some command might change environment, but ultimately failing at end
+            changed=True,
+            stdout="".join(stdout),
+            stderr="".join(stderr),
+            return_code=rc
+        )
+

 def main():
-    module = KubernetesExecCommand()
-
-    if not IMP_YAML:
-        module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
-
-    # Load kubernetes.client.Configuration
-    module.get_api_client()
-    api = core_v1_api.CoreV1Api()
-
-    # hack because passing the container as None breaks things
-    optional_kwargs = {}
-    if module.params.get('container'):
-        optional_kwargs['container'] = module.params['container']
-    resp = stream(
-        api.connect_get_namespaced_pod_exec,
-        module.params["pod"],
-        module.params["namespace"],
-        command=shlex.split(module.params["command"]),
-        stdout=True,
-        stderr=True,
-        stdin=False,
-        tty=False,
-        _preload_content=False, **optional_kwargs)
-    stdout, stderr, rc = [], [], 0
-    while resp.is_open():
-        resp.update(timeout=1)
-        if resp.peek_stdout():
-            stdout.append(resp.read_stdout())
-        if resp.peek_stderr():
-            stderr.append(resp.read_stderr())
-    err = resp.read_channel(3)
-    err = yaml.safe_load(err)
-    if err['status'] == 'Success':
-        rc = 0
-    else:
-        rc = int(err['details']['causes'][0]['message'])
-
-    module.exit_json(
-        # Some command might change environment, but ultimately failing at end
-        changed=True,
-        stdout="".join(stdout),
-        stderr="".join(stderr),
-        return_code=rc
-    )
+    KubernetesExecCommand().execute_module()


 if __name__ == '__main__':
--- a/plugins/modules/k8s_info.py
+++ b/plugins/modules/k8s_info.py
@@ -130,17 +130,25 @@ resources:
      type: dict
 '''

-
-from ansible_collections.community.kubernetes.plugins.module_utils.common import KubernetesAnsibleModule, AUTH_ARG_SPEC
 import copy

+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.kubernetes.plugins.module_utils.common import (
+    K8sAnsibleMixin, AUTH_ARG_SPEC)

-class KubernetesInfoModule(KubernetesAnsibleModule):
+
+class KubernetesInfoModule(K8sAnsibleMixin):

    def __init__(self, *args, **kwargs):
-        KubernetesAnsibleModule.__init__(self, *args,
-                                         supports_check_mode=True,
-                                         **kwargs)
+        module = AnsibleModule(
+            argument_spec=self.argspec,
+            supports_check_mode=True,
+        )
+        self.module = module
+        self.params = self.module.params
+        self.fail_json = self.module.fail_json
+        self.exit_json = self.module.exit_json
+        super(KubernetesInfoModule, self).__init__()

    def execute_module(self):
        self.client = self.get_api_client()
--- a/plugins/modules/k8s_log.py
+++ b/plugins/modules/k8s_log.py
@@ -111,18 +111,26 @@ log_lines:

 import copy

+from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.six import PY2

-from ansible_collections.community.kubernetes.plugins.module_utils.common import KubernetesAnsibleModule
-from ansible_collections.community.kubernetes.plugins.module_utils.common import AUTH_ARG_SPEC, NAME_ARG_SPEC
+from ansible_collections.community.kubernetes.plugins.module_utils.common import (
+    K8sAnsibleMixin, AUTH_ARG_SPEC, NAME_ARG_SPEC)


-class KubernetesLogModule(KubernetesAnsibleModule):
+class KubernetesLogModule(K8sAnsibleMixin):

-    def __init__(self, *args, **kwargs):
-        KubernetesAnsibleModule.__init__(self, *args,
-                                         supports_check_mode=True,
-                                         **kwargs)
+    def __init__(self):
+        module = AnsibleModule(
+            argument_spec=self.argspec,
+            supports_check_mode=True,
+        )
+        self.module = module
+        self.params = self.module.params
+        self.fail_json = self.module.fail_json
+        self.fail = self.module.fail_json
+        self.exit_json = self.module.exit_json
+        super(KubernetesLogModule, self).__init__()

    @property
    def argspec(self):