archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #695 from nix85/fix_apt_mod

Browse Source 
Standardizing the apt module
pull/690/merge
Michael DeHaan 13 years ago
parent b3b12b5e41 daf44331c4
commit ebfd7ec7e3
1 changed files with 79 additions and 116 deletions
Show Stats Download Patch File Download Diff File

199
library/apt
Unescape Escape View File

@ -17,37 +17,15 @@
# along with this software. If not, see <http://www.gnu.org/licenses/>. # along with this software. If not, see <http://www.gnu.org/licenses/>.
# #
try:
import json
except ImportError:
import simplejson as json
import os
import sys
import shlex
import subprocess
import syslog
import traceback import traceback
# added to stave off future warnings about apt api # added to stave off future warnings about apt api
import warnings; import warnings;
warnings.filterwarnings('ignore', "apt API not stable yet", FutureWarning) warnings.filterwarnings('ignore', "apt API not stable yet", FutureWarning)
# APT related constants
APT_PATH = "/usr/bin/apt-get" APT_PATH = "/usr/bin/apt-get"
APT = "DEBIAN_FRONTEND=noninteractive DEBIAN_PRIORITY=critical %s" % APT_PATH APT = "DEBIAN_FRONTEND=noninteractive DEBIAN_PRIORITY=critical %s" % APT_PATH
def exit_json(rc=0, **kwargs):
print json.dumps(kwargs)
sys.exit(rc)
def fail_json(**kwargs):
kwargs['failed'] = True
exit_json(rc=1, **kwargs)
try:
import apt, apt_pkg
except ImportError:
fail_json(msg="could not import apt, please install the python-apt package on this host")
def run_apt(command): def run_apt(command):
try: try:
cmd = subprocess.Popen(command, shell=True, cmd = subprocess.Popen(command, shell=True,
@ -72,11 +50,11 @@ def package_split(pkgspec):
else: else:
return parts[0], None return parts[0], None
def package_status(pkgname, version, cache): def package_status(m, pkgname, version, cache):
try: try:
pkg = cache[pkgname] pkg = cache[pkgname]
except KeyError: except KeyError:
fail_json(msg="No package matching '%s' is available" % pkgname) m.fail_json(msg="No package matching '%s' is available" % pkgname)
if version: if version:
try : try :
return pkg.is_installed and pkg.installed.version == version, False return pkg.is_installed and pkg.installed.version == version, False
@ -90,9 +68,9 @@ def package_status(pkgname, version, cache):
#assume older version of python-apt is installed #assume older version of python-apt is installed
return pkg.isInstalled, pkg.isUpgradable return pkg.isInstalled, pkg.isUpgradable
def install(pkgspec, cache, upgrade=False, default_release=None, install_recommends=True, force=False): def install(m, pkgspec, cache, upgrade=False, default_release=None, install_recommends=True, force=False):
name, version = package_split(pkgspec) name, version = package_split(pkgspec)
installed, upgradable = package_status(name, version, cache) installed, upgradable = package_status(m, name, version, cache)
if not installed or (upgrade and upgradable): if not installed or (upgrade and upgradable):
if force: if force:
force_yes = '--force-yes' force_yes = '--force-yes'
@ -104,107 +82,92 @@ def install(pkgspec, cache, upgrade=False, default_release=None, install_recomme
cmd += " -t '%s'" % (default_release,) cmd += " -t '%s'" % (default_release,)
if not install_recommends: if not install_recommends:
cmd += " --no-install-recommends" cmd += " --no-install-recommends"
rc, out, err = run_apt(cmd) rc, out, err = run_apt(cmd)
if rc: if rc:
fail_json(msg="'apt-get install %s' failed: %s" % (pkgspec, err)) m.fail_json(msg="'apt-get install %s' failed: %s" % (pkgspec, err))
return True else:
m.exit_json(changed=True)
else: else:
return False m.exit_json(changed=False)
def remove(pkgspec, cache, purge=False): def remove(m, pkgspec, cache, purge=False):
name, version = package_split(pkgspec) name, version = package_split(pkgspec)
installed, upgradable = package_status(name, version, cache) installed, upgradable = package_status(m, name, version, cache)
if not installed: if not installed:
return False m.exit_json(changed=False)
else: else:
purge = '--purge' if purge else '' purge = '--purge' if purge else ''
cmd = "%s -q -y %s remove '%s'" % (APT, purge, name) cmd = "%s -q -y %s remove '%s'" % (APT, purge, name)
rc, out, err = run_apt(cmd) rc, out, err = run_apt(cmd)
if rc: if rc:
fail_json(msg="'apt-get remove %s' failed: %s" % (name, err)) m.fail_json(msg="'apt-get remove %s' failed: %s" % (name, err))
return True m.exit_json(changed=True)
# =========================================== def main():
module = AnsibleModule(
if not os.path.exists(APT_PATH): argument_spec = dict(
fail_json(msg="Cannot find apt-get") state = dict(default='installed', choices=['installed', 'latest', 'removed']),
update_cache = dict(default='no', choices=['yes', 'no']),
argfile = sys.argv[1] purge = dict(default='no', choices=['yes', 'no']),
args = open(argfile, 'r').read() package = dict(default=None, aliases=['pkg', 'name']),
items = shlex.split(args) default_release = dict(default=None, aliases=['default-release']),
syslog.openlog('ansible-%s' % os.path.basename(__file__)) install_recommends = dict(default='yes', aliases=['install-recommends'], choices=['yes', 'no']),
syslog.syslog(syslog.LOG_NOTICE, 'Invoked with %s' % args) force = dict(default='no', choices=['yes', 'no'])
)
if not len(items): )
fail_json(msg='the module requires arguments -a')
sys.exit(1) try:
import apt, apt_pkg
params = {} except:
for x in items: module.fail_json("Could not import python modules: apt, apt_pkg. Please install python-apt package.")
(k, v) = x.split("=", 1)
params[k] = v if not os.path.exists(APT_PATH):
module.fail_json(msg="Cannot find apt-get")
state = params.get('state', 'installed')
package = params.get('pkg', params.get('package', params.get('name', None))) p = module.params
update_cache = params.get('update-cache', 'no') if p['package'] is None and p['update_cache'] != 'yes':
purge = params.get('purge', 'no') module.fail_json(msg='pkg=name and/or update-cache=yes is required')
default_release = params.get('default-release', None)
install_recommends = params.get('install-recommends', 'yes') install_recommends = (p['install_recommends'] == 'yes')
force = params.get('force', 'no')
cache = apt.Cache()
if state not in ['installed', 'latest', 'removed']: if p['default_release']:
fail_json(msg='invalid state') apt_pkg.config['APT::Default-Release'] = p['default_release']
# reopen cache w/ modified config
if update_cache not in ['yes', 'no']: cache.open(progress=None)
fail_json(msg='invalid value for update_cache (requires yes or no -- default is no')
if p['update_cache'] == 'yes':
if purge not in ['yes', 'no']: cache.update()
fail_json(msg='invalid value for purge (requires yes or no -- default is no)') cache.open(progress=None)
if p['package'] == None:
if force not in ['yes', 'no']: module.exit_json(changed=False)
fail_json(msg='invalid option for force (requires yes or no -- default is no)')
if p['force'] == 'yes':
if package is None and update_cache != 'yes': force_yes = True
fail_json(msg='pkg=name and/or update-cache=yes is required') else:
force_yes = False
if install_recommends not in ['yes', 'no']:
fail_json(msg='invalid value for install-recommends (requires yes or no -- default is yes)') if p['package'].count('=') > 1:
install_recommends = (install_recommends == 'yes') module.fail_json(msg='invalid package spec')
cache = apt.Cache() if p['state'] == 'latest':
if default_release: if '=' in p['package']:
apt_pkg.config['APT::Default-Release'] = default_release module.fail_json(msg='version number inconsistent with state=latest')
# reopen cache w/ modified config install(module, p['package'], cache, upgrade=True,
cache.open(progress=None) default_release=p['default_release'],
install_recommends=install_recommends,
if update_cache == 'yes': force=force_yes)
cache.update()
cache.open(progress=None) elif p['state'] == 'installed':
if package == None: install(module, p['package'], cache, default_release=p['default_release'],
exit_json(changed=False) install_recommends=install_recommends,force=force_yes)
elif p['state'] == 'removed':
if force == 'yes': remove(module, p['package'], cache, purge == 'yes')
force_yes = True
else: # this is magic, see lib/ansible/module_common.py
force_yes = False #<<INCLUDE_ANSIBLE_MODULE_COMMON>>
if package.count('=') > 1:
fail_json(msg='invalid package spec')
if state == 'latest':
if '=' in package:
fail_json(msg='version number inconsistent with state=latest')
changed = install(package, cache, upgrade=True,
default_release=default_release,
install_recommends=install_recommends,
force=force_yes)
elif state == 'installed':
changed = install(package, cache, default_release=default_release,
install_recommends=install_recommends,force=force_yes)
elif state == 'removed':
changed = remove(package, cache, purge == 'yes')
exit_json(changed=changed)
main()

Write Preview
Loading…
Cancel
Save