Windows package management with Chocolatey
This commit is contained in:
Peter Mounce
Matt Clay
parent
f408ac2d82
commit
71d2faab18
2 changed files with 366 additions and 0 deletions
248
lib/ansible/modules/extras/windows/win_chocolatey.ps1
Normal file
248
lib/ansible/modules/extras/windows/win_chocolatey.ps1
Normal file
|
|
@ -0,0 +1,248 @@
|
|||
#!powershell
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Copyright 2014, Trond Hindenes <trond@hindenes.com>
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
function Write-Log
|
||||
{
|
||||
param
|
||||
(
|
||||
[parameter(mandatory=$false)]
|
||||
[System.String]
|
||||
$message
|
||||
)
|
||||
|
||||
$date = get-date -format 'yyyy-MM-dd hh:mm:ss.zz'
|
||||
|
||||
Write-Host "$date | $message"
|
||||
|
||||
Out-File -InputObject "$date $message" -FilePath $global:LoggingFile -Append
|
||||
}
|
||||
|
||||
$params = Parse-Args $args;
|
||||
$result = New-Object PSObject;
|
||||
Set-Attr $result "changed" $false;
|
||||
|
||||
If ($params.package)
|
||||
{
|
||||
$package = $params.package
|
||||
}
|
||||
Else
|
||||
{
|
||||
Fail-Json $result "missing required argument: package"
|
||||
}
|
||||
|
||||
if(($params.logPath).length -gt 0)
|
||||
{
|
||||
$global:LoggingFile = $params.logPath
|
||||
}
|
||||
else
|
||||
{
|
||||
$global:LoggingFile = "c:\ansible-playbook.log"
|
||||
}
|
||||
If ($params.force)
|
||||
{
|
||||
$force = $params.force | ConvertTo-Bool
|
||||
}
|
||||
Else
|
||||
{
|
||||
$force = $false
|
||||
}
|
||||
|
||||
If ($params.version)
|
||||
{
|
||||
$version = $params.version
|
||||
}
|
||||
Else
|
||||
{
|
||||
$version = $null
|
||||
}
|
||||
|
||||
If ($params.showlog)
|
||||
{
|
||||
$showlog = $params.showlog | ConvertTo-Bool
|
||||
}
|
||||
Else
|
||||
{
|
||||
$showlog = $null
|
||||
}
|
||||
|
||||
If ($params.state)
|
||||
{
|
||||
$state = $params.state.ToString().ToLower()
|
||||
If (($state -ne "present") -and ($state -ne "absent"))
|
||||
{
|
||||
Fail-Json $result "state is $state; must be present or absent"
|
||||
}
|
||||
}
|
||||
Else
|
||||
{
|
||||
$state = "present"
|
||||
}
|
||||
|
||||
$ChocoAlreadyInstalled = get-command choco -ErrorAction 0
|
||||
if ($ChocoAlreadyInstalled -eq $null)
|
||||
{
|
||||
#We need to install chocolatey
|
||||
$install_choco_result = iex ((new-object net.webclient).DownloadString("https://chocolatey.org/install.ps1"))
|
||||
$result.changed = $true
|
||||
$executable = "C:\ProgramData\chocolatey\bin\choco.exe"
|
||||
}
|
||||
Else
|
||||
{
|
||||
$executable = "choco.exe"
|
||||
}
|
||||
|
||||
If ($params.source)
|
||||
{
|
||||
$source = $params.source.ToString().ToLower()
|
||||
If (($source -ne "chocolatey") -and ($source -ne "webpi") -and ($source -ne "windowsfeatures") -and ($source -ne "ruby"))
|
||||
{
|
||||
Fail-Json $result "source is $source - must be one of chocolatey, ruby, webpi or windowsfeatures."
|
||||
}
|
||||
}
|
||||
Elseif (!$params.source)
|
||||
{
|
||||
$source = "chocolatey"
|
||||
}
|
||||
|
||||
if ($source -eq "webpi")
|
||||
{
|
||||
# check whether 'webpi' installation source is available; if it isn't, install it
|
||||
$webpi_check_cmd = "$executable list webpicmd -localonly"
|
||||
$webpi_check_result = invoke-expression $webpi_check_cmd
|
||||
Set-Attr $result "chocolatey_bootstrap_webpi_check_cmd" $webpi_check_cmd
|
||||
Set-Attr $result "chocolatey_bootstrap_webpi_check_log" $webpi_check_result
|
||||
if (
|
||||
(
|
||||
($webpi_check_result.GetType().Name -eq "String") -and
|
||||
($webpi_check_result -match "No packages found")
|
||||
) -or
|
||||
($webpi_check_result -contains "No packages found.")
|
||||
)
|
||||
{
|
||||
#lessmsi is a webpicmd dependency, but dependency resolution fails unless it's installed separately
|
||||
$lessmsi_install_cmd = "$executable install lessmsi"
|
||||
$lessmsi_install_result = invoke-expression $lessmsi_install_cmd
|
||||
Set-Attr $result "chocolatey_bootstrap_lessmsi_install_cmd" $lessmsi_install_cmd
|
||||
Set-Attr $result "chocolatey_bootstrap_lessmsi_install_log" $lessmsi_install_result
|
||||
|
||||
$webpi_install_cmd = "$executable install webpicmd"
|
||||
$webpi_install_result = invoke-expression $webpi_install_cmd
|
||||
Set-Attr $result "chocolatey_bootstrap_webpi_install_cmd" $webpi_install_cmd
|
||||
Set-Attr $result "chocolatey_bootstrap_webpi_install_log" $webpi_install_result
|
||||
|
||||
if (($webpi_install_result | select-string "already installed").length -gt 0)
|
||||
{
|
||||
#no change
|
||||
}
|
||||
elseif (($webpi_install_result | select-string "webpicmd has finished successfully").length -gt 0)
|
||||
{
|
||||
$result.changed = $true
|
||||
}
|
||||
Else
|
||||
{
|
||||
Fail-Json $result "WebPI install error: $webpi_install_result"
|
||||
}
|
||||
}
|
||||
}
|
||||
$expression = $executable
|
||||
if ($state -eq "present")
|
||||
{
|
||||
$expression += " install $package"
|
||||
}
|
||||
Elseif ($state -eq "absent")
|
||||
{
|
||||
$expression += " uninstall $package"
|
||||
}
|
||||
if ($force)
|
||||
{
|
||||
if ($state -eq "present")
|
||||
{
|
||||
$expression += " -force"
|
||||
}
|
||||
}
|
||||
if ($version)
|
||||
{
|
||||
$expression += " -version $version"
|
||||
}
|
||||
if ($source -eq "chocolatey")
|
||||
{
|
||||
$expression += " -source https://chocolatey.org/api/v2/"
|
||||
}
|
||||
elseif (($source -eq "windowsfeatures") -or ($source -eq "webpi") -or ($source -eq "ruby"))
|
||||
{
|
||||
$expression += " -source $source"
|
||||
}
|
||||
|
||||
Set-Attr $result "chocolatey command" $expression
|
||||
$op_result = invoke-expression $expression
|
||||
if ($state -eq "present")
|
||||
{
|
||||
if (
|
||||
(($op_result | select-string "already installed").length -gt 0) -or
|
||||
# webpi has different text output, and that doesn't include the package name but instead the human-friendly name
|
||||
(($op_result | select-string "No products to be installed").length -gt 0)
|
||||
)
|
||||
{
|
||||
#no change
|
||||
}
|
||||
elseif (
|
||||
(($op_result | select-string "has finished successfully").length -gt 0) -or
|
||||
# webpi has different text output, and that doesn't include the package name but instead the human-friendly name
|
||||
(($op_result | select-string "Install of Products: SUCCESS").length -gt 0) -or
|
||||
(($op_result | select-string "gem installed").length -gt 0) -or
|
||||
(($op_result | select-string "gems installed").length -gt 0)
|
||||
)
|
||||
{
|
||||
$result.changed = $true
|
||||
}
|
||||
Else
|
||||
{
|
||||
Fail-Json $result "Install error: $op_result"
|
||||
}
|
||||
}
|
||||
Elseif ($state -eq "absent")
|
||||
{
|
||||
$op_result = invoke-expression "$executable uninstall $package"
|
||||
# HACK: Misleading - 'Uninstalling from folder' appears in output even when package is not installed, hence order of checks this way
|
||||
if (
|
||||
(($op_result | select-string "not installed").length -gt 0) -or
|
||||
(($op_result | select-string "Cannot find path").length -gt 0)
|
||||
)
|
||||
{
|
||||
#no change
|
||||
}
|
||||
elseif (($op_result | select-string "Uninstalling from folder").length -gt 0)
|
||||
{
|
||||
$result.changed = $true
|
||||
}
|
||||
else
|
||||
{
|
||||
Fail-Json $result "Uninstall error: $op_result"
|
||||
}
|
||||
}
|
||||
|
||||
if ($showlog)
|
||||
{
|
||||
Set-Attr $result "chocolatey_log" $op_result
|
||||
}
|
||||
Set-Attr $result "chocolatey_success" "true"
|
||||
|
||||
Exit-Json $result;
|
||||
118
lib/ansible/modules/extras/windows/win_chocolatey.py
Normal file
118
lib/ansible/modules/extras/windows/win_chocolatey.py
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2014, Trond Hindenes <trond@hindenes.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# this is a windows documentation stub. actual code lives in the .ps1
|
||||
# file of the same name
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: win_chocolatey
|
||||
version_added: "1.8"
|
||||
short_description: Installs packages using chocolatey
|
||||
description:
|
||||
- Installs packages using Chocolatey (http://chocolatey.org/). If Chocolatey is missing from the system, the module will install it. List of packages: http://chocolatey.org/packages.
|
||||
options:
|
||||
package:
|
||||
description:
|
||||
- Name of the package to be installed
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
state:
|
||||
description:
|
||||
- State of the package on the system
|
||||
required: false
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
aliases: []
|
||||
force:
|
||||
description:
|
||||
- Forces install of the package (even if it already exists). Using Force will cause ansible to always report "changed: true" on its run
|
||||
required: false
|
||||
choices:
|
||||
- yes
|
||||
- no
|
||||
default: no
|
||||
aliases: []
|
||||
version:
|
||||
description:
|
||||
- Specific version of the package to be installed
|
||||
- Ignored when state == 'absent'
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
showlog:
|
||||
description:
|
||||
- Outputs the chocolatey log inside a chocolatey_log property.
|
||||
required: false
|
||||
choices:
|
||||
- yes
|
||||
- no
|
||||
default: no
|
||||
aliases: []
|
||||
source:
|
||||
description:
|
||||
- Which source to install from
|
||||
require: false
|
||||
choices:
|
||||
- chocolatey
|
||||
- ruby
|
||||
- webpi
|
||||
- windowsfeatures
|
||||
default: chocolatey
|
||||
aliases: []
|
||||
logPath:
|
||||
description:
|
||||
- Where to log command output to
|
||||
require: false
|
||||
default: c:\\ansible-playbook.log
|
||||
aliases: []
|
||||
author: Trond Hindenes, Peter Mounce
|
||||
'''
|
||||
|
||||
# TODO:
|
||||
# * Better parsing when a package has dependencies - currently fails
|
||||
# * Time each item that is run
|
||||
# * Support 'changed' with gems - would require shelling out to `gem list` first and parsing, kinda defeating the point of using chocolatey.
|
||||
|
||||
EXAMPLES = '''
|
||||
# Install git
|
||||
win_chocolatey:
|
||||
package: git
|
||||
|
||||
# Install notepadplusplus version 6.6
|
||||
win_chocolatey:
|
||||
package: notepadplusplus.install
|
||||
version: 6.6
|
||||
|
||||
# Uninstall git
|
||||
win_chocolatey:
|
||||
package: git
|
||||
state: absent
|
||||
|
||||
# Install Application Request Routing v3 from webpi
|
||||
# Logically, this requires that you install IIS first (see win_feature)
|
||||
# To find a list of packages available via webpi source, `choco list -source webpi`
|
||||
win_chocolatey:
|
||||
package: ARRv3
|
||||
source: webpi
|
||||
'''
|
||||
Loading…
Reference in a new issue