salt/tests/unit/grains/test_iscsi.py

# -*- coding: utf-8 -*-
"""
    :codeauthor: :email:`Shane Lee <slee@saltstack.com>`
"""
# Import Python libs
from __future__ import absolute_import, print_function, unicode_literals

import errno
import textwrap

# Import Salt Libs
import salt.grains.iscsi as iscsi
from tests.support.mock import MagicMock, mock_open, patch

# Import Salt Testing Libs
from tests.support.unit import TestCase


class IscsiGrainsTestCase(TestCase):
    """
    Test cases for iscsi grains
    """

    def test_windows_iscsi_iqn_grains(self):
        cmd_run_mock = MagicMock(
            return_value={
                "stdout": "iSCSINodeName\n" "iqn.1991-05.com.microsoft:simon-x1\n"
            }
        )
        _grains = {}
        with patch("salt.utils.path.which", MagicMock(return_value=True)):
            with patch("salt.modules.cmdmod.run_all", cmd_run_mock):
                _grains["iscsi_iqn"] = iscsi._windows_iqn()

        self.assertEqual(
            _grains.get("iscsi_iqn"), ["iqn.1991-05.com.microsoft:simon-x1"]
        )

    def test_aix_iscsi_iqn_grains(self):
        cmd_run_mock = MagicMock(
            return_value="initiator_name iqn.localhost.hostid.7f000001"
        )

        _grains = {}
        with patch("salt.modules.cmdmod.run", cmd_run_mock):
            _grains["iscsi_iqn"] = iscsi._aix_iqn()

        self.assertEqual(_grains.get("iscsi_iqn"), ["iqn.localhost.hostid.7f000001"])

    def test_linux_iscsi_iqn_grains(self):
        _iscsi_file = textwrap.dedent(
            """\
            ## DO NOT EDIT OR REMOVE THIS FILE!
            ## If you remove this file, the iSCSI daemon will not start.
            ## If you change the InitiatorName, existing access control lists
            ## may reject this initiator.  The InitiatorName must be unique
            ## for each iSCSI initiator.  Do NOT duplicate iSCSI InitiatorNames.
            InitiatorName=iqn.1993-08.org.debian:01:d12f7aba36
            """
        )

        with patch("salt.utils.files.fopen", mock_open(read_data=_iscsi_file)):
            iqn = iscsi._linux_iqn()

        assert isinstance(iqn, list)
        assert len(iqn) == 1
        assert iqn == ["iqn.1993-08.org.debian:01:d12f7aba36"]

    @patch(
        "salt.utils.files.fopen",
        MagicMock(
            side_effect=IOError(errno.EPERM, "The cables are not the same length.")
        ),
    )
    @patch("salt.grains.iscsi.log", MagicMock())
    def test_linux_iqn_non_root(self):
        """
        Test if linux_iqn is running on salt-master as non-root
        and handling access denial properly.
        :return:
        """
        assert iscsi._linux_iqn() == []
        iscsi.log.debug.assert_called()
        assert "Error while accessing" in iscsi.log.debug.call_args[0][0]
        assert "cables are not the same" in iscsi.log.debug.call_args[0][2].strerror
        assert iscsi.log.debug.call_args[0][2].errno == errno.EPERM
        assert iscsi.log.debug.call_args[0][1] == "/etc/iscsi/initiatorname.iscsi"

    @patch("salt.utils.files.fopen", MagicMock(side_effect=IOError(errno.ENOENT, "")))
    @patch("salt.grains.iscsi.log", MagicMock())
    def test_linux_iqn_no_iscsii_initiator(self):
        """
        Test if linux_iqn is running on salt-master as root.
        iscsii initiator is not there accessible or is not supported.
        :return:
        """
        assert iscsi._linux_iqn() == []
        iscsi.log.debug.assert_not_called()