ansible/test/integration/targets/argspec/library/argspec.py

#!/usr/bin/python
# Copyright: (c) 2020, Matt Martz <matt@sivel.net>
# 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

from ansible.module_utils.basic import AnsibleModule


def main():
    module = AnsibleModule(
        {
            'required': {
                'required': True,
            },
            'required_one_of_one': {},
            'required_one_of_two': {},
            'required_by_one': {},
            'required_by_two': {},
            'required_by_three': {},
            'state': {
                'type': 'str',
                'choices': ['absent', 'present'],
            },
            'default_value': {
                'type': 'bool',
                'default': True,
            },
            'path': {},
            'content': {},
            'mapping': {
                'type': 'dict',
            },
            'required_one_of': {
                'required_one_of': [['thing', 'other']],
                'type': 'list',
                'elements': 'dict',
                'options': {
                    'thing': {},
                    'other': {'aliases': ['other_alias']},
                },
            },
            'required_by': {
                'required_by': {'thing': 'other'},
                'type': 'list',
                'elements': 'dict',
                'options': {
                    'thing': {},
                    'other': {},
                },
            },
            'required_together': {
                'required_together': [['thing', 'other']],
                'type': 'list',
                'elements': 'dict',
                'options': {
                    'thing': {},
                    'other': {},
                    'another': {},
                },
            },
            'required_if': {
                'required_if': (
                    ('thing', 'foo', ('other',), True),
                ),
                'type': 'list',
                'elements': 'dict',
                'options': {
                    'thing': {},
                    'other': {},
                    'another': {},
                },
            },
            'json': {
                'type': 'json',
            },
            'fail_on_missing_params': {
                'type': 'list',
                'default': [],
            },
            'needed_param': {},
            'required_together_one': {},
            'required_together_two': {},
            'suboptions_list_no_elements': {
                'type': 'list',
                'options': {
                    'thing': {},
                },
            },
            'choices_with_strings_like_bools': {
                'type': 'str',
                'choices': [
                    'on',
                    'off',
                ],
            },
            'choices': {
                'type': 'str',
                'choices': [
                    'foo',
                    'bar',
                ],
            },
            'list_choices': {
                'type': 'list',
                'choices': [
                    'foo',
                    'bar',
                    'baz',
                ],
            },
            'primary': {
                'type': 'str',
                'aliases': [
                    'alias',
                ],
            },
            'password': {
                'type': 'str',
                'no_log': True,
            },
            'not_a_password': {
                'type': 'str',
                'no_log': False,
            },
            'maybe_password': {
                'type': 'str',
            },
            'int': {
                'type': 'int',
            },
            'apply_defaults': {
                'type': 'dict',
                'apply_defaults': True,
                'options': {
                    'foo': {
                        'type': 'str',
                    },
                    'bar': {
                        'type': 'str',
                        'default': 'baz',
                        'aliases': ['bar_alias1', 'bar_alias2'],
                    },
                },
            },
            'deprecation_aliases': {
                'type': 'str',
                'aliases': [
                    'deprecation_aliases_version',
                    'deprecation_aliases_date',
                ],
                'deprecated_aliases': [
                    {
                        'name': 'deprecation_aliases_version',
                        'version': '2.0.0',
                        'collection_name': 'foo.bar',
                    },
                    {
                        'name': 'deprecation_aliases_date',
                        'date': '2023-01-01',
                        'collection_name': 'foo.bar',
                    },
                ],
            },
            'deprecation_param_version': {
                'type': 'str',
                'removed_in_version': '2.0.0',
                'removed_from_collection': 'foo.bar',
            },
            'deprecation_param_date': {
                'type': 'str',
                'removed_at_date': '2023-01-01',
                'removed_from_collection': 'foo.bar',
            },
            'subdeprecation': {
                'aliases': [
                    'subdeprecation_alias',
                ],
                'type': 'dict',
                'options': {
                    'deprecation_aliases': {
                        'type': 'str',
                        'aliases': [
                            'deprecation_aliases_version',
                            'deprecation_aliases_date',
                        ],
                        'deprecated_aliases': [
                            {
                                'name': 'deprecation_aliases_version',
                                'version': '2.0.0',
                                'collection_name': 'foo.bar',
                            },
                            {
                                'name': 'deprecation_aliases_date',
                                'date': '2023-01-01',
                                'collection_name': 'foo.bar',
                            },
                        ],
                    },
                    'deprecation_param_version': {
                        'type': 'str',
                        'removed_in_version': '2.0.0',
                        'removed_from_collection': 'foo.bar',
                    },
                    'deprecation_param_date': {
                        'type': 'str',
                        'removed_at_date': '2023-01-01',
                        'removed_from_collection': 'foo.bar',
                    },
                },
            },
            'subdeprecation_list': {
                'type': 'list',
                'elements': 'dict',
                'options': {
                    'deprecation_aliases': {
                        'type': 'str',
                        'aliases': [
                            'deprecation_aliases_version',
                            'deprecation_aliases_date',
                        ],
                        'deprecated_aliases': [
                            {
                                'name': 'deprecation_aliases_version',
                                'version': '2.0.0',
                                'collection_name': 'foo.bar',
                            },
                            {
                                'name': 'deprecation_aliases_date',
                                'date': '2023-01-01',
                                'collection_name': 'foo.bar',
                            },
                        ],
                    },
                    'deprecation_param_version': {
                        'type': 'str',
                        'removed_in_version': '2.0.0',
                        'removed_from_collection': 'foo.bar',
                    },
                    'deprecation_param_date': {
                        'type': 'str',
                        'removed_at_date': '2023-01-01',
                        'removed_from_collection': 'foo.bar',
                    },
                },
            }
        },
        required_if=(
            ('state', 'present', ('path', 'content'), True),
        ),
        mutually_exclusive=(
            ('path', 'content', 'default_value',),
        ),
        required_one_of=(
            ('required_one_of_one', 'required_one_of_two'),
        ),
        required_by={
            'required_by_one': ('required_by_two', 'required_by_three'),
        },
        required_together=(
            ('required_together_one', 'required_together_two'),
        ),
    )

    module.fail_on_missing_params(module.params['fail_on_missing_params'])

    module.exit_json(**module.params)


if __name__ == '__main__':
    main()