mirror of https://github.com/ansible/ansible.git
Handle errors during ansible-doc --metadata-dump more gracefully (#77035)
* Add option --no-fail-on-errors to return errors for ansible-doc --metadata-dump in JSON result instead of failing. * Adjust changelog fragment. * Add basic tests.pull/77362/head
Felix Fontein
2 years ago
committed by
GitHub
parent
55f90ba31f
commit
babc26adc1
@ -0,0 +1,2 @@
|
||||
minor_changes:
|
||||
- "ansible-doc metadata dump - add option ``--no-fail-on-errors`` which allows to not fail the ansible-doc invocation when errors happen during docs parsing or processing. Instead they are reported in the JSON result in an ``error`` key for the affected plugins (https://github.com/ansible/ansible/pull/77035)."
|
||||
@ -0,0 +1,30 @@
|
||||
{
|
||||
"collection_info": {
|
||||
"description": null,
|
||||
"repository": "",
|
||||
"tags": [],
|
||||
"dependencies": {},
|
||||
"authors": [
|
||||
"Ansible (https://ansible.com)"
|
||||
],
|
||||
"issues": "",
|
||||
"name": "testcol",
|
||||
"license": [
|
||||
"GPL-3.0-or-later"
|
||||
],
|
||||
"documentation": "",
|
||||
"namespace": "testns",
|
||||
"version": "0.1.1231",
|
||||
"readme": "README.md",
|
||||
"license_file": "COPYING",
|
||||
"homepage": "",
|
||||
},
|
||||
"file_manifest_file": {
|
||||
"format": 1,
|
||||
"ftype": "file",
|
||||
"chksum_sha256": "4c15a867ceba8ba1eaf2f4a58844bb5dbb82fec00645fc7eb74a3d31964900f6",
|
||||
"name": "FILES.json",
|
||||
"chksum_type": "sha256"
|
||||
},
|
||||
"format": 1
|
||||
}
|
||||
@ -0,0 +1,70 @@
|
||||
# (c) 2020 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
cache: notjsonfile
|
||||
broken:
|
||||
short_description: JSON formatted files.
|
||||
description:
|
||||
- This cache uses JSON formatted, per host, files saved to the filesystem.
|
||||
author: Ansible Core (@ansible-core)
|
||||
version_added: 0.7.0
|
||||
options:
|
||||
_uri:
|
||||
required: True
|
||||
description:
|
||||
- Path in which the cache plugin will save the JSON files
|
||||
env:
|
||||
- name: ANSIBLE_CACHE_PLUGIN_CONNECTION
|
||||
version_added: 1.2.0
|
||||
ini:
|
||||
- key: fact_caching_connection
|
||||
section: defaults
|
||||
deprecated:
|
||||
alternative: none
|
||||
why: Test deprecation
|
||||
version: '2.0.0'
|
||||
_prefix:
|
||||
description: User defined prefix to use when creating the JSON files
|
||||
env:
|
||||
- name: ANSIBLE_CACHE_PLUGIN_PREFIX
|
||||
version_added: 1.1.0
|
||||
ini:
|
||||
- key: fact_caching_prefix
|
||||
section: defaults
|
||||
deprecated:
|
||||
alternative: none
|
||||
why: Another test deprecation
|
||||
removed_at_date: '2050-01-01'
|
||||
_timeout:
|
||||
default: 86400
|
||||
description: Expiration timeout for the cache plugin data
|
||||
env:
|
||||
- name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
|
||||
ini:
|
||||
- key: fact_caching_timeout
|
||||
section: defaults
|
||||
vars:
|
||||
- name: notsjonfile_fact_caching_timeout
|
||||
version_added: 1.5.0
|
||||
deprecated:
|
||||
alternative: do not use a variable
|
||||
why: Test deprecation
|
||||
version: '3.0.0'
|
||||
type: integer
|
||||
extends_documentation_fragment:
|
||||
- testns.testcol2.plugin
|
||||
'''
|
||||
|
||||
from ansible.plugins.cache import BaseFileCacheModule
|
||||
|
||||
|
||||
class CacheModule(BaseFileCacheModule):
|
||||
"""
|
||||
A caching module backed by json files.
|
||||
"""
|
||||
pass
|
||||
@ -0,0 +1,36 @@
|
||||
# Copyright (c) 2018 Ansible Project
|
||||
# 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
|
||||
|
||||
DOCUMENTATION = '''
|
||||
inventory: statichost
|
||||
broken:
|
||||
short_description: Add a single host
|
||||
description: Add a single host
|
||||
extends_documentation_fragment:
|
||||
- inventory_cache
|
||||
options:
|
||||
plugin:
|
||||
description: plugin name (must be statichost)
|
||||
required: true
|
||||
hostname:
|
||||
description: Toggle display of stderr even when script was successful
|
||||
required: True
|
||||
'''
|
||||
|
||||
from ansible.errors import AnsibleParserError
|
||||
from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable
|
||||
|
||||
|
||||
class InventoryModule(BaseInventoryPlugin, Cacheable):
|
||||
|
||||
NAME = 'testns.content_adj.statichost'
|
||||
|
||||
def verify_file(self, path):
|
||||
pass
|
||||
|
||||
def parse(self, inventory, loader, path, cache=None):
|
||||
|
||||
pass
|
||||
@ -0,0 +1,45 @@
|
||||
# (c) 2020 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = """
|
||||
lookup: noop
|
||||
broken:
|
||||
author: Ansible core team
|
||||
short_description: returns input
|
||||
description:
|
||||
- this is a noop
|
||||
deprecated:
|
||||
alternative: Use some other lookup
|
||||
why: Test deprecation
|
||||
removed_in: '3.0.0'
|
||||
extends_documentation_fragment:
|
||||
- testns.testcol2.version_added
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: do nothing
|
||||
debug: msg="{{ lookup('testns.testcol.noop', [1,2,3,4] }}"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
_list:
|
||||
description: input given
|
||||
version_added: 1.0.0
|
||||
"""
|
||||
|
||||
from ansible.module_utils.common._collections_compat import Sequence
|
||||
from ansible.plugins.lookup import LookupBase
|
||||
from ansible.errors import AnsibleError
|
||||
|
||||
|
||||
class LookupModule(LookupBase):
|
||||
|
||||
def run(self, terms, **kwargs):
|
||||
if not isinstance(terms, Sequence):
|
||||
raise AnsibleError("testns.testcol.noop expects a list")
|
||||
return terms
|
||||
@ -0,0 +1,28 @@
|
||||
#!/usr/bin/python
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = """
|
||||
module: fakemodule
|
||||
broken:
|
||||
short_desciption: fake module
|
||||
description:
|
||||
- this is a fake module
|
||||
version_added: 1.0.0
|
||||
options:
|
||||
_notreal:
|
||||
description: really not a real option
|
||||
author:
|
||||
- me
|
||||
"""
|
||||
|
||||
import json
|
||||
|
||||
|
||||
def main():
|
||||
print(json.dumps(dict(changed=False, source='testns.testcol.fakemodule')))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,13 @@
|
||||
#!/usr/bin/python
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import json
|
||||
|
||||
|
||||
def main():
|
||||
print(json.dumps(dict(changed=False, source='testns.testcol.notrealmodule')))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,96 @@
|
||||
#!/usr/bin/python
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: randommodule
|
||||
short_description: A random module
|
||||
description:
|
||||
- A random module.
|
||||
author:
|
||||
- Ansible Core Team
|
||||
version_added: 1.0.0
|
||||
deprecated:
|
||||
alternative: Use some other module
|
||||
why: Test deprecation
|
||||
removed_in: '3.0.0'
|
||||
options:
|
||||
test:
|
||||
description: Some text.
|
||||
type: str
|
||||
version_added: 1.2.0
|
||||
sub:
|
||||
description: Suboptions.
|
||||
type: dict
|
||||
suboptions:
|
||||
subtest:
|
||||
description: A suboption.
|
||||
type: int
|
||||
version_added: 1.1.0
|
||||
# The following is the wrong syntax, and should not get processed
|
||||
# by add_collection_to_versions_and_dates()
|
||||
options:
|
||||
subtest2:
|
||||
description: Another suboption.
|
||||
type: float
|
||||
version_added: 1.1.0
|
||||
# The following is not supported in modules, and should not get processed
|
||||
# by add_collection_to_versions_and_dates()
|
||||
env:
|
||||
- name: TEST_ENV
|
||||
version_added: 1.0.0
|
||||
deprecated:
|
||||
alternative: none
|
||||
why: Test deprecation
|
||||
removed_in: '2.0.0'
|
||||
version: '2.0.0'
|
||||
extends_documentation_fragment:
|
||||
- testns.testcol2.module
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
z_last:
|
||||
description: A last result.
|
||||
broken:
|
||||
type: str
|
||||
returned: success
|
||||
version_added: 1.3.0
|
||||
|
||||
m_middle:
|
||||
description:
|
||||
- This should be in the middle.
|
||||
- Has some more data
|
||||
type: dict
|
||||
returned: success and 1st of month
|
||||
contains:
|
||||
suboption:
|
||||
description: A suboption.
|
||||
type: str
|
||||
choices: [ARF, BARN, c_without_capital_first_letter]
|
||||
version_added: 1.4.0
|
||||
|
||||
a_first:
|
||||
description: A first result.
|
||||
type: str
|
||||
returned: success
|
||||
'''
|
||||
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(),
|
||||
)
|
||||
|
||||
module.exit_json()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,30 @@
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
vars: noop_vars_plugin
|
||||
broken:
|
||||
short_description: Do NOT load host and group vars
|
||||
description: don't test loading host and group vars from a collection
|
||||
options:
|
||||
stage:
|
||||
default: all
|
||||
choices: ['all', 'inventory', 'task']
|
||||
type: str
|
||||
ini:
|
||||
- key: stage
|
||||
section: testns.testcol.noop_vars_plugin
|
||||
env:
|
||||
- name: ANSIBLE_VARS_PLUGIN_STAGE
|
||||
extends_documentation_fragment:
|
||||
- testns.testcol2.deprecation
|
||||
'''
|
||||
|
||||
from ansible.plugins.vars import BaseVarsPlugin
|
||||
|
||||
|
||||
class VarsModule(BaseVarsPlugin):
|
||||
|
||||
def get_vars(self, loader, path, entities, cache=True):
|
||||
super(VarsModule, self).get_vars(loader, path, entities)
|
||||
return {'collection': 'yes', 'notreal': 'value'}
|
||||
Loading…
Reference in New Issue