Pass network_id to device's del_network method

markgoddard · markgoddard · commit a26bce5afa8d · 2017-09-05T17:19:44.000+01:00
This allows devices which reference VLANs by name and not ID
(such as Juniper Junos devices) to delete networks by name, which
is their neutron ID.

Change-Id: If1257fad47d05016dc59a8cfc60f5d2d22be420c
diff --git a/networking_generic_switch/devices/__init__.py b/networking_generic_switch/devices/__init__.py
@@ -86,7 +86,7 @@ def add_network(self, segmentation_id, network_id):
         pass
 
     @abc.abstractmethod
-    def del_network(self, segmentation_id):
+    def del_network(self, segmentation_id, network_id):
         pass
 
     @abc.abstractmethod
diff --git a/networking_generic_switch/devices/netmiko_devices/__init__.py b/networking_generic_switch/devices/netmiko_devices/__init__.py
@@ -147,14 +147,18 @@ def add_network(self, segmentation_id, network_id):
                                           segmentation_id=segmentation_id)
         self.send_commands_to_device(cmds)
 
-    def del_network(self, segmentation_id):
+    def del_network(self, segmentation_id, network_id):
+        # NOTE(zhenguo): Remove dashes from uuid as on most devices 32 chars
+        # is the max length of vlan name.
+        network_id = uuid.UUID(network_id).hex
         cmds = []
         for port in self._get_trunk_ports():
             cmds += self._format_commands(self.UNPLUG_TRUNK_PORT_FROM_NETWORK,
                                           port=port,
                                           segmentation_id=segmentation_id)
         cmds += self._format_commands(self.DELETE_NETWORK,
-                                      segmentation_id=segmentation_id)
+                                      segmentation_id=segmentation_id,
+                                      network_id=network_id)
         self.send_commands_to_device(cmds)
 
     def plug_port_to_network(self, port, segmentation_id):
diff --git a/networking_generic_switch/generic_switch_mech.py b/networking_generic_switch/generic_switch_mech.py
@@ -161,7 +161,13 @@ def delete_network_postcommit(self, context):
             # Delete vlan on all switches from this driver
             for switch_name, switch in self.switches.items():
                 try:
-                    switch.del_network(segmentation_id)
+                    # NOTE(mgoddard): The del_network method was modified to
+                    # accept the network ID. The switch object may still be
+                    # implementing the old interface, so retry on a TypeError.
+                    try:
+                        switch.del_network(segmentation_id, network['id'])
+                    except TypeError:
+                        switch.del_network(segmentation_id)
                 except Exception as e:
                     LOG.error("Failed to delete network %(net_id)s "
                               "on device: %(switch)s, reason: %(exc)s",
diff --git a/networking_generic_switch/tests/unit/netmiko/test_arista_eos.py b/networking_generic_switch/tests/unit/netmiko/test_arista_eos.py
@@ -37,7 +37,7 @@ def test_add_network(self, m_exec):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, mock_exec):
-        self.switch.del_network(33)
+        self.switch.del_network(33, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         mock_exec.assert_called_with(['no vlan 33'])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
diff --git a/networking_generic_switch/tests/unit/netmiko/test_brocade_fastiron.py b/networking_generic_switch/tests/unit/netmiko/test_brocade_fastiron.py
@@ -39,7 +39,7 @@ def test_add_network(self, m_exec):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, mock_exec):
-        self.switch.del_network(33)
+        self.switch.del_network(33, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         mock_exec.assert_called_with(['no vlan 33'])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
diff --git a/networking_generic_switch/tests/unit/netmiko/test_cisco_ios.py b/networking_generic_switch/tests/unit/netmiko/test_cisco_ios.py
@@ -37,7 +37,7 @@ def test_add_network(self, m_exec):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, mock_exec):
-        self.switch.del_network(33)
+        self.switch.del_network(33, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         mock_exec.assert_called_with(['no vlan 33'])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
diff --git a/networking_generic_switch/tests/unit/netmiko/test_dell.py b/networking_generic_switch/tests/unit/netmiko/test_dell.py
@@ -50,14 +50,14 @@ def test_add_network_with_trunk_ports(self, mock_exec):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, mock_exec):
-        self.switch.del_network(33)
+        self.switch.del_network(33, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         mock_exec.assert_called_with(['no interface vlan 33', 'exit'])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network_with_trunk_ports(self, mock_exec):
         switch = self._make_switch_device({'ngs_trunk_ports': 'port1,port2'})
-        switch.del_network(33)
+        switch.del_network(33, '0ae071f55be943e480eae41fefe85b21')
         mock_exec.assert_called_with(
             ['interface vlan 33', 'no tagged port1', 'exit',
              'interface vlan 33', 'no tagged port2', 'exit',
diff --git a/networking_generic_switch/tests/unit/netmiko/test_huawei.py b/networking_generic_switch/tests/unit/netmiko/test_huawei.py
@@ -37,7 +37,7 @@ def test_add_network(self, m_exec):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, mock_exec):
-        self.switch.del_network(33)
+        self.switch.del_network(33, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         mock_exec.assert_called_with(
             ['undo vlan 33'])
 
diff --git a/networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py b/networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py
@@ -56,14 +56,14 @@ def test_add_network_with_trunk_ports(self, m_sctd):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, m_sctd):
-        self.switch.del_network(22)
+        self.switch.del_network(22, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         m_sctd.assert_called_with([])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network_with_trunk_ports(self, m_sctd):
         switch = self._make_switch_device({'ngs_trunk_ports': 'port1,port2'})
-        switch.del_network(22)
+        switch.del_network(22, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         m_sctd.assert_called_with([])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
diff --git a/networking_generic_switch/tests/unit/netmiko/test_ovs_linux.py b/networking_generic_switch/tests/unit/netmiko/test_ovs_linux.py
@@ -37,7 +37,7 @@ def test_add_network(self, m_exec):
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_del_network(self, mock_exec):
-        self.switch.del_network(44)
+        self.switch.del_network(44, '0ae071f5-5be9-43e4-80ea-e41fefe85b21')
         mock_exec.assert_called_with([])
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
diff --git a/networking_generic_switch/tests/unit/test_generic_switch_mech.py b/networking_generic_switch/tests/unit/test_generic_switch_mech.py
@@ -74,7 +74,7 @@ def test_delete_network_postcommit(self, m_list):
                                 'provider:segmentation_id': 22}
 
         driver.delete_network_postcommit(mock_context)
-        self.switch_mock.del_network.assert_called_once_with(22)
+        self.switch_mock.del_network.assert_called_once_with(22, 22)
 
     @mock.patch('networking_generic_switch.generic_switch_mech.LOG')
     def test_delete_network_postcommit_failure(self, m_log, m_list):
@@ -87,10 +87,23 @@ def test_delete_network_postcommit_failure(self, m_log, m_list):
                                 'provider:segmentation_id': 22}
 
         driver.delete_network_postcommit(mock_context)
-        self.switch_mock.del_network.assert_called_once_with(22)
+        self.switch_mock.del_network.assert_called_once_with(22, 22)
         self.assertEqual(1, m_log.error.call_count)
         self.assertIn('Failed to delete network', m_log.error.call_args[0][0])
 
+    def test_delete_network_postcommit_no_network_id(self, m_list):
+        driver = gsm.GenericSwitchDriver()
+        driver.initialize()
+        mock_context = mock.create_autospec(driver_context.NetworkContext)
+        mock_context.current = {'id': 22,
+                                'provider:network_type': 'vlan',
+                                'provider:segmentation_id': 22}
+        self.switch_mock.del_network.side_effect = TypeError
+
+        driver.delete_network_postcommit(mock_context)
+        self.assertEqual([mock.call(22, 22), mock.call(22)],
+                         self.switch_mock.del_network.call_args_list)
+
     def test_delete_port_postcommit(self, m_list):
         driver = gsm.GenericSwitchDriver()
         driver.initialize()
