Standardizing the apt module

reviewable/pr18780/r1
Nikhil Singh 12 years ago
parent 1fe021f7bb
commit 096022acb2

183
apt

@ -17,17 +17,7 @@
# 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)
@ -35,18 +25,11 @@ warnings.filterwarnings('ignore', "apt API not stable yet", FutureWarning)
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: try:
import apt, apt_pkg import apt, apt_pkg
except ImportError: except ImportError:
fail_json(msg="could not import apt, please install the python-apt package on this host") json.dumps(msg="could not import apt, please install the python-apt package on this host", failed=True)
sys.exit(1)
def run_apt(command): def run_apt(command):
try: try:
@ -104,107 +87,91 @@ 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: return rc, out, err
fail_json(msg="'apt-get install %s' failed: %s" % (pkgspec, err))
return True
else: else:
return False return -1, "", "" # -1 depicts that nothing was changed
def remove(pkgspec, cache, purge=False): def remove(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(name, version, cache)
if not installed: if not installed:
return False return -1, "", "" # -1 depicts nothing was changed
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: return rc, out, error
fail_json(msg="'apt-get remove %s' failed: %s" % (name, err))
return 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) if not os.path.exists(APT_PATH):
module.fail_json(msg="Cannot find apt-get")
params = {}
for x in items: p = module.params
(k, v) = x.split("=", 1) if p['package'] is None and p['update_cache'] != 'yes':
params[k] = v module.fail_json(msg='pkg=name and/or update-cache=yes is required')
state = params.get('state', 'installed') install_recommends = (p['install_recommends'] == 'yes')
package = params.get('pkg', params.get('package', params.get('name', None)))
update_cache = params.get('update-cache', 'no') cache = apt.Cache()
purge = params.get('purge', 'no') if p['default_release']:
default_release = params.get('default-release', None) apt_pkg.config['APT::Default-Release'] = p['default_release']
install_recommends = params.get('install-recommends', 'yes') # reopen cache w/ modified config
force = params.get('force', 'no') cache.open(progress=None)
if state not in ['installed', 'latest', 'removed']: if p['update_cache'] == 'yes':
fail_json(msg='invalid state') cache.update()
cache.open(progress=None)
if update_cache not in ['yes', 'no']: if p['package'] == None:
fail_json(msg='invalid value for update_cache (requires yes or no -- default is no') module.exit_json(changed=False)
if purge not in ['yes', 'no']: if p['force'] == 'yes':
fail_json(msg='invalid value for purge (requires yes or no -- default is no)') force_yes = True
else:
if force not in ['yes', 'no']: force_yes = False
fail_json(msg='invalid option for force (requires yes or no -- default is no)')
if p['package'].count('=') > 1:
if package is None and update_cache != 'yes': module.fail_json(msg='invalid package spec')
fail_json(msg='pkg=name and/or update-cache=yes is required')
if p['state'] == 'latest':
if install_recommends not in ['yes', 'no']: if '=' in package:
fail_json(msg='invalid value for install-recommends (requires yes or no -- default is yes)') module.fail_json(msg='version number inconsistent with state=latest')
install_recommends = (install_recommends == 'yes')
rc, out, err = install(p['package'], cache, upgrade=True,
cache = apt.Cache() default_release=p['default_release'],
if default_release: install_recommends=install_recommends,
apt_pkg.config['APT::Default-Release'] = default_release force=force_yes)
# reopen cache w/ modified config
cache.open(progress=None) elif p['state'] == 'installed':
rc, out, err = install(p['package'], cache, default_release=p['default_release'],
if update_cache == 'yes': install_recommends=install_recommends,force=force_yes)
cache.update() elif p['state'] == 'removed':
cache.open(progress=None) rc, out, err = remove(p['package'], cache, purge == 'yes')
if package == None:
exit_json(changed=False) if rc:
if rc == -1:
if force == 'yes': module.exit_json(changed=False)
force_yes = True else:
else: module.fail_json(msg=err)
force_yes = False else:
module.exit_json(changed=True)
if package.count('=') > 1:
fail_json(msg='invalid package spec') # this is magic, see lib/ansible/module_common.py
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
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()

Loading…
Cancel
Save