8d93ba9120
* Tag return value docs if they are a dict (and not str/None). * Try to parse return docs as YAML. * Properly dump return values in ansible-doc. * Adjust plugin formatter. * Add changelog fragment. * Don't add 'default' for return values. * Fix plugin_formatter. * Only try to parse return docs if they are still a string. * Add tests. * Warn if RETURN cannot be parsed. * Adjust tests. Also test for warning. * if -> elif (otherwise EXAMPLE will be parsed too). * Always parse return documentation, and fail if it is invalid YAML. * Polishing. * Mostly re-enable ansible-doc tests. Listing from the local collection seems to be somewhat broken. I assume this is why the test was disabled. * Lint and make tests work with Python 2. * Keep FQCNs in plugins (not modules), i.e. restore previous state.
126 lines
3.9 KiB
YAML
126 lines
3.9 KiB
YAML
- hosts: localhost
|
|
gather_facts: no
|
|
environment:
|
|
ANSIBLE_LIBRARY: "{{ playbook_dir }}/library"
|
|
tasks:
|
|
- name: module with suboptions
|
|
command: ansible-doc test_docs_suboptions
|
|
register: result
|
|
ignore_errors: true
|
|
|
|
- set_fact:
|
|
actual_output: >-
|
|
{{ result.stdout | regex_replace('^(> [A-Z_]+ +\().+library/([a-z_]+.py)\)$', '\1library/\2)', multiline=true) }}
|
|
expected_output: "{{ lookup('file', 'test_docs_suboptions.output') }}"
|
|
|
|
- assert:
|
|
that:
|
|
- result is succeeded
|
|
- actual_output == expected_output
|
|
|
|
- name: module with return docs
|
|
command: ansible-doc test_docs_returns
|
|
register: result
|
|
ignore_errors: true
|
|
|
|
- set_fact:
|
|
actual_output: >-
|
|
{{ result.stdout | regex_replace('^(> [A-Z_]+ +\().+library/([a-z_]+.py)\)$', '\1library/\2)', multiline=true) }}
|
|
expected_output: "{{ lookup('file', 'test_docs_returns.output') }}"
|
|
|
|
- assert:
|
|
that:
|
|
- result is succeeded
|
|
- actual_output == expected_output
|
|
|
|
- name: module with broken return docs
|
|
command: ansible-doc test_docs_returns_broken
|
|
register: result
|
|
ignore_errors: true
|
|
|
|
- assert:
|
|
that:
|
|
- result is failed
|
|
- '"ERROR! module test_docs_returns_broken missing documentation (or could not parse documentation)" in result.stderr'
|
|
|
|
- name: non-existent module
|
|
command: ansible-doc test_does_not_exist
|
|
register: result
|
|
- assert:
|
|
that:
|
|
- '"[WARNING]: module test_does_not_exist not found in:" in result.stderr'
|
|
|
|
- name: documented module
|
|
command: ansible-doc test_docs
|
|
register: result
|
|
- assert:
|
|
that:
|
|
- '"WARNING" not in result.stderr'
|
|
- '"TEST_DOCS " in result.stdout'
|
|
- '"AUTHOR: Ansible Core Team" in result.stdout'
|
|
|
|
- name: documented module without metadata
|
|
command: ansible-doc test_docs_no_metadata
|
|
register: result
|
|
- assert:
|
|
that:
|
|
- '"WARNING" not in result.stderr'
|
|
- '"TEST_DOCS_NO_METADATA " in result.stdout'
|
|
- '"AUTHOR: Ansible Core Team" in result.stdout'
|
|
|
|
- name: documented module with no status in metadata
|
|
command: ansible-doc test_docs_no_status
|
|
register: result
|
|
- assert:
|
|
that:
|
|
- '"WARNING" not in result.stderr'
|
|
- '"TEST_DOCS_NO_STATUS " in result.stdout'
|
|
- '"AUTHOR: Ansible Core Team" in result.stdout'
|
|
|
|
- name: documented module with non-iterable status in metadata
|
|
command: ansible-doc test_docs_non_iterable_status
|
|
register: result
|
|
- assert:
|
|
that:
|
|
- '"WARNING" not in result.stderr'
|
|
- '"TEST_DOCS_NON_ITERABLE_STATUS " in result.stdout'
|
|
- '"AUTHOR: Ansible Core Team" in result.stdout'
|
|
|
|
- name: documented module with removed status
|
|
command: ansible-doc test_docs_removed_status
|
|
register: result
|
|
|
|
- assert:
|
|
that:
|
|
- '"WARNING" not in result.stderr'
|
|
- '"TEST_DOCS_REMOVED_STATUS " in result.stdout'
|
|
- '"AUTHOR: Ansible Core Team" in result.stdout'
|
|
|
|
- name: empty module
|
|
command: ansible-doc test_empty
|
|
register: result
|
|
ignore_errors: true
|
|
|
|
- assert:
|
|
that:
|
|
- result is failed
|
|
|
|
- name: module with no documentation
|
|
command: ansible-doc test_no_docs
|
|
register: result
|
|
ignore_errors: true
|
|
|
|
- assert:
|
|
that:
|
|
- result is failed
|
|
|
|
- name: deprecated module with both removed date and version (date should get precedence)
|
|
command: ansible-doc test_docs_removed_precedence
|
|
register: result
|
|
|
|
- assert:
|
|
that:
|
|
- '"DEPRECATED" in result.stdout'
|
|
- '"Reason: Updated module released with more functionality" in result.stdout'
|
|
- '"Will be removed in a release after 2022-06-01" in result.stdout'
|
|
- '"Alternatives: new_module" in result.stdout'
|