tests/pytests/unit/utils/test_win_network.py - master - githubmirror/salt

tests/pytests/unit/utils/test_win_network.py
364 строки10 KB
twangboy
Fix stacktrace when ip4/ip6 isn't configured
16 окт 2025, 00:33
16 окт 2025, 00:335b7e0c4
import pytest

import salt.utils.win_network as win_network
from tests.support.mock import MagicMock, patch

pytestmark = [pytest.mark.skip_unless_on_windows]


class PhysicalAddress:
    def __init__(self, address):
        self.address = address

    def ToString(self):
        return str(self.address)


class Interface:
    """
    Mocked interface object
    """

    def __init__(
        self,
        i_address="02D5F1DD31E0",
        i_description="Dell GigabitEthernet",
        i_id="{C5F468C0-DD5F-4C2B-939F-A411DCB5DE16}",
        i_name="Ethernet",
        i_receive_only=False,
        i_status=1,
        i_type=6,
    ):
        self.PhysicalAddress = PhysicalAddress(i_address)
        self.Description = i_description
        self.Id = i_id
        self.Name = i_name
        self.NetworkInterfaceType = i_type
        self.IsReceiveOnly = i_receive_only
        self.OperationalStatus = i_status

    def GetPhysicalAddress(self):
        return self.PhysicalAddress


@pytest.fixture
def mock_ip_base():
    return MagicMock(
        return_value={
            "dns_enabled": False,
            "dns_suffix": "",
            "dynamic_dns_enabled": False,
            "ipv4_apipa_active": False,
            "ipv4_apipa_enabled": True,
            "ipv4_dhcp_enabled": False,
            "ipv4_forwarding_enabled": False,
            "ipv4_index": 1,
            "ipv4_mtu": 1500,
            "ipv4_wins_enabled": False,
            "ipv6_index": 1,
            "ipv6_mtu": 1500,
        }
    )


@pytest.fixture
def mock_unicast():
    return MagicMock(
        return_value={
            "ip_addresses": [
                {
                    "address": "172.18.87.49",
                    "broadcast": "172.18.87.63",
                    "loopback": "127.0.0.1",
                    "netmask": "255.255.255.240",
                    "prefix_length": 28,
                    "prefix_origin": "Manual",
                    "suffix_origin": "Manual",
                }
            ],
            "ipv6_addresses": [
                {
                    "address": "fe80::e8a4:1224:5548:2b81",
                    "interface_index": 32,
                    "prefix_length": 64,
                    "prefix_origin": "WellKnown",
                    "suffix_origin": "Router",
                }
            ],
        }
    )


@pytest.fixture
def mock_gateway():
    return MagicMock(
        return_value={
            "ip_gateways": ["192.168.0.1"],
            "ipv6_gateways": ["fe80::208:a2ff:fe0b:de70"],
        }
    )


@pytest.fixture
def mock_dns():
    return MagicMock(
        return_value={
            "ip_dns": ["10.4.0.1", "10.1.0.1", "8.8.8.8"],
            "ipv6_dns": ["2600:740a:1:304::1"],
        }
    )


@pytest.fixture
def mock_multicast():
    return MagicMock(
        return_value={
            "ip_multicast": [
                "224.0.0.1",
                "224.0.0.251",
                "224.0.0.252",
                "230.230.230.230",
                "239.0.0.250",
                "239.255.255.250",
            ],
            "ipv6_multicast": [
                "ff01::1",
                "ff02::1",
                "ff02::c",
                "ff02::fb",
                "ff02::1:3",
                "ff02::1:ff0f:4c48",
                "ff02::1:ffa6:f6e6",
            ],
        }
    )


@pytest.fixture
def mock_anycast():
    return MagicMock(return_value={"ip_anycast": [], "ipv6_anycast": []})


@pytest.fixture
def mock_wins():
    return MagicMock(return_value={"ip_wins": []})


def test_get_interface_info_dot_net(
    mock_ip_base,
    mock_unicast,
    mock_gateway,
    mock_dns,
    mock_multicast,
    mock_anycast,
    mock_wins,
):
    expected = {
        "Ethernet": {
            "alias": "Ethernet",
            "description": "Dell GigabitEthernet",
            "dns_enabled": False,
            "dns_suffix": "",
            "dynamic_dns_enabled": False,
            "id": "{C5F468C0-DD5F-4C2B-939F-A411DCB5DE16}",
            "ip_addresses": [
                {
                    "address": "172.18.87.49",
                    "broadcast": "172.18.87.63",
                    "loopback": "127.0.0.1",
                    "netmask": "255.255.255.240",
                    "prefix_length": 28,
                    "prefix_origin": "Manual",
                    "suffix_origin": "Manual",
                }
            ],
            "ip_anycast": [],
            "ip_dns": ["10.4.0.1", "10.1.0.1", "8.8.8.8"],
            "ip_gateways": ["192.168.0.1"],
            "ip_multicast": [
                "224.0.0.1",
                "224.0.0.251",
                "224.0.0.252",
                "230.230.230.230",
                "239.0.0.250",
                "239.255.255.250",
            ],
            "ip_wins": [],
            "ipv4_apipa_active": False,
            "ipv4_apipa_enabled": True,
            "ipv4_dhcp_enabled": False,
            "ipv4_forwarding_enabled": False,
            "ipv4_index": 1,
            "ipv4_mtu": 1500,
            "ipv4_wins_enabled": False,
            "ipv6_addresses": [
                {
                    "address": "fe80::e8a4:1224:5548:2b81",
                    "interface_index": 32,
                    "prefix_length": 64,
                    "prefix_origin": "WellKnown",
                    "suffix_origin": "Router",
                }
            ],
            "ipv6_anycast": [],
            "ipv6_dns": ["2600:740a:1:304::1"],
            "ipv6_gateways": ["fe80::208:a2ff:fe0b:de70"],
            "ipv6_index": 1,
            "ipv6_mtu": 1500,
            "ipv6_multicast": [
                "ff01::1",
                "ff02::1",
                "ff02::c",
                "ff02::fb",
                "ff02::1:3",
                "ff02::1:ff0f:4c48",
                "ff02::1:ffa6:f6e6",
            ],
            "physical_address": "02:D5:F1:DD:31:E0",
            "receive_only": False,
            "status": "Up",
            "type": "Ethernet",
        }
    }

    mock_int = MagicMock(return_value=[Interface()])
    with patch.object(win_network, "_get_network_interfaces", mock_int), patch.object(
        win_network, "_get_ip_base_properties", mock_ip_base
    ), patch.object(win_network, "_get_ip_unicast_info", mock_unicast), patch.object(
        win_network, "_get_ip_gateway_info", mock_gateway
    ), patch.object(
        win_network, "_get_ip_dns_info", mock_dns
    ), patch.object(
        win_network, "_get_ip_multicast_info", mock_multicast
    ), patch.object(
        win_network, "_get_ip_anycast_info", mock_anycast
    ), patch.object(
        win_network, "_get_ip_wins_info", mock_wins
    ):

        results = win_network.get_interface_info_dot_net()

    assert expected == results


def test_get_network_info(
    mock_ip_base,
    mock_unicast,
    mock_gateway,
    mock_dns,
    mock_multicast,
    mock_anycast,
    mock_wins,
):
    expected = {
        "Ethernet": {
            "description": "Dell GigabitEthernet",
            "hwaddr": "02:D5:F1:DD:31:E0",
            "inet": [
                {
                    "address": "172.18.87.49",
                    "apipa_active": False,
                    "apipa_enabled": True,
                    "broadcast": "172.18.87.63",
                    "dhcp_enabled": False,
                    "forwarding_enabled": False,
                    "gateway": "192.168.0.1",
                    "index": 1,
                    "mtu": 1500,
                    "netmask": "255.255.255.240",
                    "wins_enabled": False,
                }
            ],
            "inet6": [
                {
                    "address": "fe80::e8a4:1224:5548:2b81",
                    "gateway": "fe80::208:a2ff:fe0b:de70",
                    "index": 1,
                    "mtu": 1500,
                    "prefixlen": 64,
                }
            ],
            "up": True,
        }
    }
    mock_int = MagicMock(return_value=[Interface()])
    with patch.object(win_network, "_get_network_interfaces", mock_int), patch.object(
        win_network, "_get_ip_base_properties", mock_ip_base
    ), patch.object(win_network, "_get_ip_unicast_info", mock_unicast), patch.object(
        win_network, "_get_ip_gateway_info", mock_gateway
    ), patch.object(
        win_network, "_get_ip_dns_info", mock_dns
    ), patch.object(
        win_network, "_get_ip_multicast_info", mock_multicast
    ), patch.object(
        win_network, "_get_ip_anycast_info", mock_anycast
    ), patch.object(
        win_network, "_get_ip_wins_info", mock_wins
    ):

        results = win_network.get_interface_info()

    assert expected == results


def test__get_base_properties_tap_adapter():
    """
    Adapter Type 53 is apparently an undocumented type corresponding to
    OpenVPN TAP Adapters and possibly other TAP Adapters. This test makes
    sure the win_network util will catch that.
    https://github.com/saltstack/salt/issues/56196
    https://github.com/saltstack/salt/issues/56275
    """
    i_face = Interface(
        i_address="03DE4D0713FA",
        i_description="Windows TAP Adapter",
        i_id="{C5F468C0-DD5F-4C2B-939F-A411DCB5DE16}",
        i_name="Windows TAP Adapter",
        i_receive_only=False,
        i_status=1,
        i_type=53,
    )
    expected = {
        "alias": "Windows TAP Adapter",
        "description": "Windows TAP Adapter",
        "id": "{C5F468C0-DD5F-4C2B-939F-A411DCB5DE16}",
        "receive_only": False,
        "physical_address": "03:DE:4D:07:13:FA",
        "status": "Up",
        "type": "TAPAdapter",
    }
    results = win_network._get_base_properties(i_face=i_face)
    assert expected == results


def test__get_base_properties_undefined_adapter():
    """
    The Adapter Type 53 may be an arbitrary number assigned by OpenVPN.
    This will test the ability to avoid stack tracing on an undefined
    adapter type. If one is encountered, just use the description.
    """
    i_face = Interface(
        i_address="03DE4D0713FA",
        i_description="Undefined Adapter",
        i_id="{C5F468C0-DD5F-4C2B-939F-A411DCB5DE16}",
        i_name="Undefined",
        i_receive_only=False,
        i_status=1,
        i_type=50,
    )
    expected = {
        "alias": "Undefined",
        "description": "Undefined Adapter",
        "id": "{C5F468C0-DD5F-4C2B-939F-A411DCB5DE16}",
        "receive_only": False,
        "physical_address": "03:DE:4D:07:13:FA",
        "status": "Up",
        "type": "Undefined Adapter",
    }
    results = win_network._get_base_properties(i_face=i_face)
    assert expected == results


def test__get_network_interfaces_no_error():
    ret = win_network._get_network_interfaces()
    assert len(ret) > 0