182 lines
6.5 KiB
Python
182 lines
6.5 KiB
Python
"""Sanity test for proper import exception handling."""
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from .. import types as t
|
|
|
|
from ..sanity import (
|
|
SanityMultipleVersion,
|
|
SanityMessage,
|
|
SanityFailure,
|
|
SanitySuccess,
|
|
SANITY_ROOT,
|
|
)
|
|
|
|
from ..target import (
|
|
TestTarget,
|
|
)
|
|
|
|
from ..util import (
|
|
SubprocessError,
|
|
remove_tree,
|
|
display,
|
|
find_python,
|
|
parse_to_list_of_dict,
|
|
is_subdir,
|
|
ANSIBLE_LIB_ROOT,
|
|
)
|
|
|
|
from ..util_common import (
|
|
intercept_command,
|
|
run_command,
|
|
write_text_file,
|
|
ResultType,
|
|
)
|
|
|
|
from ..ansible_util import (
|
|
ansible_environment,
|
|
)
|
|
|
|
from ..executor import (
|
|
generate_pip_install,
|
|
)
|
|
|
|
from ..config import (
|
|
SanityConfig,
|
|
)
|
|
|
|
from ..coverage_util import (
|
|
coverage_context,
|
|
)
|
|
|
|
from ..data import (
|
|
data_context,
|
|
)
|
|
|
|
|
|
class ImportTest(SanityMultipleVersion):
|
|
"""Sanity test for proper import exception handling."""
|
|
def filter_targets(self, targets): # type: (t.List[TestTarget]) -> t.List[TestTarget]
|
|
"""Return the given list of test targets, filtered to include only those relevant for the test."""
|
|
return [target for target in targets if os.path.splitext(target.path)[1] == '.py' and
|
|
(is_subdir(target.path, data_context().content.module_path) or is_subdir(target.path, data_context().content.module_utils_path))]
|
|
|
|
def test(self, args, targets, python_version):
|
|
"""
|
|
:type args: SanityConfig
|
|
:type targets: SanityTargets
|
|
:type python_version: str
|
|
:rtype: TestResult
|
|
"""
|
|
settings = self.load_processor(args, python_version)
|
|
|
|
paths = [target.path for target in targets.include]
|
|
|
|
env = ansible_environment(args, color=False)
|
|
|
|
temp_root = os.path.join(ResultType.TMP.path, 'sanity', 'import')
|
|
|
|
# create a clean virtual environment to minimize the available imports beyond the python standard library
|
|
virtual_environment_path = os.path.join(temp_root, 'minimal-py%s' % python_version.replace('.', ''))
|
|
virtual_environment_bin = os.path.join(virtual_environment_path, 'bin')
|
|
|
|
remove_tree(virtual_environment_path)
|
|
|
|
python = find_python(python_version)
|
|
|
|
cmd = [python, '-m', 'virtualenv', virtual_environment_path, '--python', python, '--no-setuptools', '--no-wheel']
|
|
|
|
if not args.coverage:
|
|
cmd.append('--no-pip')
|
|
|
|
run_command(args, cmd, capture=True)
|
|
|
|
# add the importer to our virtual environment so it can be accessed through the coverage injector
|
|
importer_path = os.path.join(virtual_environment_bin, 'importer.py')
|
|
if not args.explain:
|
|
os.symlink(os.path.abspath(os.path.join(SANITY_ROOT, 'import', 'importer.py')), importer_path)
|
|
|
|
# create a minimal python library
|
|
python_path = os.path.join(temp_root, 'lib')
|
|
ansible_path = os.path.join(python_path, 'ansible')
|
|
ansible_init = os.path.join(ansible_path, '__init__.py')
|
|
ansible_link = os.path.join(ansible_path, 'module_utils')
|
|
|
|
if not args.explain:
|
|
remove_tree(ansible_path)
|
|
|
|
write_text_file(ansible_init, '', create_directories=True)
|
|
|
|
os.symlink(os.path.join(ANSIBLE_LIB_ROOT, 'module_utils'), ansible_link)
|
|
|
|
if data_context().content.collection:
|
|
# inject just enough Ansible code for the collections loader to work on all supported Python versions
|
|
# the __init__.py files are needed only for Python 2.x
|
|
# the empty modules directory is required for the collection loader to generate the synthetic packages list
|
|
|
|
write_text_file(os.path.join(ansible_path, 'utils/__init__.py'), '', create_directories=True)
|
|
|
|
os.symlink(os.path.join(ANSIBLE_LIB_ROOT, 'utils', 'collection_loader.py'), os.path.join(ansible_path, 'utils', 'collection_loader.py'))
|
|
os.symlink(os.path.join(ANSIBLE_LIB_ROOT, 'utils', 'singleton.py'), os.path.join(ansible_path, 'utils', 'singleton.py'))
|
|
|
|
write_text_file(os.path.join(ansible_path, 'modules/__init__.py'), '', create_directories=True)
|
|
|
|
# activate the virtual environment
|
|
env['PATH'] = '%s:%s' % (virtual_environment_bin, env['PATH'])
|
|
env['PYTHONPATH'] = python_path
|
|
|
|
env.update(
|
|
SANITY_IMPORT_DIR=os.path.relpath(temp_root, data_context().content.root) + os.path.sep,
|
|
SANITY_MINIMAL_DIR=os.path.relpath(virtual_environment_path, data_context().content.root) + os.path.sep,
|
|
)
|
|
|
|
# make sure coverage is available in the virtual environment if needed
|
|
if args.coverage:
|
|
run_command(args, generate_pip_install(['pip'], 'sanity.import', packages=['setuptools']), env=env)
|
|
run_command(args, generate_pip_install(['pip'], 'sanity.import', packages=['coverage']), env=env)
|
|
run_command(args, ['pip', 'uninstall', '--disable-pip-version-check', '-y', 'setuptools'], env=env)
|
|
run_command(args, ['pip', 'uninstall', '--disable-pip-version-check', '-y', 'pip'], env=env)
|
|
|
|
cmd = ['importer.py']
|
|
|
|
data = '\n'.join(paths)
|
|
|
|
display.info(data, verbosity=4)
|
|
|
|
results = []
|
|
|
|
virtualenv_python = os.path.join(virtual_environment_bin, 'python')
|
|
|
|
try:
|
|
with coverage_context(args):
|
|
stdout, stderr = intercept_command(args, cmd, self.name, env, capture=True, data=data, python_version=python_version,
|
|
virtualenv=virtualenv_python)
|
|
|
|
if stdout or stderr:
|
|
raise SubprocessError(cmd, stdout=stdout, stderr=stderr)
|
|
except SubprocessError as ex:
|
|
if ex.status != 10 or ex.stderr or not ex.stdout:
|
|
raise
|
|
|
|
pattern = r'^(?P<path>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+): (?P<message>.*)$'
|
|
|
|
results = parse_to_list_of_dict(pattern, ex.stdout)
|
|
|
|
relative_temp_root = os.path.relpath(temp_root, data_context().content.root) + os.path.sep
|
|
|
|
results = [SanityMessage(
|
|
message=r['message'],
|
|
path=os.path.relpath(r['path'], relative_temp_root) if r['path'].startswith(relative_temp_root) else r['path'],
|
|
line=int(r['line']),
|
|
column=int(r['column']),
|
|
) for r in results]
|
|
|
|
results = settings.process_errors(results, paths)
|
|
|
|
if results:
|
|
return SanityFailure(self.name, messages=results, python_version=python_version)
|
|
|
|
return SanitySuccess(self.name, python_version=python_version)
|