Merge pull request #1230 from rackerlabs/pydantic-netapp

chore: convert NetApp related dataclasses to pydantic

Author: cardoe

python/understack-workflows/tests/test_netapp_client.py

@@ -7,6 +7,7 @@
 
 import pytest
 from netapp_ontap.error import NetAppRestError
+from pydantic import ValidationError
 
 from understack_workflows.netapp.client import NetAppClient
 from understack_workflows.netapp.client import NetAppClientInterface
@@ -327,7 +328,7 @@ def test_create_ip_interface_success(self, mock_interface_class, netapp_client):
         assert isinstance(result, InterfaceResult)
         assert result.name == "test-interface"
         assert result.uuid == "interface-uuid-123"
-        assert result.address == "192.168.1.10"
+        assert str(result.address) == "192.168.1.10"
         assert result.netmask == "255.255.255.0"
         assert result.enabled is True
         assert result.svm_name == "test-svm"
@@ -540,7 +541,7 @@ def test_create_route_success(self, mock_route_class, netapp_client):
 
         # Verify route configuration
         assert mock_route_instance.svm == {"name": "os-test-project"}
-        assert mock_route_instance.gateway == "100.127.0.17"
+        assert str(mock_route_instance.gateway) == "100.127.0.17"
         assert mock_route_instance.destination == {
             "address": "100.126.0.0",
             "netmask": "255.255.128.0",
@@ -550,7 +551,7 @@ def test_create_route_success(self, mock_route_class, netapp_client):
         # Verify result
         assert result.uuid == "route-uuid-123"
         assert result.gateway == "100.127.0.17"
-        assert result.destination == ipaddress.IPv4Network("100.126.0.0/17")
+        assert result.destination == "100.126.0.0/17"
         assert result.svm_name == "os-test-project"
 
     @patch("understack_workflows.netapp.client.NetworkRoute")
@@ -584,7 +585,7 @@ def test_create_route_netapp_rest_error(self, mock_route_class, netapp_client):
         assert isinstance(call_args[0][0], NetAppRestError)
         assert call_args[0][1] == "Route creation"
         assert call_args[0][2]["svm_name"] == "os-nonexistent-project"
-        assert call_args[0][2]["gateway"] == "100.127.0.17"
+        assert str(call_args[0][2]["gateway"]) == "100.127.0.17"
         assert call_args[0][2]["destination"] == ipaddress.IPv4Network("100.126.0.0/17")
 
     @patch("understack_workflows.netapp.client.NetworkRoute")
@@ -638,19 +639,12 @@ def test_create_route_gateway_unreachable_error(
             )
         )
 
-        route_spec = RouteSpec(
-            svm_name="os-test-project",
-            gateway="192.168.1.1",  # Invalid gateway for this network
-            destination=ipaddress.IPv4Network("100.126.0.0/17"),
-        )
-
-        with pytest.raises(NetworkOperationError):
-            netapp_client.create_route(route_spec)
-
-        # Verify error context includes gateway information
-        call_args = netapp_client._error_handler.handle_netapp_error.call_args
-        assert call_args[0][2]["gateway"] == "192.168.1.1"
-        assert call_args[0][2]["destination"] == ipaddress.IPv4Network("100.126.0.0/17")
+        with pytest.raises(ValidationError):
+            RouteSpec(
+                svm_name="os-test-project",
+                gateway="192.168.1.1",  # Invalid gateway for this network
+                destination=ipaddress.IPv4Network("100.126.0.0/17"),
+            )
 
     @patch("understack_workflows.netapp.client.NetworkRoute")
     def test_create_route_logging_behavior(self, mock_route_class, netapp_client):
@@ -694,7 +688,7 @@ def test_create_route_logging_behavior(self, mock_route_class, netapp_client):
         assert start_log[0][1]["destination"] == ipaddress.IPv4Network(
             "100.126.128.0/17"
         )
-        assert start_log[0][1]["gateway"] == "100.127.128.17"
+        assert str(start_log[0][1]["gateway"]) == "100.127.128.17"
         assert start_log[0][1]["svm_name"] == "os-logging-test"
 
         # Verify route completion log

python/understack-workflows/tests/test_netapp_config.py

@@ -384,12 +384,12 @@ def test_integration_netapp_config_with_from_nautobot_response(
 
         # Create a mock nautobot response
         mock_interface_a = MagicMock()
-        mock_interface_a.name = "N1-test-A"
+        mock_interface_a.name = "N1-lif-A"
         mock_interface_a.address = "192.168.1.10/24"
         mock_interface_a.vlan = 100
 
         mock_interface_b = MagicMock()
-        mock_interface_b.name = "N1-test-B"
+        mock_interface_b.name = "N1-lif-B"
         mock_interface_b.address = "192.168.1.11/24"
         mock_interface_b.vlan = 100
 
@@ -413,7 +413,7 @@ def test_from_nautobot_response_default_prefix(self, valid_config_file):
 
         # Create a mock nautobot response
         mock_interface = MagicMock()
-        mock_interface.name = "N1-test-A"
+        mock_interface.name = "N1-lif-A"
         mock_interface.address = "192.168.1.10/24"
         mock_interface.vlan = 100
 

python/understack-workflows/tests/test_netapp_configure_net.py

@@ -6,10 +6,9 @@
 from unittest.mock import patch
 
 import pytest
+from pydantic import ValidationError
 
 from understack_workflows.main.netapp_configure_net import VIRTUAL_MACHINES_QUERY
-from understack_workflows.main.netapp_configure_net import InterfaceInfo
-from understack_workflows.main.netapp_configure_net import VirtualMachineNetworkInfo
 from understack_workflows.main.netapp_configure_net import argument_parser
 from understack_workflows.main.netapp_configure_net import construct_device_name
 from understack_workflows.main.netapp_configure_net import execute_graphql_query
@@ -19,6 +18,8 @@
 from understack_workflows.main.netapp_configure_net import (
     validate_and_transform_response,
 )
+from understack_workflows.netapp.value_objects import InterfaceInfo
+from understack_workflows.netapp.value_objects import VirtualMachineNetworkInfo
 
 
 def load_json_sample(filename: str) -> dict:
@@ -657,6 +658,52 @@ def test_error_messages_contain_interface_details(self):
         assert "200" in error_message
         assert "300" in error_message
 
+    def test_vlan_validation_valid_range(self):
+        """Test VLAN validation with valid VLAN IDs (1-4094)."""
+        valid_vlans = [1, 100, 2002, 4094]
+
+        for vlan in valid_vlans:
+            interface = InterfaceInfo(
+                name="test-interface", address="192.168.1.10/24", vlan=vlan
+            )
+            assert interface.vlan == vlan
+
+    def test_vlan_validation_invalid_range(self):
+        """Test VLAN validation with invalid VLAN IDs (outside 1-4094 range)."""
+        from pydantic import ValidationError
+
+        invalid_vlans = [0, -1, 4095, 5000, 65536]
+
+        for vlan in invalid_vlans:
+            with pytest.raises(
+                ValidationError, match="VLAN ID must be between 1 and 4094"
+            ):
+                InterfaceInfo(
+                    name="test-interface", address="192.168.1.10/24", vlan=vlan
+                )
+
+    def test_vlan_validation_in_from_graphql_interface(self):
+        """Test VLAN validation works in from_graphql_interface method."""
+        # Test valid VLAN
+        interface_data = {
+            "name": "test-interface",
+            "ip_addresses": [{"address": "192.168.1.10/24"}],
+            "tagged_vlans": [{"vid": 2002}],
+        }
+
+        interface = InterfaceInfo.from_graphql_interface(interface_data)
+        assert interface.vlan == 2002
+
+        # Test invalid VLAN
+        interface_data_invalid = {
+            "name": "test-interface",
+            "ip_addresses": [{"address": "192.168.1.10/24"}],
+            "tagged_vlans": [{"vid": 4095}],  # Invalid VLAN
+        }
+
+        with pytest.raises(ValidationError, match="VLAN ID must be between 1 and 4094"):
+            InterfaceInfo.from_graphql_interface(interface_data_invalid)
+
 
 class TestVirtualMachineNetworkInfo:
     """Test cases for VirtualMachineNetworkInfo data class and validation."""
@@ -1142,7 +1189,7 @@ def test_handling_of_empty_query_results(self, mock_logger):
 
         assert result["data"]["virtual_machines"] == []
         mock_logger.info.assert_called_with(
-            "GraphQL query successful. Found %s virtual machine(s) " "for device: %s",
+            "GraphQL query successful. Found %s virtual machine(s) for device: %s",
             0,
             "os-empty-project",
         )
@@ -1175,7 +1222,7 @@ def test_handling_of_empty_query_results(self, mock_logger):
         assert len(result["data"]["virtual_machines"]) == 1
         assert result["data"]["virtual_machines"][0]["interfaces"] == []
         mock_logger.info.assert_called_with(
-            "GraphQL query successful. Found %s virtual machine(s) " "for device: %s",
+            "GraphQL query successful. Found %s virtual machine(s) for device: %s",
             1,
             "os-empty-interfaces-project",
         )
@@ -1204,7 +1251,7 @@ def test_graphql_query_logging_behavior(self, mock_logger):
 
         # Verify info logging
         mock_logger.info.assert_called_with(
-            "GraphQL query successful. Found %s virtual machine(s) " "for device: %s",
+            "GraphQL query successful. Found %s virtual machine(s) for device: %s",
             1,
             "os-logging-test-project",
         )
@@ -1733,6 +1780,10 @@ def test_main_function_initializes_netapp_manager_with_default_path(
         # Mock NetAppManager
         mock_netapp_manager_instance = Mock()
         mock_netapp_manager_instance.create_routes_for_project.return_value = []
+        # Properly mock the config property with netapp_nic_slot_prefix
+        mock_config = Mock()
+        mock_config.netapp_nic_slot_prefix = "e4"
+        mock_netapp_manager_instance.config = mock_config
         mock_netapp_manager_class.return_value = mock_netapp_manager_instance
 
         # Mock sys.argv with default netapp config path
@@ -1789,6 +1840,10 @@ def test_main_function_initializes_netapp_manager_with_custom_path(
 
         # Mock NetAppManager
         mock_netapp_manager_instance = Mock()
+        # Mock the config property to return a proper config object
+        mock_config = Mock()
+        mock_config.netapp_nic_slot_prefix = "e4"
+        mock_netapp_manager_instance.config = mock_config
         mock_netapp_manager_instance.create_routes_for_project.return_value = []
         mock_netapp_manager_class.return_value = mock_netapp_manager_instance