salt/tests/unit/states/test_composer.py

# -*- coding: utf-8 -*-
"""
    :codeauthor: Jayesh Kariya <jayeshk@saltstack.com>
"""
# Import Python libs
from __future__ import absolute_import, print_function, unicode_literals

# Import Salt Libs
import salt.states.composer as composer
from salt.exceptions import SaltException

# Import Salt Testing Libs
from tests.support.mixins import LoaderModuleMockMixin
from tests.support.mock import MagicMock, patch
from tests.support.unit import TestCase


class ComposerTestCase(TestCase, LoaderModuleMockMixin):
    """
    Test cases for salt.states.composer
    """

    def setup_loader_modules(self):
        return {composer: {}}

    # 'installed' function tests: 1

    def test_installed(self):
        """
        Test to verify that the correct versions of composer
        dependencies are present.
        """
        name = "CURL"

        ret = {"name": name, "result": True, "comment": "", "changes": {}}

        mock = MagicMock(return_value=True)
        with patch.dict(composer.__salt__, {"composer.did_composer_install": mock}):
            comt = "Composer already installed this directory"
            ret.update({"comment": comt})
            self.assertDictEqual(composer.installed(name, always_check=False), ret)

            with patch.dict(composer.__opts__, {"test": True}):
                comt = 'The state of "CURL" will be changed.'
                changes = {
                    "new": "composer install will be run in CURL",
                    "old": "composer install has been run in CURL",
                }
                ret.update({"comment": comt, "result": None, "changes": changes})
                self.assertDictEqual(composer.installed(name), ret)

            with patch.dict(composer.__opts__, {"test": False}):
                mock = MagicMock(side_effect=[SaltException, {}])
                with patch.dict(composer.__salt__, {"composer.install": mock}):
                    comt = "Error executing composer in " "'CURL': "
                    ret.update({"comment": comt, "result": False, "changes": {}})
                    self.assertDictEqual(composer.installed(name), ret)

                    comt = (
                        "Composer install completed successfully,"
                        " output silenced by quiet flag"
                    )
                    ret.update({"comment": comt, "result": True})
                    self.assertDictEqual(composer.installed(name, quiet=True), ret)

    # 'update' function tests: 1

    def test_update(self):
        """
        Test to composer update the directory to ensure we have
        the latest versions of all project dependencies.
        """
        name = "CURL"

        ret = {"name": name, "result": True, "comment": "", "changes": {}}

        changes = {
            "new": "composer install/update will be run in CURL",
            "old": "composer install has not yet been run in CURL",
        }

        mock = MagicMock(return_value=True)
        with patch.dict(composer.__salt__, {"composer.did_composer_install": mock}):
            with patch.dict(composer.__opts__, {"test": True}):
                comt = 'The state of "CURL" will be changed.'
                ret.update({"comment": comt, "result": None, "changes": changes})
                self.assertDictEqual(composer.update(name), ret)

            with patch.dict(composer.__opts__, {"test": False}):
                mock = MagicMock(side_effect=[SaltException, {}])
                with patch.dict(composer.__salt__, {"composer.update": mock}):
                    comt = "Error executing composer in " "'CURL': "
                    ret.update({"comment": comt, "result": False, "changes": {}})
                    self.assertDictEqual(composer.update(name), ret)

                    comt = (
                        "Composer update completed successfully,"
                        " output silenced by quiet flag"
                    )
                    ret.update({"comment": comt, "result": True})
                    self.assertDictEqual(composer.update(name, quiet=True), ret)