ansible/library/packaging/gem

239 lines
7.3 KiB
Text
Raw Normal View History

2013-02-27 12:28:07 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2013, Johan Wiren <johan.wiren.se@gmail.com>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
DOCUMENTATION = '''
---
module: gem
short_description: Manage Ruby gems
description:
2013-02-27 12:28:07 +01:00
- Manage installation and uninstallation of Ruby gems.
version_added: "1.1"
options:
name:
description:
- The name of the gem to be managed.
2013-02-27 12:28:07 +01:00
required: true
state:
description:
- The desired state of the gem. C(latest) ensures that the latest version is installed.
required: false
2013-02-27 12:28:07 +01:00
choices: [present, absent, latest]
default: present
gem_source:
description:
- The path to a local gem used as installation source.
2013-02-27 12:28:07 +01:00
required: false
include_dependencies:
description:
2014-08-03 14:52:24 +02:00
- Whether to include dependencies or not.
2013-02-27 12:28:07 +01:00
required: false
choices: [ "yes", "no" ]
default: "yes"
2013-02-27 12:28:07 +01:00
repository:
description:
- The repository from which the gem will be installed
2013-02-27 12:28:07 +01:00
required: false
aliases: [source]
user_install:
description:
- Install gem in user's local gems cache or for all users
required: false
default: "yes"
version_added: "1.3"
executable:
description:
- Override the path to the gem executable
required: false
version_added: "1.4"
2013-02-27 12:28:07 +01:00
version:
description:
- Version of the gem to be installed/removed.
2013-02-27 12:28:07 +01:00
required: false
2014-03-28 18:08:46 +01:00
pre_release:
2013-12-18 20:34:08 +01:00
description:
2014-03-28 18:08:46 +01:00
- Allow installation of pre-release versions of the gem.
2013-12-18 20:34:08 +01:00
required: false
default: "no"
version_added: "1.6"
2013-02-27 12:28:07 +01:00
author: Johan Wiren
'''
EXAMPLES = '''
# Installs version 1.0 of vagrant.
- gem: name=vagrant version=1.0 state=present
# Installs latest available version of rake.
- gem: name=rake state=latest
# Installs rake version 1.0 from a local gem on disk.
- gem: name=rake gem_source=/path/to/gems/rake-1.0.gem state=present
'''
2013-02-27 12:28:07 +01:00
import re
def get_rubygems_path(module):
if module.params['executable']:
return module.params['executable'].split(' ')
else:
return [ module.get_bin_path('gem', True) ]
def get_rubygems_version(module):
cmd = get_rubygems_path(module) + [ '--version' ]
(rc, out, err) = module.run_command(cmd, check_rc=True)
match = re.match(r'^(\d+)\.(\d+)\.(\d+)', out)
if not match:
return None
return tuple(int(x) for x in match.groups())
def get_installed_versions(module, remote=False):
cmd = get_rubygems_path(module)
2013-02-27 12:28:07 +01:00
cmd.append('query')
if remote:
cmd.append('--remote')
if module.params['repository']:
cmd.extend([ '--source', module.params['repository'] ])
cmd.append('-n')
cmd.append('^%s$' % module.params['name'])
(rc, out, err) = module.run_command(cmd, check_rc=True)
installed_versions = []
2013-02-27 12:28:07 +01:00
for line in out.splitlines():
match = re.match(r"\S+\s+\((.+)\)", line)
if match:
versions = match.group(1)
for version in versions.split(', '):
installed_versions.append(version.split()[0])
return installed_versions
2013-02-27 12:28:07 +01:00
def exists(module):
2013-02-27 12:28:07 +01:00
if module.params['state'] == 'latest':
remoteversions = get_installed_versions(module, remote=True)
2013-02-27 12:28:07 +01:00
if remoteversions:
module.params['version'] = remoteversions[0]
installed_versions = get_installed_versions(module)
2013-02-27 12:28:07 +01:00
if module.params['version']:
if module.params['version'] in installed_versions:
2013-02-27 12:28:07 +01:00
return True
else:
if installed_versions:
2013-02-27 12:28:07 +01:00
return True
return False
def uninstall(module):
2013-02-27 12:28:07 +01:00
if module.check_mode:
return
cmd = get_rubygems_path(module)
2013-02-27 12:28:07 +01:00
cmd.append('uninstall')
if module.params['version']:
cmd.extend([ '--version', module.params['version'] ])
else:
cmd.append('--all')
cmd.append('--executable')
2013-02-27 12:28:07 +01:00
cmd.append(module.params['name'])
module.run_command(cmd, check_rc=True)
def install(module):
2013-02-27 12:28:07 +01:00
if module.check_mode:
return
ver = get_rubygems_version(module)
if ver:
major = ver[0]
else:
major = None
cmd = get_rubygems_path(module)
2013-02-27 12:28:07 +01:00
cmd.append('install')
if module.params['version']:
cmd.extend([ '--version', module.params['version'] ])
if module.params['repository']:
cmd.extend([ '--source', module.params['repository'] ])
if not module.params['include_dependencies']:
cmd.append('--ignore-dependencies')
else:
if major and major < 2:
cmd.append('--include-dependencies')
if module.params['user_install']:
cmd.append('--user-install')
else:
cmd.append('--no-user-install')
2014-03-28 18:08:46 +01:00
if module.params['pre_release']:
2013-12-18 20:34:08 +01:00
cmd.append('--pre')
2013-02-27 12:28:07 +01:00
cmd.append('--no-rdoc')
cmd.append('--no-ri')
cmd.append(module.params['gem_source'])
2013-02-27 12:28:07 +01:00
module.run_command(cmd, check_rc=True)
def main():
2013-02-27 12:28:07 +01:00
module = AnsibleModule(
argument_spec = dict(
executable = dict(required=False, type='str'),
gem_source = dict(required=False, type='str'),
include_dependencies = dict(required=False, default=True, type='bool'),
name = dict(required=True, type='str'),
repository = dict(required=False, aliases=['source'], type='str'),
state = dict(required=False, default='present', choices=['present','absent','latest'], type='str'),
user_install = dict(required=False, default=True, type='bool'),
2014-03-28 18:08:46 +01:00
pre_release = dict(required=False, default=False, type='bool'),
version = dict(required=False, type='str'),
),
2013-02-27 12:28:07 +01:00
supports_check_mode = True,
mutually_exclusive = [ ['gem_source','repository'], ['gem_source','version'] ],
)
2013-02-27 12:28:07 +01:00
if module.params['version'] and module.params['state'] == 'latest':
module.fail_json(msg="Cannot specify version when state=latest")
if module.params['gem_source'] and module.params['state'] == 'latest':
2013-02-27 12:28:07 +01:00
module.fail_json(msg="Cannot maintain state=latest when installing from local source")
2013-03-07 01:58:57 +01:00
if not module.params['gem_source']:
module.params['gem_source'] = module.params['name']
2013-02-27 12:28:07 +01:00
changed = False
if module.params['state'] in [ 'present', 'latest']:
2013-02-27 12:28:07 +01:00
if not exists(module):
install(module)
changed = True
elif module.params['state'] == 'absent':
if exists(module):
uninstall(module)
changed = True
result = {}
result['name'] = module.params['name']
result['state'] = module.params['state']
if module.params['version']:
result['version'] = module.params['version']
result['changed'] = changed
module.exit_json(**result)
# import module snippets
from ansible.module_utils.basic import *
2013-02-27 12:28:07 +01:00
main()