mirror of https://github.com/ansible/ansible.git
Add ansible-doc tests for documentation containing YAML anchors (#70436)
Co-authored-by: Tadej Borovšak <tadej.borovsak@xlab.si>pull/70503/head
parent
1a542e9824
commit
5b03267a1f
@ -0,0 +1,71 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
from __future__ import absolute_import, division, print_function
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: test_docs_yaml_anchors
|
||||||
|
short_description: Test module with YAML anchors in docs
|
||||||
|
description:
|
||||||
|
- Test module
|
||||||
|
author:
|
||||||
|
- Ansible Core Team
|
||||||
|
options:
|
||||||
|
at_the_top: &toplevel_anchor
|
||||||
|
description:
|
||||||
|
- Short desc
|
||||||
|
default: some string
|
||||||
|
type: str
|
||||||
|
|
||||||
|
last_one: *toplevel_anchor
|
||||||
|
|
||||||
|
egress:
|
||||||
|
description:
|
||||||
|
- Egress firewall rules
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions: &sub_anchor
|
||||||
|
port:
|
||||||
|
description:
|
||||||
|
- Rule port
|
||||||
|
type: int
|
||||||
|
required: true
|
||||||
|
|
||||||
|
ingress:
|
||||||
|
description:
|
||||||
|
- Ingress firewall rules
|
||||||
|
type: list
|
||||||
|
elements: dict
|
||||||
|
suboptions: *sub_anchor
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = '''
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=dict(
|
||||||
|
at_the_top=dict(type='str', default='some string'),
|
||||||
|
last_one=dict(type='str', default='some string'),
|
||||||
|
egress=dict(type='list', elements='dict', options=dict(
|
||||||
|
port=dict(type='int', required=True),
|
||||||
|
)),
|
||||||
|
ingress=dict(type='list', elements='dict', options=dict(
|
||||||
|
port=dict(type='int', required=True),
|
||||||
|
)),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
module.exit_json()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
@ -0,0 +1,49 @@
|
|||||||
|
> TEST_DOCS_YAML_ANCHORS (library/test_docs_yaml_anchors.py)
|
||||||
|
|
||||||
|
Test module
|
||||||
|
|
||||||
|
OPTIONS (= is mandatory):
|
||||||
|
|
||||||
|
- at_the_top
|
||||||
|
Short desc
|
||||||
|
[Default: some string]
|
||||||
|
type: str
|
||||||
|
|
||||||
|
- egress
|
||||||
|
Egress firewall rules
|
||||||
|
[Default: (null)]
|
||||||
|
elements: dict
|
||||||
|
type: list
|
||||||
|
|
||||||
|
SUBOPTIONS:
|
||||||
|
|
||||||
|
= port
|
||||||
|
Rule port
|
||||||
|
|
||||||
|
type: int
|
||||||
|
|
||||||
|
- ingress
|
||||||
|
Ingress firewall rules
|
||||||
|
[Default: (null)]
|
||||||
|
elements: dict
|
||||||
|
type: list
|
||||||
|
|
||||||
|
SUBOPTIONS:
|
||||||
|
|
||||||
|
= port
|
||||||
|
Rule port
|
||||||
|
|
||||||
|
type: int
|
||||||
|
|
||||||
|
- last_one
|
||||||
|
Short desc
|
||||||
|
[Default: some string]
|
||||||
|
type: str
|
||||||
|
|
||||||
|
|
||||||
|
AUTHOR: Ansible Core Team
|
||||||
|
|
||||||
|
EXAMPLES:
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue