internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-06 13:22:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a hack to test whether type=path should be used in a module

Browse Source
This commit is contained in:
Toshio Kuratomi
2017-10-07 15:55:52 -07:00
parent 75eed6a51a
commit c81314dcb9
3 changed files with 53 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst Normal file
View File

@@ -0,0 +1,11 @@
Sanity Tests » use-argspec-type-path
====================================
The AnsibleModule argument_spec knows of several types beyond the standard python types. One of
these is ``path``. When used, type ``path`` ensures that an argument is a string and expands any
shell variables and tilde characters.
This test looks for use of :meth:`os.path.expanduser` in modules. When found, it tells the user to
replace it with ``type='path'`` in the module's argument_spec or list it as a false positive in the
test.