104 lines
3.9 KiB
Python
104 lines
3.9 KiB
Python
# Copyright 2012, Dag Wieers <dag@wieers.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
from __future__ import annotations
|
|
|
|
import typing as t
|
|
|
|
from ansible._internal._templating import _jinja_bits
|
|
from ansible.errors import AnsibleTemplateError
|
|
from ansible.module_utils.common.validation import _check_type_list_strict
|
|
from ansible.plugins.action import ActionBase
|
|
from ansible._internal._templating._engine import TemplateEngine
|
|
|
|
|
|
class ActionModule(ActionBase):
|
|
"""Assert that one or more conditional expressions evaluate to true."""
|
|
|
|
_requires_connection = False
|
|
|
|
@classmethod
|
|
def finalize_task_arg(cls, name: str, value: t.Any, templar: TemplateEngine, context: t.Any) -> t.Any:
|
|
if name != 'that':
|
|
# `that` is the only key requiring special handling; delegate to base handling otherwise
|
|
return super().finalize_task_arg(name, value, templar, context)
|
|
|
|
if not isinstance(value, str):
|
|
# if `that` is not a string, we don't need to attempt to resolve it as a template before validation (which will also listify it)
|
|
return value
|
|
|
|
# if `that` is entirely a string template, we only want to resolve to the container and avoid templating the container contents
|
|
if _jinja_bits.is_possibly_all_template(value):
|
|
try:
|
|
templated_that = templar.resolve_to_container(value)
|
|
except AnsibleTemplateError:
|
|
pass
|
|
else:
|
|
if isinstance(templated_that, list): # only use `templated_that` if it is a list
|
|
return templated_that
|
|
|
|
return value
|
|
|
|
def run(self, tmp=None, task_vars=None):
|
|
if task_vars is None:
|
|
task_vars = dict()
|
|
|
|
result = super(ActionModule, self).run(tmp, task_vars)
|
|
del tmp # tmp no longer has any effect
|
|
|
|
validation_result, new_module_args = self.validate_argument_spec(
|
|
argument_spec=dict(
|
|
fail_msg=dict(type=str_or_list_of_str, aliases=['msg'], default='Assertion failed'),
|
|
success_msg=dict(type=str_or_list_of_str, default='All assertions passed'),
|
|
quiet=dict(type='bool', default=False),
|
|
# explicitly not validating types `elements` here to let type rules for conditionals apply
|
|
that=dict(type=_check_type_list_strict, required=True),
|
|
),
|
|
)
|
|
|
|
fail_msg = new_module_args['fail_msg']
|
|
success_msg = new_module_args['success_msg']
|
|
quiet = new_module_args['quiet']
|
|
that_list = new_module_args['that']
|
|
|
|
if not quiet:
|
|
result['_ansible_verbose_always'] = True
|
|
|
|
for that in that_list:
|
|
test_result = self._templar.evaluate_conditional(conditional=that)
|
|
if not test_result:
|
|
result['failed'] = True
|
|
result['evaluated_to'] = test_result
|
|
result['assertion'] = that
|
|
|
|
result['msg'] = fail_msg
|
|
|
|
return result
|
|
|
|
result['changed'] = False
|
|
result['msg'] = success_msg
|
|
return result
|
|
|
|
|
|
def str_or_list_of_str(value: t.Any) -> str | list[str]:
|
|
if isinstance(value, str):
|
|
return value
|
|
|
|
if not isinstance(value, list) or any(not isinstance(item, str) for item in value):
|
|
raise TypeError("a string or list of strings is required")
|
|
|
|
return value
|