Add virtual prop support to node/type repr methods (SYN-8919) (#4209)

Author: Cisphyx

synapse/lib/node.py

@@ -14,21 +14,35 @@
 
 class NodeBase:
 
-    def repr(self, name=None, defv=None):
+    def repr(self, name=None, defv=None, virts=None):
 
         if name is None:
-            return self.form.type.repr(self.ndef[1])
+            typeitem = self.form.type
+            if virts is None:
+                return typeitem.repr(self.valu())
+
+            virtgetr = typeitem.getVirtGetr(virts)
+            virttype = typeitem.getVirtType(virts)
+            return virttype.repr(self.valu(virts=virtgetr))
 
         prop = self.form.props.get(name)
         if prop is None:
             mesg = f'No property named {name}.'
             raise s_exc.NoSuchProp(mesg=mesg, form=self.form.name, prop=name)
 
-        valu = self.get(name)
-        if valu is None:
-            return defv
+        typeitem = prop.type
+
+        if virts is None:
+            if (valu := self.get(name)) is None:
+                return defv
+            return typeitem.repr(valu)
 
-        return prop.type.repr(valu)
+        virtgetr = typeitem.getVirtGetr(virts)
+        virttype = typeitem.getVirtType(virts)
+
+        if (valu := self.get(name, virts=virtgetr)) is None:
+            return defv
+        return virttype.repr(valu)
 
     def reprs(self):
         '''

synapse/lib/stormtypes.py

@@ -1644,10 +1644,17 @@ async def trycast(self, name, valu):
 
     @stormfunc(readonly=True)
     async def _repr(self, name, valu):
-        name = await toprim(name)
+        name = await tostr(name)
         valu = await toprim(valu)
 
-        return self._reqTypeByName(name).repr(valu)
+        parts = name.strip().split('*')
+        name = parts[0]
+
+        typeitem = self._reqTypeByName(name)
+        if len(parts) > 1:
+            typeitem = typeitem.getVirtType(parts[1:])
+
+        return typeitem.repr(valu)
 
     @stormfunc(readonly=True)
     async def _exit(self, mesg=None, **kwargs):
@@ -6188,7 +6195,17 @@ async def _methNodeNdef(self):
 
     @stormfunc(readonly=True)
     async def _methNodeRepr(self, name=None, defv=None):
-        return self.valu.repr(name=name, defv=defv)
+        name = await toprim(name)
+        defv = await toprim(defv)
+        virts = None
+
+        if name is not None:
+            parts = name.strip().split('*')
+            if len(parts) > 1:
+                name = parts[0] or None
+                virts = parts[1:]
+
+        return self.valu.repr(name=name, virts=virts, defv=defv)
 
     @stormfunc(readonly=True)
     async def _methNodeIden(self):

synapse/lib/types.py

@@ -175,6 +175,15 @@ def getVirtType(self, virts):
             return virt[0].getVirtType(virts[1:])
         return virt[0]
 
+    def getVirtGetr(self, virts):
+        name = virts[0]
+        if (virt := self.virts.get(name)) is None:
+            raise s_exc.NoSuchVirt.init(name, self)
+
+        if len(virts) > 1:
+            return (virt[1],) + virt[0].getVirtGetr(virts[1:])
+        return (virt[1],)
+
     def getRuntPode(self):
 
         ctor = '.'.join([self.__class__.__module__, self.__class__.__qualname__])

synapse/tests/test_lib_stormtypes.py

@@ -955,6 +955,8 @@ async def getseqn(genr, name, key):
             self.none(view.parent)
             self.none(view.info.get('parent'))
 
+            self.eq('0.0.0.1', await core.callStorm('return($lib.repr(inet:server*ip, ([4, 1])))'))
+
     async def test_storm_lib_ps(self):
 
         async with self.getTestCore() as core:
@@ -1224,6 +1226,11 @@ async def test_storm_lib_node(self):
             pode[1].pop('path')
             self.eq(pode, apode)
 
+            self.eq('1.2.3.4', await core.callStorm('[ inet:server=1.2.3.4:80 ] return($node.repr(*ip))'))
+            self.eq('1.2.3.4', await core.callStorm('[ inet:flow=* :dst=1.2.3.4:80 ] return($node.repr(dst*ip))'))
+
+            self.eq(None, await core.callStorm('[ inet:flow=* ] return($node.repr(dst*ip))'))
+
     async def test_storm_lib_dict(self):
         async with self.getTestCore() as core:
             nodes = await core.nodes('$blah = ({"foo": "vertex.link"}) [ inet:fqdn=$blah.foo ]')

synapse/tests/test_lib_types.py

@@ -900,6 +900,9 @@ async def test_ival(self):
             with self.raises(s_exc.NoSuchVirt):
                 ival.getVirtType(['min', 'newp'])
 
+            with self.raises(s_exc.NoSuchVirt):
+                ival.getVirtGetr(['min', 'newp'])
+
     async def test_loc(self):
         model = s_datamodel.Model()
         loctype = model.types.get('loc')