ansible/test/sanity/validate-modules
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
..
__init__.py
ignore.txt Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
main.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
module_args.py Clean up imports to prevent issues with mutable data being used in modules (#35112) 2018-01-19 16:33:16 -06:00
schema.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
skip.txt Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
test_validate_modules_regex.py Update validate-modules (#20932) 2017-02-02 11:45:22 -08:00
utils.py Fix CaptureStd in validate-modules to work on both py3 and py2 (#35060) 2018-01-18 14:50:31 -06:00
validate-modules Make validate-modules a .py file, and symlink back to validate-modules (#25227) 2017-06-07 14:44:33 -05:00