tests/pytests/unit/modules/test_proxy.py - master - githubmirror/salt

tests/pytests/unit/modules/test_proxy.py
500 строк15 KB
Pedro Algarvio
Update to isort 5.10.1
01 авг 2022, 21:49
01 авг 2022, 21:494d49013
import pytest

import salt.modules.proxy as proxy
from tests.support.mock import MagicMock, call, patch


@pytest.fixture
def configure_loader_modules():
    return {proxy: {"__grains__": {"os": "Darwin"}}}


def test_get_http_proxy_macos():
    """
    Test to make sure that we correctly get the current proxy info
    on macOS
    """
    mock = MagicMock(
        return_value=(
            "Enabled: Yes\nServer: 192.168.0.1\nPort: 3128\nAuthenticated Proxy"
            " Enabled: 0"
        )
    )
    expected = {"enabled": True, "server": "192.168.0.1", "port": "3128"}

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.get_http_proxy()
        mock.assert_called_once_with("networksetup -getwebproxy Ethernet")
        assert expected == out


def test_get_https_proxy_macos():
    """
    Test to make sure that we correctly get the current proxy info
    on macOS
    """
    mock = MagicMock(
        return_value=(
            "Enabled: Yes\nServer: 192.168.0.1\nPort: 3128\nAuthenticated Proxy"
            " Enabled: 0"
        )
    )
    expected = {"enabled": True, "server": "192.168.0.1", "port": "3128"}

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.get_https_proxy()
        mock.assert_called_once_with("networksetup -getsecurewebproxy Ethernet")
        assert expected == out


def test_get_ftp_proxy_macos():
    """
    Test to make sure that we correctly get the current proxy info
    on macOS
    """
    mock = MagicMock(
        return_value=(
            "Enabled: Yes\nServer: 192.168.0.1\nPort: 3128\nAuthenticated Proxy"
            " Enabled: 0"
        )
    )
    expected = {"enabled": True, "server": "192.168.0.1", "port": "3128"}

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.get_ftp_proxy()
        mock.assert_called_once_with("networksetup -getftpproxy Ethernet")
        assert expected == out


def test_get_http_proxy_macos_none():
    """
    Test to make sure that we correctly return when there's no proxy set
    """
    mock = MagicMock(
        return_value="Enabled: No\nServer:\nPort: 0\nAuthenticated Proxy Enabled: 0"
    )

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.get_http_proxy()
        mock.assert_called_once_with("networksetup -getwebproxy Ethernet")
        assert {} == out


def test_set_http_proxy_macos():
    """
    Test to make sure that we correctly set the proxy info
    on macOS
    """
    mock = MagicMock()

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.set_http_proxy(
            "192.168.0.1",
            3128,
            "frank",
            "badpassw0rd",
            bypass_hosts=".moo.com,.salt.com",
        )
        mock.assert_called_once_with(
            "networksetup -setwebproxy Ethernet 192.168.0.1 3128 On frank"
            " badpassw0rd"
        )
        assert out


def test_set_https_proxy_macos():
    """
    Test to make sure that we correctly set the proxy info
    on macOS
    """
    mock = MagicMock()

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.set_https_proxy(
            "192.168.0.1",
            3128,
            "frank",
            "passw0rd",
            bypass_hosts=".moo.com,.salt.com",
        )
        mock.assert_called_once_with(
            "networksetup -setsecurewebproxy Ethernet 192.168.0.1 3128 On frank"
            " passw0rd"
        )
        assert out


def test_set_ftp_proxy_macos():
    """
    Test to make sure that we correctly set the proxy info
    on macOS
    """
    mock = MagicMock()

    with patch.dict(proxy.__salt__, {"cmd.run": mock}):
        out = proxy.set_ftp_proxy(
            "192.168.0.1",
            3128,
            "frank",
            "badpassw0rd",
            bypass_hosts=".moo.com,.salt.com",
        )
        mock.assert_called_once_with(
            "networksetup -setftpproxy Ethernet 192.168.0.1 3128 On frank"
            " badpassw0rd"
        )
        assert out


def test_get_proxy_win():
    """
    Test to make sure that we correctly get the current proxy info on
    Windows
    """
    result = [
        {
            "vdata": (
                "http=192.168.0.1:3128;https=192.168.0.2:3128;ftp=192.168.0.3:3128"
            )
        },
        {"vdata": 1},
    ]
    mock_reg_read = MagicMock(side_effect=result)
    expected = {
        "enabled": True,
        "http": {"server": "192.168.0.1", "port": "3128"},
        "https": {"server": "192.168.0.2", "port": "3128"},
        "ftp": {"server": "192.168.0.3", "port": "3128"},
    }
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.read_value": mock_reg_read}
    ):
        out = proxy.get_proxy_win()
        assert out == expected
        mock_reg_read.assert_any_call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
        )
        mock_reg_read.assert_any_call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
        )


def test_get_http_proxy_windows():
    """
    Test to make sure that we correctly get the current proxy info on
    Windows
    """
    result = {
        "vdata": "http=192.168.0.1:3128;https=192.168.0.2:3128;ftp=192.168.0.3:3128"
    }
    mock = MagicMock(return_value=result)
    expected = {"server": "192.168.0.1", "port": "3128"}
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.read_value": mock}
    ):
        out = proxy.get_http_proxy()
        mock.assert_called_once_with(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
        )
        assert expected == out


def test_get_https_proxy_windows():
    """
    Test to make sure that we correctly get the current proxy info on
    Windows
    """
    result = {
        "vdata": "http=192.168.0.1:3128;https=192.168.0.2:3128;ftp=192.168.0.3:3128"
    }
    mock = MagicMock(return_value=result)
    expected = {"server": "192.168.0.2", "port": "3128"}
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.read_value": mock}
    ):
        out = proxy.get_https_proxy()
        mock.assert_called_once_with(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
        )
        assert expected == out


def test_get_ftp_proxy_windows():
    """
    Test to make sure that we correctly get the current proxy info on
    Windows
    """
    result = {
        "vdata": "http=192.168.0.1:3128;https=192.168.0.2:3128;ftp=192.168.0.3:3128"
    }
    mock = MagicMock(return_value=result)
    expected = {"server": "192.168.0.3", "port": "3128"}
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.read_value": mock}
    ):
        out = proxy.get_ftp_proxy()
        mock.assert_called_once_with(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
        )
        assert expected == out


def test_get_all_proxies_macos_fails():
    mock = MagicMock()
    with patch.dict(proxy.__utils__, {"reg.read_value": mock}):
        out = proxy.get_proxy_win()
        assert not mock.called
        assert out is None


def test_get_all_proxies_windows():
    """
    Test to make sure that we correctly get the current proxy info on
    Windows
    """
    results = [
        {
            "vdata": (
                "http=192.168.0.1:3128;https=192.168.0.2:3128;ftp=192.168.0.3:3128"
            )
        },
        {"vdata": 1},
    ]
    mock = MagicMock(side_effect=results)
    expected = {
        "enabled": True,
        "http": {"server": "192.168.0.1", "port": "3128"},
        "https": {"server": "192.168.0.2", "port": "3128"},
        "ftp": {"server": "192.168.0.3", "port": "3128"},
    }
    calls = [
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
        ),
    ]
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.read_value": mock}
    ):
        out = proxy.get_proxy_win()
        mock.assert_has_calls(calls)
        assert expected == out


def test_set_http_proxy_windows():
    """
    Test to make sure that we correctly set the proxy info on Windows
    """
    calls = [
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
            vdata="http=192.168.0.1:3128;",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
            vdata=1,
            vtype="REG_DWORD",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyOverride",
            vdata="<local>;.moo.com;.salt.com",
        ),
    ]
    mock_reg = MagicMock()
    mock_cmd = MagicMock()
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.set_value": mock_reg}
    ), patch.dict(proxy.__salt__, {"cmd.run": mock_cmd}):
        out = proxy.set_http_proxy(
            server="192.168.0.1",
            port=3128,
            bypass_hosts=[".moo.com", ".salt.com"],
        )
        mock_reg.assert_has_calls(calls)
        mock_cmd.assert_called_once_with("netsh winhttp import proxy source=ie")
        assert out


def test_set_https_proxy_windows():
    """
    Test to make sure that we correctly set the proxy info on Windows
    """
    calls = [
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
            vdata="https=192.168.0.1:3128;",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
            vdata=1,
            vtype="REG_DWORD",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyOverride",
            vdata="<local>;.moo.com;.salt.com",
        ),
    ]
    mock_reg = MagicMock()
    mock_cmd = MagicMock()
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.set_value": mock_reg}
    ), patch.dict(proxy.__salt__, {"cmd.run": mock_cmd}):
        out = proxy.set_https_proxy(
            server="192.168.0.1",
            port=3128,
            bypass_hosts=[".moo.com", ".salt.com"],
        )
        mock_reg.assert_has_calls(calls)
        mock_cmd.assert_called_once_with("netsh winhttp import proxy source=ie")
        assert out


def test_set_ftp_proxy_windows():
    """
    Test to make sure that we correctly set the proxy info on Windows
    """
    calls = [
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
            vdata="ftp=192.168.0.1:3128;",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
            vdata=1,
            vtype="REG_DWORD",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyOverride",
            vdata="<local>;.moo.com;.salt.com",
        ),
    ]
    mock_reg = MagicMock()
    mock_cmd = MagicMock()
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.set_value": mock_reg}
    ), patch.dict(proxy.__salt__, {"cmd.run": mock_cmd}):
        out = proxy.set_ftp_proxy(
            server="192.168.0.1",
            port=3128,
            bypass_hosts=[".moo.com", ".salt.com"],
        )
        mock_reg.assert_has_calls(calls)
        mock_cmd.assert_called_once_with("netsh winhttp import proxy source=ie")
        assert out


def test_set_proxy_windows():
    """
    Test to make sure that we correctly set the proxy info on Windows
    """
    calls = [
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
            vdata=(
                "http=192.168.0.1:3128;https=192.168.0.1:3128;ftp=192.168.0.1:3128;"
            ),
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
            vdata=1,
            vtype="REG_DWORD",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyOverride",
            vdata="<local>;.moo.com;.salt.com",
        ),
    ]
    mock_reg = MagicMock()
    mock_cmd = MagicMock()
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.set_value": mock_reg}
    ), patch.dict(proxy.__salt__, {"cmd.run": mock_cmd}):
        out = proxy.set_proxy_win(
            server="192.168.0.1",
            port=3128,
            bypass_hosts=[".moo.com", ".salt.com"],
        )
        mock_reg.assert_has_calls(calls)
        mock_cmd.assert_called_once_with("netsh winhttp import proxy source=ie")
        assert out


def test_set_proxy_windows_no_ftp():
    """
    Test to make sure that we correctly set the proxy info on Windows
    """
    calls = [
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyServer",
            vdata="http=192.168.0.1:3128;https=192.168.0.1:3128;",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyEnable",
            vdata=1,
            vtype="REG_DWORD",
        ),
        call(
            hive="HKEY_CURRENT_USER",
            key="SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Internet Settings",
            vname="ProxyOverride",
            vdata="<local>;.moo.com;.salt.com",
        ),
    ]
    mock_reg = MagicMock()
    mock_cmd = MagicMock()
    with patch.dict(proxy.__grains__, {"os": "Windows"}), patch.dict(
        proxy.__utils__, {"reg.set_value": mock_reg}
    ), patch.dict(proxy.__salt__, {"cmd.run": mock_cmd}):
        out = proxy.set_proxy_win(
            server="192.168.0.1",
            port=3128,
            types=["http", "https"],
            bypass_hosts=[".moo.com", ".salt.com"],
        )
        mock_reg.assert_has_calls(calls)
        mock_cmd.assert_called_once_with("netsh winhttp import proxy source=ie")
        assert out