From 22766906b036cc211447cc4d4c4d0ad64283edc4 Mon Sep 17 00:00:00 2001 From: Franck Cuny Date: Tue, 27 Nov 2012 14:49:09 -0800 Subject: [PATCH 1/3] Simple module to install Perl libraries via cpanm. cpanm is a popular alternative to the CPAN client for installing Perl libraries. Unfortunately it can't uninstall already installed module, so it can't handle states. --- library/cpanm | 118 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 library/cpanm diff --git a/library/cpanm b/library/cpanm new file mode 100644 index 0000000000..3316ac09e9 --- /dev/null +++ b/library/cpanm @@ -0,0 +1,118 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2012, Franck Cuny +# +# 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 . +# + +DOCUMENTATION = ''' +--- +module: cpanm +short_description: Manages Perl library dependencies. +description: + - Manage Perl library dependencies. +options: + name: + description: + - The name of the Perl library to install + required: false + default: null + from_path: + description: + - The local directory from where to install + required: false + default: null + notest: + description: + - Do not run unit tests + required: false + default: false + locallib: + description: + - Specify the install base to install modules + required: false + default: false +examples: + - code: "cpanm: name=Dancer" + description: Install I(Dancer) perl package. + - code: "cpanm: name=Dancer locallib=/srv/webapps/my_app/extlib" + description: "Install I(Dancer) (U(http://perldancer.org/)) into the specified I(locallib)" + - code: "cpanm: from_path=/srv/webapps/my_app/src/" + description: Install perl dependencies from local directory. + - code: "cpanm: name=Dancer notest=True locallib=/srv/webapps/my_app/extlib" + description: Install I(Dancer) perl package without running the unit tests in indicated I(locallib). +notes: + - Please note that U(http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm) must be installed on the remote host. +author: Franck Cuny +''' + +def _run(cmd): + process = subprocess.Popen(cmd, stdout=subprocess.PIPE, + stderr=subprocess.PIPE, shell=True) + stdout, stderr = process.communicate() + return (process.returncode, stdout, stderr) + + +def main(): + arg_spec = dict( + name=dict(default=None, required=False), + from_path=dict(default=None, required=False), + notest=dict(default=False, required=False), + locallib=dict(default=None, required=False), + ) + + module = AnsibleModule( + argument_spec=arg_spec, + required_one_of=[['name', 'from_path']], + ) + + cpanm = module.get_bin_path('cpanm', True) + + name = module.params['name'] + from_path = module.params['from_path'] + notest = module.params['notest'] + locallib = module.params['locallib'] + + changed = False + out_cpanm = '' + err_cpanm = '' + + if from_path: + cmd = "{cpanm} {path}".format(cpanm=cpanm, path=from_path) + else: + cmd = "{cpanm} {name}".format(cpanm=cpanm, name=name) + + if notest is True: + cmd = "{cmd} -n".format(cmd=cmd) + + if locallib is not None: + cmd = "{cmd} -l {locallib}".format(cmd=cmd, locallib=locallib) + + rc_cpanm, out_cpanm, err_cpanm = _run(cmd) + + if rc_cpanm != 0: + module.fail_json(msg=err_cpanm, cmd=cmd) + + if err_cpanm and 'is up to date' not in err_cpanm: + changed = True + + module.exit_json(changed=changed, binary=cpanm, name=name) + + +# include magic from lib/ansible/module_common.py +#<> +main() From c0729716c86df423e5ad918b42cb735bc866371b Mon Sep 17 00:00:00 2001 From: Franck Cuny Date: Wed, 28 Nov 2012 09:47:20 -0800 Subject: [PATCH 2/3] Add the `mirror` option and verify if a package is already installed. By default, the cpanm client will use a default mirror to download libraries, but it's possible for the end user to pass a different URL. Since ansible favorite idempotence when possible, we verify if the module is already installed before running the cpanm client. Another minor additional change, the `notest` option is now a boolean. --- library/cpanm | 66 +++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 48 insertions(+), 18 deletions(-) diff --git a/library/cpanm b/library/cpanm index 3316ac09e9..7927404636 100644 --- a/library/cpanm +++ b/library/cpanm @@ -25,6 +25,7 @@ module: cpanm short_description: Manages Perl library dependencies. description: - Manage Perl library dependencies. +version_added: "1.0" options: name: description: @@ -46,6 +47,11 @@ options: - Specify the install base to install modules required: false default: false + mirror: + description: + - Specifies the base URL for the CPAN mirror to use + required: false + default: false examples: - code: "cpanm: name=Dancer" description: Install I(Dancer) perl package. @@ -55,11 +61,41 @@ examples: description: Install perl dependencies from local directory. - code: "cpanm: name=Dancer notest=True locallib=/srv/webapps/my_app/extlib" description: Install I(Dancer) perl package without running the unit tests in indicated I(locallib). + - code: "cpanm: name=Dancer mirror=http://cpan.cpantesters.org/" + description: Install I(Dancer) perl package from a specific mirror notes: - Please note that U(http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm) must be installed on the remote host. author: Franck Cuny ''' +def _is_package_installed(name, locallib, cpanm): + cmd = "" + if locallib: + cmd = "PERL5LIB={locallib}/lib/perl5".format(locallib=locallib) + cmd = "{cmd} perl -M{name} -e '1'".format(cmd=cmd, name=name) + res, stdout, stderr = _run(cmd) + installed = True if res == 0 else False + return installed + + +def _build_cmd_line(name, from_path, notest, locallib, mirror, cpanm): + if from_path: + cmd = "{cpanm} {path}".format(cpanm=cpanm, path=from_path) + else: + cmd = "{cpanm} {name}".format(cpanm=cpanm, name=name) + + if notest is True: + cmd = "{cmd} -n".format(cmd=cmd) + + if locallib is not None: + cmd = "{cmd} -l {locallib}".format(cmd=cmd, locallib=locallib) + + if mirror is not None: + cmd = "{cmd} --mirror {mirror}".format(cmd=cmd, mirror=mirror) + + return cmd + + def _run(cmd): process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True) @@ -71,8 +107,9 @@ def main(): arg_spec = dict( name=dict(default=None, required=False), from_path=dict(default=None, required=False), - notest=dict(default=False, required=False), + notest=dict(default=False, choices=BOOLEANS), locallib=dict(default=None, required=False), + mirror=dict(default=None, required=False) ) module = AnsibleModule( @@ -84,31 +121,24 @@ def main(): name = module.params['name'] from_path = module.params['from_path'] - notest = module.params['notest'] + notest = module.boolean(module.params.get('notest', False)) locallib = module.params['locallib'] changed = False - out_cpanm = '' - err_cpanm = '' - if from_path: - cmd = "{cpanm} {path}".format(cpanm=cpanm, path=from_path) - else: - cmd = "{cpanm} {name}".format(cpanm=cpanm, name=name) + installed = _is_package_installed(name, locallib, cpanm) - if notest is True: - cmd = "{cmd} -n".format(cmd=cmd) + if not installed: + out_cpanm = err_cpanm = '' + cmd = _build_cmd_line(name, from_path, notest, locallib, mirror, cpanm) - if locallib is not None: - cmd = "{cmd} -l {locallib}".format(cmd=cmd, locallib=locallib) + rc_cpanm, out_cpanm, err_cpanm = _run(cmd) - rc_cpanm, out_cpanm, err_cpanm = _run(cmd) + if rc_cpanm != 0: + module.fail_json(msg=err_cpanm, cmd=cmd) - if rc_cpanm != 0: - module.fail_json(msg=err_cpanm, cmd=cmd) - - if err_cpanm and 'is up to date' not in err_cpanm: - changed = True + if err_cpanm and 'is up to date' not in err_cpanm: + changed = True module.exit_json(changed=changed, binary=cpanm, name=name) From 3603676ca0e922b81a7b28281a6f6aa1e5790c4f Mon Sep 17 00:00:00 2001 From: Franck Cuny Date: Wed, 28 Nov 2012 16:04:10 -0800 Subject: [PATCH 3/3] Alias name to pkg. --- library/cpanm | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/library/cpanm b/library/cpanm index 7927404636..ff52406df0 100644 --- a/library/cpanm +++ b/library/cpanm @@ -32,6 +32,7 @@ options: - The name of the Perl library to install required: false default: null + aliases: ["pkg"] from_path: description: - The local directory from where to install @@ -105,7 +106,7 @@ def _run(cmd): def main(): arg_spec = dict( - name=dict(default=None, required=False), + name=dict(default=None, required=False, aliases=['pkg']), from_path=dict(default=None, required=False), notest=dict(default=False, choices=BOOLEANS), locallib=dict(default=None, required=False),