Closes #49: Introduction of circuit terminations

netbox/circuits/models.py

@@ -3,12 +3,35 @@ from django.core.urlresolvers import reverse
 from django.db import models
 
 from dcim.fields import ASNField
-from dcim.models import Site, Interface
 from extras.models import CustomFieldModel, CustomFieldValue
 from tenancy.models import Tenant
 from utilities.models import CreatedUpdatedModel
 
 
+TERM_SIDE_A = 'A'
+TERM_SIDE_Z = 'Z'
+TERM_SIDE_CHOICES = (
+    (TERM_SIDE_A, 'A'),
+    (TERM_SIDE_Z, 'Z'),
+)
+
+
+def humanize_speed(speed):
+    """
+    Humanize speeds given in Kbps (e.g. 10000000 becomes '10 Gbps')
+    """
+    if speed >= 1000000000 and speed % 1000000000 == 0:
+        return '{} Tbps'.format(speed / 1000000000)
+    elif speed >= 1000000 and speed % 1000000 == 0:
+        return '{} Gbps'.format(speed / 1000000)
+    elif speed >= 1000 and speed % 1000 == 0:
+        return '{} Mbps'.format(speed / 1000)
+    elif speed >= 1000:
+        return '{} Mbps'.format(float(speed) / 1000)
+    else:
+        return '{} Kbps'.format(speed)
+
+
 class Provider(CreatedUpdatedModel, CustomFieldModel):
     """
     Each Circuit belongs to a Provider. This is usually a telecommunications company or similar organization. This model
@@ -71,15 +94,8 @@ class Circuit(CreatedUpdatedModel, CustomFieldModel):
     provider = models.ForeignKey('Provider', related_name='circuits', on_delete=models.PROTECT)
     type = models.ForeignKey('CircuitType', related_name='circuits', on_delete=models.PROTECT)
     tenant = models.ForeignKey(Tenant, related_name='circuits', blank=True, null=True, on_delete=models.PROTECT)
-    site = models.ForeignKey(Site, related_name='circuits', on_delete=models.PROTECT)
-    interface = models.OneToOneField(Interface, related_name='circuit', blank=True, null=True)
     install_date = models.DateField(blank=True, null=True, verbose_name='Date installed')
-    port_speed = models.PositiveIntegerField(verbose_name='Port speed (Kbps)')
-    upstream_speed = models.PositiveIntegerField(blank=True, null=True, verbose_name='Upstream speed (Kbps)',
-                                                 help_text='Upstream speed, if different from port speed')
     commit_rate = models.PositiveIntegerField(blank=True, null=True, verbose_name='Commit rate (Kbps)')
-    xconnect_id = models.CharField(max_length=50, blank=True, verbose_name='Cross-connect ID')
-    pp_info = models.CharField(max_length=100, blank=True, verbose_name='Patch panel/port(s)')
     comments = models.TextField(blank=True)
     custom_field_values = GenericRelation(CustomFieldValue, content_type_field='obj_type', object_id_field='obj_id')
 
@@ -99,42 +115,61 @@ class Circuit(CreatedUpdatedModel, CustomFieldModel):
             self.provider.name,
             self.type.name,
             self.tenant.name if self.tenant else '',
-            self.site.name,
             self.install_date.isoformat() if self.install_date else '',
-            str(self.port_speed),
-            str(self.upstream_speed),
             str(self.commit_rate) if self.commit_rate else '',
-            self.xconnect_id,
-            self.pp_info,
         ])
 
-    def _humanize_speed(self, speed):
-        """
-        Humanize speeds given in Kbps (e.g. 10000000 becomes '10 Gbps')
-        """
-        if speed >= 1000000000 and speed % 1000000000 == 0:
-            return '{} Tbps'.format(speed / 1000000000)
-        elif speed >= 1000000 and speed % 1000000 == 0:
-            return '{} Gbps'.format(speed / 1000000)
-        elif speed >= 1000 and speed % 1000 == 0:
-            return '{} Mbps'.format(speed / 1000)
-        elif speed >= 1000:
-            return '{} Mbps'.format(float(speed) / 1000)
-        else:
-            return '{} Kbps'.format(speed)
+    def _get_termination(self, side):
+        for ct in self.terminations.all():
+            if ct.term_side == side:
+                return ct
+        return None
+
+    @property
+    def termination_a(self):
+        return self._get_termination('A')
+
+    @property
+    def termination_z(self):
+        return self._get_termination('Z')
+
+    def commit_rate_human(self):
+        return '' if not self.commit_rate else humanize_speed(self.commit_rate)
+    commit_rate_human.admin_order_field = 'commit_rate'
+
+
+class CircuitTermination(models.Model):
+    circuit = models.ForeignKey('Circuit', related_name='terminations', on_delete=models.CASCADE)
+    term_side = models.CharField(max_length=1, choices=TERM_SIDE_CHOICES, verbose_name='Termination')
+    site = models.ForeignKey('dcim.Site', related_name='circuit_terminations', on_delete=models.PROTECT)
+    interface = models.OneToOneField('dcim.Interface', related_name='circuit_termination', blank=True, null=True)
+    port_speed = models.PositiveIntegerField(verbose_name='Port speed (Kbps)')
+    upstream_speed = models.PositiveIntegerField(blank=True, null=True, verbose_name='Upstream speed (Kbps)',
+                                                 help_text='Upstream speed, if different from port speed')
+    xconnect_id = models.CharField(max_length=50, blank=True, verbose_name='Cross-connect ID')
+    pp_info = models.CharField(max_length=100, blank=True, verbose_name='Patch panel/port(s)')
+
+    class Meta:
+        ordering = ['circuit', 'term_side']
+        unique_together = ['circuit', 'term_side']
+
+    def __unicode__(self):
+        return u'{} (Side {})'.format(self.circuit, self.get_term_side_display())
+
+    def get_parent_url(self):
+        return self.circuit.get_absolute_url()
+
+    def get_peer_termination(self):
+        peer_side = 'Z' if self.term_side == 'A' else 'A'
+        try:
+            return CircuitTermination.objects.select_related('site').get(circuit=self.circuit, term_side=peer_side)
+        except CircuitTermination.DoesNotExist:
+            return None
 
     def port_speed_human(self):
-        return self._humanize_speed(self.port_speed)
+        return humanize_speed(self.port_speed)
     port_speed_human.admin_order_field = 'port_speed'
 
     def upstream_speed_human(self):
-        if not self.upstream_speed:
-            return ''
-        return self._humanize_speed(self.upstream_speed)
+        return '' if not self.upstream_speed else humanize_speed(self.upstream_speed)
     upstream_speed_human.admin_order_field = 'upstream_speed'
-
-    def commit_rate_human(self):
-        if not self.commit_rate:
-            return ''
-        return self._humanize_speed(self.commit_rate)
-    commit_rate_human.admin_order_field = 'commit_rate'