Import test doesn't recognize relative imports in a module inside collection

[anshulbehl]

SUMMARY

When trying to check support of relative imports in modules inside collections, import sanity test fails giving below error

Running sanity test 'import' with Python 2.7
ERROR: Found 1 import issue(s) on python 2.7 which need to be resolved:
ERROR: plugins/modules/rubrik_managed_volume.py:8:0: ValueError: Attempted relative import in non-package
WARNING: Skipping sanity test 'import' on Python 3.5 due to missing interpreter.
WARNING: Skipping sanity test 'import' on Python 3.6 due to missing interpreter.
Running sanity test 'import' with Python 3.7
ERROR: Found 1 import issue(s) on python 3.7 which need to be resolved:
ERROR: plugins/modules/rubrik_managed_volume.py:8:0: ImportError: attempted relative import with no known parent package

ISSUE TYPE

• Bug Report

COMPONENT NAME

ansible-test sanity import

ANSIBLE VERSION

ansible 2.9.0b1
  config file = /home/abehl/.ansible/collections/ansible_collections/rubrikinc/rubrik/ansible.cfg
  configured module search path = ['/home/abehl/.ansible/collections/ansible_collections/rubrikinc/rubrik/library']
  ansible python module location = /home/abehl/work/src/anshul_ansible/ansible/lib/ansible
  executable location = /home/abehl/work/src/anshul_ansible/ansible/bin/ansible
  python version = 3.7.3 (default, May 11 2019, 00:38:04) [GCC 9.1.1 20190503 (Red Hat 9.1.1-1)]

CONFIGURATION

OS / ENVIRONMENT

STEPS TO REPRODUCE

Create a collection with modules having relative imports
Try running ansible-test sanity on the same module

EXPECTED RESULTS

Relative imports should pass

ACTUAL RESULTS

ansible import tests doesn't recognize relative import

[ansibot]

Files identified in the description:

• test/lib/ansible_test/_data/sanity/import/importer.py
• test/lib/ansible_test/_internal/sanity/import.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @mattclay
click here for bot help

[AlanCoding]

I hit the same thing, output was slightly different

ERROR: plugins/modules/tower_host.py:0:0: missing-module-utils-import: Did not find a module_utils import
ERROR: plugins/modules/tower_inventory.py:0:0: import-error: Exception attempting to import module for argument_spec introspection, 'attempted relative import with no known parent package'
ERROR: plugins/modules/tower_inventory.py:0:0: missing-module-utils-import: Did not find a module_utils import
ERROR: plugins/modules/tower_inventory_source.py:0:0: import-error: Exception attempti

The important thing here is that none of the other errors are reported. So I don't think we can just ignore this particular type of error.

[sivel]

#62496 is also related

[AlanCoding]

I tried to hack around this by substituting the package name where we were using .., but that still leads to problems.

ERROR: plugins/modules/tower_credential.py:0:0: import-error: Exception attempting to import module for argument_spec introspection, 'No module named 'ansible_collections.awx.awx.module_utils''
ERROR: plugins/modules/tower_credential_type.py:0:0: import-error: Exception attempting to import module for argument_spec introspection, 'No module named 'ansible_collections.awx.awx.module_utils''
ERROR: plugins/modules/tower_credential_type.py:0:0: missing-module-utils-import: Did not find a module_utils import
ERROR: plugins/modules/tower_group.py:0:0: import-error: Exception attempting to import module for argument_spec introspection, 'No module named 'ansible_collections.awx.awx.module_utils''
ERROR: plugins/modules/tower_group.py:0:0: missing-module-utils-import: Did not find a module_utils import
ERROR: plugins/modules/tower_host.py:0:0: import-error: Exception attempting to import module for argument_spec introspection, 'No module named 'ansible_collections.awx.awx.module_utils''

Either I'm doing this wrong, or this is a problem general for collections with module_utils.

[AlanCoding]

@nitzmahone some more details in #63084 (comment)

More or less, I don't think this is fixed. In the current devel branch, I get these error types:

ERROR: plugins/modules/tower_workflow_template.py:0:0: import-error: Exception attempting to import module for argument_spec introspection, 'attempted relative import with no known parent package'
ERROR: plugins/modules/tower_workflow_template.py:0:0: missing-module-utils-import: Did not find a module_utils import

I have a script that replaces the relative imports with absolute imports. If I run this, and then run sanity tests, I'm left with:

ERROR: plugins/modules/tower_organization.py:0:0: missing-module-utils-import: Did not find a module_utils import

One of these error describes #62496

However, the error "attempted relative import with no known parent package" with relative imports is this issue, and in current devel it seems to not be fixed.

[mattclay]

@AlanCoding These are two separate issues. This issue was for the import sanity test. The errors you're referring to are for the validate-modules sanity test, which should be fixed by #63932.