mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Restore README.rst, update and fix formatting. (#18012)
* Revert "Update validate-modules README and convert to MD. (#18008)"
* This reverts commit 4916fe9962
.
* Fix formatting of README.rst.
This commit is contained in:
parent
936bca9fc6
commit
05531b99d0
2 changed files with 70 additions and 62 deletions
|
@ -1,62 +0,0 @@
|
|||
# validate-modules
|
||||
|
||||
Python program to help test or validate Ansible modules.
|
||||
|
||||
Originally developed by Matt Martz (@sivel)
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
cd /path/to/ansible/source
|
||||
source hacking/env-setup
|
||||
test/sanity/validate-modules/validate-modules /path/to/modules
|
||||
```
|
||||
|
||||
## Help
|
||||
|
||||
```shell
|
||||
usage: validate-modules [-h] [-w] [--exclude EXCLUDE] modules
|
||||
|
||||
positional arguments:
|
||||
modules Path to module or module directory
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-w, --warnings Show warnings
|
||||
--exclude EXCLUDE RegEx exclusion pattern
|
||||
```
|
||||
|
||||
# Current Validations
|
||||
|
||||
## Modules
|
||||
|
||||
### Errors
|
||||
|
||||
- Interpreter line is not `#!/usr/bin/python`
|
||||
- `main()` not at the bottom of the file
|
||||
- Module does not import `ansible.module_utils.basic`
|
||||
- Missing `DOCUMENTATION`
|
||||
- Documentation is invalid YAML
|
||||
- Invalid schema for `DOCUMENTATION`
|
||||
- Missing `EXAMPLES`
|
||||
- Invalid Python Syntax
|
||||
- Tabbed indentation
|
||||
- Use of `sys.exit()` instead of `exit_json` or `fail_json`
|
||||
- Missing GPLv3 license header in module
|
||||
- PowerShell module missing `WANT_JSON`
|
||||
- PowerShell module missing `POWERSHELL_COMMON`
|
||||
- New modules have the correct `version_added`
|
||||
- New arguments have the correct `version_added`
|
||||
- Modules should not import requests, instead use `ansible.module_utils.urls`
|
||||
- Missing `RETURN` for new modules
|
||||
|
||||
### Warnings
|
||||
|
||||
- Try/Except `HAS_` expression missing
|
||||
- Missing `RETURN` for existing modules
|
||||
- `import json` found
|
||||
- Module contains duplicate globals from basic.py
|
||||
|
||||
## Module Directories (Python Packages)
|
||||
|
||||
- Missing `__init__.py`
|
70
test/sanity/validate-modules/README.rst
Normal file
70
test/sanity/validate-modules/README.rst
Normal file
|
@ -0,0 +1,70 @@
|
|||
validate-modules
|
||||
================
|
||||
|
||||
Python program to help test or validate Ansible modules.
|
||||
|
||||
Originally developed by Matt Martz (@sivel)
|
||||
|
||||
Usage
|
||||
~~~~~
|
||||
|
||||
.. code:: shell
|
||||
|
||||
cd /path/to/ansible/source
|
||||
source hacking/env-setup
|
||||
test/sanity/validate-modules/validate-modules /path/to/modules
|
||||
|
||||
Help
|
||||
~~~~
|
||||
|
||||
.. code:: shell
|
||||
|
||||
usage: validate-modules [-h] [-w] [--exclude EXCLUDE] modules
|
||||
|
||||
positional arguments:
|
||||
modules Path to module or module directory
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-w, --warnings Show warnings
|
||||
--exclude EXCLUDE RegEx exclusion pattern
|
||||
|
||||
Current Validations
|
||||
===================
|
||||
|
||||
Modules
|
||||
~~~~~~~
|
||||
|
||||
Errors
|
||||
^^^^^^
|
||||
|
||||
#. Interpreter line is not ``#!/usr/bin/python``
|
||||
#. ``main()`` not at the bottom of the file
|
||||
#. Module does not import ``ansible.module_utils.basic``
|
||||
#. Missing ``DOCUMENTATION``
|
||||
#. Documentation is invalid YAML
|
||||
#. Invalid schema for ``DOCUMENTATION``
|
||||
#. Missing ``EXAMPLES``
|
||||
#. Invalid Python Syntax
|
||||
#. Tabbed indentation
|
||||
#. Use of ``sys.exit()`` instead of ``exit_json`` or ``fail_json``
|
||||
#. Missing GPLv3 license header in module
|
||||
#. PowerShell module missing ``WANT_JSON``
|
||||
#. PowerShell module missing ``POWERSHELL_COMMON``
|
||||
#. New modules have the correct ``version_added``
|
||||
#. New arguments have the correct ``version_added``
|
||||
#. Modules should not import requests, instead use ``ansible.module_utils.urls``
|
||||
#. Missing ``RETURN`` for new modules
|
||||
|
||||
Warnings
|
||||
^^^^^^^^
|
||||
|
||||
#. Try/Except ``HAS_`` expression missing
|
||||
#. Missing ``RETURN`` for existing modules
|
||||
#. ``import json`` found
|
||||
#. Module contains duplicate globals from basic.py
|
||||
|
||||
Module Directories (Python Packages)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Missing ``__init__.py``
|
Loading…
Reference in a new issue