From 0e06e8bb7fd46b89252ace750a8e2c2676453459 Mon Sep 17 00:00:00 2001 From: dmtrs Date: Tue, 4 Mar 2014 22:38:29 +0200 Subject: [PATCH] Add module composer (php dependency manager) --- library/packaging/composer | 153 +++++++++++++++++++++++++++++++++++++ 1 file changed, 153 insertions(+) create mode 100644 library/packaging/composer diff --git a/library/packaging/composer b/library/packaging/composer new file mode 100644 index 0000000000..9220ed16bc --- /dev/null +++ b/library/packaging/composer @@ -0,0 +1,153 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2014, Dimitrios Tydeas Mengidis + +# 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: composer +author: Dimitrios Tydeas Mengidis +short_description: Dependency Manager for PHP +version_added: "1.4" +description: + - Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you +options: + working_dir: + description: + - Directory of your project ( see --working-dir ) + required: true + default: null + aliases: [ "working-dir" ] + prefer_source: + description: + - Forces installation from package sources when possible ( see --prefer-source ) + required: false + default: "no" + choices: [ "yes", "no" ] + aliases: [ "prefer-source" ] + prefer_dist: + description: + - Forces installation from package dist even for de versions ( see --prefer-dist ) + required: false + default: "no" + choices: [ "yes", "no" ] + aliases: [ "prefer-dist" ] + no_dev: + description: + - Disables installation of require-dev packages ( see --no-dev ) + required: false + default: "yes" + choices: [ "yes", "no" ] + aliases: [ "no-dev" ] + no_scripts: + description: + - Skips the execution of all scripts defined in composer.json ( see --no-scripts ) + required: false + default: "no" + choices: [ "yes", "no" ] + aliases: [ "no-scripts" ] + no_plugins: + description: + - Disables all plugins ( see --no-plugins ) + required: false + default: "no" + choices: [ "yes", "no" ] + aliases: [ "no-plugins" ] + optimize_autoloader: + description: + - Optimize autoloader during autoloader dump ( see --optimize-autoloader ). Convert PSR-0/4 autoloading to classmap to get a faster autoloader. This is recommended especially for production, but can take a bit of time to run so it is currently not done by default. + required: false + default: "yes" + choices: [ "yes", "no" ] + aliases: [ "optimize-autoloader" ] +requirements: + - php + - composer installed in bin path (recommended /usr/local/bin) +notes: + - Default options that are always appended in each execution are --no-ansi, --no-progress, and --no-interaction +''' + +EXAMPLES = ''' +# Downloads and installs all the libs and dependencies outlined in the /path/to/project/composer.lock +- composer: command=install working_dir=/path/to/project +''' + +import os +import re + +def parse_out(string): + return re.sub("\s+", " ", string).strip() + +def has_changed(string): + return (re.match("Nothing to install or update", string) != None) + +def composer_install(module, options): + php_path = module.get_bin_path("php", True, ["/usr/local/bin"]) + composer_path = module.get_bin_path("composer", True, ["/usr/local/bin"]) + cmd = "%s %s install %s" % (php_path, composer_path, " ".join(options)) + + return module.run_command(cmd) + +def main(): + module = AnsibleModule( + argument_spec = dict( + working_dir = dict(aliases=["working-dir"], required=True), + prefer_source = dict(default="no", type="bool", aliases=["prefer-source"]), + prefer_dist = dict(default="no", type="bool", aliases=["prefer-dist"]), + no_dev = dict(default="yes", type="bool", aliases=["no-dev"]), + no_scripts = dict(default="no", type="bool", aliases=["no-scripts"]), + no_plugins = dict(default="no", type="bool", aliases=["no-plugins"]), + optimize_autoloader = dict(default="yes", type="bool", aliases=["optimize-autoloader"]), + ), + supports_check_mode=True + ) + + module.params["working_dir"] = os.path.abspath(module.params["working_dir"]) + + options = set([]) + # Default options + options.add("--no-ansi") + options.add("--no-progress") + options.add("--no-interaction") + + if module.check_mode: + options.add("--dry-run") + + # Prepare options + for i in module.params: + opt = "--%s" % i.replace("_","-") + p = module.params[i] + if isinstance(p, (bool)) and p: + options.add(opt) + elif isinstance(p, (str)): + options.add("%s=%s" % (opt, p)) + + rc, out, err = composer_install(module, options) + + if rc != 0: + output = parse_out(err) + module.fail_json(msg=output) + else: + output = parse_out(out) + module.exit_json(changed=has_changed(output), msg=output) + +# import module snippets +from ansible.module_utils.basic import * + +main()