mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
204 lines
5.5 KiB
Python
204 lines
5.5 KiB
Python
|
# Copyright (c) 2024 Vladimir Botka <vbotka@gmail.com>
|
||
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||
|
|
||
|
from __future__ import (absolute_import, division, print_function)
|
||
|
__metaclass__ = type
|
||
|
|
||
|
DOCUMENTATION = '''
|
||
|
name: ansible_type
|
||
|
short_description: Validate input type
|
||
|
version_added: "9.2.0"
|
||
|
author: Vladimir Botka (@vbotka)
|
||
|
description: This test validates input type.
|
||
|
options:
|
||
|
_input:
|
||
|
description: Input data.
|
||
|
type: raw
|
||
|
required: true
|
||
|
dtype:
|
||
|
description: A single data type, or a data types list to be validated.
|
||
|
type: raw
|
||
|
required: true
|
||
|
alias:
|
||
|
description: Data type aliases.
|
||
|
default: {}
|
||
|
type: dictionary
|
||
|
'''
|
||
|
|
||
|
EXAMPLES = '''
|
||
|
|
||
|
# Substitution converts str to AnsibleUnicode
|
||
|
# -------------------------------------------
|
||
|
|
||
|
# String. AnsibleUnicode.
|
||
|
dtype: AnsibleUnicode
|
||
|
data: "abc"
|
||
|
result: '{{ data is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# String. AnsibleUnicode alias str.
|
||
|
alias: {"AnsibleUnicode": "str"}
|
||
|
dtype: str
|
||
|
data: "abc"
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
|
||
|
# List. All items are AnsibleUnicode.
|
||
|
dtype: list[AnsibleUnicode]
|
||
|
data: ["a", "b", "c"]
|
||
|
result: '{{ data is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Dictionary. All keys are AnsibleUnicode. All values are AnsibleUnicode.
|
||
|
dtype: dict[AnsibleUnicode, AnsibleUnicode]
|
||
|
data: {"a": "foo", "b": "bar", "c": "baz"}
|
||
|
result: '{{ data is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# No substitution and no alias. Type of strings is str
|
||
|
# ----------------------------------------------------
|
||
|
|
||
|
# String
|
||
|
dtype: str
|
||
|
result: '{{ "abc" is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Integer
|
||
|
dtype: int
|
||
|
result: '{{ 123 is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Float
|
||
|
dtype: float
|
||
|
result: '{{ 123.45 is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Boolean
|
||
|
dtype: bool
|
||
|
result: '{{ true is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# List. All items are strings.
|
||
|
dtype: list[str]
|
||
|
result: '{{ ["a", "b", "c"] is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# List of dictionaries.
|
||
|
dtype: list[dict]
|
||
|
result: '{{ [{"a": 1}, {"b": 2}] is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Dictionary. All keys are strings. All values are integers.
|
||
|
dtype: dict[str, int]
|
||
|
result: '{{ {"a": 1} is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Dictionary. All keys are strings. All values are integers.
|
||
|
dtype: dict[str, int]
|
||
|
result: '{{ {"a": 1, "b": 2} is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Type of strings is AnsibleUnicode or str
|
||
|
# ----------------------------------------
|
||
|
|
||
|
# Dictionary. The keys are integers or strings. All values are strings.
|
||
|
alias: {"AnsibleUnicode": "str"}
|
||
|
dtype: dict[int|str, str]
|
||
|
data: {1: 'a', 'b': 'b'}
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Dictionary. All keys are integers. All values are keys.
|
||
|
alias: {"AnsibleUnicode": "str"}
|
||
|
dtype: dict[int, str]
|
||
|
data: {1: 'a', 2: 'b'}
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Dictionary. All keys are strings. Multiple types values.
|
||
|
alias: {"AnsibleUnicode": "str"}
|
||
|
dtype: dict[str, bool|dict|float|int|list|str]
|
||
|
data: {'a': 1, 'b': 1.1, 'c': 'abc', 'd': True, 'e': ['x', 'y', 'z'], 'f': {'x': 1, 'y': 2}}
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
|
||
|
# List. Multiple types items.
|
||
|
alias: {"AnsibleUnicode": "str"}
|
||
|
dtype: list[bool|dict|float|int|list|str]
|
||
|
data: [1, 2, 1.1, 'abc', True, ['x', 'y', 'z'], {'x': 1, 'y': 2}]
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Option dtype is list
|
||
|
# --------------------
|
||
|
|
||
|
# AnsibleUnicode or str
|
||
|
dtype: ['AnsibleUnicode', 'str']
|
||
|
data: abc
|
||
|
result: '{{ data is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# float or int
|
||
|
dtype: ['float', 'int']
|
||
|
data: 123
|
||
|
result: '{{ data is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# float or int
|
||
|
dtype: ['float', 'int']
|
||
|
data: 123.45
|
||
|
result: '{{ data is community.general.ansible_type(dtype) }}'
|
||
|
# result => true
|
||
|
|
||
|
# Multiple alias
|
||
|
# --------------
|
||
|
|
||
|
# int alias number
|
||
|
alias: {"int": "number", "float": "number"}
|
||
|
dtype: number
|
||
|
data: 123
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
|
||
|
# float alias number
|
||
|
alias: {"int": "number", "float": "number"}
|
||
|
dtype: number
|
||
|
data: 123.45
|
||
|
result: '{{ data is community.general.ansible_type(dtype, alias) }}'
|
||
|
# result => true
|
||
|
'''
|
||
|
|
||
|
RETURN = '''
|
||
|
_value:
|
||
|
description: Whether the data type is valid.
|
||
|
type: bool
|
||
|
'''
|
||
|
|
||
|
from ansible.errors import AnsibleFilterError
|
||
|
from ansible.module_utils.common._collections_compat import Sequence
|
||
|
from ansible_collections.community.general.plugins.plugin_utils.ansible_type import _ansible_type
|
||
|
|
||
|
|
||
|
def ansible_type(data, dtype, alias=None):
|
||
|
"""Validates data type"""
|
||
|
|
||
|
if not isinstance(dtype, Sequence):
|
||
|
msg = "The argument dtype must be a string or a list. dtype is %s."
|
||
|
raise AnsibleFilterError(msg % (dtype, type(dtype)))
|
||
|
|
||
|
if isinstance(dtype, str):
|
||
|
data_types = [dtype]
|
||
|
else:
|
||
|
data_types = dtype
|
||
|
|
||
|
return _ansible_type(data, alias) in data_types
|
||
|
|
||
|
|
||
|
class TestModule(object):
|
||
|
|
||
|
def tests(self):
|
||
|
return {
|
||
|
'ansible_type': ansible_type
|
||
|
}
|