Merge "Adds ngs_switchport_mode config option to Dell PowerConnect driver"

6 files changed, 107 insertions, 0 deletions

diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 580e237..f8100c0 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -98,6 +98,12 @@ for the Dell PowerConnect device::
     password = password
     secret = secret
 
+    # You can set ngs_switchport_mode according to switchmode you have set on
+    # the switch. The following options are supported: general, access. It
+    # will default to access mode if left unset. In general mode, the port
+    # be set to transmit untagged packets.
+    ngs_switchport_mode = access
+
 Dell PowerConnect devices have been seen to have issues with multiple
 concurrent configuration sessions. See :ref:`synchronization` for details on
 how to limit the number of concurrent active connections to each device.
diff --git a/networking_generic_switch/devices/__init__.py b/networking_generic_switch/devices/__init__.py
index 2dd1ab2..6ca744e 100644
--- a/networking_generic_switch/devices/__init__.py
+++ b/networking_generic_switch/devices/__init__.py
@@ -34,6 +34,7 @@ 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'}
 ]
 
 
diff --git a/networking_generic_switch/devices/netmiko_devices/dell.py b/networking_generic_switch/devices/netmiko_devices/dell.py
index 7529ca1..8a9ce3f 100644
--- a/networking_generic_switch/devices/netmiko_devices/dell.py
+++ b/networking_generic_switch/devices/netmiko_devices/dell.py
@@ -13,6 +13,7 @@
 #    under the License.
 
 from networking_generic_switch.devices import netmiko_devices
+from networking_generic_switch import exceptions as exc
 
 
 class DellNos(netmiko_devices.NetmikoSwitch):
@@ -57,6 +58,26 @@ class DellNos(netmiko_devices.NetmikoSwitch):
 class DellPowerConnect(netmiko_devices.NetmikoSwitch):
     """Netmiko device driver for Dell PowerConnect switches."""
 
+    def _switch_to_general_mode(self):
+        self.PLUG_PORT_TO_NETWORK = self.PLUG_PORT_TO_NETWORK_GENERAL
+        self.DELETE_PORT = self.DELETE_PORT_GENERAL
+
+    def __init__(self, device_cfg):
+        super(DellPowerConnect, self).__init__(device_cfg)
+        port_mode = self.ngs_config['ngs_switchport_mode']
+        switchport_mode = {
+            'general': self._switch_to_general_mode,
+            'access': lambda: ()
+        }
+
+        def on_invalid_switchmode():
+            raise exc.GenericSwitchConfigException(
+                option="ngs_switchport_mode",
+                allowed_options=switchport_mode.keys()
+            )
+
+        switchport_mode.get(port_mode.lower(), on_invalid_switchmode)()
+
     ADD_NETWORK = (
         'vlan database',
         'vlan {segmentation_id}',
@@ -69,12 +90,26 @@ class DellPowerConnect(netmiko_devices.NetmikoSwitch):
         'exit',
     )
 
+    PLUG_PORT_TO_NETWORK_GENERAL = (
+        'interface {port}',
+        'switchport general allowed vlan add {segmentation_id} untagged',
+        'switchport general pvid {segmentation_id}',
+        'exit',
+    )
+
     PLUG_PORT_TO_NETWORK = (
         'interface {port}',
         'switchport access vlan {segmentation_id}',
         'exit',
     )
 
+    DELETE_PORT_GENERAL = (
+        'interface {port}',
+        'switchport general allowed vlan remove {segmentation_id}',
+        'no switchport general pvid',
+        'exit',
+    )
+
     DELETE_PORT = (
         'interface {port}',
         'switchport access vlan none',
diff --git a/networking_generic_switch/exceptions.py b/networking_generic_switch/exceptions.py
index 29fc074..b3649da 100644
--- a/networking_generic_switch/exceptions.py
+++ b/networking_generic_switch/exceptions.py
@@ -21,6 +21,10 @@ class GenericSwitchException(exceptions.NeutronException):
     message = _("%(method)s failed.")
 
 
+class GenericSwitchConfigException(exceptions.NeutronException):
+    message = _("%(option)s must be one of: %(allowed_options)s")
+
+
 class GenericSwitchEntrypointLoadError(GenericSwitchException):
     message = _("Failed to load entrypoint %(ep)s: %(err)s")
 
diff --git a/networking_generic_switch/tests/unit/netmiko/test_dell.py b/networking_generic_switch/tests/unit/netmiko/test_dell.py
index 0052b56..8ce9686 100644
--- a/networking_generic_switch/tests/unit/netmiko/test_dell.py
+++ b/networking_generic_switch/tests/unit/netmiko/test_dell.py
@@ -15,6 +15,7 @@
 import mock
 
 from networking_generic_switch.devices.netmiko_devices import dell
+from networking_generic_switch import exceptions as exc
 from networking_generic_switch.tests.unit.netmiko import test_netmiko_base
 
 
@@ -133,6 +134,18 @@ class TestNetmikoDellPowerConnect(test_netmiko_base.NetmikoSwitchTestBase):
         m_exec.assert_called_with(
             ['vlan database', 'vlan 33', 'exit'])
 
+    def test_invalid_switchmode(self):
+        with self.assertRaises(exc.GenericSwitchConfigException):
+            self._make_switch_device({'ngs_switchport_mode': 'BAD_PORT_MODE'})
+
+    def test_switchmode_general(self):
+        # should not raise an exception
+        self._make_switch_device({'ngs_switchport_mode': 'GENERAL'})
+
+    def test_switchmode_access(self):
+        # should not raise an exception
+        self._make_switch_device({'ngs_switchport_mode': 'access'})
+
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
     def test_add_network_with_trunk_ports(self, mock_exec):
@@ -174,11 +187,33 @@ class TestNetmikoDellPowerConnect(test_netmiko_base.NetmikoSwitchTestBase):
 
     @mock.patch('networking_generic_switch.devices.netmiko_devices.'
                 'NetmikoSwitch.send_commands_to_device')
+    def test_plug_port_to_network_general_mode(self, mock_exec):
+        switch = self._make_switch_device({'ngs_switchport_mode': 'GENERAL'})
+        switch.plug_port_to_network(3333, 33)
+        mock_exec.assert_called_with(
+            ['interface 3333',
+             'switchport general allowed vlan add 33 untagged',
+             'switchport general pvid 33',
+             'exit'])
+
+    @mock.patch('networking_generic_switch.devices.netmiko_devices.'
+                'NetmikoSwitch.send_commands_to_device')
     def test_delete_port(self, mock_exec):
         self.switch.delete_port(3333, 33)
         mock_exec.assert_called_with(
             ['interface 3333', 'switchport access vlan none', 'exit'])
 
+    @mock.patch('networking_generic_switch.devices.netmiko_devices.'
+                'NetmikoSwitch.send_commands_to_device')
+    def test_delete_port_general(self, mock_exec):
+        switch = self._make_switch_device({'ngs_switchport_mode': 'GENERAL'})
+        switch.delete_port(3333, 33)
+        mock_exec.assert_called_with(
+            ['interface 3333',
+             'switchport general allowed vlan remove 33',
+             'no switchport general pvid',
+             'exit'])
+
     def test__format_commands(self):
         cmd_set = self.switch._format_commands(
             dell.DellPowerConnect.ADD_NETWORK,
@@ -221,3 +256,24 @@ class TestNetmikoDellPowerConnect(test_netmiko_base.NetmikoSwitchTestBase):
         self.assertEqual(cmd_set,
                          ['interface 3333',
                           'switchport general allowed vlan remove 33', 'exit'])
+
+    def test__format_commands_general_mode(self):
+        switch = self._make_switch_device({'ngs_switchport_mode': 'GENERAL'})
+        cmd_set = switch._format_commands(
+            dell.DellPowerConnect.PLUG_PORT_TO_NETWORK_GENERAL,
+            port=3333,
+            segmentation_id=33)
+        self.assertEqual(cmd_set,
+                         ['interface 3333',
+                          'switchport general allowed vlan add 33 untagged',
+                          'switchport general pvid 33',
+                          'exit'])
+        cmd_set = switch._format_commands(
+            dell.DellPowerConnect.DELETE_PORT_GENERAL,
+            port=3333,
+            segmentation_id=33)
+        self.assertEqual(cmd_set,
+                         ['interface 3333',
+                          'switchport general allowed vlan remove 33',
+                          'no switchport general pvid',
+                          'exit'])
diff --git a/releasenotes/notes/add-switchmode-option-to-dell-powerconnect-87718a84430444ef.yaml b/releasenotes/notes/add-switchmode-option-to-dell-powerconnect-87718a84430444ef.yaml
new file mode 100644
index 0000000..745885d
--- /dev/null
+++ b/releasenotes/notes/add-switchmode-option-to-dell-powerconnect-87718a84430444ef.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Adds a new config option, ``ngs_switchport_mode`` to the Dell
+    PowerConnect driver.