Fixes #92 - fixes device.Vsys and reclassify network.VirtualWire as VsysOperations (#94)

Author: shinmog

pandevice/base.py

@@ -314,13 +314,13 @@ def _parent_xpath(self):
         if self.parent is None:
             return ""
         else:
-            return self.parent._build_xpath(self.ROOT)
+            return self.parent._build_xpath(self.ROOT, None)
 
-    def _build_xpath(self, root):
+    def _build_xpath(self, root, vsys):
         if self.parent is None:
             # self with no parent
             return ""
-        parent_xpath = self.parent._build_xpath(root) + self.XPATH
+        parent_xpath = self.parent._build_xpath(root, vsys) + self.XPATH
         if self.SUFFIX is not None:
             parent_xpath += self.SUFFIX % (self.uid, )
         return parent_xpath
@@ -334,9 +334,12 @@ def xpath_panorama(self):
             return self.parent.xpath_panorama()
 
     def _root_xpath_vsys(self, vsys):
-        root_xpath = "/config/devices/entry[@name='localhost.localdomain']/vsys"
-        specific_vsys = "/entry[@name='{0}']".format(vsys) if vsys else ""
-        return root_xpath + specific_vsys
+        if vsys == 'shared':
+            return '/config/shared'
+
+        xpath = "/config/devices/entry[@name='localhost.localdomain']"
+        xpath += "/vsys/entry[@name='{0}']".format(vsys or 'vsys1')
+        return xpath
 
     def element(self, with_children=True, comparable=False):
         """Construct an ElementTree for this PanObject and all its children
@@ -3273,14 +3276,14 @@ def set_config_changed(self, scope=None):
         if scope not in self.config_changed:
             self.config_changed.append(scope)
 
-    def _build_xpath(self, root):
-        return self.xpath_root(root)
+    def _build_xpath(self, root, vsys):
+        return self.xpath_root(root, vsys or self.vsys)
 
-    def xpath_root(self, root_type):
+    def xpath_root(self, root_type, vsys):
         if root_type == Root.DEVICE:
             xpath = self.xpath_device()
         elif root_type == Root.VSYS:
-            xpath = self.xpath_vsys()
+            xpath = self._root_xpath_vsys(vsys)
         elif root_type == Root.MGTCONFIG:
             xpath = self.xpath_mgtconfig()
         elif root_type == Root.PANORAMA:

pandevice/device.py

@@ -131,22 +131,12 @@ def _setup(self):
         self._params = tuple(params)
 
     def xpath_vsys(self):
-        if self.name == "shared":
-            return "/config/shared"
-        elif self.name is None:
-            return self._root_xpath_vsys('vsys1')
-        else:
-            return self._root_xpath_vsys(self.name)
-
-    def _build_xpath(self, root):
-        if root == Root.VSYS:
-            return super(Vsys, self)._build_xpath(root)
-        else:
-            # If original object is not a VSYS Root, then bypass the vsys part of the xpath
-            if self.parent is None:
-                return ""
-            else:
-                return self.parent._build_xpath(root)
+        return self._root_xpath_vsys(self.name)
+
+    def _build_xpath(self, root, vsys):
+        if self.parent is None:
+            return ''
+        return self.parent._build_xpath(root, self.name)
 
     @property
     def vsys(self):

pandevice/firewall.py

@@ -150,12 +150,7 @@ def vsys(self, value):
             self.ha_peer._vsys = value
 
     def xpath_vsys(self):
-        if self.vsys == "shared":
-            return "/config/shared"
-        elif self.vsys is None:
-            return self._root_xpath_vsys('vsys1')
-        else:
-            return self._root_xpath_vsys(self.vsys)
+        return self._root_xpath_vsys(self.vsys)
 
     def xpath_panorama(self):
         raise err.PanDeviceError("Attempt to modify Panorama configuration on non-Panorama device")

pandevice/network.py

@@ -505,7 +505,7 @@ def _setup(self):
         self._params = tuple(params)
 
 
-class VirtualWire(VersionedPanObject):
+class VirtualWire(VsysOperations):
     """Virtual wires (vwire)
 
     Args:
@@ -524,6 +524,9 @@ def _setup(self):
         # xpaths
         self._xpaths.add_profile(value='/network/virtual-wire')
 
+        # xpath imports
+        self._xpath_imports.add_profile(value='/network/virtual-wire')
+
         # params
         params = []
 

pandevice/panorama.py

@@ -87,13 +87,14 @@ def xpath_vsys(self):
         else:
             return "/config/devices/entry[@name='localhost.localdomain']/device-group/entry[@name='%s']" % self.name
 
-    def _build_xpath(self, root):
+    def _build_xpath(self, root, vsys):
         if (self.name == "shared" or self.name is None) and root == Root.VSYS:
             # This is a Vsys object in shared Panorama scope, so proceed normally
-            return super(DeviceGroup, self)._build_xpath(root)
+            return super(DeviceGroup, self)._build_xpath(root,
+                self.name or 'shared')
         else:
             # This is a member of the device-group, so override to use DeviceGroup root
-            return super(DeviceGroup, self)._build_xpath(self.ROOT)
+            return super(DeviceGroup, self)._build_xpath(self.ROOT, self.name)
 
 
 class Panorama(base.PanDevice):

tests/test_base.py

@@ -372,7 +372,7 @@ def test_parent_xpath_for_xpath_parent(self):
         ret_val = self.obj._parent_xpath()
 
         self.assertEqual(Path, ret_val)
-        self.obj.parent._build_xpath.assert_called_once_with(0)
+        self.obj.parent._build_xpath.assert_called_once_with(0, None)
 
     def test_xpath_vsys_without_parent(self):
         ret_val = self.obj.xpath_vsys()

tests/test_vsys_xpaths.py

@@ -0,0 +1,98 @@
+import pytest
+
+from pandevice import device
+from pandevice import firewall
+from pandevice import network
+from pandevice import objects
+from pandevice import panorama
+
+
+def _check(obj, vsys, with_pano, chk_import=False):
+    if chk_import:
+        func = 'xpath_import_base'
+    else:
+        func = 'xpath'
+    fw = firewall.Firewall('127.0.0.1', 'admin', 'admin', serial='01234567890')
+    fw.vsys = vsys
+    fw.add(obj)
+
+    if with_pano:
+        pano = panorama.Panorama('127.0.0.1', 'admin2', 'admin2')
+        pano.add(fw)
+
+    expected = getattr(obj, func)()
+
+    fw.remove(obj)
+    fw.vsys = None
+    vsys = device.Vsys(vsys or 'vsys1')
+    fw.add(vsys)
+    vsys.add(obj)
+
+    result = getattr(obj, func)()
+
+    assert expected == result
+
+
+@pytest.mark.parametrize('vsys', [None, 'vsys1', 'vsys3'])
+@pytest.mark.parametrize('with_pano', [False, True])
+def test_xpath_for_vsys_root(vsys, with_pano):
+    obj = network.Zone('myzone')
+    _check(obj, vsys, with_pano)
+
+
+@pytest.mark.parametrize('vsys', [None, 'vsys1', 'vsys3'])
+@pytest.mark.parametrize('with_pano', [False, True])
+def test_xpath_for_device_root(vsys, with_pano):
+    obj = device.SystemSettings(hostname='example')
+    _check(obj, vsys, with_pano)
+
+
+@pytest.mark.parametrize('vsys', [None, 'vsys1', 'vsys3'])
+@pytest.mark.parametrize('with_pano', [False, True])
+def test_xpath_for_mgtconfig_root(vsys, with_pano):
+    obj = device.Administrator('newadmin')
+    _check(obj, vsys, with_pano)
+
+
+@pytest.mark.parametrize('vsys', [None, 'vsys1', 'vsys3'])
+@pytest.mark.parametrize('with_pano', [False, True])
+@pytest.mark.parametrize('obj', [
+    network.EthernetInterface('ethernet1/3', 'layer3'),
+    network.Layer3Subinterface('ethernet1/4.42', 42),
+    network.Layer2Subinterface('ethernet1/4.420', 420),
+    network.VirtualRouter('someroute'),
+    network.VirtualWire('tripwire'),
+    network.Vlan('myvlan'),
+])
+def test_xpath_import(vsys, with_pano, obj):
+    _check(obj, vsys, with_pano, True)
+
+
+def test_vsys_xpath_unchanged():
+    expected = "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys3']"
+    c = firewall.Firewall('127.0.0.1', 'admin', 'admin')
+    c.vsys = 'vsys3'
+
+    assert expected == c.xpath_vsys()
+
+    c.vsys = None
+    vsys = device.Vsys('vsys3')
+    c.add(vsys)
+
+    assert expected == vsys.xpath_vsys()
+
+    zone = network.Zone('myzone')
+    vsys.add(zone)
+
+    assert expected == zone.xpath_vsys()
+
+
+def test_device_group_xpath_unchanged():
+    expected = "/config/devices/entry[@name='localhost.localdomain']/device-group/entry[@name='somegroup']/address/entry[@name='intnet']"
+    pano = panorama.Panorama('127.0.0.1')
+    dg = panorama.DeviceGroup('somegroup')
+    ao = objects.AddressObject('intnet', '192.168.0.0/16')
+    pano.add(dg)
+    dg.add(ao)
+
+    assert expected == ao.xpath()