diff options
Diffstat (limited to 'lib/ansible/module_utils/yumdnf.py')
| -rw-r--r-- | lib/ansible/module_utils/yumdnf.py | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/lib/ansible/module_utils/yumdnf.py b/lib/ansible/module_utils/yumdnf.py new file mode 100644 index 0000000..e265a2d --- /dev/null +++ b/lib/ansible/module_utils/yumdnf.py @@ -0,0 +1,182 @@ +# -*- coding: utf-8 -*- +# +# # Copyright: (c) 2012, Red Hat, Inc +# Written by Seth Vidal <skvidal at fedoraproject.org> +# Contributing Authors: +# - Ansible Core Team +# - Eduard Snesarev (@verm666) +# - Berend De Schouwer (@berenddeschouwer) +# - Abhijeet Kasurde (@Akasurde) +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import time +import glob +import tempfile +from abc import ABCMeta, abstractmethod + +from ansible.module_utils._text import to_native +from ansible.module_utils.six import with_metaclass + +yumdnf_argument_spec = dict( + argument_spec=dict( + allow_downgrade=dict(type='bool', default=False), + autoremove=dict(type='bool', default=False), + bugfix=dict(required=False, type='bool', default=False), + cacheonly=dict(type='bool', default=False), + conf_file=dict(type='str'), + disable_excludes=dict(type='str', default=None), + disable_gpg_check=dict(type='bool', default=False), + disable_plugin=dict(type='list', elements='str', default=[]), + disablerepo=dict(type='list', elements='str', default=[]), + download_only=dict(type='bool', default=False), + download_dir=dict(type='str', default=None), + enable_plugin=dict(type='list', elements='str', default=[]), + enablerepo=dict(type='list', elements='str', default=[]), + exclude=dict(type='list', elements='str', default=[]), + installroot=dict(type='str', default="/"), + install_repoquery=dict(type='bool', default=True), + install_weak_deps=dict(type='bool', default=True), + list=dict(type='str'), + name=dict(type='list', elements='str', aliases=['pkg'], default=[]), + releasever=dict(default=None), + security=dict(type='bool', default=False), + skip_broken=dict(type='bool', default=False), + # removed==absent, installed==present, these are accepted as aliases + state=dict(type='str', default=None, choices=['absent', 'installed', 'latest', 'present', 'removed']), + update_cache=dict(type='bool', default=False, aliases=['expire-cache']), + update_only=dict(required=False, default="no", type='bool'), + validate_certs=dict(type='bool', default=True), + sslverify=dict(type='bool', default=True), + lock_timeout=dict(type='int', default=30), + ), + required_one_of=[['name', 'list', 'update_cache']], + mutually_exclusive=[['name', 'list']], + supports_check_mode=True, +) + + +class YumDnf(with_metaclass(ABCMeta, object)): # type: ignore[misc] + """ + Abstract class that handles the population of instance variables that should + be identical between both YUM and DNF modules because of the feature parity + and shared argument spec + """ + + def __init__(self, module): + + self.module = module + + self.allow_downgrade = self.module.params['allow_downgrade'] + self.autoremove = self.module.params['autoremove'] + self.bugfix = self.module.params['bugfix'] + self.cacheonly = self.module.params['cacheonly'] + self.conf_file = self.module.params['conf_file'] + self.disable_excludes = self.module.params['disable_excludes'] + self.disable_gpg_check = self.module.params['disable_gpg_check'] + self.disable_plugin = self.module.params['disable_plugin'] + self.disablerepo = self.module.params.get('disablerepo', []) + self.download_only = self.module.params['download_only'] + self.download_dir = self.module.params['download_dir'] + self.enable_plugin = self.module.params['enable_plugin'] + self.enablerepo = self.module.params.get('enablerepo', []) + self.exclude = self.module.params['exclude'] + self.installroot = self.module.params['installroot'] + self.install_repoquery = self.module.params['install_repoquery'] + self.install_weak_deps = self.module.params['install_weak_deps'] + self.list = self.module.params['list'] + self.names = [p.strip() for p in self.module.params['name']] + self.releasever = self.module.params['releasever'] + self.security = self.module.params['security'] + self.skip_broken = self.module.params['skip_broken'] + self.state = self.module.params['state'] + self.update_only = self.module.params['update_only'] + self.update_cache = self.module.params['update_cache'] + self.validate_certs = self.module.params['validate_certs'] + self.sslverify = self.module.params['sslverify'] + self.lock_timeout = self.module.params['lock_timeout'] + + # It's possible someone passed a comma separated string since it used + # to be a string type, so we should handle that + self.names = self.listify_comma_sep_strings_in_list(self.names) + self.disablerepo = self.listify_comma_sep_strings_in_list(self.disablerepo) + self.enablerepo = self.listify_comma_sep_strings_in_list(self.enablerepo) + self.exclude = self.listify_comma_sep_strings_in_list(self.exclude) + + # Fail if someone passed a space separated string + # https://github.com/ansible/ansible/issues/46301 + for name in self.names: + if ' ' in name and not any(spec in name for spec in ['@', '>', '<', '=']): + module.fail_json( + msg='It appears that a space separated string of packages was passed in ' + 'as an argument. To operate on several packages, pass a comma separated ' + 'string of packages or a list of packages.' + ) + + # Sanity checking for autoremove + if self.state is None: + if self.autoremove: + self.state = "absent" + else: + self.state = "present" + + if self.autoremove and (self.state != "absent"): + self.module.fail_json( + msg="Autoremove should be used alone or with state=absent", + results=[], + ) + + # This should really be redefined by both the yum and dnf module but a + # default isn't a bad idea + self.lockfile = '/var/run/yum.pid' + + @abstractmethod + def is_lockfile_pid_valid(self): + return + + def _is_lockfile_present(self): + return (os.path.isfile(self.lockfile) or glob.glob(self.lockfile)) and self.is_lockfile_pid_valid() + + def wait_for_lock(self): + '''Poll until the lock is removed if timeout is a positive number''' + + if not self._is_lockfile_present(): + return + + if self.lock_timeout > 0: + for iteration in range(0, self.lock_timeout): + time.sleep(1) + if not self._is_lockfile_present(): + return + + self.module.fail_json(msg='{0} lockfile is held by another process'.format(self.pkg_mgr_name)) + + def listify_comma_sep_strings_in_list(self, some_list): + """ + method to accept a list of strings as the parameter, find any strings + in that list that are comma separated, remove them from the list and add + their comma separated elements to the original list + """ + new_list = [] + remove_from_original_list = [] + for element in some_list: + if ',' in element: + remove_from_original_list.append(element) + new_list.extend([e.strip() for e in element.split(',')]) + + for element in remove_from_original_list: + some_list.remove(element) + + some_list.extend(new_list) + + if some_list == [""]: + return [] + + return some_list + + @abstractmethod + def run(self): + raise NotImplementedError |