ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

fix #Requires to be valid in real Powershell (#31858)

Browse source 
* module_utils #Requires should not have .psm1 extension if "real" Powershell will ever execute them
* updated validate-modules to enforce this
* added check to disallow multi-module syntax on Ansible.ModuleUtils #Requires
This commit is contained in:
Matt Davis 2017-10-23 11:40:54 -07:00 committed by GitHub
parent 11c225e039
commit 0c34cdd0f7
21 changed files with 60 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/modules/windows/win_acl.ps1
View file

@ -4,8 +4,8 @@
# Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de> # Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.SID.psm1 #Requires -Module Ansible.ModuleUtils.SID
# win_acl module (File/Resources Permission Additions/Removal) # win_acl module (File/Resources Permission Additions/Removal)

4
lib/ansible/modules/windows/win_audit_rule.ps1
View file

@ -3,8 +3,8 @@
# Copyright: (c) 2017, Noah Sparks <nsparks@outlook.com> # Copyright: (c) 2017, Noah Sparks <nsparks@outlook.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.SID.psm1 #Requires -Module Ansible.ModuleUtils.SID
$params = Parse-Args -arguments $args -supports_check_mode $true $params = Parse-Args -arguments $args -supports_check_mode $true
$check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false $check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false

4
lib/ansible/modules/windows/win_command.ps1
View file

@ -4,8 +4,8 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.CommandUtil.psm1 #Requires -Module Ansible.ModuleUtils.CommandUtil
# TODO: add check mode support # TODO: add check mode support

2
lib/ansible/modules/windows/win_copy.ps1
View file

@ -5,7 +5,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = 'Stop' $ErrorActionPreference = 'Stop'

4
lib/ansible/modules/windows/win_dotnet_ngen.ps1
View file

@ -5,8 +5,8 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.CommandUtil.psm1 #Requires -Module Ansible.ModuleUtils.CommandUtil
$ErrorActionPreference = 'Stop' $ErrorActionPreference = 'Stop'

2
lib/ansible/modules/windows/win_environment.ps1
View file

@ -3,7 +3,7 @@
# Copyright: (c) 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk> # Copyright: (c) 2015, Jon Hawkesworth (@jhawkesworth) <figs@unity.demon.co.uk>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_eventlog_entry.ps1
View file

@ -3,7 +3,7 @@
# (c) 2017, Andrew Saraceni <andrew.saraceni@gmail.com> # (c) 2017, Andrew Saraceni <andrew.saraceni@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_file.ps1
View file

@ -4,7 +4,7 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_hotfix.ps1
View file

@ -4,7 +4,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_mapped_drive.ps1
View file

@ -4,7 +4,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = 'Stop' $ErrorActionPreference = 'Stop'

4
lib/ansible/modules/windows/win_owner.ps1
View file

@ -2,8 +2,8 @@
# Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de> # Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.SID.psm1 #Requires -Module Ansible.ModuleUtils.SID
$result = @{ $result = @{
changed = $false changed = $false

2
lib/ansible/modules/windows/win_power_plan.ps1
View file

@ -3,7 +3,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$params = Parse-Args -arguments $args -supports_check_mode $true $params = Parse-Args -arguments $args -supports_check_mode $true
$check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false $check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false

2
lib/ansible/modules/windows/win_regedit.ps1
View file

@ -5,7 +5,7 @@
# (c) 2017, Jordan Borean <jborean93@gmail.com> # (c) 2017, Jordan Borean <jborean93@gmail.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

4
lib/ansible/modules/windows/win_share.ps1
View file

@ -2,8 +2,8 @@
# Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de> # Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.SID.psm1 #Requires -Module Ansible.ModuleUtils.SID
#Functions #Functions
Function NormalizeAccounts { Function NormalizeAccounts {

4
lib/ansible/modules/windows/win_shell.ps1
View file

@ -4,8 +4,8 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
#Requires -Module Ansible.ModuleUtils.CommandUtil.psm1 #Requires -Module Ansible.ModuleUtils.CommandUtil
# TODO: add check mode support # TODO: add check mode support

2
lib/ansible/modules/windows/win_shortcut.ps1
View file

@ -5,7 +5,7 @@
# Based on: http://powershellblogger.com/2016/01/create-shortcuts-lnk-or-url-files-with-powershell/ # Based on: http://powershellblogger.com/2016/01/create-shortcuts-lnk-or-url-files-with-powershell/
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_toast.ps1
View file

@ -5,7 +5,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_uri.ps1
View file

@ -4,7 +4,7 @@
# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com> # Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

2
lib/ansible/modules/windows/win_user_right.ps1
View file

@ -4,7 +4,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = 'Stop' $ErrorActionPreference = 'Stop'
$params = Parse-Args $args -supports_check_mode $true $params = Parse-Args $args -supports_check_mode $true

2
lib/ansible/modules/windows/win_wait_for.ps1
View file

@ -4,7 +4,7 @@
# Copyright (c) 2017 Ansible Project # Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy.psm1 #Requires -Module Ansible.ModuleUtils.Legacy
$ErrorActionPreference = "Stop" $ErrorActionPreference = "Stop"

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

@ -635,13 +635,41 @@ class ModuleValidator(Validator):
line=import_line line=import_line
) )
def _find_ps_replacers(self): def _validate_ps_replacers(self):
ps_module_util_template = '#Requires -Module Ansible.ModuleUtils.' # loop all (for/else + error)
if ps_module_util_template not in self.text and REPLACER_WINDOWS not in self.text: # get module list for each
# check "shape" of each module name
module_requires = r'(?im)^#\s*requires\s+\-module(?:s?)\s*(Ansible\.ModuleUtils\..+)'
found_requires = False
for req_stmt in re.finditer(module_requires, self.text):
found_requires = True
# this will bomb on dictionary format - "don't do that"
module_list = [x.strip() for x in req_stmt.group(1).split(',')]
if len(module_list) > 1:
self.reporter.error(
path=self.object_path,
code=210,
msg='Ansible.ModuleUtils requirements do not support multiple modules per statement: "%s"' % req_stmt.group(0)
)
continue
module_name = module_list[0]
if module_name.lower().endswith('.psm1'):
self.reporter.error(
path=self.object_path,
code=211,
msg='Module #Requires should not end in .psm1: "%s"' % module_name
)
# also accept the legacy #POWERSHELL_COMMON replacer signal
if not found_requires and REPLACER_WINDOWS not in self.text:
self.reporter.error( self.reporter.error(
path=self.object_path, path=self.object_path,
code=207, code=207,
msg='"%s" not found in module' % ps_module_util_template msg='No Ansible.ModuleUtils module requirements/imports found'
) )
def _find_ps_docs_py_file(self): def _find_ps_docs_py_file(self):
@ -1087,7 +1115,7 @@ class ModuleValidator(Validator):
self._ensure_imports_below_docs(doc_info, first_callable) self._ensure_imports_below_docs(doc_info, first_callable)
if self._powershell_module(): if self._powershell_module():
self._find_ps_replacers() self._validate_ps_replacers()
self._find_ps_docs_py_file() self._find_ps_docs_py_file()
self._check_for_gpl3_header() self._check_for_gpl3_header()