mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
354 lines
12 KiB
Python
354 lines
12 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2013, bleader
|
|
# Written by bleader <bleader@ratonland.org>
|
|
# Based on pkgin module written by Shaun Zinck <shaun.zinck at gmail.com>
|
|
# that was based on pacman module written by Afterburn <http://github.com/afterburn>
|
|
# that was based on apt module written by Matthew Williams <matthew@flowroute.com>
|
|
#
|
|
# This module 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.
|
|
#
|
|
# This software 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 this software. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: pkgng
|
|
short_description: Package manager for FreeBSD >= 9.0
|
|
description:
|
|
- Manage binary packages for FreeBSD using 'pkgng' which
|
|
is available in versions after 9.0.
|
|
version_added: "1.2"
|
|
options:
|
|
name:
|
|
description:
|
|
- Name of package to install/remove.
|
|
required: true
|
|
state:
|
|
description:
|
|
- State of the package.
|
|
choices: [ 'present', 'absent' ]
|
|
required: false
|
|
default: present
|
|
cached:
|
|
description:
|
|
- Use local package base instead of fetching an updated one.
|
|
choices: [ 'yes', 'no' ]
|
|
required: false
|
|
default: no
|
|
annotation:
|
|
description:
|
|
- A comma-separated list of keyvalue-pairs of the form
|
|
C(<+/-/:><key>[=<value>]). A C(+) denotes adding an annotation, a
|
|
C(-) denotes removing an annotation, and C(:) denotes modifying an
|
|
annotation.
|
|
If setting or modifying annotations, a value must be provided.
|
|
required: false
|
|
version_added: "1.6"
|
|
pkgsite:
|
|
description:
|
|
- For pkgng versions before 1.1.4, specify packagesite to use
|
|
for downloading packages. If not specified, use settings from
|
|
C(/usr/local/etc/pkg.conf).
|
|
- For newer pkgng versions, specify a the name of a repository
|
|
configured in C(/usr/local/etc/pkg/repos).
|
|
required: false
|
|
rootdir:
|
|
description:
|
|
- For pkgng versions 1.5 and later, pkg will install all packages
|
|
within the specified root directory.
|
|
- Can not be used together with I(chroot) option.
|
|
required: false
|
|
chroot:
|
|
version_added: "2.1"
|
|
description:
|
|
- Pkg will chroot in the specified environment.
|
|
- Can not be used together with I(rootdir) option.
|
|
required: false
|
|
autoremove:
|
|
version_added: "2.2"
|
|
description:
|
|
- Remove automatically installed packages which are no longer needed.
|
|
required: false
|
|
choices: [ "yes", "no" ]
|
|
default: no
|
|
author: "bleader (@bleader)"
|
|
notes:
|
|
- When using pkgsite, be careful that already in cache packages won't be downloaded again.
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Install package foo
|
|
- pkgng: name=foo state=present
|
|
|
|
# Annotate package foo and bar
|
|
- pkgng: name=foo,bar annotation=+test1=baz,-test2,:test3=foobar
|
|
|
|
# Remove packages foo and bar
|
|
- pkgng: name=foo,bar state=absent
|
|
'''
|
|
|
|
|
|
import re
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
def query_package(module, pkgng_path, name, dir_arg):
|
|
|
|
rc, out, err = module.run_command("%s %s info -g -e %s" % (pkgng_path, dir_arg, name))
|
|
|
|
if rc == 0:
|
|
return True
|
|
|
|
return False
|
|
|
|
def pkgng_older_than(module, pkgng_path, compare_version):
|
|
|
|
rc, out, err = module.run_command("%s -v" % pkgng_path)
|
|
version = map(lambda x: int(x), re.split(r'[\._]', out))
|
|
|
|
i = 0
|
|
new_pkgng = True
|
|
while compare_version[i] == version[i]:
|
|
i += 1
|
|
if i == min(len(compare_version), len(version)):
|
|
break
|
|
else:
|
|
if compare_version[i] > version[i]:
|
|
new_pkgng = False
|
|
return not new_pkgng
|
|
|
|
|
|
def remove_packages(module, pkgng_path, packages, dir_arg):
|
|
|
|
remove_c = 0
|
|
# Using a for loop incase of error, we can report the package that failed
|
|
for package in packages:
|
|
# Query the package first, to see if we even need to remove
|
|
if not query_package(module, pkgng_path, package, dir_arg):
|
|
continue
|
|
|
|
if not module.check_mode:
|
|
rc, out, err = module.run_command("%s %s delete -y %s" % (pkgng_path, dir_arg, package))
|
|
|
|
if not module.check_mode and query_package(module, pkgng_path, package, dir_arg):
|
|
module.fail_json(msg="failed to remove %s: %s" % (package, out))
|
|
|
|
remove_c += 1
|
|
|
|
if remove_c > 0:
|
|
|
|
return (True, "removed %s package(s)" % remove_c)
|
|
|
|
return (False, "package(s) already absent")
|
|
|
|
|
|
def install_packages(module, pkgng_path, packages, cached, pkgsite, dir_arg):
|
|
|
|
install_c = 0
|
|
|
|
# as of pkg-1.1.4, PACKAGESITE is deprecated in favor of repository definitions
|
|
# in /usr/local/etc/pkg/repos
|
|
old_pkgng = pkgng_older_than(module, pkgng_path, [1, 1, 4])
|
|
if pkgsite != "":
|
|
if old_pkgng:
|
|
pkgsite = "PACKAGESITE=%s" % (pkgsite)
|
|
else:
|
|
pkgsite = "-r %s" % (pkgsite)
|
|
|
|
batch_var = 'env BATCH=yes' # This environment variable skips mid-install prompts,
|
|
# setting them to their default values.
|
|
|
|
if not module.check_mode and not cached:
|
|
if old_pkgng:
|
|
rc, out, err = module.run_command("%s %s update" % (pkgsite, pkgng_path))
|
|
else:
|
|
rc, out, err = module.run_command("%s %s update" % (pkgng_path, dir_arg))
|
|
if rc != 0:
|
|
module.fail_json(msg="Could not update catalogue")
|
|
|
|
for package in packages:
|
|
if query_package(module, pkgng_path, package, dir_arg):
|
|
continue
|
|
|
|
if not module.check_mode:
|
|
if old_pkgng:
|
|
rc, out, err = module.run_command("%s %s %s install -g -U -y %s" % (batch_var, pkgsite, pkgng_path, package))
|
|
else:
|
|
rc, out, err = module.run_command("%s %s %s install %s -g -U -y %s" % (batch_var, pkgng_path, dir_arg, pkgsite, package))
|
|
|
|
if not module.check_mode and not query_package(module, pkgng_path, package, dir_arg):
|
|
module.fail_json(msg="failed to install %s: %s" % (package, out), stderr=err)
|
|
|
|
install_c += 1
|
|
|
|
if install_c > 0:
|
|
return (True, "added %s package(s)" % (install_c))
|
|
|
|
return (False, "package(s) already present")
|
|
|
|
def annotation_query(module, pkgng_path, package, tag, dir_arg):
|
|
rc, out, err = module.run_command("%s %s info -g -A %s" % (pkgng_path, dir_arg, package))
|
|
match = re.search(r'^\s*(?P<tag>%s)\s*:\s*(?P<value>\w+)' % tag, out, flags=re.MULTILINE)
|
|
if match:
|
|
return match.group('value')
|
|
return False
|
|
|
|
|
|
def annotation_add(module, pkgng_path, package, tag, value, dir_arg):
|
|
_value = annotation_query(module, pkgng_path, package, tag, dir_arg)
|
|
if not _value:
|
|
# Annotation does not exist, add it.
|
|
rc, out, err = module.run_command('%s %s annotate -y -A %s %s "%s"'
|
|
% (pkgng_path, dir_arg, package, tag, value))
|
|
if rc != 0:
|
|
module.fail_json("could not annotate %s: %s"
|
|
% (package, out), stderr=err)
|
|
return True
|
|
elif _value != value:
|
|
# Annotation exists, but value differs
|
|
module.fail_json(
|
|
mgs="failed to annotate %s, because %s is already set to %s, but should be set to %s"
|
|
% (package, tag, _value, value))
|
|
return False
|
|
else:
|
|
# Annotation exists, nothing to do
|
|
return False
|
|
|
|
def annotation_delete(module, pkgng_path, package, tag, value, dir_arg):
|
|
_value = annotation_query(module, pkgng_path, package, tag, dir_arg)
|
|
if _value:
|
|
rc, out, err = module.run_command('%s %s annotate -y -D %s %s'
|
|
% (pkgng_path, dir_arg, package, tag))
|
|
if rc != 0:
|
|
module.fail_json("could not delete annotation to %s: %s"
|
|
% (package, out), stderr=err)
|
|
return True
|
|
return False
|
|
|
|
def annotation_modify(module, pkgng_path, package, tag, value, dir_arg):
|
|
_value = annotation_query(module, pkgng_path, package, tag, dir_arg)
|
|
if not value:
|
|
# No such tag
|
|
module.fail_json("could not change annotation to %s: tag %s does not exist"
|
|
% (package, tag))
|
|
elif _value == value:
|
|
# No change in value
|
|
return False
|
|
else:
|
|
rc,out,err = module.run_command('%s %s annotate -y -M %s %s "%s"'
|
|
% (pkgng_path, dir_arg, package, tag, value))
|
|
if rc != 0:
|
|
module.fail_json("could not change annotation annotation to %s: %s"
|
|
% (package, out), stderr=err)
|
|
return True
|
|
|
|
|
|
def annotate_packages(module, pkgng_path, packages, annotation, dir_arg):
|
|
annotate_c = 0
|
|
annotations = map(lambda _annotation:
|
|
re.match(r'(?P<operation>[\+-:])(?P<tag>\w+)(=(?P<value>\w+))?',
|
|
_annotation).groupdict(),
|
|
re.split(r',', annotation))
|
|
|
|
operation = {
|
|
'+': annotation_add,
|
|
'-': annotation_delete,
|
|
':': annotation_modify
|
|
}
|
|
|
|
for package in packages:
|
|
for _annotation in annotations:
|
|
if operation[_annotation['operation']](module, pkgng_path, package, _annotation['tag'], _annotation['value']):
|
|
annotate_c += 1
|
|
|
|
if annotate_c > 0:
|
|
return (True, "added %s annotations." % annotate_c)
|
|
return (False, "changed no annotations")
|
|
|
|
def autoremove_packages(module, pkgng_path, dir_arg):
|
|
rc, out, err = module.run_command("%s %s autoremove -n" % (pkgng_path, dir_arg))
|
|
|
|
autoremove_c = 0
|
|
|
|
match = re.search('^Deinstallation has been requested for the following ([0-9]+) packages', out, re.MULTILINE)
|
|
if match:
|
|
autoremove_c = int(match.group(1))
|
|
|
|
if autoremove_c == 0:
|
|
return False, "no package(s) to autoremove"
|
|
|
|
if not module.check_mode:
|
|
rc, out, err = module.run_command("%s %s autoremove -y" % (pkgng_path, dir_arg))
|
|
|
|
return True, "autoremoved %d package(s)" % (autoremove_c)
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
state = dict(default="present", choices=["present","absent"], required=False),
|
|
name = dict(aliases=["pkg"], required=True, type='list'),
|
|
cached = dict(default=False, type='bool'),
|
|
annotation = dict(default="", required=False),
|
|
pkgsite = dict(default="", required=False),
|
|
rootdir = dict(default="", required=False, type='path'),
|
|
chroot = dict(default="", required=False, type='path'),
|
|
autoremove = dict(default=False, type='bool')),
|
|
supports_check_mode = True,
|
|
mutually_exclusive =[["rootdir", "chroot"]])
|
|
|
|
pkgng_path = module.get_bin_path('pkg', True)
|
|
|
|
p = module.params
|
|
|
|
pkgs = p["name"]
|
|
|
|
changed = False
|
|
msgs = []
|
|
dir_arg = ""
|
|
|
|
if p["rootdir"] != "":
|
|
old_pkgng = pkgng_older_than(module, pkgng_path, [1, 5, 0])
|
|
if old_pkgng:
|
|
module.fail_json(msg="To use option 'rootdir' pkg version must be 1.5 or greater")
|
|
else:
|
|
dir_arg = "--rootdir %s" % (p["rootdir"])
|
|
|
|
if p["chroot"] != "":
|
|
dir_arg = '--chroot %s' % (p["chroot"])
|
|
|
|
if p["state"] == "present":
|
|
_changed, _msg = install_packages(module, pkgng_path, pkgs, p["cached"], p["pkgsite"], dir_arg)
|
|
changed = changed or _changed
|
|
msgs.append(_msg)
|
|
|
|
elif p["state"] == "absent":
|
|
_changed, _msg = remove_packages(module, pkgng_path, pkgs, dir_arg)
|
|
changed = changed or _changed
|
|
msgs.append(_msg)
|
|
|
|
if p["autoremove"]:
|
|
_changed, _msg = autoremove_packages(module, pkgng_path, dir_arg)
|
|
changed = changed or _changed
|
|
msgs.append(_msg)
|
|
|
|
if p["annotation"]:
|
|
_changed, _msg = annotate_packages(module, pkgng_path, pkgs, p["annotation"], dir_arg)
|
|
changed = changed or _changed
|
|
msgs.append(_msg)
|
|
|
|
module.exit_json(changed=changed, msg=", ".join(msgs))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|