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

apt_rpm: PEP8 compliancy and documentation changes (#33431)

This PR includes:
- PEP8 compliancy changes
- Documentation changes
This commit is contained in:
Dag Wieers 2017-12-01 14:19:35 +01:00 committed by ansibot
parent dc112a03dd
commit 5b5d767c0b
2 changed files with 38 additions and 44 deletions

View file

@ -1,21 +1,19 @@
#!/usr/bin/python -tt #!/usr/bin/python -tt
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# (c) 2013, Evgenii Terechkov # Copyright: (c) 2013, Evgenii Terechkov
# Written by Evgenii Terechkov <evg@altlinux.org> # Written by Evgenii Terechkov <evg@altlinux.org>
# Based on urpmi module written by Philippe Makowski <philippem@mageia.org> # Based on urpmi module written by Philippe Makowski <philippem@mageia.org>
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # 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 from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'], 'status': ['preview'],
'supported_by': 'community'} 'supported_by': 'community'}
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: apt_rpm module: apt_rpm
@ -28,59 +26,55 @@ options:
description: description:
- name of package to install, upgrade or remove. - name of package to install, upgrade or remove.
required: true required: true
default: null
state: state:
description: description:
- Indicates the desired package state - Indicates the desired package state.
required: false choices: [ absent, present ]
default: present default: present
choices: [ "absent", "present" ]
update_cache: update_cache:
description: description:
- update the package database first C(apt-get update). - update the package database first C(apt-get update).
required: false type: bool
default: no default: 'no'
choices: [ "yes", "no" ] author:
author: "Evgenii Terechkov (@evgkrsk)" - Evgenii Terechkov (@evgkrsk)
notes: []
''' '''
EXAMPLES = ''' EXAMPLES = '''
# install package foo - name: Install package foo
- apt_rpm: apt_rpm:
pkg: foo pkg: foo
state: present state: present
# remove package foo - name: Remove package foo
- apt_rpm: apt_rpm:
pkg: foo pkg: foo
state: absent state: absent
# description: remove packages foo and bar - name: Remove packages foo and bar
- apt_rpm: apt_rpm:
pkg: foo,bar pkg: foo,bar
state: absent state: absent
# description: update the package database and install bar (bar will be the updated if a newer version exists) # bar will be the updated if a newer version exists
- apt_rpm: - name: Update the package database and install bar
apt_rpm:
name: bar name: bar
state: present state: present
update_cache: yes update_cache: yes
''' '''
try:
import json import json
except ImportError:
import simplejson as json
import shlex
import os import os
import shlex
import sys import sys
from ansible.module_utils.basic import AnsibleModule
APT_PATH = "/usr/bin/apt-get" APT_PATH = "/usr/bin/apt-get"
RPM_PATH = "/usr/bin/rpm" RPM_PATH = "/usr/bin/rpm"
def query_package(module, name): def query_package(module, name):
# rpm -q returns 0 if the package is installed, # rpm -q returns 0 if the package is installed,
# 1 if it is not installed # 1 if it is not installed
@ -90,18 +84,21 @@ def query_package(module, name):
else: else:
return False return False
def query_package_provides(module, name): def query_package_provides(module, name):
# rpm -q returns 0 if the package is installed, # rpm -q returns 0 if the package is installed,
# 1 if it is not installed # 1 if it is not installed
rc, out, err = module.run_command("%s -q --provides %s" % (RPM_PATH, name)) rc, out, err = module.run_command("%s -q --provides %s" % (RPM_PATH, name))
return rc == 0 return rc == 0
def update_package_db(module): def update_package_db(module):
rc, out, err = module.run_command("%s update" % APT_PATH) rc, out, err = module.run_command("%s update" % APT_PATH)
if rc != 0: if rc != 0:
module.fail_json(msg="could not update package db: %s" % err) module.fail_json(msg="could not update package db: %s" % err)
def remove_packages(module, packages): def remove_packages(module, packages):
remove_c = 0 remove_c = 0
@ -152,10 +149,11 @@ def install_packages(module, pkgspec):
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
state = dict(default='installed', choices=['installed', 'removed', 'absent', 'present']), state=dict(type='str', default='installed', choices=['absent', 'installed', 'present', 'removed']),
update_cache = dict(default=False, aliases=['update-cache'], type='bool'), update_cache=dict(type='bool', default=False, aliases=['update-cache']),
package = dict(aliases=['pkg', 'name'], required=True))) package=dict(type='str', required=True, aliases=['name', 'pkg']),
),
)
if not os.path.exists(APT_PATH) or not os.path.exists(RPM_PATH): if not os.path.exists(APT_PATH) or not os.path.exists(RPM_PATH):
module.fail_json(msg="cannot find /usr/bin/apt-get and/or /usr/bin/rpm") module.fail_json(msg="cannot find /usr/bin/apt-get and/or /usr/bin/rpm")
@ -170,11 +168,8 @@ def main():
if p['state'] in ['installed', 'present']: if p['state'] in ['installed', 'present']:
install_packages(module, packages) install_packages(module, packages)
elif p['state'] in [ 'removed', 'absent' ]: elif p['state'] in ['absent', 'removed']:
remove_packages(module, packages) remove_packages(module, packages)
# this is magic, see lib/ansible/module_common.py
from ansible.module_utils.basic import *
if __name__ == '__main__': if __name__ == '__main__':
main() main()

View file

@ -261,7 +261,6 @@ lib/ansible/modules/packaging/os/apk.py
lib/ansible/modules/packaging/os/apt.py lib/ansible/modules/packaging/os/apt.py
lib/ansible/modules/packaging/os/apt_key.py lib/ansible/modules/packaging/os/apt_key.py
lib/ansible/modules/packaging/os/apt_repository.py lib/ansible/modules/packaging/os/apt_repository.py
lib/ansible/modules/packaging/os/apt_rpm.py
lib/ansible/modules/packaging/os/dpkg_selections.py lib/ansible/modules/packaging/os/dpkg_selections.py
lib/ansible/modules/packaging/os/homebrew.py lib/ansible/modules/packaging/os/homebrew.py
lib/ansible/modules/packaging/os/homebrew_cask.py lib/ansible/modules/packaging/os/homebrew_cask.py