Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardizing the apt module #695

Merged
merged 3 commits into from Jul 27, 2012
Merged

Standardizing the apt module #695

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c8d949
Standardizing the apt module
Jul 26, 2012
dd9e09d
Adding dict() for json.dumps
Jul 26, 2012
daf4433
Code review changes
Jul 26, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
195 changes: 79 additions & 116 deletions library/apt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,37 +17,15 @@
# 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

# added to stave off future warnings about apt api
import warnings;
warnings.filterwarnings('ignore', "apt API not stable yet", FutureWarning)

# APT related constants
APT_PATH = "/usr/bin/apt-get"
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):
try:
cmd = subprocess.Popen(command, shell=True,
Expand All @@ -72,11 +50,11 @@ def package_split(pkgspec):
else:
return parts[0], None

def package_status(pkgname, version, cache):
def package_status(m, pkgname, version, cache):
try:
pkg = cache[pkgname]
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:
try :
return pkg.is_installed and pkg.installed.version == version, False
Expand All @@ -90,9 +68,9 @@ def package_status(pkgname, version, cache):
#assume older version of python-apt is installed
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)
installed, upgradable = package_status(name, version, cache)
installed, upgradable = package_status(m, name, version, cache)
if not installed or (upgrade and upgradable):
if force:
force_yes = '--force-yes'
Expand All @@ -104,107 +82,92 @@ def install(pkgspec, cache, upgrade=False, default_release=None, install_recomme
cmd += " -t '%s'" % (default_release,)
if not install_recommends:
cmd += " --no-install-recommends"

rc, out, err = run_apt(cmd)
if rc:
fail_json(msg="'apt-get install %s' failed: %s" % (pkgspec, err))
return True
m.fail_json(msg="'apt-get install %s' failed: %s" % (pkgspec, err))
else:
m.exit_json(changed=True)
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)
installed, upgradable = package_status(name, version, cache)
installed, upgradable = package_status(m, name, version, cache)
if not installed:
return False
m.exit_json(changed=False)
else:
purge = '--purge' if purge else ''
cmd = "%s -q -y %s remove '%s'" % (APT, purge, name)
rc, out, err = run_apt(cmd)
if rc:
fail_json(msg="'apt-get remove %s' failed: %s" % (name, err))
return True
m.fail_json(msg="'apt-get remove %s' failed: %s" % (name, err))
m.exit_json(changed=True)


# ===========================================

if not os.path.exists(APT_PATH):
fail_json(msg="Cannot find apt-get")

argfile = sys.argv[1]
args = open(argfile, 'r').read()
items = shlex.split(args)
syslog.openlog('ansible-%s' % os.path.basename(__file__))
syslog.syslog(syslog.LOG_NOTICE, 'Invoked with %s' % args)

if not len(items):
fail_json(msg='the module requires arguments -a')
sys.exit(1)

params = {}
for x in items:
(k, v) = x.split("=", 1)
params[k] = v

state = params.get('state', 'installed')
package = params.get('pkg', params.get('package', params.get('name', None)))
update_cache = params.get('update-cache', 'no')
purge = params.get('purge', 'no')
default_release = params.get('default-release', None)
install_recommends = params.get('install-recommends', 'yes')
force = params.get('force', 'no')

if state not in ['installed', 'latest', 'removed']:
fail_json(msg='invalid state')

if update_cache not in ['yes', 'no']:
fail_json(msg='invalid value for update_cache (requires yes or no -- default is no')

if purge not in ['yes', 'no']:
fail_json(msg='invalid value for purge (requires yes or no -- default is no)')

if force not in ['yes', 'no']:
fail_json(msg='invalid option for force (requires yes or no -- default is no)')

if package is None and update_cache != 'yes':
fail_json(msg='pkg=name and/or update-cache=yes is required')

if install_recommends not in ['yes', 'no']:
fail_json(msg='invalid value for install-recommends (requires yes or no -- default is yes)')
install_recommends = (install_recommends == 'yes')

cache = apt.Cache()
if default_release:
apt_pkg.config['APT::Default-Release'] = default_release
# reopen cache w/ modified config
cache.open(progress=None)

if update_cache == 'yes':
cache.update()
cache.open(progress=None)
if package == None:
exit_json(changed=False)

if force == 'yes':
force_yes = True
else:
force_yes = False

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)
def main():
module = AnsibleModule(
argument_spec = dict(
state = dict(default='installed', choices=['installed', 'latest', 'removed']),
update_cache = dict(default='no', choices=['yes', 'no']),
purge = dict(default='no', choices=['yes', 'no']),
package = dict(default=None, aliases=['pkg', 'name']),
default_release = dict(default=None, aliases=['default-release']),
install_recommends = dict(default='yes', aliases=['install-recommends'], choices=['yes', 'no']),
force = dict(default='no', choices=['yes', 'no'])
)
)

try:
import apt, apt_pkg
except:
module.fail_json("Could not import python modules: apt, apt_pkg. Please install python-apt package.")

if not os.path.exists(APT_PATH):
module.fail_json(msg="Cannot find apt-get")

p = module.params
if p['package'] is None and p['update_cache'] != 'yes':
module.fail_json(msg='pkg=name and/or update-cache=yes is required')

install_recommends = (p['install_recommends'] == 'yes')

cache = apt.Cache()
if p['default_release']:
apt_pkg.config['APT::Default-Release'] = p['default_release']
# reopen cache w/ modified config
cache.open(progress=None)

if p['update_cache'] == 'yes':
cache.update()
cache.open(progress=None)
if p['package'] == None:
module.exit_json(changed=False)

if p['force'] == 'yes':
force_yes = True
else:
force_yes = False

if p['package'].count('=') > 1:
module.fail_json(msg='invalid package spec')

if p['state'] == 'latest':
if '=' in p['package']:
module.fail_json(msg='version number inconsistent with state=latest')
install(module, p['package'], cache, upgrade=True,
default_release=p['default_release'],
install_recommends=install_recommends,
force=force_yes)

elif p['state'] == 'installed':
install(module, p['package'], cache, default_release=p['default_release'],
install_recommends=install_recommends,force=force_yes)
elif p['state'] == 'removed':
remove(module, p['package'], cache, purge == 'yes')

# this is magic, see lib/ansible/module_common.py
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>

main()