Merge pull request #113 from atb00ker/fix-api

[enchancement] Add URLCONF & BASEURL options

Author: nemesifier

CHANGES.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+Version 0.6.1 [unreleased]
+--------------------------
+
+- Added settings option TOPOLOGY_RECEIVE_URLCONF & TOPOLOGY_RECEIVE_BASEURL
+
 Version 0.6.0 [2020-02-07]
 --------------------------
 

README.rst

@@ -292,6 +292,32 @@ it will be deleted by the ``update_topology`` management command. This depends o
 ``NETJSONGRAPH_LINK_EXPIRATION`` being enabled.
 Replace ``False`` with an integer to enable the feature.
 
+``TOPOLOGY_RECEIVE_URLCONF``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++--------------+---------------+
+| **type**:    |   ``string``  |
++--------------+---------------+
+| **default**: |   ``None``    |
++--------------+---------------+
+
+Use the ``urlconf`` option to change receive api url to point to
+another module, example, ``myapp.urls``.
+
+``TOPOLOGY_RECEIVE_BASEURL``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++--------------+---------------+
+| **type**:    |   ``string``  |
++--------------+---------------+
+| **default**: |   ``None``    |
++--------------+---------------+
+
+If you have a seperate instanse of django-netjsongraph to
+which you want to point your receive url to, you can use
+this option to change the base of the url,
+example: ``https://mytopology.myapp.com``.
+
 Overriding visualizer templates
 -------------------------------
 

django_netjsongraph/base/admin.py

@@ -8,6 +8,7 @@
 from django.utils.translation import ugettext_lazy as _
 from openwisp_utils.admin import ReceiveUrlAdmin
 
+from .. import settings as app_settings
 from ..contextmanagers import log_failure
 
 
@@ -46,6 +47,8 @@ class AbstractTopologyAdmin(BaseAdmin, ReceiveUrlAdmin):
               'expiration_time', 'receive_url', 'published', 'protocol',
               'version', 'revision', 'metric', 'created']
     receive_url_name = 'receive_topology'
+    receive_url_urlconf = app_settings.TOPOLOGY_RECEIVE_URLCONF
+    receive_url_baseurl = app_settings.TOPOLOGY_RECEIVE_BASEURL
 
     def get_actions(self, request):
         """

django_netjsongraph/base/link.py

@@ -13,7 +13,7 @@
 from openwisp_utils.base import TimeStampedEditableModel
 from rest_framework.utils.encoders import JSONEncoder
 
-from .. import settings
+from .. import settings as app_settings
 from ..utils import link_status_changed, print_info
 
 
@@ -115,7 +115,7 @@ def delete_expired_links(cls):
         deletes links that have been down for more than
         ``NETJSONGRAPH_LINK_EXPIRATION`` days
         """
-        LINK_EXPIRATION = settings.LINK_EXPIRATION
+        LINK_EXPIRATION = app_settings.LINK_EXPIRATION
         if LINK_EXPIRATION not in [False, None]:
             expiration_date = now() - timedelta(days=int(LINK_EXPIRATION))
             expired_links = cls.objects.filter(status='down',

django_netjsongraph/base/node.py

@@ -9,7 +9,7 @@
 from openwisp_utils.base import TimeStampedEditableModel
 from rest_framework.utils.encoders import JSONEncoder
 
-from .. import settings
+from .. import settings as app_settings
 from ..utils import print_info
 
 
@@ -101,8 +101,8 @@ def delete_expired_nodes(cls):
         deletes nodes that have not been  connected to the network
         for more than ``NETJSONGRAPH__EXPIRATION`` days
         """
-        NODE_EXPIRATION = settings.NODE_EXPIRATION
-        LINK_EXPIRATION = settings.LINK_EXPIRATION
+        NODE_EXPIRATION = app_settings.NODE_EXPIRATION
+        LINK_EXPIRATION = app_settings.LINK_EXPIRATION
         if NODE_EXPIRATION not in [False, None] and LINK_EXPIRATION not in [False, None]:
             expiration_date = now() - timedelta(days=int(NODE_EXPIRATION))
             expired_nodes = cls.objects.filter(modified__lt=expiration_date,

django_netjsongraph/settings.py

@@ -15,3 +15,5 @@
 LINK_EXPIRATION = getattr(settings, 'NETJSONGRAPH_LINK_EXPIRATION', 60)
 NODE_EXPIRATION = getattr(settings, 'NETJSONGRAPH_NODE_EXPIRATION', False)
 VISUALIZER_CSS = getattr(settings, 'NETJSONGRAPH_VISUALIZER_CSS', 'netjsongraph/css/style.css')
+TOPOLOGY_RECEIVE_URLCONF = getattr(settings, 'TOPOLOGY_RECEIVE_URLCONF', None)
+TOPOLOGY_RECEIVE_BASEURL = getattr(settings, 'TOPOLOGY_RECEIVE_BASEURL', None)

django_netjsongraph/tests/base/test_admin.py

@@ -3,10 +3,12 @@
 from django.urls import reverse
 
 from ...apps import DjangoNetjsongraphConfig as appconfig
+from ...base.admin import AbstractTopologyAdmin
 from ..utils import LoadMixin
 
 
 class TestAdminMixin(LoadMixin):
+    module = 'django_netjsongraph'
     fixtures = [
         'test_users.json'
     ]
@@ -95,6 +97,32 @@ def test_topology_receive_url(self):
         self.assertEqual(response.status_code, 200)
         self.assertContains(response, 'field-receive_url')
 
+    def test_custom_topology_receive_url(self):
+        t = self.topology_model.objects.first()
+        t.strategy = 'receive'
+        t.save()
+        path = reverse('{0}_topology_change'.format(self.prefix), args=[t.pk])
+        # No change in URL Test
+        response = self.client.get(path)
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'field-receive_url')
+        self.assertContains(response, 'http://testserver/api/receive')
+        # Change URL Test
+        AbstractTopologyAdmin.receive_url_baseurl = 'http://changedurlbase'
+        response = self.client.get(path)
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'field-receive_url')
+        self.assertContains(response, 'http://changedurlbase/api/receive')
+        # Change URLConf Test
+        AbstractTopologyAdmin.receive_url_urlconf = '{}.api.urls'.format(self.module)
+        response = self.client.get(path)
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, 'field-receive_url')
+        self.assertContains(response, 'http://changedurlbase/receive')
+        # Reset test options
+        AbstractTopologyAdmin.receive_url_baseurl = None
+        AbstractTopologyAdmin.receive_url_urlconf = None
+
     def test_node_change_form(self):
         n = self.node_model.objects.first()
         path = reverse('{0}_node_change'.format(self.prefix), args=[n.pk])

django_netjsongraph/tests/utils.py

@@ -11,7 +11,7 @@
 from django.test.runner import DiscoverRunner
 from django.utils.timezone import now
 
-from .. import settings
+from .. import settings as app_settings
 
 
 @contextmanager
@@ -134,7 +134,7 @@ def test_delete_expired_links(self):
         t.parser = 'netdiff.NetJsonParser'
         t.save()
         # should not delete
-        almost_expired_date = now() - timedelta(days=settings.LINK_EXPIRATION-10)
+        almost_expired_date = now() - timedelta(days=app_settings.LINK_EXPIRATION-10)
         n1 = self.node_model.objects.all()[0]
         n2 = self.node_model.objects.all()[1]
         link = self._create_link(source=n1,
@@ -160,7 +160,7 @@ def test_delete_expired_links(self):
         self.assertEqual(self.node_model.objects.count(), 2)
         self.assertEqual(self.link_model.objects.count(), 1)
         # should delete
-        expired_date = now() - timedelta(days=settings.LINK_EXPIRATION+10)
+        expired_date = now() - timedelta(days=app_settings.LINK_EXPIRATION+10)
         self.link_model.objects.filter(pk=link.pk).update(created=expired_date,
                                                           modified=expired_date)
         self.topology_model.update_all('testnetwork')
@@ -169,10 +169,10 @@ def test_delete_expired_links(self):
 
     @responses.activate
     def test_delete_expired_nodes(self):
-        NODE_EXPIRATION = getattr(settings, 'NODE_EXPIRATION')
+        NODE_EXPIRATION = getattr(app_settings, 'NODE_EXPIRATION')
         # Test with the default value(False)
         # Should not delete
-        setattr(settings, 'NODE_EXPIRATION', False)
+        setattr(app_settings, 'NODE_EXPIRATION', False)
         t = self.topology_model.objects.first()
         t.parser = 'netdiff.NetJsonParser'
         t.save()
@@ -200,8 +200,8 @@ def test_delete_expired_nodes(self):
 
         # Test with a custom value
         # Should delete
-        setattr(settings, 'NODE_EXPIRATION', 60)
-        expired_date = now() - timedelta(days=settings.NODE_EXPIRATION+10)
+        setattr(app_settings, 'NODE_EXPIRATION', 60)
+        expired_date = now() - timedelta(days=app_settings.NODE_EXPIRATION+10)
         self.node_model.objects.filter(pk=n1.pk).update(created=expired_date,
                                                         modified=expired_date)
         self.node_model.objects.filter(pk=n2.pk).update(created=expired_date,
@@ -210,7 +210,7 @@ def test_delete_expired_nodes(self):
         self.assertEqual(self.node_model.objects.count(), 0)
         self.assertEqual(self.link_model.objects.count(), 0)
         # Set the setting to it's original value
-        setattr(settings, 'NODE_EXPIRATION', NODE_EXPIRATION)
+        setattr(app_settings, 'NODE_EXPIRATION', NODE_EXPIRATION)
 
     @responses.activate
     def test_delete_expired_disabled(self):
@@ -224,7 +224,7 @@ def test_delete_expired_disabled(self):
                                  cost=1,
                                  status='down',
                                  topology=t)
-        expired_date = now() - timedelta(days=settings.LINK_EXPIRATION+10)
+        expired_date = now() - timedelta(days=app_settings.LINK_EXPIRATION+10)
         self.link_model.objects.filter(pk=link.pk).update(created=expired_date,
                                                           modified=expired_date)
         empty_topology = json.dumps({
@@ -239,12 +239,12 @@ def test_delete_expired_disabled(self):
                       'http://127.0.0.1:9090',
                       body=empty_topology,
                       content_type='application/json')
-        ORIGINAL_LINK_EXPIRATION = int(settings.LINK_EXPIRATION)
-        settings.LINK_EXPIRATION = False
+        ORIGINAL_LINK_EXPIRATION = int(app_settings.LINK_EXPIRATION)
+        app_settings.LINK_EXPIRATION = False
         self.topology_model.update_all('testnetwork')
         self.assertEqual(self.node_model.objects.count(), 2)
         self.assertEqual(self.link_model.objects.count(), 1)
-        settings.LINK_EXPIRATION = ORIGINAL_LINK_EXPIRATION
+        app_settings.LINK_EXPIRATION = ORIGINAL_LINK_EXPIRATION
 
     def test_save_snapshot_all_method(self, **kwargs):
         self.assertEqual(self.snapshot_model.objects.count(), 0)