Merge "Support disabling inactive links"

4 files changed, 51 insertions, 1 deletions

diff --git a/networking_generic_switch/devices/__init__.py b/networking_generic_switch/devices/__init__.py
index 6ca744e..12c6831 100644
--- a/networking_generic_switch/devices/__init__.py
+++ b/networking_generic_switch/devices/__init__.py
@@ -34,7 +34,9 @@ NGS_INTERNAL_OPTS = [
     {'name': 'ngs_ssh_connect_timeout', 'default': 60},
     {'name': 'ngs_ssh_connect_interval', 'default': 10},
     {'name': 'ngs_max_connections', 'default': 1},
-    {'name': 'ngs_switchport_mode', 'default': 'access'}
+    {'name': 'ngs_switchport_mode', 'default': 'access'},
+    # If True, disable switch ports that are not in use.
+    {'name': 'ngs_disable_inactive_ports', 'default': False},
 ]
 
 
@@ -97,6 +99,15 @@ class GenericSwitchDevice(object):
             return []
         return physnets.split(',')
 
+    @staticmethod
+    def _str_to_bool(value):
+        truthy = ('true', 'yes', '1')
+        return str(value).lower() in truthy
+
+    def _disable_inactive_ports(self):
+        """Return whether inactive ports should be disabled."""
+        return self._str_to_bool(self.ngs_config['ngs_disable_inactive_ports'])
+
     @abc.abstractmethod
     def add_network(self, segmentation_id, network_id):
         pass
diff --git a/networking_generic_switch/devices/netmiko_devices/__init__.py b/networking_generic_switch/devices/netmiko_devices/__init__.py
index 5e4900d..57d8e2a 100644
--- a/networking_generic_switch/devices/netmiko_devices/__init__.py
+++ b/networking_generic_switch/devices/netmiko_devices/__init__.py
@@ -73,6 +73,10 @@ class NetmikoSwitch(devices.GenericSwitchDevice):
 
     REMOVE_NETWORK_FROM_TRUNK = None
 
+    ENABLE_PORT = None
+
+    DISABLE_PORT = None
+
     SAVE_CONFIGURATION = None
 
     ERROR_MSG_PATTERNS = ()
@@ -217,6 +221,8 @@ class NetmikoSwitch(devices.GenericSwitchDevice):
     @check_output('plug port')
     def plug_port_to_network(self, port, segmentation_id):
         cmds = []
+        if self._disable_inactive_ports() and self.ENABLE_PORT:
+            cmds += self._format_commands(self.ENABLE_PORT, port=port)
         ngs_port_default_vlan = self._get_port_default_vlan()
         if ngs_port_default_vlan:
             cmds += self._format_commands(
@@ -244,6 +250,8 @@ class NetmikoSwitch(devices.GenericSwitchDevice):
                 self.PLUG_PORT_TO_NETWORK,
                 port=port,
                 segmentation_id=ngs_port_default_vlan)
+        if self._disable_inactive_ports() and self.DISABLE_PORT:
+            cmds += self._format_commands(self.DISABLE_PORT, port=port)
         return self.send_commands_to_device(cmds)
 
     def send_config_set(self, net_connect, cmd_set):
diff --git a/networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py b/networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py
index b1fb934..95aba66 100644
--- a/networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py
+++ b/networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py
@@ -114,6 +114,18 @@ class TestNetmikoSwitch(NetmikoSwitchTestBase):
                 return_value='fake output')
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.check_output')
+    def test_plug_port_to_network_disable_inactive(self, m_check, m_sctd):
+        switch = self._make_switch_device(
+            {'ngs_disable_inactive_ports': 'true'})
+        switch.plug_port_to_network(2222, 22)
+        m_sctd.assert_called_with([])
+        m_check.assert_called_once_with('fake output', 'plug port')
+
+    @mock.patch('networking_generic_switch.devices.netmiko_devices.'
+                'NetmikoSwitch.send_commands_to_device',
+                return_value='fake output')
+    @mock.patch('networking_generic_switch.devices.netmiko_devices.'
+                'NetmikoSwitch.check_output')
     def test_delete_port(self, m_check, m_sctd):
         self.switch.delete_port(2222, 22)
         m_sctd.assert_called_with([])
@@ -130,6 +142,18 @@ class TestNetmikoSwitch(NetmikoSwitchTestBase):
         m_sctd.assert_called_with([])
         m_check.assert_called_once_with('fake output', 'unplug port')
 
+    @mock.patch('networking_generic_switch.devices.netmiko_devices.'
+                'NetmikoSwitch.send_commands_to_device',
+                return_value='fake output')
+    @mock.patch('networking_generic_switch.devices.netmiko_devices.'
+                'NetmikoSwitch.check_output')
+    def test_delete_port_disable_inactive(self, m_check, m_sctd):
+        switch = self._make_switch_device(
+            {'ngs_disable_inactive_ports': 'true'})
+        switch.delete_port(2222, 22)
+        m_sctd.assert_called_with([])
+        m_check.assert_called_once_with('fake output', 'unplug port')
+
     def test__format_commands(self):
         self.switch._format_commands(
             netmiko_devices.NetmikoSwitch.ADD_NETWORK,
diff --git a/releasenotes/notes/disable-inactive-ports-bd6c42ceb232aab2.yaml b/releasenotes/notes/disable-inactive-ports-bd6c42ceb232aab2.yaml
new file mode 100644
index 0000000..3e6e67c
--- /dev/null
+++ b/releasenotes/notes/disable-inactive-ports-bd6c42ceb232aab2.yaml
@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Adds support for disabling inactive switch interfaces. This is configured
+    on a per-device basis using the ``ngs_disable_inactive_ports`` flag. See
+    `Story 2003391 <https://storyboard.openstack.org/#!/story/2003391>`__ for
+    details.