[fix] Fixed CONTEXT setting getting modified at runtime #272

Fixes #272

Author: nemesifier

openwisp_controller/config/base/base.py

@@ -95,7 +95,7 @@ def get_config(self):
         return c
 
     def get_context(self):
-        return app_settings.CONTEXT
+        return app_settings.CONTEXT.copy()
 
     @classmethod
     def validate_netjsonconfig_backend(cls, backend):

openwisp_controller/config/tests/test_device.py

@@ -7,13 +7,15 @@
 
 from openwisp_users.tests.utils import TestOrganizationMixin
 
+from .. import settings as app_settings
 from ..validators import device_name_validator, mac_address_validator
 from .utils import CreateConfigTemplateMixin
 
 TEST_ORG_SHARED_SECRET = 'functional_testing_secret'
 
 Config = load_model('config', 'Config')
 Device = load_model('config', 'Device')
+_original_context = app_settings.CONTEXT.copy()
 
 
 class TestDevice(CreateConfigTemplateMixin, TestOrganizationMixin, TestCase):
@@ -154,7 +156,9 @@ def test_add_device_with_context(self):
     def test_get_context_with_config(self):
         d = self._create_device()
         c = self._create_config(device=d)
+        self.assertEqual(app_settings.CONTEXT, _original_context)
         self.assertEqual(d.get_context(), c.get_context())
+        self.assertEqual(app_settings.CONTEXT, _original_context)
 
     def test_get_context_without_config(self):
         d = self._create_device()

openwisp_controller/config/tests/test_template.py

@@ -8,6 +8,7 @@
 from openwisp_users.tests.utils import TestOrganizationMixin
 from openwisp_utils.tests import catch_signal
 
+from .. import settings as app_settings
 from ..signals import config_modified, config_status_changed
 from .utils import CreateConfigTemplateMixin, TestVpnX509Mixin
 
@@ -19,6 +20,8 @@
 Cert = load_model('django_x509', 'Cert')
 User = get_user_model()
 
+_original_context = app_settings.CONTEXT.copy()
+
 
 class TestTemplate(
     TestOrganizationMixin, CreateConfigTemplateMixin, TestVpnX509Mixin, TestCase
@@ -412,3 +415,24 @@ def test_template_name_and_organization_unique(self):
         # two templates with the same organization can't have the same name
         with self.assertRaises(ValidationError):
             self._create_template(**kwargs)
+
+    def test_context_regression(self):
+        self.test_auto_generated_certificate_for_organization()
+
+        with self.subTest('test Template.get_context()'):
+            template_qs = Template.objects.filter(type='vpn')
+            self.assertEqual(template_qs.count(), 1)
+            t = template_qs.first()
+            self.assertEqual(t.get_context(), _original_context)
+            self.assertEqual(app_settings.CONTEXT, _original_context)
+
+        with self.subTest(
+            'test Device.get_context() interacting with VPN client template'
+        ):
+            device_qs = Device.objects.all()
+            self.assertEqual(device_qs.count(), 1)
+            d = device_qs.first()
+            orig_context_set = set(_original_context.items())
+            context_set = set(d.get_context().items())
+            self.assertTrue(orig_context_set.issubset(context_set))
+            self.assertEqual(app_settings.CONTEXT, _original_context)

openwisp_controller/config/tests/test_vpn.py

@@ -8,6 +8,7 @@
 from openwisp_users.tests.utils import TestOrganizationMixin
 
 from ...vpn_backends import OpenVpn
+from .. import settings as app_settings
 from .utils import CreateConfigTemplateMixin, TestVpnX509Mixin
 
 Config = load_model('config', 'Config')
@@ -232,6 +233,7 @@ def test_get_context(self):
         }
         expected.update(settings.OPENWISP_CONTROLLER_CONTEXT)
         self.assertEqual(v.get_context(), expected)
+        self.assertNotEqual(v.get_context(), app_settings.CONTEXT)
 
     @mock.patch('openwisp_controller.config.base.vpn.AbstractVpn.dhparam')
     def test_dh(self, mocked_dhparam):