[req-changes] Improved tests and comments

Author: pandafy

openwisp_controller/config/base/config.py

@@ -718,9 +718,9 @@ def _send_config_modified_signal(self, action=None):
         """
         Emits ``config_modified`` signal.
 
-        A short-lived cache key (``_CONFIG_MODIFIED_TIMEOUT``)
-        prevents emitting duplicate signals inside the same logical window;
-        if that key exists the method returns early without emitting.
+        A short-lived cache key prevents emitting duplicate signals inside the
+        same change window; if that key exists the method returns early without
+        emitting the signal again.
 
         Side effects
         ------------

openwisp_controller/config/tests/test_admin.py

@@ -2602,9 +2602,10 @@ def test_restoring_template_sends_config_modified(self):
         self.assertEqual(config.status, "modified")
         self.assertNotEqual(config.checksum, config_checksum)
 
+    @patch.object(Config, "_CONFIG_MODIFIED_TIMEOUT", 3)
     def test_config_modified_signal(self):
         """
-        Verifies multiple config_modified signal is not send for
+        Verifies multiple config_modified signal are not sent for
         a single change
         """
         required = self._create_template(

openwisp_controller/config/tests/test_api.py

@@ -1669,6 +1669,7 @@ def test_device_patch_with_templates_of_same_org(self):
         self.assertEqual(d1.config.templates.count(), 2)
         self.assertEqual(r.data["config"]["templates"], [t1.id, t2.id])
 
+    @patch.object(Config, "_CONFIG_MODIFIED_TIMEOUT", 3)
     def test_config_modified_signal(self):
         """
         Verifies that config_modified signal is sent only once.
@@ -1694,7 +1695,6 @@ def test_config_modified_signal(self):
         self.assertEqual(config.templates.count(), 2)
         device_detail = reverse("config_api:device_detail", args=[config.device_id])
 
-        config._delete_config_modified_timeout_cache()
         with self.subTest(
             "Updating the unused context variable does not send config_modified signal"
         ):

openwisp_controller/config/tests/test_config.py

@@ -818,7 +818,6 @@ def test_config_modified_sent(self):
             )
             self.assertEqual(c.status, "modified")
 
-        c._delete_config_modified_timeout_cache()
         with catch_signal(config_modified) as handler:
             c.config = {"general": {"description": "changed again"}}
             c.full_clean()

openwisp_controller/config/tests/test_template.py

@@ -606,7 +606,6 @@ def test_config_modified_signal(self):
         # refresh instance to reset _just_created attribute
         conf = Config.objects.get(pk=conf.pk)
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("signal sent if config status is already modified"):
             with catch_signal(config_modified) as handler:
                 conf.templates.add(template1, template2)
@@ -624,7 +623,6 @@ def test_config_modified_signal(self):
         # reset status
         conf.set_status_applied()
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("signal sent after assigning template to config"):
             with catch_signal(config_modified) as handler:
                 conf.templates.remove(template2)
@@ -643,7 +641,6 @@ def test_config_modified_signal(self):
         # reset status
         conf.set_status_applied()
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("post_clear m2m ignored"):
             with catch_signal(config_modified) as handler:
                 conf.templates.clear()
@@ -658,7 +655,6 @@ def test_config_modified_signal(self):
         conf.save()
         conf.refresh_from_db()
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("post_add and previous_status=applied"):
             with catch_signal(config_modified) as handler:
                 conf.templates.add(template1, template2)
@@ -678,7 +674,6 @@ def test_config_modified_signal(self):
         # reset status
         conf.set_status_applied()
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("test remove/add"):
             with catch_signal(config_modified) as handler:
                 conf.templates.remove(template1, template2)
@@ -691,7 +686,6 @@ def test_config_modified_signal(self):
         # reset status
         conf.set_status_applied()
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("signal sent after changing a template"):
             with catch_signal(config_modified) as handler:
                 template1.config["interfaces"][0]["name"] = "eth1"
@@ -709,7 +703,6 @@ def test_config_modified_signal(self):
                 conf.refresh_from_db()
                 self.assertEqual(conf.status, "modified")
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("signal sent also if config is already in modified status"):
             # status has already changed to modified
             # signal should be triggered anyway

openwisp_controller/config/tests/utils.py

@@ -55,6 +55,7 @@ def _create_device_config(self, device_opts=None, config_opts=None):
 
 class CreateConfigMixin(CreateDeviceMixin):
     TEST_KEY = "w1gwJxKaHcamUw62TQIPgYchwLKn3AA0"
+    Config._CONFIG_MODIFIED_TIMEOUT = 0
 
     def _create_config(self, **kwargs):
         options = dict(backend="netjsonconfig.OpenWrt", config={"general": {}})

openwisp_controller/connection/tests/test_models.py

@@ -959,7 +959,6 @@ def _assert_applying_conf_test_command(mocked_exec):
 
         conf = self._prepare_conf_object()
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("Unable to get openwisp-config version"):
             with mock.patch(_exec_command_path) as mocked_exec_command:
                 mocked_exec_command.return_value = self._exec_command_return_value(
@@ -971,7 +970,6 @@ def _assert_applying_conf_test_command(mocked_exec):
             conf.refresh_from_db()
             self.assertEqual(conf.status, "modified")
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("openwisp_config >= 0.6.0a"):
             conf.config = '{"dns_servers": []}'
             conf.full_clean()
@@ -987,7 +985,6 @@ def _assert_applying_conf_test_command(mocked_exec):
             conf.refresh_from_db()
             self.assertEqual(conf.status, "modified")
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("openwisp_config < 0.6.0a: exit_code 0"):
             conf.config = '{"interfaces": [{"name": "eth00","type": "ethernet"}]}'
             conf.full_clean()
@@ -1002,7 +999,6 @@ def _assert_applying_conf_test_command(mocked_exec):
             conf.refresh_from_db()
             self.assertEqual(conf.status, "modified")
 
-        conf._delete_config_modified_timeout_cache()
         with self.subTest("openwisp_config < 0.6.0a: exit_code 1"):
             conf.config = '{"radios": []}'
             conf.full_clean()