ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 12:50:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Extend win_psmodule - the second attempt, the previous was #46516 (#50621)

Browse source 
* Extend win_psmodule - rebased at 2019-01-07

* Change a way how defined parameters are added to the list

* Correct registering a repository

* Change way how tests for the check_mode: true are run

* Post-review updates

* Post-review updates -2

* Post-review updates -3

* Switch to PowerShell loop

* Minor updates

* Remove variants of an exception handling

* Change error handling
This commit is contained in:
Wojciech Sciesinski 2019-03-05 21:56:55 +01:00 • committed by Jordan Borean
commit 8136e2e4fe
9 changed files with 1442 additions and 187 deletions
Download patch file Download diff file Expand all files Collapse all files

506
lib/ansible/modules/windows/win_psmodule.ps1
View file

@ -1,65 +1,312 @@
#!powershell
# Copyright: (c) 2018, Wojciech Sciesinski <wojciech[at]sciesinski[dot]net>
# Copyright: (c) 2017, Daniele Lazzari <lazzari@mailup.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#Requires -Module Ansible.ModuleUtils.Legacy
# win_psmodule (Powershell modules Additions/Removal)
# win_psmodule (Windows PowerShell modules Additions/Removals/Updates)
$params = Parse-Args $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
$name = Get-AnsibleParam -obj $params -name "name" -type "str" -failifempty $true
$required_version = Get-AnsibleParam -obj $params -name "required_version" -type "str"
$minimum_version = Get-AnsibleParam -obj $params -name "minimum_version" -type "str"
$maximum_version = Get-AnsibleParam -obj $params -name "maximum_version" -type "str"
$repo = Get-AnsibleParam -obj $params -name "repository" -type "str"
$url = Get-AnsibleParam -obj $params -name "url" -type "str"
$state = Get-AnsibleParam -obj $params -name "state" -type "str" -default "present" -validateset "present", "absent"
$url = Get-AnsibleParam -obj $params -name "url" -type str
$state = Get-AnsibleParam -obj $params -name "state" -type "str" -default "present" -validateset "present", "absent", "latest"
$allow_clobber = Get-AnsibleParam -obj $params -name "allow_clobber" -type "bool" -default $false
$check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -default $false
$skip_publisher_check = Get-AnsibleParam -obj $params -name "skip_publisher_check" -type "bool" -default $false
$allow_prerelease = Get-AnsibleParam -obj $params -name "allow_prerelease" -type "bool" -default $false
$result = @{"changed" = $false
"output" = ""
"nuget_changed" = $false
"repository_changed" = $false}
$result = @{changed = $false
output = ""
nuget_changed = $false
repository_changed = $false}
Function Install-NugetProvider {
param(
[bool]$CheckMode
Param(
[Bool]$CheckMode
)
$PackageProvider = Get-PackageProvider -ListAvailable|?{($_.name -eq 'Nuget') -and ($_.version -ge "2.8.5.201")}
if (!($PackageProvider)){
try{
Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force -ErrorAction Stop -WhatIf:$CheckMode | out-null
$result.changed = $true
$result.nuget_changed = $true
}
catch{
$ErrorMessage = "Problems adding package provider: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
$PackageProvider = Get-PackageProvider -ListAvailable | Where-Object { ($_.name -eq 'Nuget') -and ($_.version -ge "2.8.5.201") }
if (-not($PackageProvider)){
try {
Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force -WhatIf:$CheckMode | out-null
$result.changed = $true
$result.nuget_changed = $true
}
catch [ System.Exception ] {
$ErrorMessage = "Problems adding package provider: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
}
Function Install-PrereqModule {
Param(
[Switch]$TestInstallationOnly,
[Bool]$CheckMode
)
# Those are minimum required versions of modules.
$PrereqModules = @{
PackageManagement = '1.1.7'
PowerShellGet = '1.6.0'
}
[Bool]$PrereqModulesInstalled = $true
ForEach ( $Name in $PrereqModules.Keys ) {
$ExistingPrereqModule = Get-Module -ListAvailable | Where-Object { ($_.name -eq $Name) -and ($_.version -ge $PrereqModules[$Name]) }
if ( -not $ExistingPrereqModule ) {
if ( $TestInstallationOnly ) {
$PrereqModulesInstalled = $false
}
else {
try {
Install-Module -Name $Name -MinimumVersion $PrereqModules[$Name] -Force -WhatIf:$CheckMode | Out-Null
if ( $Name -eq 'PowerShellGet' ) {
# An order has to be reverted due to dependency
Remove-Module -Name PowerShellGet, PackageManagement -Force
Import-Module -Name PowerShellGet, PackageManagement -Force
}
$result.changed = $true
}
catch [ System.Exception ] {
$ErrorMessage = "Problems adding a prerequisite module $Name $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
}
}
if ( $TestInstallationOnly ) {
$PrereqModulesInstalled
}
}
Function Get-PsModule {
Param(
[Parameter(Mandatory=$true)]
[String]$Name,
[String]$RequiredVersion,
[String]$MinimumVersion,
[String]$MaximumVersion
)
$ExistingModule = @{
Exists = $false
Version = ""
}
$ExistingModules = Get-Module -Listavailable | Where-Object {($_.name -eq $Name)}
$ExistingModulesCount = $($ExistingModules | Measure-Object).Count
if ( $ExistingModulesCount -gt 0 ) {
$ExistingModules | Add-Member -MemberType ScriptProperty -Name FullVersion -Value { if ( $null -ne ( $this.PrivateData ) ) { [String]"$($this.Version)-$(($this | Select-Object -ExpandProperty PrivateData).PSData.Prerelease)".TrimEnd('-') } else { [String]"$($this.Version)" } }
if ( -not ($RequiredVersion -or
$MinimumVersion -or
$MaximumVersion) ) {
$ReturnedModule = $ExistingModules | Select-Object -First 1
}
elseif ( $RequiredVersion ) {
$ReturnedModule = $ExistingModules | Where-Object -FilterScript { $_.FullVersion -eq $RequiredVersion }
}
elseif ( $MinimumVersion -and $MaximumVersion ) {
$ReturnedModule = $ExistingModules | Where-Object -FilterScript { $MinimumVersion -le $_.Version -and $MaximumVersion -ge $_.Version } | Select-Object -First 1
}
elseif ( $MinimumVersion ) {
$ReturnedModule = $ExistingModules | Where-Object -FilterScript { $MinimumVersion -le $_.Version } | Select-Object -First 1
}
elseif ( $MaximumVersion ) {
$ReturnedModule = $ExistingModules | Where-Object -FilterScript { $MaximumVersion -ge $_.Version } | Select-Object -First 1
}
}
$ReturnedModuleCount = ($ReturnedModule | Measure-Object).Count
if ( $ReturnedModuleCount -eq 1 ) {
$ExistingModule.Exists = $true
$ExistingModule.Version = $ReturnedModule.FullVersion
}
$ExistingModule
}
Function Add-DefinedParameter {
Param (
[Parameter(Mandatory=$true)]
[Hashtable]$Hashtable,
[Parameter(Mandatory=$true)]
[String[]]$ParametersNames
)
ForEach ($ParameterName in $ParametersNames) {
$ParameterVariable = Get-Variable -Name $ParameterName -ErrorAction Ignore
if ( $ParameterVariable.Value -and $Hashtable.Keys -notcontains $ParameterName ){
$Hashtable.Add($ParameterName,$ParameterVariable.Value)
}
}
$Hashtable
}
Function Install-PsModule {
Param(
[Parameter(Mandatory=$true)]
[String]$Name,
[String]$RequiredVersion,
[String]$MinimumVersion,
[String]$MaximumVersion,
[String]$Repository,
[Bool]$AllowClobber,
[Bool]$SkipPublisherCheck,
[Bool]$AllowPrerelease,
[Bool]$CheckMode
)
$ExistingModuleBefore = Get-PsModule -Name $Name -RequiredVersion $RequiredVersion -MinimumVersion $MinimumVersion -MaximumVersion $MaximumVersion
if ( -not $ExistingModuleBefore.Exists ) {
try {
# Install NuGet provider if needed.
Install-NugetProvider -CheckMode $CheckMode
$ht = @{
Name = $Name
WhatIf = $CheckMode
Force = $true
}
[String[]]$ParametersNames = @("RequiredVersion","MinimumVersion","MaximumVersion","AllowPrerelease","AllowClobber","SkipPublisherCheck","Repository")
$ht = Add-DefinedParameter -Hashtable $ht -ParametersNames $ParametersNames
Install-Module @ht -ErrorVariable ErrorDetails | out-null
$result.changed = $true
$result.output = "Module $($Name) installed"
}
catch [ System.Exception ] {
$ErrorMessage = "Problems installing $($Name) module: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
else {
$result.output = "Module $($Name) already present"
}
}
Function Remove-PsModule {
Param(
[Parameter(Mandatory=$true)]
[String]$Name,
[String]$RequiredVersion,
[String]$MinimumVersion,
[String]$MaximumVersion,
[Bool]$CheckMode
)
# If module is present, uninstalls it.
if (Get-Module -Listavailable | Where-Object {$_.name -eq $Name}) {
try {
$ht = @{
Name = $Name
Confirm = $false
Force = $true
}
$ExistingModuleBefore = Get-PsModule -Name $Name -RequiredVersion $RequiredVersion -MinimumVersion $MinimumVersion -MaximumVersion $MaximumVersion
[String[]]$ParametersNames = @("RequiredVersion","MinimumVersion","MaximumVersion")
$ht = Add-DefinedParameter -Hashtable $ht -ParametersNames $ParametersNames
if ( -not ( $RequiredVersion -or $MinimumVersion -or $MaximumVersion ) ) {
$ht.Add("AllVersions", $true)
}
if ( $ExistingModuleBefore.Exists) {
# The Force parameter overwrite the WhatIf parameter
if ( -not $CheckMode ) {
Uninstall-Module @ht -ErrorVariable ErrorDetails | out-null
}
$result.changed = $true
$result.output = "Module $($Name) removed"
}
}
catch [ System.Exception ] {
$ErrorMessage = "Problems uninstalling $($Name) module: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
else {
$result.output = "Module $($Name) removed"
}
}
Function Find-LatestPsModule {
Param(
[Parameter(Mandatory=$true)]
[String]$Name,
[String]$Repository,
[Bool]$AllowPrerelease,
[Bool]$CheckMode
)
try {
$ht = @{
Name = $Name
}
[String[]]$ParametersNames = @("AllowPrerelease","Repository")
$ht = Add-DefinedParameter -Hashtable $ht -ParametersNames $ParametersNames
$LatestModule = Find-Module @ht
$LatestModuleVersion = $LatestModule.Version
}
catch [ System.Exception ] {
$ErrorMessage = "Cant find the module $($Name): $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
$LatestModuleVersion
}
Function Install-Repository {
Param(
[Parameter(Mandatory=$true)]
[string]$Name,
[Parameter(Mandatory=$true)]
[string]$Url,
[bool]$CheckMode
[Parameter(Mandatory=$true)]
[string]$Name,
[Parameter(Mandatory=$true)]
[string]$Url,
[bool]$CheckMode
)
$Repo = (Get-PSRepository).SourceLocation
# Install NuGet provider if needed.
Install-NugetProvider -CheckMode $CheckMode
$Repos = (Get-PSRepository).SourceLocation
# If repository isn't already present, try to register it as trusted.
if ($Repo -notcontains $Url){
if ($Repos -notcontains $Url){
try {
if (!($CheckMode)) {
Register-PSRepository -Name $Name -SourceLocation $Url -InstallationPolicy Trusted -ErrorAction Stop
if ( -not ($CheckMode) ) {
Register-PSRepository -Name $Name -SourceLocation $Url -InstallationPolicy Trusted -ErrorAction Stop
}
$result.changed = $true
$result.repository_changed = $true
}
catch {
$ErrorMessage = "Problems adding $($Name) repository: $($_.Exception.Message)"
$ErrorMessage = "Problems registering $($Name) repository: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
@ -67,120 +314,143 @@ Function Install-Repository {
Function Remove-Repository{
Param(
[Parameter(Mandatory=$true)]
[string]$Name,
[bool]$CheckMode
[Parameter(Mandatory=$true)]
[string]$Name,
[bool]$CheckMode
)
$Repo = (Get-PSRepository).SourceLocation
$Repo = (Get-PSRepository).Name
# Try to remove the repository
if ($Repo -contains $Name){
try {
if (!($CheckMode)) {
try {
if ( -not ($CheckMode) ) {
Unregister-PSRepository -Name $Name -ErrorAction Stop
}
$result.changed = $true
$result.repository_changed = $true
}
catch {
$ErrorMessage = "Problems removing $($Name)repository: $($_.Exception.Message)"
catch [ System.Exception ] {
$ErrorMessage = "Problems unregistering $($Name)repository: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
}
Function Install-PsModule {
param(
[Parameter(Mandatory=$true)]
[string]$Name,
[string]$Repository,
[bool]$AllowClobber,
[bool]$CheckMode
)
if (Get-Module -Listavailable|?{$_.name -eq $Name}){
$result.output = "Module $($Name) already present"
}
else {
try{
# Install NuGet Provider if needed
Install-NugetProvider -CheckMode $CheckMode;
$ht = @{
Name = $Name;
WhatIf = $CheckMode;
ErrorAction = "Stop";
Force = $true;
};
# If specified, use repository name to select module source
if ($Repository) {
$ht["Repository"] = "$Repository";
}
# Check Powershell Version (-AllowClobber was introduced in PowerShellGet 1.6.0)
if ("AllowClobber" -in ((Get-Command PowerShellGet\Install-Module | Select -ExpandProperty Parameters).Keys)) {
$ht['AllowClobber'] = $AllowClobber;
}
Install-Module @ht | out-null;
$result.output = "Module $($Name) installed"
$result.changed = $true
}
catch{
$ErrorMessage = "Problems installing $($Name) module: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
}
Function Remove-PsModule {
param(
[Parameter(Mandatory=$true)]
[string]$Name,
[bool]$CheckMode
)
# If module is present, unistalls it.
if (Get-Module -Listavailable|?{$_.name -eq $Name}){
try{
Uninstall-Module -Name $Name -Confirm:$false -Force -ErrorAction Stop -WhatIf:$CheckMode | out-null
$result.output = "Module $($Name) removed"
$result.changed = $true
}
catch{
$ErrorMessage = "Problems removing $($Name) module: $($_.Exception.Message)"
Fail-Json $result $ErrorMessage
}
}
else{
$result.output = "Module $($Name) not present"
}
}
# Check powershell version, fail if < 5.0
# Check PowerShell version, fail if < 5.0 and required modules are not installed
$PsVersion = $PSVersionTable.PSVersion
if ($PsVersion.Major -lt 5){
$ErrorMessage = "Powershell 5.0 or higher is needed"
Fail-Json $result $ErrorMessage
if ($PsVersion.Major -lt 5 ) {
$PrereqModulesInstalled = Install-PrereqModule -TestInstallationOnly
if ( -not $PrereqModulesInstalled ) {
$ErrorMessage = "Modules PowerShellGet and PackageManagement in versions 1.6.0 and 1.1.7 respectively have to be installed before using the win_psmodule."
Fail-Json $result $ErrorMessage
}
}
if ( $required_version -and ( $minimum_version -or $maximum_version ) ) {
$ErrorMessage = "Parameters required_version and minimum/maximum_version are mutually exclusive."
Fail-Json $result $ErrorMessage
}
if ( $allow_prerelease -and ( $minimum_version -or $maximum_version ) ) {
$ErrorMessage = "Parameters minimum_version, maximum_version can't be used with the parameter allow_prerelease."
Fail-Json $result $ErrorMessage
}
if ( $allow_prerelease -and $state -eq "absent" ) {
$ErrorMessage = "The parameter allow_prerelease can't be used with state set to 'absent'."
Fail-Json $result $ErrorMessage
}
if ( ($state -eq "latest") -and
( $required_version -or $minimum_version -or $maximum_version ) ) {
$ErrorMessage = "When the parameter state is equal 'latest' you can use any of required_version, minimum_version, maximum_version."
Fail-Json $result $ErrorMessage
}
if ( $repo -and (-not $url) ) {
$RepositoryExists = Get-PSRepository -Name $repo -ErrorAction Ignore
if ( $null -eq $RepositoryExists) {
$ErrorMessage = "The repository $repo doesn't exist."
Fail-Json $result $ErrorMessage
}
}
if ( ($allow_clobber -or $allow_prerelease -or $skip_publisher_check -or
$required_version -or $minimum_version -or $maximum_version) ) {
# Update the PowerShellGet and PackageManagement modules.
# It's required to support AllowClobber, AllowPrerelease parameters.
Install-PrereqModule -CheckMode $check_mode
}
Import-Module -Name PackageManagement, PowerShellGet
if ($state -eq "present") {
if (($repo) -and ($url)) {
Install-Repository -Name $repo -Url $url -CheckMode $check_mode
Install-Repository -Name $repo -Url $url -CheckMode $check_mode
}
else {
$ErrorMessage = "Repository Name and Url are mandatory if you want to add a new repository"
}
Install-PsModule -Name $Name -Repository $repo -CheckMode $check_mode -AllowClobber $allow_clobber;
if ($name) {
$ht = @{
Name = $name
RequiredVersion = $required_version
MinimumVersion = $minimum_version
MaximumVersion = $maximum_version
Repository = $repo
AllowClobber = $allow_clobber
SkipPublisherCheck = $skip_publisher_check
AllowPrerelease = $allow_prerelease
CheckMode = $check_mode
}
Install-PsModule @ht
}
}
else {
if ($repo) {
elseif ($state -eq "absent") {
if ($repo) {
Remove-Repository -Name $repo -CheckMode $check_mode
}
Remove-PsModule -Name $Name -CheckMode $check_mode
if ($name) {
$ht = @{
Name = $Name
CheckMode = $check_mode
RequiredVersion = $required_version
MinimumVersion = $minimum_version
MaximumVersion = $maximum_version
}
Remove-PsModule @ht
}
}
elseif ( $state -eq "latest") {
$ht = @{
Name = $Name
AllowPrerelease = $allow_prerelease
Repository = $repo
CheckMode = $check_mode
}
$LatestVersion = Find-LatestPsModule @ht
$ExistingModule = Get-PsModule $Name
if ( $LatestVersion.Version -ne $ExistingModule.Version ) {
$ht = @{
Name = $Name
RequiredVersion = $LatestVersion
Repository = $repo
AllowClobber = $allow_clobber
SkipPublisherCheck = $skip_publisher_check
AllowPrerelease = $allow_prerelease
CheckMode = $check_mode
}
Install-PsModule @ht
}
}
Exit-Json $result

101
lib/ansible/modules/windows/win_psmodule.py
View file

@ -1,6 +1,7 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Wojciech Sciesinski <wojciech[at]sciesinski[dot]net>
# Copyright: (c) 2017, Daniele Lazzari <lazzari@mailup.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
@ -15,20 +16,58 @@ DOCUMENTATION = r'''
---
module: win_psmodule
version_added: "2.4"
short_description: Adds or removes a Powershell Module
short_description: Adds or removes a Windows PowerShell module
description:
- This module helps to install Powershell modules and register custom modules repository on Windows Server.
- This module helps to install Windows PowerShell modules and register custom modules repository on Windows-based systems.
options:
name:
description:
- Name of the powershell module that has to be installed.
- Name of the Windows PowerShell module that has to be installed.
type: str
required: yes
state:
description:
- If C(present) a new module is installed.
- If C(absent) a module is removed.
- If C(latest) a module is updated to the newest version. This option was added in version 2.8.
type: str
choices: [ absent, latest, present ]
default: present
required_version:
description:
- The exact version of the PowerShell module that has to be installed.
type: str
version_added: "2.8"
minimum_version:
description:
- The minimum version of the PowerShell module that has to be installed.
type: str
version_added: "2.8"
maximum_version:
description:
- The maximum version of the PowerShell module that has to be installed.
type: str
version_added: "2.8"
allow_clobber:
description:
- If C(yes) imports all commands, even if they have the same names as commands that already exists. Available only in Powershell 5.1 or higher.
- If C(yes) allows install modules that contains commands those have the same names as commands that already exists.
type: bool
default: no
skip_publisher_check:
description:
- If C(yes), allows you to install a different version of a module that already exists on your computer in the case when a different one
is not digitally signed by a trusted publisher and the newest existing module is digitally signed by a trusted publisher.
type: bool
default: no
version_added: "2.8"
allow_prerelease:
description:
- If C(yes) installs modules marked as prereleases.
- It doesn't work with the parameters C(minimum_version) and/or C(maximum_version).
- It doesn't work with the C(state) set to absent.
type: bool
default: no
version_added: "2.8"
repository:
description:
- Name of the custom repository to register or use.
@ -37,50 +76,60 @@ options:
description:
- URL of the custom repository to register.
type: str
state:
description:
- If C(present) a new module is installed.
- If C(absent) a module is removed.
type: str
choices: [ absent, present ]
default: present
notes:
- Powershell 5.0 or higher is needed.
- PowerShell modules needed
- PowerShellGet >= 1.6.0
- PackageManagement >= 1.1.7
- PowerShell package provider needed
- NuGet >= 2.8.5.201
- On PowerShell 5.x required modules and a package provider will be updated under the first run of the win_psmodule module.
- On PowerShell 3.x and 4.x you have to install them before using the win_psmodule.
seealso:
- module: win_psrepository
author:
- Wojciech Sciesinski (@it-praktyk)
- Daniele Lazzari (@dlazz)
'''
EXAMPLES = r'''
---
- name: Add a powershell module
- name: Add a PowerShell module
win_psmodule:
name: PowershellModule
name: PowerShellModule
state: present
- name: Add a powershell module and register a repository
- name: Add an exact version of PowerShell module
win_psmodule:
name: PowerShellModule
required_version: "4.0.2"
state: present
- name: Install or update an existing PowerShell module to the newest version
win_psmodule:
name: PowerShellModule
state: latest
- name: Install newer version of built-in Windows module
win_psmodule:
name: Pester
skip_publisher_check: yes
state: present
- name: Add a PowerShell module and register a repository
win_psmodule:
name: MyCustomModule
repository: MyRepository
url: https://myrepo.com
state: present
- name: Add a powershell module from a specific repository
- name: Add a PowerShell module from a specific repository
win_psmodule:
name: PowershellModule
name: PowerShellModule
repository: MyRepository
state: present
- name: Remove a powershell module
- name: Remove a PowerShell module
win_psmodule:
name: PowershellModule
state: absent
- name: Remove a powershell module and a repository
win_psmodule:
name: MyCustomModule
repository: MyRepository
name: PowerShellModule
state: absent
'''