mirror of https://github.com/ansible/ansible.git
Move _handle_aliases() out of basic.py (#48578)
Refinements: - return legal_inputs and update class properties - remove redundant arguments from method and handle in caller - add better exception types to method * Add unit tests for handle_aliasespull/53149/head
Sam Doran
5 years ago
committed by
GitHub
parent
1c87ea6fa6
commit
2a98faee2b
@ -0,0 +1,65 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (c) 2019 Ansible Project
|
||||
# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.common._collections_compat import Mapping
|
||||
from ansible.module_utils.common.collections import is_iterable
|
||||
|
||||
from ansible.module_utils.six import (
|
||||
binary_type,
|
||||
integer_types,
|
||||
text_type,
|
||||
)
|
||||
|
||||
# Python2 & 3 way to get NoneType
|
||||
NoneType = type(None)
|
||||
|
||||
PASS_VARS = {
|
||||
'check_mode': 'check_mode',
|
||||
'debug': '_debug',
|
||||
'diff': '_diff',
|
||||
'keep_remote_files': '_keep_remote_files',
|
||||
'module_name': '_name',
|
||||
'no_log': 'no_log',
|
||||
'remote_tmp': '_remote_tmp',
|
||||
'selinux_special_fs': '_selinux_special_fs',
|
||||
'shell_executable': '_shell',
|
||||
'socket': '_socket_path',
|
||||
'string_conversion_action': '_string_conversion_action',
|
||||
'syslog_facility': '_syslog_facility',
|
||||
'tmpdir': '_tmpdir',
|
||||
'verbosity': '_verbosity',
|
||||
'version': 'ansible_version',
|
||||
}
|
||||
|
||||
|
||||
def handle_aliases(argument_spec, params):
|
||||
"""Return a two item tuple. The first is a dictionary of aliases, the second is
|
||||
a list of legal inputs."""
|
||||
|
||||
legal_inputs = ['_ansible_%s' % k for k in PASS_VARS]
|
||||
aliases_results = {} # alias:canon
|
||||
|
||||
for (k, v) in argument_spec.items():
|
||||
legal_inputs.append(k)
|
||||
aliases = v.get('aliases', None)
|
||||
default = v.get('default', None)
|
||||
required = v.get('required', False)
|
||||
if default is not None and required:
|
||||
# not alias specific but this is a good place to check this
|
||||
raise ValueError("internal error: required and default are mutually exclusive for %s" % k)
|
||||
if aliases is None:
|
||||
continue
|
||||
if not is_iterable(aliases) or isinstance(aliases, (binary_type, text_type)):
|
||||
raise TypeError('internal error: aliases must be a list or tuple')
|
||||
for alias in aliases:
|
||||
legal_inputs.append(alias)
|
||||
aliases_results[alias] = k
|
||||
if alias in params:
|
||||
params[k] = params[alias]
|
||||
|
||||
return aliases_results, legal_inputs
|
||||
@ -0,0 +1,102 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright (c) 2019 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
import pytest
|
||||
|
||||
from ansible.module_utils.common.parameters import handle_aliases
|
||||
from ansible.module_utils._text import to_native
|
||||
|
||||
DEFAULT_LEGAL_INPUTS = [
|
||||
'_ansible_check_mode',
|
||||
'_ansible_debug',
|
||||
'_ansible_diff',
|
||||
'_ansible_keep_remote_files',
|
||||
'_ansible_module_name',
|
||||
'_ansible_no_log',
|
||||
'_ansible_remote_tmp',
|
||||
'_ansible_selinux_special_fs',
|
||||
'_ansible_shell_executable',
|
||||
'_ansible_socket',
|
||||
'_ansible_string_conversion_action',
|
||||
'_ansible_syslog_facility',
|
||||
'_ansible_tmpdir',
|
||||
'_ansible_verbosity',
|
||||
'_ansible_version',
|
||||
]
|
||||
|
||||
|
||||
def test_handle_aliases_no_aliases():
|
||||
argument_spec = {
|
||||
'name': {'type': 'str'},
|
||||
}
|
||||
|
||||
params = {
|
||||
'name': 'foo',
|
||||
'path': 'bar'
|
||||
}
|
||||
|
||||
expected = (
|
||||
{},
|
||||
DEFAULT_LEGAL_INPUTS + ['name'],
|
||||
)
|
||||
expected[1].sort()
|
||||
|
||||
result = handle_aliases(argument_spec, params)
|
||||
result[1].sort()
|
||||
assert expected == result
|
||||
|
||||
|
||||
def test_handle_aliases_basic():
|
||||
argument_spec = {
|
||||
'name': {'type': 'str', 'aliases': ['surname', 'nick']},
|
||||
}
|
||||
|
||||
params = {
|
||||
'name': 'foo',
|
||||
'path': 'bar',
|
||||
'surname': 'foo',
|
||||
'nick': 'foo',
|
||||
}
|
||||
|
||||
expected = (
|
||||
{'surname': 'name', 'nick': 'name'},
|
||||
DEFAULT_LEGAL_INPUTS + ['name', 'surname', 'nick'],
|
||||
)
|
||||
expected[1].sort()
|
||||
|
||||
result = handle_aliases(argument_spec, params)
|
||||
result[1].sort()
|
||||
assert expected == result
|
||||
|
||||
|
||||
def test_handle_aliases_value_error():
|
||||
argument_spec = {
|
||||
'name': {'type': 'str', 'aliases': ['surname', 'nick'], 'default': 'bob', 'required': True},
|
||||
}
|
||||
|
||||
params = {
|
||||
'name': 'foo',
|
||||
}
|
||||
|
||||
with pytest.raises(ValueError) as ve:
|
||||
handle_aliases(argument_spec, params)
|
||||
assert 'internal error: aliases must be a list or tuple' == to_native(ve.error)
|
||||
|
||||
|
||||
def test_handle_aliases_type_error():
|
||||
argument_spec = {
|
||||
'name': {'type': 'str', 'aliases': 'surname'},
|
||||
}
|
||||
|
||||
params = {
|
||||
'name': 'foo',
|
||||
}
|
||||
|
||||
with pytest.raises(TypeError) as te:
|
||||
handle_aliases(argument_spec, params)
|
||||
assert 'internal error: required and default are mutually exclusive' in to_native(te.error)
|
||||
Loading…
Reference in New Issue