Merge branch 'release/0.6.1'

Author: btorresgil

.travis.yml

@@ -13,3 +13,13 @@ install: pip install -r requirements.txt
 
 # command to run tests, e.g. python setup.py test
 script: python setup.py test
+
+# deploy to pypi on tagged commits
+deploy:
+  provider: pypi
+  user: btorresgil
+  password:
+    secure: HDdWhCTXRqlWslYJ2yNEq4ObVlqjBgBMQb1ZiwkMFWc28uDR4L8jrtyEgiu1EqVEHFACSHM52ktd92Baufiv350qwpu2enljM2XA3hYTqYkM2dp/ItsKYZ/4QUkfnWUekebav1FkoPpoFMWkAeoDkQwVTKexJTqTwTnr1atTA7Q=
+  on:
+    tags: true
+

HISTORY.rst

@@ -3,6 +3,18 @@
 History
 =======
 
+0.6.1
+-----
+
+Released: 2018-03-27
+
+Status: Alpha
+
+- Added: visualize configuration tree in Jupyter Notebooks and graphviz
+- Fixed: small xpath generation issue
+- Fixed: uid is equal to id when id exists
+
+
 0.6.0
 -----
 

pandevice/__init__.py

@@ -23,7 +23,7 @@
 
 __author__ = 'Palo Alto Networks'
 __email__ = '[email protected]'
-__version__ = '0.6.0'
+__version__ = '0.6.1'
 
 
 import logging
@@ -43,6 +43,9 @@ def emit(self, record):
     logging.NullHandler = NullHandler
 
 
+DOCUMENTATION_URL = 'http://pandevice.readthedocs.io/en/latest'
+
+
 def getlogger(name=__name__):
     import types
     logger_instance = logging.getLogger(name)
@@ -185,6 +188,29 @@ def stringToVersion(other):
     return other
 
 
+def tree_legend_dot():
+    """Create a graphviz dot string for a legend graph"""
+    modules = ['firewall', 'policies', 'objects', 'network', 'device', 'panorama', 'ha']
+    result = 'graph legend {' \
+             'graph [fontsize=10, margin=0.001];' \
+             'node [shape=box, fontsize=10, height=0.001, margin=0.1, ordering=out];'
+    for module in modules:
+        result += '{module} [style=filled fillcolor={color} URL="{url}' \
+                  '/module-{module}.html" target="_blank"];'.format(
+                   module=module,
+                   color=node_color(module),
+                   url=DOCUMENTATION_URL,
+        )
+    result += '}'
+    return result
+
+
+def tree_legend():
+    """Display a legend for the colors of the tree method"""
+    import graphviz
+    return graphviz.Source(tree_legend_dot())
+
+
 # Convenience methods used internally by module
 # Do not use these methods outside the module
 
@@ -303,3 +329,19 @@ def yesno(value):
         False: "no",
     }
     return convert[value]
+
+
+def node_color(module):
+    nodecolor = {
+        'device':    'lightpink',
+        'firewall':  'lightblue',
+        'ha':        'lavender',
+        'network':   'lightcyan',
+        'objects':   'lemonchiffon',
+        'policies':  'lightsalmon',
+        'panorama':  'palegreen2',
+    }
+    try:
+        return nodecolor[module]
+    except KeyError:
+        return ''

pandevice/base.py

@@ -152,7 +152,9 @@ def vsys(self, value):
     @property
     def uid(self):
         """Returns the unique identifier of this object as a string."""
-        if self.NAME is not None:
+        if hasattr(self, 'id'):
+            return self.id
+        elif self.NAME is not None:
             return str(getattr(self, self.NAME))
         else:
             return None
@@ -1664,6 +1666,59 @@ def _perform_vsys_dict_import_delete(self, dev, vsys_dict):
                 # imports.
                 dev.xapi.delete(xpath, retry_on_peer=self.HA_SYNC)
 
+    def dot(self):
+        result = 'digraph configtree {graph [rankdir=LR, fontsize=10, margin=0.001];' \
+                 'node [shape=box, fontsize=10, height=0.001, margin=0.1, ordering=out];'
+        result += self._dot(root_node=True)
+        result += '}'
+        return result
+
+    def _dot(self, root_node=False):
+        node = type(self).__name__
+        module = type(self).__module__.split('.')[-1]
+        result = '"{node_name}" [style=filled fillcolor={color} ' \
+               'URL="{url}' \
+               '/module-{module}.html#pandevice.{module}.{node}" ' \
+               'target="_blank"];'
+        result = result.format(node_name=node+' : '+self.uid,
+                               node=node,
+                               module=module,
+                               url=pandevice.DOCUMENTATION_URL,
+                               color=pandevice.node_color(module))
+        # Make recursive call to children
+        for child in self.children:
+            result += child._dot()
+        # Build relationship with parent
+        if not root_node and self.parent is not None:
+            if self.parent is not None:
+                result += '"{0}" -> "{1}";'.format(
+                    type(self.parent).__name__+' : '+self.parent.uid,
+                    type(self).__name__+' : '+self.uid,
+                )
+        return result
+
+    def tree(self):
+        """Display a graph of the configuration tree
+
+        The tree includes this object and its children, recursively.
+
+        This method is only for use in Jupyder Notebooks
+
+        """
+        import graphviz
+        return graphviz.Source(self.dot())
+
+    def fulltree(self):
+        """Display a graph of the entire configuration tree
+
+        This method is only for use in Jupyder Notebooks
+
+        """
+        if self.parent is not None:
+            return self.parent.fulltree()
+        return self.tree()
+
+
 
 class VersioningSupport(object):
     """A class that supports getting version specific values of something.

pandevice/firewall.py

@@ -281,7 +281,8 @@ def create_vsys(self):
             if self.vsys_name is not None:
                 ET.SubElement(element, "display-name").text = self.vsys_name
             self.set_config_changed()
-            self.xapi.set(self._root_xpath_vsys(None), ET.tostring(element), retry_on_peer=True)
+            path = self._root_xpath_vsys(None).rsplit('/', 1)[0]
+            self.xapi.set(path, ET.tostring(element, encoding='utf-8'), retry_on_peer=True)
 
     def delete_vsys(self):
         """Delete the vsys on the live device that this Firewall object represents"""

setup.py

@@ -23,7 +23,7 @@
 
 setup(
     name='pandevice',
-    version='0.6.0',
+    version='0.6.1',
     description='Framework for interacting with Palo Alto Networks devices via API',
     long_description='The Palo Alto Networks Device Framework is a way to interact with Palo Alto Networks devices (including Next-generation Firewalls and Panorama) using the device API that is object oriented and conceptually similar to interaction with the device via the GUI or CLI.',
     author='Palo Alto Networks',