salt/tests/pytests/unit/states/test_jboss7.py

# pylint: disable=unused-argument


import pytest

import salt.states.jboss7 as jboss7
from salt.exceptions import CommandExecutionError
from tests.support.mock import MagicMock, patch


@pytest.fixture
def configure_loader_modules():
    return {
        jboss7: {
            "__salt__": {
                "jboss7.read_datasource": MagicMock(),
                "jboss7.create_datasource": MagicMock(),
                "jboss7.update_datasource": MagicMock(),
                "jboss7.remove_datasource": MagicMock(),
                "jboss7.read_simple_binding": MagicMock(),
                "jboss7.create_simple_binding": MagicMock(),
                "jboss7.update_simple_binding": MagicMock(),
                "jboss7.undeploy": MagicMock(),
                "jboss7.deploy": MagicMock,
                "file.get_managed": MagicMock,
                "file.manage_file": MagicMock,
                "jboss7.list_deployments": MagicMock,
            },
            "__env__": "base",
        }
    }


def test_should_not_redeploy_unchanged():
    # given
    parameters = {
        "target_file": "some_artifact",
        "undeploy_force": False,
        "undeploy": "some_artifact",
        "source": "some_artifact_on_master",
    }
    jboss_conf = {"cli_path": "somewhere", "controller": "some_controller"}

    def list_deployments(jboss_config):
        return ["some_artifact"]

    def file_get_managed(
        name,
        template,
        source,
        source_hash,
        source_hash_name,
        user,
        group,
        mode,
        attrs,
        saltenv,
        context,
        defaults,
        skip_verify,
        kwargs,
    ):
        return "sfn", "hash", ""

    def file_manage_file(
        name,
        sfn,
        ret,
        source,
        source_sum,
        user,
        group,
        mode,
        attrs,
        saltenv,
        backup,
        makedirs,
        template,
        show_diff,
        contents,
        dir_mode,
    ):
        return {"result": True, "changes": False}

    jboss7_undeploy_mock = MagicMock()
    jboss7_deploy_mock = MagicMock()
    file_get_managed = MagicMock(side_effect=file_get_managed)
    file_manage_file = MagicMock(side_effect=file_manage_file)
    list_deployments_mock = MagicMock(side_effect=list_deployments)
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.undeploy": jboss7_undeploy_mock,
            "jboss7.deploy": jboss7_deploy_mock,
            "file.get_managed": file_get_managed,
            "file.manage_file": file_manage_file,
            "jboss7.list_deployments": list_deployments_mock,
        },
    ):
        # when
        result = jboss7.deployed(
            name="unchanged", jboss_config=jboss_conf, salt_source=parameters
        )

        # then
        assert not jboss7_undeploy_mock.called
        assert not jboss7_deploy_mock.called


def test_should_redeploy_changed():
    # given
    parameters = {
        "target_file": "some_artifact",
        "undeploy_force": False,
        "undeploy": "some_artifact",
        "source": "some_artifact_on_master",
    }
    jboss_conf = {"cli_path": "somewhere", "controller": "some_controller"}

    def list_deployments(jboss_config):
        return ["some_artifact"]

    def file_get_managed(
        name,
        template,
        source,
        source_hash,
        source_hash_name,
        user,
        group,
        mode,
        attrs,
        saltenv,
        context,
        defaults,
        skip_verify,
        kwargs,
    ):
        return "sfn", "hash", ""

    def file_manage_file(
        name,
        sfn,
        ret,
        source,
        source_sum,
        user,
        group,
        mode,
        attrs,
        saltenv,
        backup,
        makedirs,
        template,
        show_diff,
        contents,
        dir_mode,
    ):
        return {"result": True, "changes": True}

    jboss7_undeploy_mock = MagicMock()
    jboss7_deploy_mock = MagicMock()
    file_get_managed = MagicMock(side_effect=file_get_managed)
    file_manage_file = MagicMock(side_effect=file_manage_file)
    list_deployments_mock = MagicMock(side_effect=list_deployments)
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.undeploy": jboss7_undeploy_mock,
            "jboss7.deploy": jboss7_deploy_mock,
            "file.get_managed": file_get_managed,
            "file.manage_file": file_manage_file,
            "jboss7.list_deployments": list_deployments_mock,
        },
    ):
        # when
        result = jboss7.deployed(
            name="unchanged", jboss_config=jboss_conf, salt_source=parameters
        )

        # then
        assert jboss7_undeploy_mock.called
        assert jboss7_deploy_mock.called


def test_should_deploy_different_artifact():
    # given
    parameters = {
        "target_file": "some_artifact",
        "undeploy_force": False,
        "undeploy": "some_artifact",
        "source": "some_artifact_on_master",
    }
    jboss_conf = {"cli_path": "somewhere", "controller": "some_controller"}

    def list_deployments(jboss_config):
        return ["some_other_artifact"]

    def file_get_managed(
        name,
        template,
        source,
        source_hash,
        source_hash_name,
        user,
        group,
        mode,
        attrs,
        saltenv,
        context,
        defaults,
        skip_verify,
        kwargs,
    ):
        return "sfn", "hash", ""

    def file_manage_file(
        name,
        sfn,
        ret,
        source,
        source_sum,
        user,
        group,
        mode,
        attrs,
        saltenv,
        backup,
        makedirs,
        template,
        show_diff,
        contents,
        dir_mode,
    ):
        return {"result": True, "changes": False}

    jboss7_undeploy_mock = MagicMock()
    jboss7_deploy_mock = MagicMock()
    file_get_managed = MagicMock(side_effect=file_get_managed)
    file_manage_file = MagicMock(side_effect=file_manage_file)
    list_deployments_mock = MagicMock(side_effect=list_deployments)
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.undeploy": jboss7_undeploy_mock,
            "jboss7.deploy": jboss7_deploy_mock,
            "file.get_managed": file_get_managed,
            "file.manage_file": file_manage_file,
            "jboss7.list_deployments": list_deployments_mock,
        },
    ):
        # when
        result = jboss7.deployed(
            name="unchanged", jboss_config=jboss_conf, salt_source=parameters
        )

        # then
        assert not jboss7_undeploy_mock.called
        assert jboss7_deploy_mock.called


def test_should_redploy_undeploy_force():
    # given
    parameters = {
        "target_file": "some_artifact",
        "undeploy_force": True,
        "undeploy": "some_artifact",
        "source": "some_artifact_on_master",
    }
    jboss_conf = {"cli_path": "somewhere", "controller": "some_controller"}

    def list_deployments(jboss_config):
        return ["some_artifact"]

    def file_get_managed(
        name,
        template,
        source,
        source_hash,
        source_hash_name,
        user,
        group,
        mode,
        attrs,
        saltenv,
        context,
        defaults,
        skip_verify,
        kwargs,
    ):
        return "sfn", "hash", ""

    def file_manage_file(
        name,
        sfn,
        ret,
        source,
        source_sum,
        user,
        group,
        mode,
        attrs,
        saltenv,
        backup,
        makedirs,
        template,
        show_diff,
        contents,
        dir_mode,
    ):
        return {"result": True, "changes": False}

    jboss7_undeploy_mock = MagicMock()
    jboss7_deploy_mock = MagicMock()
    file_get_managed = MagicMock(side_effect=file_get_managed)
    file_manage_file = MagicMock(side_effect=file_manage_file)
    list_deployments_mock = MagicMock(side_effect=list_deployments)
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.undeploy": jboss7_undeploy_mock,
            "jboss7.deploy": jboss7_deploy_mock,
            "file.get_managed": file_get_managed,
            "file.manage_file": file_manage_file,
            "jboss7.list_deployments": list_deployments_mock,
        },
    ):
        # when
        result = jboss7.deployed(
            name="unchanged", jboss_config=jboss_conf, salt_source=parameters
        )

        # then
        assert jboss7_undeploy_mock.called
        assert jboss7_deploy_mock.called


def test_should_create_new_datasource_if_not_exists():
    # given
    datasource_properties = {"connection-url": "jdbc:/old-connection-url"}
    ds_status = {"created": False}

    def read_func(jboss_config, name, profile):
        if ds_status["created"]:
            return {"success": True, "result": datasource_properties}
        else:
            return {"success": False, "err_code": "JBAS014807"}

    def create_func(jboss_config, name, datasource_properties, profile):
        ds_status["created"] = True
        return {"success": True}

    read_mock = MagicMock(side_effect=read_func)
    create_mock = MagicMock(side_effect=create_func)
    update_mock = MagicMock()
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_datasource": read_mock,
            "jboss7.create_datasource": create_mock,
            "jboss7.update_datasource": update_mock,
        },
    ):

        # when
        result = jboss7.datasource_exists(
            name="appDS",
            jboss_config={},
            datasource_properties=datasource_properties,
            profile=None,
        )

        # then
        create_mock.assert_called_with(
            name="appDS",
            jboss_config={},
            datasource_properties=datasource_properties,
            profile=None,
        )

        assert not update_mock.called
        assert result["comment"] == "Datasource created."


def test_should_update_the_datasource_if_exists():
    ds_status = {"updated": False}

    def read_func(jboss_config, name, profile):
        if ds_status["updated"]:
            return {
                "success": True,
                "result": {"connection-url": "jdbc:/new-connection-url"},
            }
        else:
            return {
                "success": True,
                "result": {"connection-url": "jdbc:/old-connection-url"},
            }

    def update_func(jboss_config, name, new_properties, profile):
        ds_status["updated"] = True
        return {"success": True}

    read_mock = MagicMock(side_effect=read_func)
    create_mock = MagicMock()
    update_mock = MagicMock(side_effect=update_func)
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_datasource": read_mock,
            "jboss7.create_datasource": create_mock,
            "jboss7.update_datasource": update_mock,
        },
    ):
        result = jboss7.datasource_exists(
            name="appDS",
            jboss_config={},
            datasource_properties={"connection-url": "jdbc:/new-connection-url"},
            profile=None,
        )

        update_mock.assert_called_with(
            name="appDS",
            jboss_config={},
            new_properties={"connection-url": "jdbc:/new-connection-url"},
            profile=None,
        )
        assert read_mock.called
        assert result["comment"] == "Datasource updated."


def test_should_recreate_the_datasource_if_specified():
    read_mock = MagicMock(
        return_value={
            "success": True,
            "result": {"connection-url": "jdbc:/same-connection-url"},
        }
    )
    create_mock = MagicMock(return_value={"success": True})
    remove_mock = MagicMock(return_value={"success": True})
    update_mock = MagicMock()
    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_datasource": read_mock,
            "jboss7.create_datasource": create_mock,
            "jboss7.remove_datasource": remove_mock,
            "jboss7.update_datasource": update_mock,
        },
    ):
        result = jboss7.datasource_exists(
            name="appDS",
            jboss_config={},
            datasource_properties={"connection-url": "jdbc:/same-connection-url"},
            recreate=True,
        )

        remove_mock.assert_called_with(name="appDS", jboss_config={}, profile=None)
        create_mock.assert_called_with(
            name="appDS",
            jboss_config={},
            datasource_properties={"connection-url": "jdbc:/same-connection-url"},
            profile=None,
        )
        assert result["changes"]["removed"] == "appDS"
        assert result["changes"]["created"] == "appDS"


def test_should_inform_if_the_datasource_has_not_changed():
    read_mock = MagicMock(
        return_value={
            "success": True,
            "result": {"connection-url": "jdbc:/same-connection-url"},
        }
    )
    create_mock = MagicMock()
    remove_mock = MagicMock()
    update_mock = MagicMock(return_value={"success": True})

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_datasource": read_mock,
            "jboss7.create_datasource": create_mock,
            "jboss7.remove_datasource": remove_mock,
            "jboss7.update_datasource": update_mock,
        },
    ):
        result = jboss7.datasource_exists(
            name="appDS",
            jboss_config={},
            datasource_properties={"connection-url": "jdbc:/old-connection-url"},
        )

        update_mock.assert_called_with(
            name="appDS",
            jboss_config={},
            new_properties={"connection-url": "jdbc:/old-connection-url"},
            profile=None,
        )
        assert not create_mock.called
        assert result["comment"] == "Datasource not changed."


def test_should_create_binding_if_not_exists():
    # given
    binding_status = {"created": False}

    def read_func(jboss_config, binding_name, profile):
        if binding_status["created"]:
            return {"success": True, "result": {"value": "DEV"}}
        else:
            return {"success": False, "err_code": "JBAS014807"}

    def create_func(jboss_config, binding_name, value, profile):
        binding_status["created"] = True
        return {"success": True}

    read_mock = MagicMock(side_effect=read_func)
    create_mock = MagicMock(side_effect=create_func)
    update_mock = MagicMock()

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_simple_binding": read_mock,
            "jboss7.create_simple_binding": create_mock,
            "jboss7.update_simple_binding": update_mock,
        },
    ):

        # when
        result = jboss7.bindings_exist(
            name="bindings", jboss_config={}, bindings={"env": "DEV"}, profile=None
        )

        # then
        create_mock.assert_called_with(
            jboss_config={}, binding_name="env", value="DEV", profile=None
        )
        assert update_mock.call_count == 0
        assert result["changes"] == {"added": "env:DEV\n"}
        assert result["comment"] == "Bindings changed."


def test_should_update_bindings_if_exists_and_different():
    # given
    binding_status = {"updated": False}

    def read_func(jboss_config, binding_name, profile):
        if binding_status["updated"]:
            return {"success": True, "result": {"value": "DEV2"}}
        else:
            return {"success": True, "result": {"value": "DEV"}}

    def update_func(jboss_config, binding_name, value, profile):
        binding_status["updated"] = True
        return {"success": True}

    read_mock = MagicMock(side_effect=read_func)
    create_mock = MagicMock()
    update_mock = MagicMock(side_effect=update_func)

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_simple_binding": read_mock,
            "jboss7.create_simple_binding": create_mock,
            "jboss7.update_simple_binding": update_mock,
        },
    ):
        # when
        result = jboss7.bindings_exist(
            name="bindings", jboss_config={}, bindings={"env": "DEV2"}, profile=None
        )

        # then
        update_mock.assert_called_with(
            jboss_config={}, binding_name="env", value="DEV2", profile=None
        )
        assert create_mock.call_count == 0
        assert result["changes"] == {"changed": "env:DEV->DEV2\n"}
        assert result["comment"] == "Bindings changed."


def test_should_not_update_bindings_if_same():
    # given
    read_mock = MagicMock(return_value={"success": True, "result": {"value": "DEV2"}})
    create_mock = MagicMock()
    update_mock = MagicMock()

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_simple_binding": read_mock,
            "jboss7.create_simple_binding": create_mock,
            "jboss7.update_simple_binding": update_mock,
        },
    ):
        # when
        result = jboss7.bindings_exist(
            name="bindings", jboss_config={}, bindings={"env": "DEV2"}
        )

        # then
        assert create_mock.call_count == 0
        assert update_mock.call_count == 0
        assert result["changes"] == {}
        assert result["comment"] == "Bindings not changed."


def test_should_raise_exception_if_cannot_create_binding():
    def read_func(jboss_config, binding_name, profile):
        return {"success": False, "err_code": "JBAS014807"}

    def create_func(jboss_config, binding_name, value, profile):
        return {"success": False, "failure-description": "Incorrect binding name."}

    read_mock = MagicMock(side_effect=read_func)
    create_mock = MagicMock(side_effect=create_func)
    update_mock = MagicMock()

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_simple_binding": read_mock,
            "jboss7.create_simple_binding": create_mock,
            "jboss7.update_simple_binding": update_mock,
        },
    ):
        # when
        with pytest.raises(CommandExecutionError) as exc:
            jboss7.bindings_exist(
                name="bindings",
                jboss_config={},
                bindings={"env": "DEV2"},
                profile=None,
            )
        assert str(exc.value) == "Incorrect binding name."


def test_should_raise_exception_if_cannot_update_binding():
    def read_func(jboss_config, binding_name, profile):
        return {"success": True, "result": {"value": "DEV"}}

    def update_func(jboss_config, binding_name, value, profile):
        return {"success": False, "failure-description": "Incorrect binding name."}

    read_mock = MagicMock(side_effect=read_func)
    create_mock = MagicMock()
    update_mock = MagicMock(side_effect=update_func)

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_simple_binding": read_mock,
            "jboss7.create_simple_binding": create_mock,
            "jboss7.update_simple_binding": update_mock,
        },
    ):

        # when
        with pytest.raises(CommandExecutionError) as exc:
            jboss7.bindings_exist(
                name="bindings",
                jboss_config={},
                bindings={"env": "DEV2"},
                profile=None,
            )
        assert str(exc.value) == "Incorrect binding name."


def test_datasource_exist_create_datasource_good_code():
    jboss_config = {
        "cli_path": "/home/ch44d/Desktop/wildfly-18.0.0.Final/bin/jboss-cli.sh",
        "controller": "127.0.0.1: 9990",
        "cli_user": "user",
        "cli_password": "user",
    }

    datasource_properties = {
        "driver - name": "h2",
        "connection - url": "jdbc:sqlserver://127.0.0.1:1433;DatabaseName=test_s2",
        "jndi - name": (
            "java:/home/ch44d/Desktop/sqljdbc_7.4/enu/mssql-jdbc-7.4.1.jre8.jar"
        ),
        "user - name": "user",
        "password": "user",
        "use - java - context": True,
    }

    read_datasource = MagicMock(
        return_value={"success": False, "err_code": "WFLYCTL0216"}
    )

    error_msg = "Error: -1"
    create_datasource = MagicMock(return_value={"success": False, "stdout": error_msg})

    with patch.dict(
        jboss7.__salt__,
        {
            "jboss7.read_datasource": read_datasource,
            "jboss7.create_datasource": create_datasource,
        },
    ):
        ret = jboss7.datasource_exists("SQL", jboss_config, datasource_properties)

        assert "result" in ret
        assert not ret["result"]
        assert "comment" in ret
        assert error_msg in ret["comment"]

        read_datasource.assert_called_once()
        create_datasource.assert_called_once()


def test_datasource_exist_create_datasource_bad_code():
    jboss_config = {
        "cli_path": "/home/ch44d/Desktop/wildfly-18.0.0.Final/bin/jboss-cli.sh",
        "controller": "127.0.0.1: 9990",
        "cli_user": "user",
        "cli_password": "user",
    }

    datasource_properties = {
        "driver - name": "h2",
        "connection - url": "jdbc:sqlserver://127.0.0.1:1433;DatabaseName=test_s2",
        "jndi - name": (
            "java:/home/ch44d/Desktop/sqljdbc_7.4/enu/mssql-jdbc-7.4.1.jre8.jar"
        ),
        "user - name": "user",
        "password": "user",
        "use - java - context": True,
    }

    read_datasource = MagicMock(
        return_value={
            "success": False,
            "err_code": "WFLYCTL0217",
            "failure-description": "Something happened",
        }
    )

    with patch.dict(jboss7.__salt__, {"jboss7.read_datasource": read_datasource}):
        pytest.raises(
            CommandExecutionError,
            jboss7.datasource_exists,
            "SQL",
            jboss_config,
            datasource_properties,
        )
        read_datasource.assert_called_once()