1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/pkgin.py

401 lines
12 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2013 Shaun Zinck <shaun.zinck at gmail.com>
# Copyright (c) 2015 Lawrence Leonard Gilbert <larry@L2G.to>
# Copyright (c) 2016 Jasper Lievisse Adriaanse <j at jasper.la>
#
# Written by Shaun Zinck
# Based on pacman module written by Afterburn <http://github.com/afterburn>
# that was based on apt module written by Matthew Williams <matthew@flowroute.com>
#
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: pkgin
2022-11-09 13:57:41 +01:00
short_description: Package manager for SmartOS, NetBSD, et al
2020-03-09 10:11:07 +01:00
description:
- "The standard package manager for SmartOS, but also usable on NetBSD
or any OS that uses C(pkgsrc). (Home: U(http://pkgin.net/))"
author:
- "Larry Gilbert (@L2G)"
- "Shaun Zinck (@szinck)"
- "Jasper Lievisse Adriaanse (@jasperla)"
notes:
- "Known bug with pkgin < 0.8.0: if a package is removed and another
package depends on it, the other package will be silently removed as
well."
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
2020-03-09 10:11:07 +01:00
options:
name:
description:
- Name of package to install/remove;
- multiple names may be given, separated by commas
aliases: [pkg]
type: list
elements: str
2020-03-09 10:11:07 +01:00
state:
description:
- Intended state of the package
choices: [ 'present', 'absent' ]
default: present
type: str
2020-03-09 10:11:07 +01:00
update_cache:
description:
- Update repository database. Can be run with other steps or on it's own.
type: bool
default: false
2020-03-09 10:11:07 +01:00
upgrade:
description:
- Upgrade main packages to their newer versions
type: bool
default: false
2020-03-09 10:11:07 +01:00
full_upgrade:
description:
- Upgrade all packages to their newer versions
type: bool
default: false
2020-03-09 10:11:07 +01:00
clean:
description:
- Clean packages cache
type: bool
default: false
2020-03-09 10:11:07 +01:00
force:
description:
- Force package reinstall
type: bool
default: false
2020-03-09 10:11:07 +01:00
'''
EXAMPLES = '''
- name: Install package foo
community.general.pkgin:
2020-03-09 10:11:07 +01:00
name: foo
state: present
- name: Install specific version of foo package
community.general.pkgin:
name: foo-2.0.1
state: present
- name: Update cache and install foo package
community.general.pkgin:
2020-03-09 10:11:07 +01:00
name: foo
update_cache: true
2020-03-09 10:11:07 +01:00
- name: Remove package foo
community.general.pkgin:
2020-03-09 10:11:07 +01:00
name: foo
state: absent
- name: Remove packages foo and bar
community.general.pkgin:
2020-03-09 10:11:07 +01:00
name: foo,bar
state: absent
- name: Update repositories as a separate step
community.general.pkgin:
update_cache: true
2020-03-09 10:11:07 +01:00
- name: Upgrade main packages (equivalent to pkgin upgrade)
community.general.pkgin:
upgrade: true
2020-03-09 10:11:07 +01:00
- name: Upgrade all packages (equivalent to pkgin full-upgrade)
community.general.pkgin:
full_upgrade: true
2020-03-09 10:11:07 +01:00
- name: Force-upgrade all packages (equivalent to pkgin -F full-upgrade)
community.general.pkgin:
full_upgrade: true
force: true
2020-03-09 10:11:07 +01:00
- name: Clean packages cache (equivalent to pkgin clean)
community.general.pkgin:
clean: true
2020-03-09 10:11:07 +01:00
'''
import re
from ansible.module_utils.basic import AnsibleModule
class PackageState(object):
PRESENT = 1
NOT_INSTALLED = 2
OUTDATED = 4
NOT_FOUND = 8
2020-03-09 10:11:07 +01:00
def query_package(module, name):
"""Search for the package by name and return state of the package.
2020-03-09 10:11:07 +01:00
"""
# test whether '-p' (parsable) flag is supported.
rc, out, err = module.run_command([PKGIN_PATH, "-p", "-v"])
2020-03-09 10:11:07 +01:00
if rc == 0:
pflag = ['-p']
2020-03-09 10:11:07 +01:00
splitchar = ';'
else:
pflag = []
2020-03-09 10:11:07 +01:00
splitchar = ' '
# Use "pkgin search" to find the package. The regular expression will
# only match on the complete name.
rc, out, err = module.run_command([PKGIN_PATH] + pflag + ["search", "^%s$" % name])
2020-03-09 10:11:07 +01:00
# rc will not be 0 unless the search was a success
if rc == 0:
# Search results may contain more than one line (e.g., 'emacs'), so iterate
# through each line to see if we have a match.
packages = out.split('\n')
for package in packages:
# Break up line at spaces. The first part will be the package with its
# version (e.g. 'gcc47-libs-4.7.2nb4'), and the second will be the state
# of the package:
# '' - not installed
# '<' - installed but out of date
# '=' - installed and up to date
# '>' - installed but newer than the repository version
if (package in ('reading local summary...',
'processing local summary...',
'downloading pkg_summary.xz done.')) or \
(package.startswith('processing remote summary (')):
continue
2020-03-09 10:11:07 +01:00
pkgname_with_version, raw_state = package.split(splitchar)[0:2]
# Search for package, stripping version
# (results in sth like 'gcc47-libs' or 'emacs24-nox11')
pkg_search_obj = re.search(r'^(.*?)\-[0-9][0-9.]*(nb[0-9]+)*', pkgname_with_version, re.M)
# Do not proceed unless we have a match
if not pkg_search_obj:
continue
# Grab matched string
pkgname_without_version = pkg_search_obj.group(1)
if name not in (pkgname_with_version, pkgname_without_version):
2020-03-09 10:11:07 +01:00
continue
# The package was found; now return its state
if raw_state == '<':
return PackageState.OUTDATED
2020-03-09 10:11:07 +01:00
elif raw_state == '=' or raw_state == '>':
return PackageState.PRESENT
2020-03-09 10:11:07 +01:00
else:
# Package found but not installed
return PackageState.NOT_INSTALLED
2020-03-09 10:11:07 +01:00
# no fall-through
# No packages were matched
return PackageState.NOT_FOUND
# Search failed
return PackageState.NOT_FOUND
2020-03-09 10:11:07 +01:00
def format_action_message(module, action, count):
vars = {"actioned": action,
"count": count}
if module.check_mode:
message = "would have %(actioned)s %(count)d package" % vars
else:
message = "%(actioned)s %(count)d package" % vars
if count == 1:
return message
else:
return message + "s"
def format_pkgin_command(module, command, package=None):
# Not all commands take a package argument, so cover this up by passing
# an empty string. Some commands (e.g. 'update') will ignore extra
# arguments, however this behaviour cannot be relied on for others.
if package is None:
packages = []
else:
packages = [package]
2020-03-09 10:11:07 +01:00
if module.params["force"]:
force = ["-F"]
2020-03-09 10:11:07 +01:00
else:
force = []
2020-03-09 10:11:07 +01:00
if module.check_mode:
return [PKGIN_PATH, "-n", command] + packages
2020-03-09 10:11:07 +01:00
else:
return [PKGIN_PATH, "-y"] + force + [command] + packages
2020-03-09 10:11:07 +01:00
def remove_packages(module, packages):
remove_c = 0
# Using a for loop in case 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 query_package(module, package) in [PackageState.NOT_INSTALLED, PackageState.NOT_FOUND]:
2020-03-09 10:11:07 +01:00
continue
rc, out, err = module.run_command(
format_pkgin_command(module, "remove", package))
if not module.check_mode and query_package(module, package) in [PackageState.PRESENT, PackageState.OUTDATED]:
module.fail_json(msg="failed to remove %s: %s" % (package, out), stdout=out, stderr=err)
2020-03-09 10:11:07 +01:00
remove_c += 1
if remove_c > 0:
module.exit_json(changed=True, msg=format_action_message(module, "removed", remove_c))
module.exit_json(changed=False, msg="package(s) already absent")
def install_packages(module, packages):
install_c = 0
for package in packages:
query_result = query_package(module, package)
if query_result in [PackageState.PRESENT, PackageState.OUTDATED]:
2020-03-09 10:11:07 +01:00
continue
elif query_result is PackageState.NOT_FOUND:
module.fail_json(msg="failed to find package %s for installation" % package)
2020-03-09 10:11:07 +01:00
rc, out, err = module.run_command(
format_pkgin_command(module, "install", package))
if not module.check_mode and not query_package(module, package) in [PackageState.PRESENT, PackageState.OUTDATED]:
module.fail_json(msg="failed to install %s: %s" % (package, out), stdout=out, stderr=err)
2020-03-09 10:11:07 +01:00
install_c += 1
if install_c > 0:
module.exit_json(changed=True, msg=format_action_message(module, "installed", install_c), stdout=out, stderr=err)
2020-03-09 10:11:07 +01:00
module.exit_json(changed=False, msg="package(s) already present")
2020-03-09 10:11:07 +01:00
def update_package_db(module):
rc, out, err = module.run_command(
format_pkgin_command(module, "update"))
if rc == 0:
if re.search('database for.*is up-to-date\n$', out):
return False, "database is up-to-date"
else:
return True, "updated repository database"
else:
module.fail_json(msg="could not update package db", stdout=out, stderr=err)
2020-03-09 10:11:07 +01:00
def do_upgrade_packages(module, full=False):
if full:
cmd = "full-upgrade"
else:
cmd = "upgrade"
rc, out, err = module.run_command(
format_pkgin_command(module, cmd))
if rc == 0:
if re.search('^(.*\n|)nothing to do.\n$', out):
2020-03-09 10:11:07 +01:00
module.exit_json(changed=False, msg="nothing left to upgrade")
else:
module.fail_json(msg="could not %s packages" % cmd, stdout=out, stderr=err)
2020-03-09 10:11:07 +01:00
def upgrade_packages(module):
do_upgrade_packages(module)
def full_upgrade_packages(module):
do_upgrade_packages(module, True)
def clean_cache(module):
rc, out, err = module.run_command(
format_pkgin_command(module, "clean"))
if rc == 0:
# There's no indication if 'clean' actually removed anything,
# so assume it did.
module.exit_json(changed=True, msg="cleaned caches")
else:
module.fail_json(msg="could not clean package cache", stdout=out, stderr=err)
2020-03-09 10:11:07 +01:00
def main():
module = AnsibleModule(
argument_spec=dict(
state=dict(default="present", choices=["present", "absent"]),
name=dict(aliases=["pkg"], type='list', elements='str'),
update_cache=dict(default=False, type='bool'),
upgrade=dict(default=False, type='bool'),
full_upgrade=dict(default=False, type='bool'),
clean=dict(default=False, type='bool'),
force=dict(default=False, type='bool')),
2020-03-09 10:11:07 +01:00
required_one_of=[['name', 'update_cache', 'upgrade', 'full_upgrade', 'clean']],
supports_check_mode=True)
global PKGIN_PATH
PKGIN_PATH = module.get_bin_path('pkgin', True, ['/opt/local/bin'])
module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C', LC_CTYPE='C')
p = module.params
if p["update_cache"]:
c, msg = update_package_db(module)
if not (p['name'] or p["upgrade"] or p["full_upgrade"]):
module.exit_json(changed=c, msg=msg)
if p["upgrade"]:
upgrade_packages(module)
if not p['name']:
module.exit_json(changed=True, msg='upgraded packages')
if p["full_upgrade"]:
full_upgrade_packages(module)
if not p['name']:
module.exit_json(changed=True, msg='upgraded all packages')
if p["clean"]:
clean_cache(module)
if not p['name']:
module.exit_json(changed=True, msg='cleaned caches')
pkgs = p["name"]
if p["state"] == "present":
install_packages(module, pkgs)
elif p["state"] == "absent":
remove_packages(module, pkgs)
if __name__ == '__main__':
main()