start getting modules to use shared import error code

[jborean93]

SUMMARY

Start to get modules to use the shared missing_required_lib error message. This error message builds a common error message in the case of an error when importing a required module. It includes information such as;

• The module name
• The host it is required on
• An optional reason if the module wishes to add this
• The Python executable that ran the module

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

lots

[ansibot]

cc @!UNKNOWN @Alb0t @AnderEnder @Andersson007 @Dorn- @Jmainguy @Lujeni @MarkusTeufelberger @NickatEpic @Spredzy @amenonsen @andytom @b6d @bendoh @chouseknecht @chrishoffman @cmprescott @dagwieers @dareko @dschep @elliotttf @erjohnso @evrardjp @fabianvf @felixfontein @flaper87 @gdelpierre @gregswift @hyperized @jarv @jbscalia @jensdepuydt @jhoekx @john-westcott-iv @kenichi-ogawa-1988 @kostiantyn-nemchenko @manuel-sousa @matburt @maxamillion @n0ts @nerzhul @resmo @rhysmeister @sivel @skornehl @slok @sm4rk0 @supertom @tbielawa @thaumos @treyperry @vedit @willthames
click here for bot help

[nitzmahone]

one minor formatting thing, otherwise LGTM

[ansibot]

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/modules/database/mongodb/mongodb_user.py:353:29: undefined-variable Undefined variable 'missing_required_lib'

click here for bot help

[maxamillion]

I'm a big fan of this, I like to see more uniformity in this kind of stuff for UX consistency. 👍

[felixfontein]

I've checked the crypto/acme modules, they look fine.

Requested changes were made.

[drzraf]

Note sure this is related to this specific modification, but starting to use missing_required_lib :
$ python3 test/sanity/validate-modules/validate-modules -w --format json lib/ansible/modules/<foo>
(eg: with lib/ansible/modules/source_control/gitlab_project.py)

Results:
Exception attempting to import module for argument_spec introspection, 'cannot import name 'missing_required_lib''

Traceback (most recent call last):
  File \"/ansible/test/sanity/validate-modules/module_args.py\", line 84, in get_argument_spec
    mod = imp.load_source('module', filename)
  File \"/usr/lib/python3.6/imp.py\", line 172, in load_source
    module = _load(spec)
  File \"<frozen importlib._bootstrap>\", line 684, in _load
  File \"<frozen importlib._bootstrap>\", line 665, in _load_unlocked
  File \"<frozen importlib._bootstrap_external>\", line 678, in exec_module
  File \"<frozen importlib._bootstrap>\", line 219, in _call_with_frames_removed
  File \"lib/ansible/modules/<foo>\", line 172, in <module>
    from ansible.module_utils.basic import missing_required_lib
ImportError: cannot import name 'missing_required_lib'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File \"test/sanity/validate-modules/validate-modules\", line 1125, in _validate_ansible_module_call
    spec, args, kwargs = get_argument_spec(self.path)
  File \"ansible/test/sanity/validate-modules/module_args.py\", line 90, in get_argument_spec
    reraise(AnsibleModuleImportError, AnsibleModuleImportError('%s' % e), sys.exc_info()[2])
  File \".local/lib/python3.6/site-packages/ansible/module_utils/six/__init__.py\", line 699, in reraise
    raise value.with_traceback(tb)
  File \"ansible/test/sanity/validate-modules/module_args.py\", line 84, in get_argument_spec
    mod = imp.load_source('module', filename)
  File \"/usr/lib/python3.6/imp.py\", line 172, in load_source
    module = _load(spec)
  File \"<frozen importlib._bootstrap>\", line 684, in _load
  File \"<frozen importlib._bootstrap>\", line 665, in _load_unlocked
  File \"<frozen importlib._bootstrap_external>\", line 678, in exec_module
  File \"<frozen importlib._bootstrap>\", line 219, in _call_with_frames_removed
  File \"lib/ansible/modules/<foo>\", line 172, in <module>
    from ansible.module_utils.basic import missing_required_lib
module_args.AnsibleModuleImportError: cannot import name 'missing_required_lib

[jborean93]

@drzraf missing_required_lib was only added in the devel branch and has not been included in a stable release just yet. Going by your traceback it seems like it's looking up an Ansible install in a Python's site-packages so not sure if this is based on devel or an older release.