Mini Shell

"""
Manage and query Bower packages
===============================

This module manages the installed packages using Bower.
Note that npm, git and bower must be installed for this module to be
available.

"""

import logging
import shlex

import salt.utils.json
import salt.utils.path
from salt.exceptions import CommandExecutionError
from salt.utils.versions import Version

log = logging.getLogger(__name__)

# Function alias to make sure not to shadow built-in's
__func_alias__ = {"list_": "list"}


def __virtual__():
    """
    Only work when Bower is installed
    """
    if salt.utils.path.which("bower") is None:
        return (False, "The bower module could not be loaded: bower command not found")
    return True


def _check_valid_version():
    """
    Check the version of Bower to ensure this module will work. Currently
    bower must be at least version 1.3.
    """
    # pylint: disable=no-member
    bower_version = Version(
        __salt__["cmd.run"]("{} --version".format(salt.utils.path.which("bower")))
    )
    valid_version = Version("1.3")
    # pylint: enable=no-member
    if bower_version < valid_version:
        raise CommandExecutionError(
            "'bower' is not recent enough({} < {}). Please Upgrade.".format(
                bower_version, valid_version
            )
        )


def _construct_bower_command(bower_command):
    """
    Create bower command line string
    """
    if not bower_command:
        raise CommandExecutionError("bower_command, e.g. install, must be specified")

    cmd = [salt.utils.path.which("bower")] + shlex.split(bower_command)
    cmd.extend(
        [
            "--config.analytics",
            "false",
            "--config.interactive",
            "false",
            "--allow-root",
            "--json",
        ]
    )
    return cmd


def install(pkg, dir, pkgs=None, runas=None, env=None):
    """
    Install a Bower package.

    If no package is specified, the dependencies (from bower.json) of the
    package in the given directory will be installed.

    pkg
        A package name in any format accepted by Bower, including a version
        identifier

    dir
        The target directory in which to install the package

    pkgs
        A list of package names in the same format as the ``pkg`` parameter

    runas
        The user to run Bower with

    env
        Environment variables to set when invoking Bower. Uses the same ``env``
        format as the :py:func:`cmd.run <salt.modules.cmdmod.run>` execution
        function.

    CLI Example:

    .. code-block:: bash

        salt '*' bower.install underscore /path/to/project

        salt '*' bower.install jquery#2.0 /path/to/project

    """
    _check_valid_version()

    cmd = _construct_bower_command("install")

    if pkg:
        cmd.append(pkg)
    elif pkgs:
        cmd.extend(pkgs)

    result = __salt__["cmd.run_all"](
        cmd, cwd=dir, runas=runas, env=env, python_shell=False
    )

    if result["retcode"] != 0:
        raise CommandExecutionError(result["stderr"])

    # If package is already installed, Bower will emit empty dict to STDOUT
    stdout = salt.utils.json.loads(result["stdout"])
    return stdout != {}


def uninstall(pkg, dir, runas=None, env=None):
    """
    Uninstall a Bower package.

    pkg
        A package name in any format accepted by Bower

    dir
        The target directory from which to uninstall the package

    runas
        The user to run Bower with

    env
        Environment variables to set when invoking Bower. Uses the same ``env``
        format as the :py:func:`cmd.run <salt.modules.cmdmod.run>` execution
        function.

    CLI Example:

    .. code-block:: bash

        salt '*' bower.uninstall underscore /path/to/project

    """
    _check_valid_version()

    cmd = _construct_bower_command("uninstall")
    cmd.append(pkg)

    result = __salt__["cmd.run_all"](
        cmd, cwd=dir, runas=runas, env=env, python_shell=False
    )

    if result["retcode"] != 0:
        raise CommandExecutionError(result["stderr"])

    # If package is not installed, Bower will emit empty dict to STDOUT
    stdout = salt.utils.json.loads(result["stdout"])
    return stdout != {}


def list_(dir, runas=None, env=None):
    """
    List installed Bower packages.

    dir
        The directory whose packages will be listed

    runas
        The user to run Bower with

    env
        Environment variables to set when invoking Bower. Uses the same ``env``
        format as the :py:func:`cmd.run <salt.modules.cmdmod.run>` execution
        function.

    CLI Example:

    .. code-block:: bash

        salt '*' bower.list /path/to/project

    """
    _check_valid_version()

    cmd = _construct_bower_command("list")
    cmd.append("--offline")

    result = __salt__["cmd.run_all"](
        cmd, cwd=dir, runas=runas, env=env, python_shell=False
    )

    if result["retcode"] != 0:
        raise CommandExecutionError(result["stderr"])

    return salt.utils.json.loads(result["stdout"])["dependencies"]


def prune(dir, runas=None, env=None):
    """
    .. versionadded:: 2017.7.0

    Remove extraneous local Bower packages, i.e. those not referenced in bower.json

    dir
        The directory whose packages will be pruned

    runas
        The user to run Bower with

    env
        Environment variables to set when invoking Bower. Uses the same ``env``
        format as the :py:func:`cmd.run <salt.modules.cmdmod.run>` execution
        function.

    CLI Example:

    .. code-block:: bash

        salt '*' bower.prune /path/to/project

    """
    _check_valid_version()

    cmd = _construct_bower_command("prune")

    result = __salt__["cmd.run_all"](
        cmd, cwd=dir, runas=runas, env=env, python_shell=False
    )

    if result["retcode"] != 0:
        raise CommandExecutionError(result["stderr"])

    # Bower returns an empty dictionary if nothing was pruned
    return salt.utils.json.loads(result["stdout"])