Merge branch 'module-cpanm' of git://github.com/franckcuny/ansible into franckcuny-module-cpanm

library/cpanm

+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2012, Franck Cuny <franck@lumberjaph.net>
+#
+# 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: cpanm
+short_description: Manages Perl library dependencies.
+description:
+  - Manage Perl library dependencies.
+version_added: "1.0"
+options:
+  name:
+    description:
+      - The name of the Perl library to install
+    required: false
+    default: null
+    aliases: ["pkg"]
+  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
+  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.
+   - 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).
+   - 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)
+    stdout, stderr = process.communicate()
+    return (process.returncode, stdout, stderr)
+
+
+def main():
+    arg_spec = dict(
+        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),
+        mirror=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.boolean(module.params.get('notest', False))
+    locallib = module.params['locallib']
+
+    changed = False
+
+    installed = _is_package_installed(name, locallib, cpanm)
+
+    if not installed:
+        out_cpanm = err_cpanm = ''
+        cmd = _build_cmd_line(name, from_path, notest, locallib, mirror, cpanm)
+
+        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
+#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
+main()