ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-05-11 03:31:29 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Add arg and doc validation for PowerShell modules (#53615)

Browse source 
* Add arg and doc validation for PowerShell modules

* Verify if pwsh exists before running it
This commit is contained in:
Jordan Borean 2019-03-12 07:56:51 +10:00 • committed by GitHub
parent da9b19cef7
commit f297229b52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 159 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

13
test/sanity/validate-modules/main.py
View file

@ -230,6 +230,9 @@ class ModuleValidator(Validator):
'slurp.ps1',
'setup.ps1'
))
PS_ARG_VALIDATE_BLACKLIST = frozenset((
'win_dsc.ps1', # win_dsc is a dynamic arg spec, the docs won't ever match
))
WHITELIST_FUTURE_IMPORTS = frozenset(('absolute_import', 'division', 'print_function'))
@ -773,6 +776,7 @@ class ModuleValidator(Validator):
code=503,
msg='Missing python documentation file'
)
return py_path
def _get_docs(self):
docs = {
@ -1531,7 +1535,14 @@ class ModuleValidator(Validator):
if self._powershell_module():
self._validate_ps_replacers()
self._find_ps_docs_py_file()
docs_path = self._find_ps_docs_py_file()
# We can only validate PowerShell arg spec if it is using the new Ansible.Basic.AnsibleModule util
pattern = r'(?im)^#\s*ansiblerequires\s+\-csharputil\s*Ansible\.Basic'
if re.search(pattern, self.text) and self.object_name not in self.PS_ARG_VALIDATE_BLACKLIST:
with ModuleValidator(docs_path, base_branch=self.base_branch, git_cache=self.git_cache) as docs_mv:
docs = docs_mv._validate_docs()[1]
self._validate_ansible_module_call(docs)
self._check_gpl3_header()
if not self._just_docs() and not end_of_deprecation_should_be_removed_only: