Merge pull request #104 from Weirdo914/master

[models] Addresses implementation is not optimal #61

Author: nemesifier

.gitignore

@@ -7,6 +7,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+venv/
 env/
 build/
 develop-eggs/
@@ -54,6 +55,7 @@ target/
 # editors
 *.komodoproject
 *.komodotools
+.vscode/
 
 # other
 *.DS_Store*

django_netjsongraph/base/link.py

@@ -103,8 +103,8 @@ def get_from_nodes(cls, source, target, topology):
         :param topology: Topology instance
         :returns: Link object or None
         """
-        source = ';{0};'.format(source)
-        target = ';{0};'.format(target)
+        source = '"{}"'.format(source)
+        target = '"{}"'.format(target)
         q = (Q(source__addresses__contains=source,
                target__addresses__contains=target) |
              Q(source__addresses__contains=target,

django_netjsongraph/base/node.py

@@ -23,7 +23,7 @@ class AbstractNode(TimeStampedEditableModel):
                                  on_delete=models.CASCADE)
     label = models.CharField(max_length=64, blank=True)
     # netjson ID and local_addresses
-    addresses = models.CharField(max_length=510, db_index=True)
+    addresses = JSONField(default=[])
     properties = JSONField(default=dict,
                            blank=True,
                            load_kwargs={'object_pairs_hook': OrderedDict},
@@ -40,50 +40,17 @@ def clean(self):
             self.properties = {}
 
     def save(self, *args, **kwargs):
-        self._format_addresses()
         super(AbstractNode, self).save(*args, **kwargs)
 
-    def _format_addresses(self):
-        """
-        Ensure address format is correct: ";addr1;addr2;addr3;"
-        """
-        self.addresses = self.addresses.replace(',', ';')\
-                                       .replace(' ', '')\
-                                       .replace(';', ';')
-        if not self.addresses.startswith(';'):
-            self.addresses = ';' + self.addresses
-        if not self.addresses.endswith(';'):
-            self.addresses += ';'
-
-    def truncate_addresses(self):
-        """
-        ensures "addresses" field is not too long
-        """
-        max_length = self._meta.get_field('addresses').max_length
-        if len(self.addresses) <= max_length:
-            return
-        addresses = self.address_list
-        # +1 stands for the character added in self._format_address()
-        while len(';'.join(addresses)) + 2 > max_length:
-            addresses.pop()
-        self.addresses = ';'.join(addresses)
-
-    @cached_property
-    def address_list(self):
-        addresses = self.addresses.replace(' ', '')
-        if addresses.startswith(';'):
-            addresses = addresses[1:]
-        return addresses[0:-1].split(';')
-
     @property
     def netjson_id(self):
-        if self.addresses:
-            return self.address_list[0]
+        if len(self.addresses) > 0:
+            return self.addresses[0]
 
     @cached_property
     def local_addresses(self):
-        if self.addresses and len(self.address_list) > 1:
-            return self.address_list[1:]
+        if len(self.addresses) > 1:
+            return self.addresses[1:]
 
     @property
     def name(self):
@@ -114,7 +81,7 @@ def get_from_address(cls, address, topology):
         :param topology: Topology instance
         :returns: Node object or None
         """
-        address = ';{0};'.format(address)
+        address = '"{}"'.format(address)
         return cls.objects.filter(topology=topology,
                                   addresses__contains=address).first()
 
@@ -126,7 +93,7 @@ def count_address(cls, address, topology):
         :param topology: Topology instance
         :returns: int
         """
-        address = ';{0};'.format(address)
+        address = '"{}"'.format(address)
         return cls.objects.filter(topology=topology,
                                   addresses__contains=address).count()
 

django_netjsongraph/base/topology.py

@@ -208,14 +208,13 @@ def update(self, data=None):
             if node:  # pragma no cover
                 continue
             # if node doesn't exist create new
-            addresses = '{0};'.format(node_dict['id'])
-            addresses += ';'.join(node_dict.get('local_addresses', []))
+            addresses = [node_dict['id']]
+            addresses += node_dict.get('local_addresses', [])
             properties = node_dict.get('properties', {})
             node = self._create_node(addresses=addresses,
                                      properties=properties)
             if 'label' in node_dict:
                 node.label = node_dict.get('label')
-            node.truncate_addresses()
             node.full_clean()
             node.save()
 

django_netjsongraph/fixtures/test_nodes.json

@@ -5,7 +5,7 @@
         "fields":{
             "label":"node1",
             "topology":"a083b494-8e16-4054-9537-fb9eba914861",
-            "addresses": "192.168.0.1;",
+            "addresses": ["192.168.0.1"],
             "created":"2015-05-16T20:02:52.483Z",
             "modified":"2015-05-16T19:33:41.621Z",
             "properties": {}
@@ -17,7 +17,7 @@
         "fields":{
             "label":"node2",
             "topology":"a083b494-8e16-4054-9537-fb9eba914861",
-            "addresses": "192.168.0.2;",
+            "addresses": ["192.168.0.2"],
             "created":"2015-05-16T20:02:52.483Z",
             "modified":"2015-05-16T19:33:41.621Z",
             "properties": {}

django_netjsongraph/migrations/0008_create_new_address_field.py

@@ -0,0 +1,24 @@
+# Generated by Django 2.2.9 on 2019-12-24 07:52
+
+import jsonfield.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_netjsongraph', '0007_link_status_changed'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='node',
+            old_name='addresses',
+            new_name='addresses_old',
+        ),
+        migrations.AddField(
+            model_name='node',
+            name='addresses',
+            field=jsonfield.fields.JSONField(default=[]),
+        ),
+    ]

django_netjsongraph/migrations/0009_migrate_addresses_data.py

@@ -0,0 +1,16 @@
+# Generated by Django 2.2.9 on 2019-12-30 07:29
+
+from django.db import migrations
+
+from . import migrate_addresses
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_netjsongraph', '0008_create_new_address_field'),
+    ]
+
+    operations = [
+        migrations.RunPython(migrate_addresses)
+    ]

django_netjsongraph/migrations/0010_remove_old_addresses.py

@@ -0,0 +1,17 @@
+# Generated by Django 2.2.9 on 2019-12-30 07:45
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_netjsongraph', '0009_migrate_addresses_data'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='node',
+            name='addresses_old',
+        ),
+    ]

django_netjsongraph/migrations/__init__.py

@@ -0,0 +1,9 @@
+def migrate_addresses(apps, schema_editor, app='django_netjsongraph'):
+    Node = apps.get_model(app, 'Node')
+    for node in Node.objects.all():
+        addresses = node.addresses_old.replace(' ', '')
+        if addresses.startswith(';'):
+            addresses = addresses[1:]
+        addresses = addresses[0:-1].split(';')
+        node.addresses = addresses
+        node.save()

django_netjsongraph/tests/__init__.py

@@ -17,7 +17,7 @@ def _create_topology(self, **kwargs):
 
     def _create_node(self, **kwargs):
         options = dict(label='TestNode',
-                       addresses='192.168.0.1;',
+                       addresses=['192.168.0.1'],
                        created='2017-07-10T20:02:52.483Z',
                        modified='2017-07-14T20:02:52.483Z',
                        properties={})