start getting modules to use shared import error code (#51787)

lib/ansible/module_utils/basic.py

@@ -727,10 +727,13 @@ def jsonify(data, **kwargs):
     raise UnicodeError('Invalid unicode encoding encountered')
 
 
-def missing_required_lib(library):
+def missing_required_lib(library, reason=None):
     hostname = platform.node()
-    return "Failed to import the required Python library (%s) on %s's Python %s. Please read module documentation " \
-           "and install in the appropriate location." % (library, hostname, sys.executable)
+    msg = "Failed to import the required Python library (%s) on %s's Python %s." % (library, hostname, sys.executable)
+    if reason:
+        msg += " This is required %s." % reason
+
+    return msg + " Please read module documentation and install in the appropriate location"
 
 
 class AnsibleFallbackNotFound(Exception):

lib/ansible/module_utils/influxdb.py

@@ -5,18 +5,26 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+import traceback
+
+from ansible.module_utils.basic import missing_required_lib
+
+REQUESTS_IMP_ERR = None
 try:
     import requests.exceptions
     HAS_REQUESTS = True
 except ImportError:
+    REQUESTS_IMP_ERR = traceback.format_exc()
     HAS_REQUESTS = False
 
+INFLUXDB_IMP_ERR = None
 try:
     from influxdb import InfluxDBClient
     from influxdb import __version__ as influxdb_version
     from influxdb import exceptions
     HAS_INFLUXDB = True
 except ImportError:
+    INFLUXDB_IMP_ERR = traceback.format_exc()
     HAS_INFLUXDB = False
 
 
@@ -33,10 +41,10 @@ class InfluxDb():
 
     def check_lib(self):
         if not HAS_REQUESTS:
-            self.module.fail_json(msg='This module requires "requests" module.')
+            self.module.fail_json(msg=missing_required_lib('requests'), exception=REQUESTS_IMP_ERR)
 
         if not HAS_INFLUXDB:
-            self.module.fail_json(msg='This module requires influxdb python package.')
+            self.module.fail_json(msg=missing_required_lib('influxdb'), exception=INFLUXDB_IMP_ERR)
 
     @staticmethod
     def influxdb_argument_spec():

lib/ansible/module_utils/k8s/common.py

@@ -20,12 +20,15 @@ from __future__ import absolute_import, division, print_function
 import copy
 import json
 import os
+import traceback
 
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 from ansible.module_utils.common.dict_transformations import recursive_diff
 from ansible.module_utils.six import iteritems, string_types
+from ansible.module_utils._text import to_native
 
+K8S_IMP_ERR = None
 try:
     import kubernetes
     import openshift
@@ -36,11 +39,14 @@ try:
 except ImportError as e:
     HAS_K8S_MODULE_HELPER = False
     k8s_import_exception = e
+    K8S_IMP_ERR = traceback.format_exc()
 
+YAML_IMP_ERR = None
 try:
     import yaml
     HAS_YAML = True
 except ImportError:
+    YAML_IMP_ERR = traceback.format_exc()
     HAS_YAML = False
 
 try:
@@ -244,11 +250,12 @@ class KubernetesAnsibleModule(AnsibleModule, K8sAnsibleMixin):
         AnsibleModule.__init__(self, *args, **kwargs)
 
         if not HAS_K8S_MODULE_HELPER:
-            self.fail_json(msg="This module requires the OpenShift Python client. Try `pip install openshift`", error=str(k8s_import_exception))
+            self.fail_json(msg=missing_required_lib('openshift'), exception=K8S_IMP_ERR,
+                           error=to_native(k8s_import_exception))
         self.openshift_version = openshift.__version__
 
         if not HAS_YAML:
-            self.fail_json(msg="This module requires PyYAML. Try `pip install PyYAML`")
+            self.fail_json(msg=missing_required_lib("PyYAML"), exception=YAML_IMP_ERR)
 
     def execute_module(self):
         raise NotImplementedError()

lib/ansible/module_utils/k8s/raw.py

@@ -23,7 +23,9 @@ from datetime import datetime
 from distutils.version import LooseVersion
 import time
 import sys
+import traceback
 
+from ansible.module_utils.basic import missing_required_lib
 from ansible.module_utils.k8s.common import AUTH_ARG_SPEC, COMMON_ARG_SPEC
 from ansible.module_utils.six import string_types
 from ansible.module_utils.k8s.common import KubernetesAnsibleModule
@@ -45,10 +47,12 @@ try:
 except ImportError:
     HAS_KUBERNETES_VALIDATE = False
 
+K8S_CONFIG_HASH_IMP_ERR = None
 try:
     from openshift.helper.hashes import generate_hash
     HAS_K8S_CONFIG_HASH = True
 except ImportError:
+    K8S_CONFIG_HASH_IMP_ERR = traceback.format_exc()
     HAS_K8S_CONFIG_HASH = False
 
 
@@ -97,10 +101,11 @@ class KubernetesRawModule(KubernetesAnsibleModule):
         self.append_hash = self.params.get('append_hash')
         if self.append_hash:
             if not HAS_K8S_CONFIG_HASH:
-                self.fail_json(msg="openshift >= 0.7.2 is required for append_hash")
+                self.fail_json(msg=missing_required_lib("openshift >= 0.7.2", reason="for append_hash"),
+                               exception=K8S_CONFIG_HASH_IMP_ERR)
         if self.params['merge_type']:
             if LooseVersion(self.openshift_version) < LooseVersion("0.6.2"):
-                self.fail_json(msg="openshift >= 0.6.2 is required for merge_type")
+                self.fail_json(msg=missing_required_lib("openshift >= 0.6.2", reason="for merge_type"))
         if resource_definition:
             if isinstance(resource_definition, string_types):
                 try:

lib/ansible/module_utils/rabbitmq.py

@@ -8,18 +8,20 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-from ansible.module_utils._text import to_native, to_text
-from ansible.module_utils.basic import env_fallback
+from ansible.module_utils._text import to_native
+from ansible.module_utils.basic import missing_required_lib
 from mimetypes import MimeTypes
 
-import json
 import os
+import traceback
 
+PIKA_IMP_ERR = None
 try:
     import pika
     from pika import spec
     HAS_PIKA = True
 except ImportError:
+    PIKA_IMP_ERR = traceback.format_exc()
     HAS_PIKA = False
 
 
@@ -61,7 +63,7 @@ class RabbitClient():
 
     def check_required_library(self):
         if not HAS_PIKA:
-            self.module.fail_json(msg="Unable to find 'pika' Python library which is required.")
+            self.module.fail_json(msg=missing_required_lib("pika"), exception=PIKA_IMP_ERR)
 
     def check_host_params(self):
         # Fail if url is specified and other conflicting parameters have been specified