test_mount.py

import os

import pytest

import salt.states.mount as mount
from tests.support.mock import MagicMock, patch


@pytest.fixture
def configure_loader_modules():
    return {mount: {}}


def test_mounted():
    """
    Test to verify that a device is mounted.
    """
    name = os.path.realpath("/mnt/sdb")
    device = os.path.realpath("/dev/sdb5")
    fstype = "xfs"

    name2 = os.path.realpath("/mnt/cifs")
    device2 = "//SERVER/SHARE/"
    fstype2 = "cifs"
    opts2 = ["noowners"]
    superopts2 = ["uid=510", "gid=100", "username=cifsuser", "domain=cifsdomain"]

    name3 = os.path.realpath("/mnt/jfs2")
    device3 = "/dev/hd1"
    fstype3 = "jfs2"
    opts3 = [""]
    superopts3 = ["uid=510", "gid=100", "username=jfs2user", "domain=jfs2sdomain"]

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

    mock = MagicMock(
        side_effect=["new", "present", "present", "new", "change", "bad config", "salt"]
    )
    mock_t = MagicMock(return_value=True)
    mock_f = MagicMock(return_value=False)
    mock_ret = MagicMock(return_value={"retcode": 1})
    mock_mnt = MagicMock(
        return_value={
            name: {"device": device, "opts": [], "superopts": []},
            name2: {"device": device2, "opts": opts2, "superopts": superopts2},
            name3: {"device": device3, "opts": opts3, "superopts": superopts3},
        }
    )
    mock_aixfs_retn = MagicMock(return_value="present")

    mock_emt = MagicMock(return_value={})
    mock_str = MagicMock(return_value="salt")
    mock_user = MagicMock(return_value={"uid": 510})
    mock_group = MagicMock(return_value={"gid": 100})
    mock_read_cache = MagicMock(return_value={})
    mock_write_cache = MagicMock(return_value=True)
    with patch.dict(mount.__grains__, {"os": "Darwin"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.active": mock_mnt,
                "cmd.run_all": mock_ret,
                "mount.umount": mock_f,
            },
        ), patch("os.path.exists", MagicMock(return_value=True)):
            comt = "Unable to find device with label /dev/sdb5."
            ret.update({"comment": comt})
            assert mount.mounted(name, "LABEL=/dev/sdb5", fstype) == ret

            with patch.dict(mount.__opts__, {"test": True}):
                comt = "Remount would be forced because options (noowners) changed"
                ret.update({"comment": comt, "result": None})
                assert mount.mounted(name, device, fstype) == ret

            with patch.dict(mount.__opts__, {"test": False}):
                comt = f"Unable to unmount {name}: False."
                umount = "Forced a lazy unmount and mount because the previous unmount failed and because the options (noowners) changed"
                ret.update(
                    {
                        "comment": comt,
                        "result": False,
                        "changes": {"umount": umount},
                    }
                )
                assert mount.mounted(name, device, "nfs") == ret

                umount1 = (
                    "Forced unmount because devices don't match. "
                    "Wanted: {0}, current: {1}, {1}".format(
                        os.path.realpath("/dev/sdb6"), device
                    )
                )
                comt = "Unable to unmount"
                ret.update(
                    {
                        "comment": comt,
                        "result": False,
                        "changes": {"umount": umount1},
                    }
                )
                assert (
                    mount.mounted(name, os.path.realpath("/dev/sdb6"), fstype, opts=[])
                    == ret
                )

            with patch.dict(
                mount.__salt__,
                {
                    "mount.active": mock_emt,
                    "mount.mount": mock_str,
                    "mount.set_automaster": mock,
                },
            ):
                with patch.dict(mount.__opts__, {"test": True}), patch(
                    "os.path.exists", MagicMock(return_value=False)
                ):
                    comt = f"{name} does not exist and would not be created"
                    ret.update({"comment": comt, "changes": {}, "result": None})
                    assert mount.mounted(name, device, fstype) == ret

                with patch.dict(mount.__opts__, {"test": False}):
                    with patch.object(os.path, "exists", mock_f):
                        comt = "Mount directory is not present"
                        ret.update({"comment": comt, "result": False})
                        assert mount.mounted(name, device, fstype) == ret

                    with patch.object(os.path, "exists", mock_t):
                        comt = "Mount directory is not present"
                        ret.update({"comment": "salt", "result": False})
                        assert mount.mounted(name, device, fstype) == ret

                with patch.dict(mount.__opts__, {"test": True}), patch(
                    "os.path.exists", MagicMock(return_value=False)
                ):
                    comt = (
                        "{0} does not exist and would neither be created nor"
                        " mounted. {0} needs to be written to the fstab in order to"
                        " be made persistent.".format(name)
                    )
                    ret.update({"comment": comt, "result": None})
                    assert mount.mounted(name, device, fstype, mount=False) == ret

                with patch.dict(mount.__opts__, {"test": True}), patch(
                    "os.path.exists", MagicMock(return_value=True)
                ):
                    comt = "{} would not be mounted. Entry already exists in the fstab.".format(
                        name
                    )
                    ret.update({"comment": comt, "result": True})
                    assert mount.mounted(name, device, fstype, mount=False) == ret

                with patch.dict(mount.__opts__, {"test": False}), patch(
                    "os.path.exists", MagicMock(return_value=False)
                ):
                    comt = (
                        "{} not present and not mounted. "
                        "Entry already exists in the fstab.".format(name)
                    )
                    ret.update({"comment": comt, "result": True})
                    assert mount.mounted(name, device, fstype, mount=False) == ret

                    comt = (
                        "{} not present and not mounted. "
                        "Added new entry to the fstab.".format(name)
                    )
                    ret.update(
                        {
                            "comment": comt,
                            "result": True,
                            "changes": {"persist": "new"},
                        }
                    )
                    assert mount.mounted(name, device, fstype, mount=False) == ret

                    comt = (
                        "{} not present and not mounted. "
                        "Updated the entry in the fstab.".format(name)
                    )
                    ret.update(
                        {
                            "comment": comt,
                            "result": True,
                            "changes": {"persist": "update"},
                        }
                    )
                    assert mount.mounted(name, device, fstype, mount=False) == ret

                    comt = (
                        "{} not present and not mounted. "
                        "However, the fstab was not found.".format(name)
                    )
                    ret.update({"comment": comt, "result": False, "changes": {}})
                    assert mount.mounted(name, device, fstype, mount=False) == ret

                    comt = f"{name} not present and not mounted"
                    ret.update({"comment": comt, "result": True, "changes": {}})
                    assert mount.mounted(name, device, fstype, mount=False) == ret

    # Test no change for uid provided as a name #25293
    with patch.dict(mount.__grains__, {"os": "CentOS"}):
        set_fstab_mock = MagicMock(autospec=True, return_value="present")
        with patch.dict(
            mount.__salt__,
            {
                "mount.active": mock_mnt,
                "mount.mount": mock_str,
                "mount.umount": mock_f,
                "mount.read_mount_cache": mock_read_cache,
                "mount.write_mount_cache": mock_write_cache,
                "mount.set_fstab": set_fstab_mock,
                "user.info": mock_user,
                "group.info": mock_group,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}), patch.object(
                os.path, "exists", mock_t
            ):
                # Starting with Python 3.8 the os.path.realpath function attempts to resolve
                # symbolic links and junctions on Windows. So, since were using a share
                # that doesn't exist, we need to mock
                # https://docs.python.org/3/library/os.path.html?highlight=ntpath%20realpath#os.path.realpath
                with patch.object(
                    os.path,
                    "realpath",
                    MagicMock(side_effect=[name2, device2, device2]),
                ):
                    comt = (
                        "Target was already mounted. Entry already exists in the fstab."
                    )
                    ret.update({"name": name2, "result": True})
                    ret.update({"comment": comt, "changes": {}})
                    assert (
                        mount.mounted(
                            name2,
                            device2,
                            fstype2,
                            opts=["uid=user1", "gid=group1"],
                        )
                        == ret
                    )
                    # Test to check the options order #57520, reverted in #62557
                    set_fstab_mock.assert_called_with(
                        name2,
                        "//SERVER/SHARE/",
                        "cifs",
                        ["uid=user1", "gid=group1"],
                        0,
                        0,
                        "/etc/fstab",
                        test=True,
                        match_on="auto",
                    )

    with patch.dict(mount.__grains__, {"os": "AIX"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.active": mock_mnt,
                "mount.mount": mock_str,
                "mount.umount": mock_f,
                "mount.read_mount_cache": mock_read_cache,
                "mount.write_mount_cache": mock_write_cache,
                "mount.set_filesystems": mock_aixfs_retn,
                "user.info": mock_user,
                "group.info": mock_group,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}):
                with patch.object(os.path, "exists", mock_t):
                    comt = (
                        "Target was already mounted. Entry already exists in the"
                        " fstab."
                    )
                    ret.update({"name": name3, "result": True})
                    ret.update({"comment": comt, "changes": {}})
                    assert (
                        mount.mounted(
                            name3,
                            device3,
                            fstype3,
                            opts=["uid=user1", "gid=group1"],
                        )
                        == ret
                    )


def test_swap():
    """
    Test to activates a swap device.
    """
    name = "/mnt/sdb"

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

    mock = MagicMock(side_effect=["present", "new", "change", "bad config"])
    mock_f = MagicMock(return_value=False)
    mock_swp = MagicMock(return_value=[name])
    mock_fs = MagicMock(return_value={"none": {"device": name, "fstype": "xfs"}})
    mock_fs_diff = MagicMock(
        return_value={"none": {"device": "something_else", "fstype": "xfs"}}
    )
    mock_aixfs = MagicMock(return_value={name: {"dev": name, "fstype": "jfs2"}})
    mock_emt = MagicMock(return_value={})
    with patch.dict(mount.__grains__, {"os": "test"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.swaps": mock_swp,
                "mount.fstab": mock_fs_diff,
                "file.is_link": mock_f,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}):
                comt = (
                    "Swap {} is set to be added to the "
                    "fstab and to be activated".format(name)
                )
                ret.update({"comment": comt})
                assert mount.swap(name) == ret

            with patch.dict(mount.__opts__, {"test": False}):
                comt = f"Swap {name} already active"
                ret.update({"comment": comt, "result": True})
                assert mount.swap(name, persist=False) == ret

                with patch.dict(
                    mount.__salt__,
                    {"mount.fstab": mock_emt, "mount.set_fstab": mock},
                ):
                    comt = f"Swap {name} already active"
                    ret.update({"comment": comt, "result": True})
                    assert mount.swap(name) == ret

                    comt = "Swap /mnt/sdb already active. Added new entry to the fstab."
                    ret.update(
                        {
                            "comment": comt,
                            "result": True,
                            "changes": {"persist": "new"},
                        }
                    )
                    assert mount.swap(name) == ret

                    comt = (
                        "Swap /mnt/sdb already active. "
                        "Updated the entry in the fstab."
                    )
                    ret.update(
                        {
                            "comment": comt,
                            "result": True,
                            "changes": {"persist": "update"},
                        }
                    )
                    assert mount.swap(name) == ret

                    comt = (
                        "Swap /mnt/sdb already active. "
                        "However, the fstab was not found."
                    )
                    ret.update({"comment": comt, "result": False, "changes": {}})
                    assert mount.swap(name) == ret

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

    mock = MagicMock(side_effect=["present", "new", "change", "bad config"])
    mock_emt = MagicMock(return_value={})
    with patch.dict(mount.__grains__, {"os": "test"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.swaps": mock_swp,
                "mount.fstab": mock_fs,
                "file.is_link": mock_f,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}):
                comt = f"Swap {name} already active"
                ret.update({"comment": comt, "result": True})
                assert mount.swap(name) == ret

            with patch.dict(mount.__opts__, {"test": False}):
                comt = f"Swap {name} already active"
                ret.update({"comment": comt, "result": True})
                assert mount.swap(name) == ret

                with patch.dict(
                    mount.__salt__,
                    {"mount.fstab": mock_emt, "mount.set_fstab": mock},
                ):
                    comt = f"Swap {name} already active"
                    ret.update({"comment": comt, "result": True})
                    assert mount.swap(name) == ret

                    comt = "Swap /mnt/sdb already active. Added new entry to the fstab."
                    ret.update(
                        {
                            "comment": comt,
                            "result": True,
                            "changes": {"persist": "new"},
                        }
                    )
                    assert mount.swap(name) == ret

                    comt = (
                        "Swap /mnt/sdb already active. "
                        "Updated the entry in the fstab."
                    )
                    ret.update(
                        {
                            "comment": comt,
                            "result": True,
                            "changes": {"persist": "update"},
                        }
                    )
                    assert mount.swap(name) == ret

                    comt = (
                        "Swap /mnt/sdb already active. "
                        "However, the fstab was not found."
                    )
                    ret.update({"comment": comt, "result": False, "changes": {}})
                    assert mount.swap(name) == ret

    with patch.dict(mount.__grains__, {"os": "AIX"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.swaps": mock_swp,
                "mount.filesystems": mock_aixfs,
                "file.is_link": mock_f,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}):
                comt = f"Swap {name} already active"
                ret.update({"comment": comt, "result": True})
                assert mount.swap(name) == ret

            with patch.dict(mount.__opts__, {"test": False}):
                comt = (
                    "Swap {} already active. swap not present"
                    " in /etc/filesystems on AIX.".format(name)
                )
                ret.update({"comment": comt, "result": False})
                assert mount.swap(name) == ret

                with patch.dict(
                    mount.__salt__,
                    {"mount.filesystems": mock_emt, "mount.set_filesystems": mock},
                ):
                    comt = (
                        "Swap {} already active. swap not present"
                        " in /etc/filesystems on AIX.".format(name)
                    )
                    ret.update({"comment": comt, "result": False})
                    assert mount.swap(name) == ret


def test_unmounted():
    """
    Test to verify that a device is not mounted
    """
    name = "/mnt/sdb"
    device = "/dev/sdb5"

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

    mock_f = MagicMock(return_value=False)
    mock_t = MagicMock(return_value=True)
    mock_dev = MagicMock(return_value={name: {"device": device}})
    mock_fs = MagicMock(return_value={name: {"device": name}})
    mock_mnt = MagicMock(side_effect=[{name: {}}, {}, {}, {}])

    name3 = os.path.realpath("/mnt/jfs2")
    device3 = "/dev/hd1"
    fstype3 = "jfs2"
    opts3 = [""]
    mock_mnta = MagicMock(return_value={name3: {"device": device3, "opts": opts3}})
    mock_aixfs = MagicMock(return_value={name: {"dev": name3, "fstype": fstype3}})
    mock_delete_cache = MagicMock(return_value=True)

    comt3 = (
        "Mount point /mnt/sdb is unmounted but needs to be purged "
        "from /etc/auto_salt to be made persistent"
    )

    with patch.dict(mount.__grains__, {"os": "Darwin"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.active": mock_mnt,
                "mount.automaster": mock_fs,
                "file.is_link": mock_f,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}):
                comt = f"Mount point {name} is mounted but should not be"
                ret.update({"comment": comt})
                assert mount.unmounted(name, device) == ret

                comt = (
                    "Target was already unmounted. "
                    "fstab entry for device {} not found".format(device)
                )
                ret.update({"comment": comt, "result": True})
                assert mount.unmounted(name, device, persist=True) == ret

                with patch.dict(mount.__salt__, {"mount.automaster": mock_dev}):
                    ret.update({"comment": comt3, "result": None})
                    assert mount.unmounted(name, device, persist=True) == ret

                comt = "Target was already unmounted"
                ret.update({"comment": comt, "result": True})
                assert mount.unmounted(name, device) == ret

    with patch.dict(mount.__grains__, {"os": "AIX"}):
        with patch.dict(
            mount.__salt__,
            {
                "mount.active": mock_mnta,
                "mount.filesystems": mock_aixfs,
                "file.is_link": mock_f,
            },
        ):
            with patch.dict(mount.__opts__, {"test": True}):
                comt = "Target was already unmounted"
                ret.update({"comment": comt, "result": True})
                assert mount.unmounted(name, device) == ret

                comt = (
                    "Target was already unmounted. "
                    "fstab entry for device /dev/sdb5 not found"
                )
                ret.update({"comment": comt, "result": True})
                assert mount.unmounted(name, device, persist=True) == ret

                with patch.dict(mount.__salt__, {"mount.filesystems": mock_dev}):
                    comt = f"Mount point {name3} is mounted but should not be"
                    ret.update({"comment": comt, "result": None, "name": name3})
                    assert mount.unmounted(name3, device3, persist=True) == ret

                    with patch.dict(mount.__opts__, {"test": False}), patch.dict(
                        mount.__salt__,
                        {
                            "mount.umount": mock_t,
                            "mount.delete_mount_cache": mock_delete_cache,
                        },
                    ):
                        comt = "Target was successfully unmounted"
                        ret.update(
                            {
                                "comment": comt,
                                "result": True,
                                "name": name3,
                                "changes": {"umount": True},
                            }
                        )
                        assert mount.unmounted(name3, device3) == ret


def test_mod_watch():
    """
    Test the mounted watcher, called to invoke the watch command.
    """
    name = "/mnt/sdb"

    ret = {
        "name": name,
        "result": True,
        "comment": "Watch not supported in unmount at this time",
        "changes": {},
    }

    assert mount.mod_watch(name, sfun="unmount") == ret


def test_mounted_multiple_mounts():
    """
    Test to verify that a device is mounted.
    """
    name = "/mnt/nfs1"
    device = "localhost:/mnt/nfsshare"
    fstype = "nfs4"

    name2 = "/mnt/nfs2"
    device2 = "localhost:/mnt/nfsshare"
    fstype2 = "nfs4"

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

    mock = MagicMock(
        side_effect=[
            "new",
            "present",
            "new",
            "change",
            "bad config",
            "salt",
            "present",
        ]
    )
    mock_t = MagicMock(return_value=True)
    mock_f = MagicMock(return_value=False)
    mock_ret = MagicMock(return_value={"retcode": 1})
    mock_mnt = MagicMock(
        return_value={name: {"device": device, "opts": [], "superopts": []}}
    )
    mock_read_cache = MagicMock(return_value={})
    mock_write_cache = MagicMock(return_value=True)
    mock_user = MagicMock(return_value={"uid": 510})
    mock_group = MagicMock(return_value={"gid": 100})
    mock_str = MagicMock(return_value="salt")
    mock_fstab_config = ["localhost:/mnt/nfsshare		/mnt/nfs1	nfs	defaults	0 0"]

    # Test no change for uid provided as a name #25293
    with patch.dict(mount.__grains__, {"os": "CentOS"}):
        with patch.dict(mount.__opts__, {"test": True}):
            with patch.dict(
                mount.__salt__,
                {
                    "mount.active": mock_mnt,
                    "mount.mount": mock_str,
                    "mount.umount": mock_f,
                    "mount.read_mount_cache": mock_read_cache,
                    "mount.write_mount_cache": mock_write_cache,
                    "user.info": mock_user,
                    "group.info": mock_group,
                },
            ):
                with patch.object(os.path, "exists", mock_t):
                    comt = "/mnt/nfs2 would be mounted"
                    ret.update({"name": name2, "result": None})
                    ret.update({"comment": comt, "changes": {}})
                    assert mount.mounted(name2, device2, fstype2, opts=[]) == ret


def test__convert_to_fast_none():
    """
    Test the device name conversor
    """
    assert mount._convert_to("/dev/sda1", None) == "/dev/sda1"


def test__convert_to_fast_device():
    """
    Test the device name conversor
    """
    assert mount._convert_to("/dev/sda1", "device") == "/dev/sda1"


def test__convert_to_fast_token():
    """
    Test the device name conversor
    """
    assert mount._convert_to("LABEL=home", "label") == "LABEL=home"


def test__convert_to_device_none():
    """
    Test the device name conversor
    """
    salt_mock = {
        "disk.blkid": MagicMock(return_value={}),
    }
    with patch.dict(mount.__salt__, salt_mock):
        assert mount._convert_to("/dev/sda1", "uuid") is None
        salt_mock["disk.blkid"].assert_called_with("/dev/sda1")


def test__convert_to_device_token():
    """
    Test the device name conversor
    """
    uuid = "988c663d-74a2-432b-ba52-3eea34015f22"
    salt_mock = {
        "disk.blkid": MagicMock(return_value={"/dev/sda1": {"UUID": uuid}}),
    }
    with patch.dict(mount.__salt__, salt_mock):
        uuid = f"UUID={uuid}"
        assert mount._convert_to("/dev/sda1", "uuid") == uuid
        salt_mock["disk.blkid"].assert_called_with("/dev/sda1")


def test__convert_to_token_device():
    """
    Test the device name conversor
    """
    uuid = "988c663d-74a2-432b-ba52-3eea34015f22"
    salt_mock = {
        "disk.blkid": MagicMock(return_value={"/dev/sda1": {"UUID": uuid}}),
    }
    with patch.dict(mount.__salt__, salt_mock):
        uuid = f"UUID={uuid}"
        assert mount._convert_to(uuid, "device") == "/dev/sda1"
        salt_mock["disk.blkid"].assert_called_with(token=uuid)


def test_fstab_present_macos_test_present():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry is already in /etc/auto_salt."],
    }

    grains_mock = {"os": "MacOS"}
    opts_mock = {"test": True}
    salt_mock = {"mount.set_automaster": MagicMock(return_value="present")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_automaster"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="noowners",
            config="/etc/auto_salt",
            test=True,
            not_change=False,
        )


def test_fstab_present_aix_test_present():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry is already in /etc/filesystems."],
    }

    grains_mock = {"os": "AIX"}
    opts_mock = {"test": True}
    salt_mock = {"mount.set_filesystems": MagicMock(return_value="present")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_filesystems"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            mount=True,
            opts="",
            config="/etc/filesystems",
            test=True,
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_test_present():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry is already in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": True}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="present")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            test=True,
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_test_new():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": None,
        "changes": {},
        "comment": [
            "/home entry will be written in /etc/fstab.",
            "Will mount /dev/sda1 on /home",
        ],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": True}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="new")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            test=True,
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_test_change():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": None,
        "changes": {},
        "comment": ["/home entry will be updated in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": True}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="change")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            test=True,
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_test_error():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": False,
        "changes": {},
        "comment": ["/home entry cannot be created in /etc/fstab: error."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": True}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="error")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            test=True,
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_macos_present():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry was already in /etc/auto_salt."],
    }

    grains_mock = {"os": "MacOS"}
    opts_mock = {"test": False}
    salt_mock = {"mount.set_automaster": MagicMock(return_value="present")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_automaster"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="noowners",
            config="/etc/auto_salt",
            not_change=False,
        )


def test_fstab_present_aix_present():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry was already in /etc/filesystems."],
    }

    grains_mock = {"os": "AIX"}
    opts_mock = {"test": False}
    salt_mock = {"mount.set_filesystems": MagicMock(return_value="present")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_filesystems"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            mount=True,
            opts="",
            config="/etc/filesystems",
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_present():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry was already in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="present")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_new():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {"persist": "new"},
        "comment": [
            "/home entry added in /etc/fstab.",
            "Mounted /dev/sda1 on /home",
        ],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    set_fstab_mock = {"mount.set_fstab": MagicMock(return_value="new")}
    mount_mock = {"mount.mount": MagicMock(return_value=True)}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, mount_mock), patch.dict(
        mount.__salt__, set_fstab_mock
    ):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        set_fstab_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_new_no_mount():
    """
    Test fstab_present with mount=false option
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {"persist": "new"},
        "comment": ["/home entry added in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="new")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2", mount=False) == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_change():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {"persist": "change"},
        "comment": ["/home entry updated in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="change")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            match_on="auto",
            not_change=False,
        )


def test_fstab_present_fail():
    """
    Test fstab_present
    """
    ret = {
        "name": "/dev/sda1",
        "result": False,
        "changes": {},
        "comment": ["/home entry cannot be changed in /etc/fstab: error."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    salt_mock = {"mount.set_fstab": MagicMock(return_value="error")}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_present("/dev/sda1", "/home", "ext2") == ret
        salt_mock["mount.set_fstab"].assert_called_with(
            name="/home",
            device="/dev/sda1",
            fstype="ext2",
            opts="defaults",
            dump=0,
            pass_num=0,
            config="/etc/fstab",
            match_on="auto",
            not_change=False,
        )


def test_fstab_absent_macos_test_absent():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": None,
        "changes": {},
        "comment": ["/home entry is already missing in /etc/auto_salt."],
    }

    grains_mock = {"os": "MacOS"}
    opts_mock = {"test": True}
    salt_mock = {"mount.automaster": MagicMock(return_value={})}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.automaster"].assert_called_with("/etc/auto_salt")


def test_fstab_absent_aix_test_absent():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": None,
        "changes": {},
        "comment": ["/home entry is already missing in /etc/filesystems."],
    }

    grains_mock = {"os": "AIX"}
    opts_mock = {"test": True}
    salt_mock = {"mount.filesystems": MagicMock(return_value={})}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.filesystems"].assert_called_with("/etc/filesystems")


def test_fstab_absent_test_absent():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": None,
        "changes": {},
        "comment": ["/home entry is already missing in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": True}
    salt_mock = {"mount.fstab": MagicMock(return_value={})}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.fstab"].assert_called_with("/etc/fstab")


def test_fstab_absent_test_present():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": None,
        "changes": {},
        "comment": ["/home entry will be removed from /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": True}
    salt_mock = {"mount.fstab": MagicMock(return_value={"/home": {}})}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.fstab"].assert_called_with("/etc/fstab")


def test_fstab_absent_macos_present():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {"persist": "removed"},
        "comment": ["/home entry removed from /etc/auto_salt."],
    }

    grains_mock = {"os": "MacOS"}
    opts_mock = {"test": False}
    salt_mock = {
        "mount.automaster": MagicMock(return_value={"/home": {}}),
        "mount.rm_automaster": MagicMock(return_value=True),
    }
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.automaster"].assert_called_with("/etc/auto_salt")
        salt_mock["mount.rm_automaster"].assert_called_with(
            name="/home", device="/dev/sda1", config="/etc/auto_salt"
        )


def test_fstab_absent_aix_present():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {"persist": "removed"},
        "comment": ["/home entry removed from /etc/filesystems."],
    }

    grains_mock = {"os": "AIX"}
    opts_mock = {"test": False}
    salt_mock = {
        "mount.filesystems": MagicMock(return_value={"/home": {}}),
        "mount.rm_filesystems": MagicMock(return_value=True),
    }
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.filesystems"].assert_called_with("/etc/filesystems")
        salt_mock["mount.rm_filesystems"].assert_called_with(
            name="/home", device="/dev/sda1", config="/etc/filesystems"
        )


def test_fstab_absent_present():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {"persist": "removed"},
        "comment": ["/home entry removed from /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    salt_mock = {
        "mount.fstab": MagicMock(return_value={"/home": {}}),
        "mount.rm_fstab": MagicMock(return_value=True),
    }
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.fstab"].assert_called_with("/etc/fstab")
        salt_mock["mount.rm_fstab"].assert_called_with(
            name="/home", device="/dev/sda1", config="/etc/fstab"
        )


def test_fstab_absent_absent():
    """
    Test fstab_absent
    """
    ret = {
        "name": "/dev/sda1",
        "result": True,
        "changes": {},
        "comment": ["/home entry is already missing in /etc/fstab."],
    }

    grains_mock = {"os": "Linux"}
    opts_mock = {"test": False}
    salt_mock = {"mount.fstab": MagicMock(return_value={})}
    with patch.dict(mount.__grains__, grains_mock), patch.dict(
        mount.__opts__, opts_mock
    ), patch.dict(mount.__salt__, salt_mock):
        assert mount.fstab_absent("/dev/sda1", "/home") == ret
        salt_mock["mount.fstab"].assert_called_with("/etc/fstab")


@pytest.mark.parametrize("mount_name", ["/home/tmp", "/home/tmp with spaces"])
def test_bind_mount_copy_active_opts(mount_name):
    name = mount_name
    device = name
    active_name = name.replace(" ", "\\040")
    fstype = "none"
    opts = [
        "bind",
        "nodev",
        "noexec",
        "nosuid",
        "rw",
    ]

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

    mock_active = MagicMock(
        return_value={
            active_name: {
                "alt_device": "/dev/vda1",
                "device": "/dev/vda1",
                "device_label": None,
                "device_uuid": "b4e712d1-cd94-4b7c-97cd-294d3db80ec6",
                "fstype": "ext4",
                "major": "254",
                "minor": "1",
                "mountid": "105",
                "opts": ["rw", "relatime"],
                "parentid": "25",
                "root": active_name,
                "superopts": ["rw", "discard", "errors=remount-ro"],
            },
        }
    )
    mock_read_mount_cache = MagicMock(
        return_value={
            "device": device,
            "fstype": "none",
            "mkmnt": False,
            "opts": ["bind", "nodev", "noexec", "nosuid", "rw"],
        }
    )
    mock_set_fstab = MagicMock(return_value="new")

    with patch.dict(mount.__grains__, {"os": "CentOS"}), patch.dict(
        mount.__salt__,
        {
            "mount.active": mock_active,
            "mount.read_mount_cache": mock_read_mount_cache,
            "mount.remount": MagicMock(return_value=True),
            "mount.set_fstab": mock_set_fstab,
            "mount.write_mount_cache": MagicMock(return_value=True),
        },
    ), patch.object(
        os.path,
        "realpath",
        MagicMock(
            side_effect=[
                name,
                "/dev/vda1",
                name,
                "/dev/vda1",
                name,
                "/dev/vda1",
            ]
        ),
    ):
        with patch.dict(mount.__opts__, {"test": True}):
            ret["comment"] = (
                "Remount would be forced because options (nodev,noexec,nosuid) changed"
            )
            result = mount.mounted(
                name=name,
                device=device,
                fstype=fstype,
                opts=opts,
                persist=True,
                bind_mount_copy_active_opts=False,
            )
            assert result == ret

        with patch.dict(mount.__opts__, {"test": False}):
            ret["comment"] = "Target was already mounted. Added new entry to the fstab."
            ret["changes"] = {
                "persist": "new",
                "umount": "Forced remount because options (nodev,noexec,nosuid) changed",
            }
            ret["result"] = True

            # bind_mount_copy_active_opts is off
            result = mount.mounted(
                name=name,
                device=device,
                fstype=fstype,
                opts=opts,
                persist=True,
                bind_mount_copy_active_opts=False,
            )
            assert result == ret

            mock_set_fstab.assert_called_with(
                name,
                device,
                fstype,
                ["bind", "nodev", "noexec", "nosuid", "rw"],
                0,
                0,
                "/etc/fstab",
                match_on="auto",
            )

            # bind_mount_copy_active_opts is on (default)
            result = mount.mounted(
                name=name,
                device=device,
                fstype=fstype,
                opts=opts,
                persist=True,
            )
            assert result == ret

            mock_set_fstab.assert_called_with(
                name,
                device,
                fstype,
                [
                    "bind",
                    "discard",
                    "errors=remount-ro",
                    "nodev",
                    "noexec",
                    "nosuid",
                    "relatime",
                    "rw",
                ],
                0,
                0,
                "/etc/fstab",
                match_on="auto",
            )


def test_mount_opts_change_lazy_umount():
    name = "/mnt/nfs"
    device = name
    active_name = name
    fstype = "nfs"
    opts = [
        "nodev",
        "noexec",
        "nosuid",
        "rw",
    ]

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

    mock_active = MagicMock(
        return_value={
            active_name: {
                "alt_device": "192.168.0.1:/volume2/nfs",
                "device": "192.168.0.1:/volume2/nfs",
                "fstype": "nfs4",
                "opts": [
                    "rw",
                    "noexec",
                    "nodev",
                    "relatime",
                    "vers=4.1",
                    "rsize=131072",
                    "wsize=131072",
                ],
            },
        }
    )
    mock_read_mount_cache = MagicMock(
        return_value={
            "device": "192.168.0.1:/volume2/nfs",
            "fstype": "nfs",
            "mkmnt": True,
            "opts": ["noexec", "nodev"],
        }
    )
    mock_set_fstab = MagicMock(return_value="new")

    with patch.dict(mount.__grains__, {"os": "CentOS"}), patch.dict(
        mount.__salt__,
        {
            "mount.active": mock_active,
            "mount.read_mount_cache": mock_read_mount_cache,
            "mount.umount": MagicMock(side_effect=[False, True]),
            "mount.mount": MagicMock(return_value=True),
            "mount.set_fstab": mock_set_fstab,
            "mount.write_mount_cache": MagicMock(return_value=True),
        },
    ), patch.object(
        os.path,
        "realpath",
        MagicMock(return_value=name),
    ):
        with patch.dict(mount.__opts__, {"test": True}):
            ret["comment"] = "Remount would be forced because options (nosuid) changed"
            result = mount.mounted(
                name=name,
                device=device,
                fstype=fstype,
                opts=opts,
                persist=True,
                bind_mount_copy_active_opts=False,
            )
            assert result == ret

        with patch.dict(mount.__opts__, {"test": False}):
            ret["comment"] = "Target was already mounted. Added new entry to the fstab."
            ret["changes"] = {
                "persist": "new",
                "umount": "Forced a lazy unmount and mount because the previous unmount failed and because the options (nosuid) changed",
            }
            ret["result"] = True

            # bind_mount_copy_active_opts is off
            result = mount.mounted(
                name=name,
                device=device,
                fstype=fstype,
                opts=opts,
                persist=True,
            )
            assert result == ret

            mock_set_fstab.assert_called_with(
                name,
                device,
                fstype,
                ["nodev", "noexec", "nosuid", "rw"],
                0,
                0,
                "/etc/fstab",
                match_on="auto",
            )