Merge "Introduce new option ngs_save_configuration"

Author: Zuul

doc/source/configuration.rst

@@ -292,3 +292,16 @@ networking generic switch adding or removing any VLANs::
 
     [genericswitch:device-hostname]
     ngs_manage_vlans = False
+
+Saving configuration on devices
+===============================
+
+By default, all configuration changes are saved on persistent storage of the
+devices, using model-specific commands.  This occurs after each change.
+
+This may be undesirable for performance reasons, or if you have external means
+of saving configuration on a regular basis.  In this case, configuration saving
+can be disabled::
+
+    [genericswitch:device-hostname]
+    ngs_save_configuration = False

networking_generic_switch/devices/__init__.py

@@ -42,6 +42,8 @@
     {'name': 'ngs_network_name_format', 'default': '{network_id}'},
     # If false, ngs will not add and delete VLANs from switches
     {'name': 'ngs_manage_vlans', 'default': True},
+    # If False, ngs will skip saving configuration on devices
+    {'name': 'ngs_save_configuration', 'default': True},
 ]
 
 
@@ -121,6 +123,11 @@ def _disable_inactive_ports(self):
         return strutils.bool_from_string(
             self.ngs_config['ngs_disable_inactive_ports'])
 
+    def _get_save_configuration(self):
+        """Return whether configuration should be saved on device."""
+        return strutils.bool_from_string(
+            self.ngs_config['ngs_save_configuration'])
+
     def _get_network_name(self, network_id, segmentation_id):
         """Return a network name to configure on switches.
 

networking_generic_switch/devices/netmiko_devices/__init__.py

@@ -192,9 +192,10 @@ def send_commands_to_device(self, cmd_set):
             with ngs_lock.PoolLock(self.locker, **self.lock_kwargs):
                 with self._get_connection() as net_connect:
                     output = self.send_config_set(net_connect, cmd_set)
-                    # NOTE (vsaienko) always save configuration
-                    # when configuration is applied successfully.
-                    self.save_configuration(net_connect)
+                    if self._get_save_configuration():
+                        # Save configuration only if enabled in settings
+                        # and when configuration is applied successfully.
+                        self.save_configuration(net_connect)
         except exc.GenericSwitchException:
             # Reraise without modification exceptions originating from this
             # module.

networking_generic_switch/tests/unit/netmiko/test_netmiko_base.py

@@ -256,6 +256,21 @@ def test_send_commands_to_device(self, save_mock, send_mock, gc_mock):
         self.assertEqual('fake output', result)
         save_mock.assert_called_once_with(connect_mock)
 
+    @mock.patch.object(netmiko_devices.NetmikoSwitch, '_get_connection')
+    @mock.patch.object(netmiko_devices.NetmikoSwitch, 'send_config_set')
+    @mock.patch.object(netmiko_devices.NetmikoSwitch, 'save_configuration')
+    def test_send_commands_to_device_without_save_config(self, save_mock,
+                                                         send_mock, gc_mock):
+        switch = self._make_switch_device(
+            extra_cfg={'ngs_save_configuration': False})
+        connect_mock = mock.MagicMock(netmiko.base_connection.BaseConnection)
+        gc_mock.return_value.__enter__.return_value = connect_mock
+        send_mock.return_value = 'fake output'
+        result = switch.send_commands_to_device(['spam ham aaaa'])
+        send_mock.assert_called_once_with(connect_mock, ['spam ham aaaa'])
+        self.assertEqual('fake output', result)
+        save_mock.assert_not_called()
+
     def test_send_config_set(self):
         connect_mock = mock.MagicMock(netmiko.base_connection.BaseConnection)
         connect_mock.send_config_set.return_value = 'fake output'

releasenotes/notes/add-ngs_save_configuration-180c2145f08e54d2.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Add new device setting ``ngs_save_configuration``, allowing to disable
+    saving configuration on the device after each change.  This can speed up
+    the overall process significantly, but changes will be lost if the device
+    reboots.