Added a trace property to the traceable interface classes

pynetbox/models/dcim.py

@@ -13,12 +13,56 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+from six.moves.urllib.parse import urlsplit
+
+from pynetbox.core.query import Request
 from pynetbox.core.response import Record, JsonField
 from pynetbox.core.endpoint import RODetailEndpoint
 from pynetbox.models.ipam import IpAddresses
 from pynetbox.models.circuits import Circuits
 
 
+class TraceableRecord(Record):
+    @property
+    def trace(self):
+        req = Request(
+            key=str(self.id) + "/trace" if not self.url else None,
+            base=self.endpoint.url,
+            token=self.api.token,
+            session_key=self.api.session_key,
+            http_session=self.api.http_session,
+        )
+        ret = []
+        for (termination_a_data, cable_data, termination_b_data) in req.get():
+            this_hop_ret = []
+            for hop_item_data in (termination_a_data, cable_data, termination_b_data):
+                # if not fully terminated then some items will be None
+                if not hop_item_data:
+                    this_hop_ret.append(hop_item_data)
+                    continue
+
+                url_path = urlsplit(hop_item_data["url"]).path
+                if url_path.startswith("/api/dcim/cables"):
+                    return_obj_class = Cables
+                elif url_path.startswith("/api/dcim/front-ports"):
+                    return_obj_class = FrontPorts
+                elif url_path.startswith("/api/dcim/interfaces"):
+                    return_obj_class = Interfaces
+                elif url_path.startswith("/api/dcim/rear-ports"):
+                    return_obj_class = RearPorts
+                else:
+                    raise NotImplementedError(
+                        "unable to unpack item data from endpoint '{}'".format(url_path)
+                    )
+                this_hop_ret.append(
+                    return_obj_class(hop_item_data, self.endpoint.api, self.endpoint)
+                )
+
+            ret.append(this_hop_ret)
+
+        return ret
+
+
 class DeviceTypes(Record):
     def __str__(self):
         return self.model
@@ -80,11 +124,27 @@ class ConnectedEndpoint(Record):
     device = Devices
 
 
-class Interfaces(Record):
+class Interfaces(TraceableRecord):
     interface_connection = InterfaceConnection
     connected_endpoint = ConnectedEndpoint
 
 
+class PowerOutlets(TraceableRecord):
+    device = Devices
+
+
+class PowerPorts(TraceableRecord):
+    device = Devices
+
+
+class ConsolePorts(TraceableRecord):
+    device = Devices
+
+
+class ConsoleServerPorts(TraceableRecord):
+    device = Devices
+
+
 class RackReservations(Record):
     def __str__(self):
         return self.description
@@ -99,6 +159,14 @@ class RUs(Record):
     device = Devices
 
 
+class FrontPorts(Record):
+    device = Devices
+
+
+class RearPorts(Record):
+    device = Devices
+
+
 class Racks(Record):
     @property
     def units(self):
@@ -154,7 +222,26 @@ def __str__(self):
 
 class Cables(Record):
     def __str__(self):
-        return "{} <> {}".format(self.termination_a, self.termination_b)
+        # populate the terminations to get the full names if they are not already
+        try:
+            termination_a_name = self.termination_a.name
+        except AttributeError:
+            try:
+                self.termination_a.full_details()
+            except TypeError:
+                self.termination_a.full_details(self)
+            termination_a_name = getattr(self.termination_a, "name", self.termination_a)
+
+        try:
+            termination_b_name = self.termination_b.name
+        except AttributeError:
+            try:
+                self.termination_b.full_details()
+            except TypeError:
+                self.termination_b.full_details(self)
+            termination_b_name = getattr(self.termination_b, "name", self.termination_b)
+
+        return "{} <> {}".format(termination_a_name, termination_b_name)
 
     termination_a = Termination
     termination_b = Termination

tests/test_dcim.py

@@ -5,9 +5,9 @@
 from .util import Response
 
 if six.PY3:
-    from unittest.mock import patch
+    from unittest.mock import patch, call
 else:
-    from mock import patch
+    from mock import patch, call
 
 
 api = pynetbox.api("http://localhost:8000", token="abc123",)
@@ -526,11 +526,31 @@ def test_get_circuit(self):
             self.assertTrue(isinstance(ret, self.ret))
             self.assertTrue(isinstance(str(ret), str))
             self.assertTrue(isinstance(dict(ret), dict))
-            mock.assert_called_with(
-                "http://localhost:8000/api/{}/{}/1/".format(
-                    self.app, self.name.replace("_", "-")
-                ),
-                headers=HEADERS,
-                params={},
-                json=None,
+            mock.assert_has_calls(
+                [
+                    call(
+                        "http://localhost:8000/api/{}/{}/1/".format(
+                            self.app, self.name.replace("_", "-")
+                        ),
+                        headers=HEADERS,
+                        params={},
+                        json=None,
+                    ),
+                    call(
+                        "http://localhost:8000/api/{}/{}/1/".format(
+                            "circuits", "circuit-terminations"
+                        ),
+                        headers=HEADERS,
+                        params={},
+                        json=None,
+                    ),
+                    call(
+                        "http://localhost:8000/api/{}/{}/1/".format(
+                            "circuits", "circuit-terminations"
+                        ),
+                        headers=HEADERS,
+                        params={},
+                        json=None,
+                    ),
+                ]
             )