diff options
| author | Mark Chappell <mchappel@redhat.com> | 2020-01-29 21:06:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-29 21:06:36 +0100 |
| commit | 1156962cded3cfed8b40a23b841415811fb24cba (patch) | |
| tree | b2b70061267ddab5ac3fce762d5cfcbf49de91e1 /docs | |
| parent | 6e2fff1accffdf6503b9f585ffb01db03b5b1584 (diff) | |
| download | ansible-1156962cded3cfed8b40a23b841415811fb24cba.tar.gz | |
Forbid `state=(list|info)` in modules via ansible-test sanity check
PR #66898
This change introduces a new sanity check with code
`parameter-state-invalid-choice` in the `ansible-test sanity`
validator. It enforces modules not to support `list` or `info`
as their `state`.
Co-Authored-By: Sviatoslav Sydorenko <webknjaz@redhat.com>
Co-Authored-By: Felix Fontein <felix@fontein.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docsite/rst/dev_guide/testing_validate-modules.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/docsite/rst/dev_guide/testing_validate-modules.rst b/docs/docsite/rst/dev_guide/testing_validate-modules.rst index 4f997d8a7d..fca483a760 100644 --- a/docs/docsite/rst/dev_guide/testing_validate-modules.rst +++ b/docs/docsite/rst/dev_guide/testing_validate-modules.rst @@ -126,6 +126,7 @@ Codes parameter-alias-self Parameters Error argument in argument_spec is specified as its own alias parameter-documented-multiple-times Documentation Error argument in argument_spec with aliases is documented multiple times parameter-list-no-elements Parameters Error argument in argument_spec "type" is specified as ``list`` without defining "elements" + parameter-state-invalid-choice Parameters Error Argument ``state`` includes ``list`` or ``info`` as a choice. Functionality should be in an ``_info`` or (if further conditions apply) ``_facts`` module. python-syntax-error Syntax Error Python ``SyntaxError`` while parsing module return-syntax-error Documentation Error ``RETURN`` is not valid YAML, ``RETURN`` fragments missing or invalid subdirectory-missing-init Naming Error Ansible module subdirectories must contain an ``__init__.py`` |