Remove unused global_refresh_firewall

This param is set in the functions, but actually no use. It
was never set to True. And it reduces the code readability.
So better remove it. From the code search [1], only neutron
and networking-vsphere have such global_refresh_firewall now.

[1] http://codesearch.openstack.org/?q=global_refresh_firewall

Change-Id: I87e1463d2cc1ee855f0cf6631863d89a6bd8ee2e

neutron/agent/securitygroups_rpc.py

@@ -89,8 +89,6 @@ class SecurityGroupAgentRpc(object):
         # Stores devices for which firewall should be refreshed when
         # deferred refresh is enabled.
         self.devices_to_refilter = set()
-        # Flag raised when a global refresh is needed
-        self.global_refresh_firewall = False
         self._use_enhanced_rpc = None
 
     @property
@@ -229,7 +227,7 @@ class SecurityGroupAgentRpc(object):
         self._apply_port_filter(device_ids, update_filter=True)
 
     def firewall_refresh_needed(self):
-        return self.global_refresh_firewall or self.devices_to_refilter
+        return self.devices_to_refilter
 
     def setup_port_filters(self, new_devices, updated_devices):
         """Configure port filters for devices.
@@ -245,9 +243,7 @@ class SecurityGroupAgentRpc(object):
         # These data structures are cleared here in order to avoid
         # losing updates occurring during firewall refresh
         devices_to_refilter = self.devices_to_refilter
-        global_refresh_firewall = self.global_refresh_firewall
         self.devices_to_refilter = set()
-        self.global_refresh_firewall = False
         # We must call prepare_devices_filter() after we've grabbed
         # self.devices_to_refilter since an update for a new port
         # could arrive while we're processing, and we need to make
@@ -256,21 +252,14 @@ class SecurityGroupAgentRpc(object):
             LOG.debug("Preparing device filters for %d new devices",
                       len(new_devices))
             self.prepare_devices_filter(new_devices)
-        # TODO(salv-orlando): Avoid if possible ever performing the global
-        # refresh providing a precise list of devices for which firewall
-        # should be refreshed
-        if global_refresh_firewall:
-            LOG.debug("Refreshing firewall for all filtered devices")
-            self.refresh_firewall()
-        else:
-            if self.use_enhanced_rpc and updated_devices:
-                self.firewall.security_group_updated('sg_member', [],
-                                                     updated_devices)
-            # If a device is both in new and updated devices
-            # avoid reprocessing it
-            updated_devices = ((updated_devices | devices_to_refilter) -
-                               new_devices)
-            if updated_devices:
-                LOG.debug("Refreshing firewall for %d devices",
-                          len(updated_devices))
-                self.refresh_firewall(updated_devices)
+        if self.use_enhanced_rpc and updated_devices:
+            self.firewall.security_group_updated('sg_member', [],
+                                                 updated_devices)
+        # If a device is both in new and updated devices
+        # avoid reprocessing it
+        updated_devices = ((updated_devices | devices_to_refilter) -
+                           new_devices)
+        if updated_devices:
+            LOG.debug("Refreshing firewall for %d devices",
+                      len(updated_devices))
+            self.refresh_firewall(updated_devices)

neutron/tests/unit/agent/test_securitygroups_rpc.py

@@ -1183,10 +1183,8 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set()
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(['fake_new_device']), set())
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.prepare_devices_filter.assert_called_once_with(
             set(['fake_new_device']))
         self.assertFalse(self.agent.refresh_firewall.called)
@@ -1196,10 +1194,8 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set()
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(), set(['fake_updated_device']))
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.refresh_firewall.assert_called_once_with(
             set(['fake_updated_device']))
         self.assertFalse(self.agent.prepare_devices_filter.called)
@@ -1209,11 +1205,9 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set()
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(['fake_new_device']),
                                       set(['fake_updated_device']))
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.prepare_devices_filter.assert_called_once_with(
             set(['fake_new_device']))
         self.agent.refresh_firewall.assert_called_once_with(
@@ -1224,10 +1218,8 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set(['fake_device'])
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(), set())
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.refresh_firewall.assert_called_once_with(
             set(['fake_device']))
         self.assertFalse(self.agent.prepare_devices_filter.called)
@@ -1237,10 +1229,8 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set(['fake_device'])
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(['fake_new_device']), set())
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.prepare_devices_filter.assert_called_once_with(
             set(['fake_new_device']))
         self.agent.refresh_firewall.assert_called_once_with(
@@ -1258,11 +1248,9 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = self._test_prepare_devices_filter
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set(['new_device', 'fake_device'])
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(['new_device']), set())
         self.assertEqual(self.agent.devices_to_refilter,
                          set(['fake_new_device']))
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.refresh_firewall.assert_called_once_with(
             set(['fake_device']))
         self.assertFalse(self.firewall.security_group_updated.called)
@@ -1271,11 +1259,9 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set(['fake_device', 'fake_device_2'])
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(
             set(), set(['fake_device', 'fake_updated_device']))
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.refresh_firewall.assert_called_once_with(
             set(['fake_device', 'fake_device_2', 'fake_updated_device']))
         self.assertFalse(self.agent.prepare_devices_filter.called)
@@ -1285,12 +1271,10 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set(['fake_device', 'fake_device_2'])
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(
             set(['fake_new_device']),
             set(['fake_device', 'fake_updated_device']))
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.agent.prepare_devices_filter.assert_called_once_with(
             set(['fake_new_device']))
         self.agent.refresh_firewall.assert_called_once_with(
@@ -1301,26 +1285,12 @@ class SecurityGroupAgentRpcWithDeferredRefreshTestCase(
         self.agent.prepare_devices_filter = mock.Mock()
         self.agent.refresh_firewall = mock.Mock()
         self.agent.devices_to_refilter = set()
-        self.agent.global_refresh_firewall = False
         self.agent.setup_port_filters(set(), set())
         self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
         self.assertFalse(self.agent.refresh_firewall.called)
         self.assertFalse(self.agent.prepare_devices_filter.called)
         self.assertFalse(self.firewall.security_group_updated.called)
 
-    def test_setup_port_filters_with_global_refresh(self):
-        self.agent.prepare_devices_filter = mock.Mock()
-        self.agent.refresh_firewall = mock.Mock()
-        self.agent.devices_to_refilter = set()
-        self.agent.global_refresh_firewall = True
-        self.agent.setup_port_filters(set(), set())
-        self.assertFalse(self.agent.devices_to_refilter)
-        self.assertFalse(self.agent.global_refresh_firewall)
-        self.agent.refresh_firewall.assert_called_once_with()
-        self.assertFalse(self.agent.prepare_devices_filter.called)
-        self.assertFalse(self.firewall.security_group_updated.called)
-
 
 class FakeSGNotifierAPI(securitygroups_rpc.SecurityGroupAgentRpcApiMixin):
     def __init__(self):