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/packaging/os/yum_versionlock.py

157 lines
4.5 KiB
Python
Raw Normal View History

yum_versionlock: new module (#1405) * new module: yum_versionlock * Removed redundant logic * Added check_mode support * Updated examples * Updated documentation Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> * Update plugins/modules/packaging/os/yum_versionlock.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Fix version_added * Add module symlink * Fix symlink * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation * Add notes section * check_mode is supported * Initial integration test * Change pkg to name * Do the tests only when there is something to update * Ignore CentOS 6 * Fix * Do not update obsolete packages * yum -q versionlock list does not show anything in CentOS 8 * Various suggestions by Andersson007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Apply suggestions from felixfontein review Co-authored-by: Felix Fontein <felix@fontein.de> * returned always * Apply felixfontein suggestion Co-authored-by: Felix Fontein <felix@fontein.de> * Fix RETUNRED values returned * Change default from present to locked * Remove locked, unlocked states * change locked/unlocked to present/absent in integration tests Co-authored-by: Felix Fontein <felix@fontein.de> * Fix module short_description formatting * Add myself as co-author Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-12-03 20:00:49 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Florian Paul Hoberg <florian.hoberg@credativ.de>
#
# 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
DOCUMENTATION = r'''
---
module: yum_versionlock
version_added: 2.0.0
short_description: Locks / unlocks a installed package(s) from being updated by yum package manager
description:
- This module adds installed packages to yum versionlock to prevent the package(s) from being updated.
yum_versionlock: new module (#1405) * new module: yum_versionlock * Removed redundant logic * Added check_mode support * Updated examples * Updated documentation Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> * Update plugins/modules/packaging/os/yum_versionlock.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Fix version_added * Add module symlink * Fix symlink * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation * Add notes section * check_mode is supported * Initial integration test * Change pkg to name * Do the tests only when there is something to update * Ignore CentOS 6 * Fix * Do not update obsolete packages * yum -q versionlock list does not show anything in CentOS 8 * Various suggestions by Andersson007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Apply suggestions from felixfontein review Co-authored-by: Felix Fontein <felix@fontein.de> * returned always * Apply felixfontein suggestion Co-authored-by: Felix Fontein <felix@fontein.de> * Fix RETUNRED values returned * Change default from present to locked * Remove locked, unlocked states * change locked/unlocked to present/absent in integration tests Co-authored-by: Felix Fontein <felix@fontein.de> * Fix module short_description formatting * Add myself as co-author Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-12-03 20:00:49 +01:00
options:
name:
description:
- Package name or a list of packages.
type: list
required: true
elements: str
state:
description:
- If state is C(present), package(s) will be added to yum versionlock list.
- If state is C(absent), package(s) will be removed from yum versionlock list.
choices: [ 'absent', 'present' ]
type: str
default: present
notes:
- Requires yum-plugin-versionlock package on the remote node.
- Supports C(check_mode).
requirements:
- yum
- yum-versionlock
author:
- Florian Paul Hoberg (@florianpaulhoberg)
- Amin Vakil (@aminvakil)
'''
EXAMPLES = r'''
- name: Prevent Apache / httpd from being updated
community.general.yum_versionlock:
state: present
name: httpd
- name: Prevent multiple packages from being updated
community.general.yum_versionlock:
state: present
name:
- httpd
- nginx
- haproxy
- curl
- name: Remove lock from Apache / httpd to be updated again
community.general.yum_versionlock:
state: absent
package: httpd
'''
RETURN = r'''
packages:
description: A list of package(s) in versionlock list.
returned: success
type: list
elements: str
sample: [ 'httpd' ]
state:
description: State of package(s).
returned: success
type: str
sample: present
'''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_native
class YumVersionLock:
def __init__(self, module):
self.module = module
self.params = module.params
self.yum_bin = module.get_bin_path('yum', required=True)
def get_versionlock_packages(self):
""" Get an overview of all packages on yum versionlock """
rc, out, err = self.module.run_command([self.yum_bin, "versionlock", "list"])
if rc == 0:
return out
elif rc == 1 and 'o such command:' in err:
self.module.fail_json(msg="Error: Please install rpm package yum-plugin-versionlock : " + to_native(err) + to_native(out))
self.module.fail_json(msg="Error: " + to_native(err) + to_native(out))
def ensure_state(self, packages, command):
""" Ensure packages state """
rc, out, err = self.module.run_command([self.yum_bin, "-q", "versionlock", command] + packages)
yum_versionlock: new module (#1405) * new module: yum_versionlock * Removed redundant logic * Added check_mode support * Updated examples * Updated documentation Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> * Update plugins/modules/packaging/os/yum_versionlock.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Fix version_added * Add module symlink * Fix symlink * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation * Add notes section * check_mode is supported * Initial integration test * Change pkg to name * Do the tests only when there is something to update * Ignore CentOS 6 * Fix * Do not update obsolete packages * yum -q versionlock list does not show anything in CentOS 8 * Various suggestions by Andersson007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Apply suggestions from felixfontein review Co-authored-by: Felix Fontein <felix@fontein.de> * returned always * Apply felixfontein suggestion Co-authored-by: Felix Fontein <felix@fontein.de> * Fix RETUNRED values returned * Change default from present to locked * Remove locked, unlocked states * change locked/unlocked to present/absent in integration tests Co-authored-by: Felix Fontein <felix@fontein.de> * Fix module short_description formatting * Add myself as co-author Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-12-03 20:00:49 +01:00
if rc == 0:
return True
self.module.fail_json(msg="Error: " + to_native(err) + to_native(out))
def main():
""" start main program to add/remove a package to yum versionlock"""
module = AnsibleModule(
argument_spec=dict(
state=dict(default='present', choices=['present', 'absent']),
name=dict(required=True, type='list', elements='str'),
),
supports_check_mode=True
)
state = module.params['state']
packages = module.params['name']
changed = False
yum_v = YumVersionLock(module)
# Get an overview of all packages that have a version lock
versionlock_packages = yum_v.get_versionlock_packages()
# Ensure versionlock state of packages
packages_list = []
yum_versionlock: new module (#1405) * new module: yum_versionlock * Removed redundant logic * Added check_mode support * Updated examples * Updated documentation Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> * Update plugins/modules/packaging/os/yum_versionlock.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Fix version_added * Add module symlink * Fix symlink * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation * Add notes section * check_mode is supported * Initial integration test * Change pkg to name * Do the tests only when there is something to update * Ignore CentOS 6 * Fix * Do not update obsolete packages * yum -q versionlock list does not show anything in CentOS 8 * Various suggestions by Andersson007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Apply suggestions from felixfontein review Co-authored-by: Felix Fontein <felix@fontein.de> * returned always * Apply felixfontein suggestion Co-authored-by: Felix Fontein <felix@fontein.de> * Fix RETUNRED values returned * Change default from present to locked * Remove locked, unlocked states * change locked/unlocked to present/absent in integration tests Co-authored-by: Felix Fontein <felix@fontein.de> * Fix module short_description formatting * Add myself as co-author Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-12-03 20:00:49 +01:00
if state in ('present'):
command = 'add'
for single_pkg in packages:
if single_pkg not in versionlock_packages:
if module.check_mode:
changed = True
continue
packages_list.append(single_pkg)
if packages_list:
changed = yum_v.ensure_state(packages_list, command)
yum_versionlock: new module (#1405) * new module: yum_versionlock * Removed redundant logic * Added check_mode support * Updated examples * Updated documentation Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> * Update plugins/modules/packaging/os/yum_versionlock.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Fix version_added * Add module symlink * Fix symlink * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation * Add notes section * check_mode is supported * Initial integration test * Change pkg to name * Do the tests only when there is something to update * Ignore CentOS 6 * Fix * Do not update obsolete packages * yum -q versionlock list does not show anything in CentOS 8 * Various suggestions by Andersson007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Apply suggestions from felixfontein review Co-authored-by: Felix Fontein <felix@fontein.de> * returned always * Apply felixfontein suggestion Co-authored-by: Felix Fontein <felix@fontein.de> * Fix RETUNRED values returned * Change default from present to locked * Remove locked, unlocked states * change locked/unlocked to present/absent in integration tests Co-authored-by: Felix Fontein <felix@fontein.de> * Fix module short_description formatting * Add myself as co-author Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-12-03 20:00:49 +01:00
elif state in ('absent'):
command = 'delete'
for single_pkg in packages:
if single_pkg in versionlock_packages:
if module.check_mode:
changed = True
continue
packages_list.append(single_pkg)
if packages_list:
changed = yum_v.ensure_state(packages_list, command)
yum_versionlock: new module (#1405) * new module: yum_versionlock * Removed redundant logic * Added check_mode support * Updated examples * Updated documentation Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> * Update plugins/modules/packaging/os/yum_versionlock.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Fix version_added * Add module symlink * Fix symlink * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation formatting by Anderssoon007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve documentation * Add notes section * check_mode is supported * Initial integration test * Change pkg to name * Do the tests only when there is something to update * Ignore CentOS 6 * Fix * Do not update obsolete packages * yum -q versionlock list does not show anything in CentOS 8 * Various suggestions by Andersson007 Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Apply suggestions from felixfontein review Co-authored-by: Felix Fontein <felix@fontein.de> * returned always * Apply felixfontein suggestion Co-authored-by: Felix Fontein <felix@fontein.de> * Fix RETUNRED values returned * Change default from present to locked * Remove locked, unlocked states * change locked/unlocked to present/absent in integration tests Co-authored-by: Felix Fontein <felix@fontein.de> * Fix module short_description formatting * Add myself as co-author Co-authored-by: Erik-jan Riemers <riemers@binkey.nl> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-12-03 20:00:49 +01:00
module.exit_json(
changed=changed,
meta={
"packages": packages,
"state": state
}
)
if __name__ == '__main__':
main()