Fixes #71 - add reorganizer and allow subinterfaces to have vsys/fw objects as parents (#79)

Author: shinmog

pandevice/firewall.py

@@ -18,6 +18,7 @@
 """Palo Alto Networks Firewall object"""
 
 # import modules
+import itertools
 import re
 import logging
 import xml.etree.ElementTree as ET
@@ -360,6 +361,63 @@ def commit_policy_and_objects(self, sync=False, exception=False):
         return self._commit(sync=sync, exclude="policy-and-objects",
                             exception=exception)
 
+    def organize_into_vsys(self, create_vsys_objects=True, refresh_vsys=True):
+        """Organizes all imported objects under the appropriate Vsys object.
+
+        Args:
+            create_vsys_objects (bool): Create the vsys objects (True) or use the ones already connected to this firewall (False).
+            refresh_vsys (bool): Refresh all vsys objects' parameters before doing the reorganization or not.  This is assumed True if create_vsys_objects is True.
+
+        """
+        from pandevice import network
+
+        # Mapping of device.Vsys params to pandevice classes.
+        mapping = {
+            'interface': network.Interface,
+            'vlans': network.Vlan,
+            'virtual_wires': network.VirtualWire,
+            'virtual_routers': network.VirtualRouter,
+        }
+
+        # Optional: create the vsys objects.
+        if create_vsys_objects:
+            device.Vsys.refreshall(self, name_only=True)
+
+        # Vsys to put objects into.
+        available_vsys = [x for x in self.children
+                          if isinstance(x, device.Vsys)]
+
+        # Optional: refresh the vsys params.
+        if create_vsys_objects or refresh_vsys:
+            for x in available_vsys:
+                x.refresh(refresh_children=False)
+
+        # List of objects we need to iterate over.
+        parents = self.children[:]
+
+        # Reorganize into vsys.
+        for x in itertools.chain(parents):
+            # Skip device.Vsys children.
+            if isinstance(x, device.Vsys):
+                continue
+
+            # Add children for later processing.
+            parents.extend(x.children)
+
+            # Check this class against the importable classes.
+            for param, importable_class in mapping.items():
+                if isinstance(x, importable_class):
+                    # Importable class found, check if it should be moved.
+                    for vsys in available_vsys:
+                        if (getattr(vsys, param) is not None and
+                                x.uid in getattr(vsys, param)):
+                            # If its vsys isn't right, move it.
+                            if x.vsys != vsys.uid:
+                                x.parent.remove(x)
+                                vsys.add(x)
+                            break
+                    break
+
 
 class FirewallState(object):
 

pandevice/network.py

@@ -549,11 +549,24 @@ class Subinterface(Interface):
     Do not instantiate this object. Use a subclass.
 
     """
+    _BASE_INTERFACE_NAME = 'entry BASE_INTERFACE_NAME'
+
     def set_name(self):
         """Create a name appropriate for a subinterface if it isn't already"""
         if '.' not in self.name:
             self.name = '{0}.{1}'.format(self.name, self.tag)
 
+    @property
+    def XPATH(self):
+        path = super(Subinterface, self).XPATH
+
+        if self._BASE_INTERFACE_NAME in path:
+            base = self.uid.split('.')[0]
+            path = path.replace(self._BASE_INTERFACE_NAME,
+                                "entry[@name='{0}']".format(base))
+
+        return path
+
 
 class AbstractSubinterface(object):
     """When a subinterface is needed, but the layer is unknown
@@ -689,8 +702,13 @@ class Layer3Subinterface(Subinterface):
     )
 
     def _setup(self):
-        # xpaths
+        # xpaths for parents: EthernetInterface, AggregateInterface)
         self._xpaths.add_profile(value='/layer3/units')
+        # xpaths for parents: firewall.Firewall, device.Vsys
+        self._xpaths.add_profile(
+            parents=('Firewall', 'Vsys'),
+            value=('/network/interface/ethernet/{0}/layer3/units'.format(
+                self._BASE_INTERFACE_NAME)))
 
         # xpath imports
         self._xpath_imports.add_profile(value='/network/interface')
@@ -759,8 +777,13 @@ class Layer2Subinterface(Subinterface):
     ALLOW_SET_VLAN = True
 
     def _setup(self):
-        # xpaths
+        # xpaths for parents: EthernetInterface, AggregateInterface
         self._xpaths.add_profile(value='/layer2/units')
+        # xpaths for parents: firewall.Firewall, device.Vsys
+        self._xpaths.add_profile(
+            parents=('Firewall', 'Vsys'),
+            value=('/network/interface/ethernet/{0}/layer2/units'.format(
+                self._BASE_INTERFACE_NAME)))
 
         # xpath imports
         self._xpath_imports.add_profile(value='/network/interface')

tests/test_integration.py

@@ -658,5 +658,64 @@ def test_set_xpath_from_addressobject_with_dg_panorama_parents(self):
 
         self.assertEqual(expected, ret_val)
 
+
+class TestVariousSubinterfaceXpaths(unittest.TestCase):
+    def test_l2_subinterface_with_firewall_parent(self):
+        fw = pandevice.firewall.Firewall('192.168.1.1', 'admin', 'admin', vsys='vsys2')
+        iface = pandevice.network.EthernetInterface('ethernet1/3', 'layer2')
+        eth = pandevice.network.Layer2Subinterface('ethernet1/3.3', 3)
+        iface.add(eth)
+        fw.add(iface)
+
+        expected = eth.xpath()
+
+        fw.add(eth)
+
+        self.assertEqual(expected, eth.xpath())
+
+    def test_l2_subinterface_with_vsys_parent(self):
+        fw = pandevice.firewall.Firewall('192.168.1.1', 'admin', 'admin')
+        vsys = pandevice.device.Vsys('vsys2')
+        iface = pandevice.network.EthernetInterface('ethernet1/3', 'layer2')
+        eth = pandevice.network.Layer2Subinterface('ethernet1/3.3', 3)
+        iface.add(eth)
+        vsys.add(iface)
+        fw.add(vsys)
+
+        expected = eth.xpath()
+
+        vsys.add(eth)
+
+        self.assertEqual(expected, eth.xpath())
+
+    def test_l3_subinterface_with_firewall_parent(self):
+        fw = pandevice.firewall.Firewall('192.168.1.1', 'admin', 'admin', vsys='vsys3')
+        iface = pandevice.network.EthernetInterface('ethernet1/4', 'layer3')
+        eth = pandevice.network.Layer3Subinterface('ethernet1/4.4', 4)
+        iface.add(eth)
+        fw.add(iface)
+
+        expected = eth.xpath()
+
+        fw.add(eth)
+
+        self.assertEqual(expected, eth.xpath())
+
+    def test_l3_subinterface_with_vsys_parent(self):
+        fw = pandevice.firewall.Firewall('192.168.1.1', 'admin', 'admin')
+        vsys = pandevice.device.Vsys('vsys3')
+        iface = pandevice.network.EthernetInterface('ethernet1/4', 'layer3')
+        eth = pandevice.network.Layer2Subinterface('ethernet1/4.4', 4)
+        iface.add(eth)
+        vsys.add(iface)
+        fw.add(vsys)
+
+        expected = eth.xpath()
+
+        vsys.add(eth)
+
+        self.assertEqual(expected, eth.xpath())
+
+
 if __name__=='__main__':
     unittest.main()