Merge pull request ansible-collections#481 from ansible-collections/2…

….x-refactor

Refactor common.py

changelogs/fragments/481-refactor-common.yml

@@ -0,0 +1,3 @@
+---
+major_changes:
+  - refactor K8sAnsibleMixin into module_utils/k8s/ (https://github.com/ansible-collections/kubernetes.core/pull/481).

plugins/module_utils/common.py

@@ -130,6 +130,7 @@
 
 
 def configuration_digest(configuration, **kwargs):
+    """This function has been deprecated and will be removed in version 4.0.0."""
     m = hashlib.sha256()
     for k in AUTH_ARG_MAP:
         if not hasattr(configuration, k):
@@ -150,6 +151,8 @@ def configuration_digest(configuration, **kwargs):
 
 
 class unique_string(str):
+    """This function has been deprecated and will be removed in version 4.0.0."""
+
     _low = None
 
     def __hash__(self):
@@ -169,6 +172,7 @@ def lower(self):
 
 
 def get_api_client(module=None, **kwargs):
+    """This function has been deprecated and will be removed in version 4.0.0. Please use module_utils.k8s.client.get_api_client() instead."""
     auth = {}
 
     def _raise_or_fail(exc, msg):
@@ -340,6 +344,11 @@ def _load_config():
 
 class K8sAnsibleMixin(object):
     def __init__(self, module, pyyaml_required=True, *args, **kwargs):
+        module.deprecate(
+            msg="The K8sAnsibleMixin class has been deprecated and refactored into the module_utils/k8s/ directory.",
+            version="4.0.0",
+            collection_name="kubernetes.core",
+        )
         if not HAS_K8S_MODULE_HELPER:
             module.fail_json(
                 msg=missing_required_lib("kubernetes"),

plugins/module_utils/copy.py

@@ -24,6 +24,9 @@
 import tarfile
 
 # from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible.module_utils._text import to_native
 
 try:
@@ -376,12 +379,17 @@ def run(self):
         )
 
 
-def check_pod(k8s_ansible_mixin, module):
-    resource = k8s_ansible_mixin.find_resource("Pod", None, True)
+def check_pod(svc):
+    module = svc.module
     namespace = module.params.get("namespace")
     name = module.params.get("pod")
     container = module.params.get("container")
 
+    try:
+        resource = svc.find_resource("Pod", None, True)
+    except CoreException as e:
+        module.fail_json(msg=to_native(e))
+
     def _fail(exc):
         arg = {}
         if hasattr(exc, "body"):
@@ -398,7 +406,7 @@ def _fail(exc):
         module.fail_json(msg=msg, **arg)
 
     try:
-        result = resource.get(name=name, namespace=namespace)
+        result = svc.client.get(resource, name=name, namespace=namespace)
         containers = [
             c["name"] for c in result.to_dict()["status"]["containerStatuses"]
         ]