#!/usr/bin/env python3
"""
Tests for device models in src/schemas/models.py.
Tests the Device dataclass and related dataclass models to ensure
proper validation and functionality.
"""
import ipaddress
from dataclasses import fields
from typing import get_type_hints, Optional
from src.schemas.models import (
Device,
DeviceListResult,
DeviceErrorResult,
NetworkOS,
)
class TestDeviceModel:
"""Test suite for the Device model."""
def test_device_creation_with_minimal_fields(self):
"""Test Device creation with only required fields."""
device = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
)
assert device.name == "test-device"
assert device.ip_address == ipaddress.IPv4Address("192.168.1.1")
assert device.nos == NetworkOS.IOSXR
assert device.port == 830 # Default value
assert device.username is None # Default value (optional)
assert device.password is None # Default value (optional)
assert device.skip_verify is False # Default value
assert device.gnmi_timeout == 5 # Default value
assert device.insecure is True # Default value
def test_device_creation_with_all_fields(self):
"""Test Device creation with all fields specified."""
device = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
port=57400,
nos=NetworkOS.IOSXR,
username="admin",
password="admin123",
path_cert="/path/to/cert.pem",
path_key="/path/to/key.pem",
path_root="/path/to/root.pem",
override="override.example.com",
skip_verify=True,
gnmi_timeout=10,
grpc_options=["grpc.keepalive_time_ms", 30000],
show_diff="unified",
insecure=False,
)
assert device.name == "test-device"
assert device.ip_address == ipaddress.IPv4Address("192.168.1.1")
assert device.port == 57400
assert device.nos == NetworkOS.IOSXR
assert device.username == "admin"
assert device.password == "admin123"
assert device.path_cert == "/path/to/cert.pem"
assert device.path_key == "/path/to/key.pem"
assert device.path_root == "/path/to/root.pem"
assert device.override == "override.example.com"
assert device.skip_verify is True
assert device.gnmi_timeout == 10
assert device.grpc_options == ["grpc.keepalive_time_ms", 30000]
assert device.show_diff == "unified"
assert device.insecure is False
def test_device_default_values(self):
"""Test that Device has proper default values."""
device = Device()
# Test all default values
assert device.name == ""
assert device.ip_address == None
assert device.port == 830
assert device.nos == NetworkOS.IOSXR
assert device.username is None # Now optional
assert device.password is None # Now optional
assert device.path_cert is None
assert device.path_key is None
assert device.path_root is None
assert device.override is None
assert device.skip_verify is False
assert device.gnmi_timeout == 5
assert device.grpc_options is None
assert device.show_diff is None
assert device.insecure is True
def test_device_to_device_info_method(self):
"""Test that to_device_info method has been removed."""
device = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
port=57400,
nos=NetworkOS.IOSXR,
username="admin",
password="secret123",
)
# Verify the method no longer exists
assert not hasattr(device, "to_device_info")
# Verify the device still works for basic functionality
assert device.name == "test-device"
assert device.ip_address == ipaddress.IPv4Address("192.168.1.1")
assert device.port == 57400
assert device.nos == NetworkOS.IOSXR
def test_device_model_dataclass_fields(self):
"""Test that Device has all expected fields."""
device_fields = [f.name for f in fields(Device)]
expected_fields = [
"name",
"ip_address",
"port",
"nos",
"username",
"password",
"path_cert",
"path_key",
"path_root",
"override",
"skip_verify",
"gnmi_timeout",
"grpc_options",
"show_diff",
"insecure",
]
for field_name in expected_fields:
assert field_name in device_fields, f"Missing field: {field_name}"
def test_device_field_types(self):
"""Test that Device fields have correct type annotations."""
import ipaddress
from typing import Union
type_hints = get_type_hints(Device)
# Test key field types
assert type_hints["name"] == str
assert (
type_hints["ip_address"]
== Union[ipaddress.IPv4Address, ipaddress.IPv6Address, None]
)
assert type_hints["port"] == int
assert type_hints["nos"] == NetworkOS
assert type_hints["username"] == Optional[str] # Now optional
assert type_hints["password"] == Optional[str] # Now optional
assert type_hints["skip_verify"] == bool
assert type_hints["gnmi_timeout"] == int
assert type_hints["insecure"] == bool
def test_device_equality(self):
"""Test Device equality comparison."""
device1 = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
)
device2 = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
)
device3 = Device(
name="different-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
)
assert device1 == device2
assert device1 != device3
def test_device_string_representation(self):
"""Test Device string representation."""
device = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
)
device_str = str(device)
assert "test-device" in device_str
assert "192.168.1.1" in device_str
assert "iosxr" in device_str
class TestDeviceListResult:
"""Test suite for DeviceListResult dataclass."""
def test_device_list_result_structure(self):
"""Test that DeviceListResult has correct structure."""
# Create some test devices
device1 = Device(
name="device1",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
)
device2 = Device(
name="device2",
ip_address=ipaddress.IPv4Address("192.168.1.2"),
nos=NetworkOS.IOSXR,
)
device_list = DeviceListResult(devices=[device1, device2])
assert hasattr(device_list, "devices")
assert isinstance(device_list.devices, list)
assert len(device_list.devices) == 2
assert device_list.devices[0].name == "device1"
assert device_list.devices[1].name == "device2"
assert device_list.devices[0].ip_address == ipaddress.IPv4Address(
"192.168.1.1"
)
assert device_list.devices[1].ip_address == ipaddress.IPv4Address(
"192.168.1.2"
)
def test_device_list_result_empty(self):
"""Test DeviceListResult with empty device list."""
device_list = DeviceListResult(devices=[])
assert hasattr(device_list, "devices")
assert isinstance(device_list.devices, list)
assert len(device_list.devices) == 0
class TestDeviceErrorResult:
"""Test suite for DeviceErrorResult dataclass."""
def test_device_error_result_with_device_info(self):
"""Test DeviceErrorResult with device information."""
error_result = DeviceErrorResult(
msg="Connection failed",
nos=NetworkOS.IOSXR,
ip_address=ipaddress.IPv4Address("192.168.1.1"),
device_info={
"name": "test-device",
"ip_address": "192.168.1.1",
"port": 57400,
"nos": "iosxr",
},
)
assert error_result.msg == "Connection failed"
assert error_result.nos == NetworkOS.IOSXR
assert error_result.device_info is not None
assert error_result.device_info["name"] == "test-device"
def test_device_error_result_without_device_info(self):
"""Test DeviceErrorResult without device information."""
error_result = DeviceErrorResult(
msg="Generic error",
device_info=None,
)
assert error_result.msg == "Generic error"
assert error_result.nos == NetworkOS.UNKNOWN # Default value
assert error_result.device_info is None
class TestDeviceModelIntegration:
"""Integration tests for Device model with real-world scenarios."""
def test_device_creation_from_inventory_data(self):
"""Test Device creation from typical inventory data."""
from src.inventory.file_handler import _convert_device_data
inventory_data = {
"name": "PE1-NYC",
"ip_address": "10.0.1.100",
"port": 57400,
"nos": "iosxr",
"username": "gnmi",
"password": "gnmi123",
"insecure": True,
"skip_verify": True,
"gnmi_timeout": 30,
}
# Convert data as it would be done in inventory loading
converted_data = _convert_device_data(inventory_data)
device = Device(**converted_data)
assert device.name == "PE1-NYC"
assert str(device.ip_address) == "10.0.1.100"
assert device.port == 57400
assert device.nos == NetworkOS.IOSXR
assert device.username == "gnmi"
assert device.password == "gnmi123"
assert device.insecure is True
assert device.skip_verify is True
assert device.gnmi_timeout == 30
class TestDeviceSanitizationMethods:
"""Test suite for Device model cleanup verification."""
def test_device_model_maintains_clean_interface(self):
"""Test that Device model maintains a clean interface without deprecated methods."""
device = Device(
name="test-device",
ip_address=ipaddress.IPv4Address("192.168.1.1"),
nos=NetworkOS.IOSXR,
username="admin",
password="secret123",
path_cert="/path/to/cert.pem",
path_key="/path/to/key.pem",
)
# Verify that deprecated methods have been removed
assert not hasattr(device, "to_device_info")
assert not hasattr(device, "to_device_info_safe")
assert not hasattr(device, "to_device_info_with_auth")
# Verify the device still works as expected for actual use cases
assert device.name == "test-device"
assert device.ip_address == ipaddress.IPv4Address("192.168.1.1")
assert (
device.password == "secret123"
) # Full data preserved in Device object
