mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-06 09:00:58 +02:00
71 lines
2.0 KiB
Python
71 lines
2.0 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2012 Dag Wieers <dag@wieers.com>
|
|
# 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
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: assert
|
|
short_description: Asserts given expressions are true
|
|
description:
|
|
- This module asserts that given expressions are true with an optional custom message.
|
|
- This module is also supported for Windows targets.
|
|
version_added: "1.5"
|
|
options:
|
|
that:
|
|
description:
|
|
- "A string expression of the same form that can be passed to the 'when' statement"
|
|
- "Alternatively, a list of string expressions"
|
|
required: true
|
|
fail_msg:
|
|
version_added: "2.7"
|
|
description:
|
|
- "The customized message used for a failing assertion"
|
|
- "This argument was called 'msg' before version 2.7, now it's renamed to 'fail_msg' with alias 'msg'"
|
|
aliases:
|
|
- msg
|
|
success_msg:
|
|
version_added: "2.7"
|
|
description:
|
|
- "The customized message used for a successful assertion"
|
|
notes:
|
|
- This module is also supported for Windows targets.
|
|
author:
|
|
- "Ansible Core Team"
|
|
- "Michael DeHaan"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- assert: { that: "ansible_os_family != 'RedHat'" }
|
|
|
|
- assert:
|
|
that:
|
|
- "'foo' in some_command_result.stdout"
|
|
- "number_of_the_counting == 3"
|
|
|
|
- name: after version 2.7 both 'msg' and 'fail_msg' can customize failing assertion message
|
|
assert:
|
|
that:
|
|
- "my_param <= 100"
|
|
- "my_param >= 0"
|
|
fail_msg: "'my_param' must be between 0 and 100"
|
|
success_msg: "'my_param' is between 0 and 100"
|
|
|
|
- name: please use 'msg' when ansible version is smaller than 2.7
|
|
assert:
|
|
that:
|
|
- "my_param <= 100"
|
|
- "my_param >= 0"
|
|
msg: "'my_param' must be between 0 and 100"
|
|
'''
|