Ensure CoreExceptions are handled gracefully (#476)

Ensure CoreExceptions are handled gracefully

SUMMARY

CoreExceptions, when raised, should have a reasonably helpful and
actionable message associated with them. This adds a final check in
module execution to gracefully fail from these exceptions. A new
fail_from_exception method is added both to simplify exiting the module,
and to ensure that any chained exceptions are available when using -vvv.

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
Reviewed-by: Joseph Torcasso <None>

plugins/module_utils/k8s/client.py

@@ -15,6 +15,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.args_common import
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
     requires as _requires,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 
 try:
     from ansible_collections.kubernetes.core.plugins.module_utils import (
@@ -335,9 +338,13 @@ def get_api_client(module=None, **kwargs: Optional[Any]) -> K8SClient:
     if auth_spec.get("no_proxy"):
         requires("kubernetes", "19.15.0", "to use the no_proxy feature")
 
-    configuration = _create_configuration(auth_spec)
-    headers = _create_headers(module, **kwargs)
-    client = create_api_client(configuration, **headers)
+    try:
+        configuration = _create_configuration(auth_spec)
+        headers = _create_headers(module, **kwargs)
+        client = create_api_client(configuration, **headers)
+    except kubernetes.config.ConfigException as e:
+        msg = "Could not create API client: {0}".format(e)
+        raise CoreException(msg) from e
 
     k8s_client = K8SClient(
         configuration=configuration,

plugins/module_utils/k8s/core.py

@@ -1,3 +1,5 @@
+import traceback
+
 from typing import Optional
 
 from ansible_collections.kubernetes.core.plugins.module_utils.version import (
@@ -72,6 +74,13 @@ class AnsibleK8SModule:
     def fail_json(self, *args, **kwargs):
         return self._module.fail_json(*args, **kwargs)
 
+    def fail_from_exception(self, exception):
+        msg = to_text(exception)
+        tb = "".join(
+            traceback.format_exception(None, exception, exception.__traceback__)
+        )
+        return self.fail_json(msg=msg, exception=tb)
+
     def has_at_least(
         self, dependency: str, minimum: Optional[str] = None, warn: bool = False
     ) -> bool:

plugins/module_utils/k8s/runner.py

@@ -8,6 +8,9 @@ from ansible.module_utils._text import to_native
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
     get_api_client,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import (
     create_definitions,
 )
@@ -48,7 +51,11 @@ def run_module(module) -> None:
     changed = False
     client = get_api_client(module)
     svc = K8sService(client, module)
-    definitions = create_definitions(module.params)
+    try:
+        definitions = create_definitions(module.params)
+    except Exception as e:
+        msg = "Failed to load resource definition: {0}".format(e)
+        raise CoreException(msg) from e
 
     for definition in definitions:
         result = {"changed": False, "result": {}}

plugins/modules/k8s.py

@@ -394,6 +394,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.args_common import
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
     AnsibleK8SModule,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.runner import (
     run_module,
 )
@@ -458,7 +461,10 @@ def main():
         mutually_exclusive=mutually_exclusive,
         supports_check_mode=True,
     )
-    run_module(module)
+    try:
+        run_module(module)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_cluster_info.py

@@ -157,6 +157,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule impo
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
     AnsibleK8SModule,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
     AUTH_ARG_SPEC,
 )
@@ -219,7 +222,10 @@ def main():
         get_api_client,
     )
 
-    execute_module(module, client=get_api_client(module=module))
+    try:
+        execute_module(module, client=get_api_client(module=module))
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_cp.py

@@ -148,6 +148,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
     AnsibleK8SModule,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
     K8sService,
 )
@@ -212,7 +215,10 @@ def main():
         supports_check_mode=True,
     )
 
-    execute_module(module)
+    try:
+        execute_module(module)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_drain.py

@@ -142,6 +142,10 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
     AnsibleK8SModule,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
+
 from ansible.module_utils._text import to_native
 
 try:
@@ -497,9 +501,12 @@ def main():
             error=to_native(k8s_import_exception),
         )
 
-    client = get_api_client(module=module)
-    k8s_drain = K8sDrainAnsible(module, client.client)
-    k8s_drain.execute_module()
+    try:
+        client = get_api_client(module=module)
+        k8s_drain = K8sDrainAnsible(module, client.client)
+        k8s_drain.execute_module()
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_exec.py

@@ -144,6 +144,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
     get_api_client,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 
 try:
     from kubernetes.client.apis import core_v1_api
@@ -240,8 +243,11 @@ def main():
         supports_check_mode=True,
     )
 
-    client = get_api_client(module)
-    execute_module(module, client.client)
+    try:
+        client = get_api_client(module)
+        execute_module(module, client.client)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_info.py

@@ -161,6 +161,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
     get_api_client,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
     K8sService,
 )
@@ -202,9 +205,12 @@ def main():
     module = AnsibleK8SModule(
         module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
     )
-    client = get_api_client(module)
-    svc = K8sService(client, module)
-    execute_module(module, svc)
+    try:
+        client = get_api_client(module)
+        svc = K8sService(client, module)
+        execute_module(module, svc)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_json_patch.py

@@ -142,6 +142,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
     AnsibleK8SModule,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
     diff_objects,
 )
@@ -283,8 +286,11 @@ def main():
     module = AnsibleK8SModule(
         module_class=AnsibleModule, argument_spec=args, supports_check_mode=True
     )
-    client = get_api_client(module)
-    execute_module(module, client)
+    try:
+        client = get_api_client(module)
+        execute_module(module, client)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_log.py

@@ -272,7 +272,7 @@ def main():
         result = execute_module(svc, module.params)
         module.exit_json(**result)
     except CoreException as e:
-        module.fail_json(msg=e)
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_rollback.py

@@ -262,9 +262,12 @@ def main():
         module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
     )
 
-    client = get_api_client(module=module)
-    svc = K8sService(client, module)
-    execute_module(svc)
+    try:
+        client = get_api_client(module=module)
+        svc = K8sService(client, module)
+        execute_module(svc)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_scale.py

@@ -411,8 +411,11 @@ def main():
         supports_check_mode=True,
     )
 
-    client = get_api_client(module=module)
-    execute_module(client, module)
+    try:
+        client = get_api_client(module=module)
+        execute_module(client, module)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":

plugins/modules/k8s_service.py

@@ -160,6 +160,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
     get_api_client,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
+    CoreException,
+)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
     K8sService,
 )
@@ -274,9 +277,12 @@ def main():
         supports_check_mode=True,
     )
 
-    client = get_api_client(module=module)
-    svc = K8sService(client, module)
-    execute_module(svc)
+    try:
+        client = get_api_client(module=module)
+        svc = K8sService(client, module)
+        execute_module(svc)
+    except CoreException as e:
+        module.fail_from_exception(e)
 
 
 if __name__ == "__main__":