Merge pull request #79 from napalm-automation/develop

Merging develop into master for the new testing framework

Author: mirceaulinic

.gitignore

@@ -59,4 +59,4 @@ env
 *.swp
 
 test/unit/test_devices.py
-
+report.json

.travis.yml

@@ -13,31 +13,8 @@ deploy:
     tags: true
     branch: master
 script:
-- pylama .
-- cd test/unit
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_bgp_config
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_bgp_neighbors
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_bgp_neighbors_detail
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_environment
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_facts
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_interfaces
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_interfaces_counters
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_lldp_neighbors
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_lldp_neighbors_detail
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_arp_table
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_ntp_peers
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_ntp_stats
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_ntp_servers
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_interfaces_ip
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_mac_address_table
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_route_to
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_snmp_information
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_probes_config
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_probes_results
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_traceroute
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_users
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_optics
-- nosetests --with-coverage --cover-package napalm_junos -v TestJunOSDriver:TestGetterJunOSDriver.test_get_config
-- cd ../..
-- coverage combine test/unit/.coverage
-after_success: coveralls
+  - py.test --cov-report= --cov=napalm_junos test/
+  - pylama .
+after_success:
+- coveralls
+- if [ $TRAVIS_TAG ]; then curl -X POST https://readthedocs.org/build/napalm; fi

napalm_junos/constants.py

@@ -0,0 +1,16 @@
+"""Constants for the JunOS driver."""
+
+from __future__ import unicode_literals
+
+from napalm_base.constants import *  # noqa
+
+# OpenConfig mapping
+# ref: https://github.com/openconfig/public/blob/master/release/models/network-instance/openconfig-network-instance-types.yang  # noqa
+OC_NETWORK_INSTANCE_TYPE_MAP = {
+    'default': 'DEFAULT_INSTANCE',
+    'l2vpn': 'L2VPN',
+    'vrf': 'L3VRF',
+    'evpn': 'BGP_EVPN',
+    'vpls': 'BGP_VPLS',
+    'forwarding': 'L2P2P'
+}

napalm_junos/junos.py

@@ -36,6 +36,7 @@
 from napalm_base.base import NetworkDriver
 from napalm_base.utils import string_parsers
 from napalm_base.utils import py23_compat
+import napalm_junos.constants as C
 from napalm_base.exceptions import ConnectionException
 from napalm_base.exceptions import MergeConfigException
 from napalm_base.exceptions import CommandErrorException
@@ -84,26 +85,33 @@ def open(self):
             del self.device.cu
         self.device.bind(cu=Config)
         if self.config_lock:
-            self.lock()
+            self._lock()
 
     def close(self):
         """Close the connection."""
         if self.config_lock:
-            self.unlock()
+            self._unlock()
         self.device.close()
 
-    def lock(self):
+    def _lock(self):
         """Lock the config DB."""
         if not self.locked:
             self.device.cu.lock()
             self.locked = True
 
-    def unlock(self):
+    def _unlock(self):
         """Unlock the config DB."""
         if self.locked:
             self.device.cu.unlock()
             self.locked = False
 
+    def is_alive(self):
+        # evaluate the state of the underlying SSH connection
+        # and also the NETCONF status from PyEZ
+        return {
+            'is_alive': self.device._conn._session.transport.is_active() and self.device.connected
+        }
+
     def _load_candidate(self, filename, config, overwrite):
         if filename is None:
             configuration = config
@@ -114,7 +122,7 @@ def _load_candidate(self, filename, config, overwrite):
         if not self.config_lock:
             # if not locked during connection time
             # will try to lock it if not already aquired
-            self.lock()
+            self._lock()
             # and the device will be locked till first commit/rollback
 
         try:
@@ -148,13 +156,13 @@ def commit_config(self):
         """Commit configuration."""
         self.device.cu.commit()
         if not self.config_lock:
-            self.unlock()
+            self._unlock()
 
     def discard_config(self):
         """Discard changes (rollback 0)."""
         self.device.cu.rollback(rb_id=0)
         if not self.config_lock:
-            self.unlock()
+            self._unlock()
 
     def rollback(self):
         """Rollback to previous commit."""
@@ -468,7 +476,7 @@ def get_lldp_neighbors_detail(self, interface=''):
 
         return lldp_neighbors
 
-    def cli(self, commands=None):
+    def cli(self, commands):
         """Execute raw CLI commands and returns their output."""
         cli_output = {}
 
@@ -951,21 +959,24 @@ def get_mac_address_table(self):
 
         return mac_address_table
 
-    def get_route_to(self, destination=None, protocol=None):
+    def get_route_to(self, destination='', protocol=''):
         """Return route details to a specific destination, learned from a certain protocol."""
         routes = {}
 
         if not isinstance(destination, py23_compat.string_types):
             raise TypeError('Please specify a valid destination!')
 
-        if not isinstance(protocol, py23_compat.string_types) or \
-           protocol.lower() not in ('static', 'bgp', 'isis'):
+        if protocol and (not isinstance(protocol, py23_compat.string_types) or
+           protocol.lower() not in ('static', 'bgp', 'isis', 'connected', 'direct')):
             raise TypeError("Protocol not supported: {protocol}.".format(
                 protocol=protocol
             ))
 
         protocol = protocol.lower()
 
+        if protocol == 'connected':
+            protocol = 'direct'  # this is how is called on JunOS
+
         _COMMON_PROTOCOL_FIELDS_ = [
             'destination',
             'prefix_length',
@@ -1003,18 +1014,19 @@ def get_route_to(self, destination=None, protocol=None):
                 'level',
                 'metric',
                 'local_as'
-            ],
-            'static': [  # nothing specific to static routes
             ]
         }
 
         routes_table = junos_views.junos_protocol_route_table(self.device)
 
+        rt_kargs = {
+            'destination': destination
+        }
+        if protocol:
+            rt_kargs['protocol'] = protocol
+
         try:
-            routes_table.get(
-                destination=destination,
-                protocol=protocol
-            )
+            routes_table.get(**rt_kargs)
         except RpcTimeoutError:
             # on devices with milions of routes
             # in case the destination is too generic (e.g.: 10/8)
@@ -1030,7 +1042,7 @@ def get_route_to(self, destination=None, protocol=None):
 
         for route in routes_items:
             d = {}
-            next_hop = route[0]
+            # next_hop = route[0]
             d = {elem[0]: elem[1] for elem in route[1]}
             destination = napalm_base.helpers.ip(d.pop('destination', ''))
             prefix_length = d.pop('prefix_length', 32)
@@ -1048,10 +1060,13 @@ def get_route_to(self, destination=None, protocol=None):
                 # to be sure that contains only AS Numbers
             if d.get('inactive_reason') is None:
                 d['inactive_reason'] = u''
+            route_protocol = d.get('protocol').lower()
+            if protocol and protocol != route_protocol:
+                continue
             communities = d.get('communities')
             if communities is not None and type(communities) is not list:
                 d['communities'] = [communities]
-            d['next_hop'] = unicode(next_hop)
+            # d['next_hop'] = unicode(next_hop)
             d_keys = d.keys()
             # fields that are not in _COMMON_PROTOCOL_FIELDS_ are supposed to be protocol specific
             all_protocol_attributes = {
@@ -1061,7 +1076,7 @@ def get_route_to(self, destination=None, protocol=None):
             }
             protocol_attributes = {
                 key: value for key, value in all_protocol_attributes.iteritems()
-                if key in _PROTOCOL_SPECIFIC_FIELDS_.get(protocol)
+                if key in _PROTOCOL_SPECIFIC_FIELDS_.get(route_protocol, [])
             }
             d['protocol_attributes'] = protocol_attributes
             if destination not in routes.keys():
@@ -1170,7 +1185,11 @@ def get_probes_results(self):
 
         return probes_results
 
-    def traceroute(self, destination, source='', ttl=0, timeout=0):
+    def traceroute(self,
+                   destination,
+                   source=C.TRACEROUTE_SOURCE,
+                   ttl=C.TRACEROUTE_TTL,
+                   timeout=C.TRACEROUTE_TIMEOUT):
         """Execute traceroute and return results."""
         traceroute_result = {}
 
@@ -1285,9 +1304,10 @@ def get_optics(self):
         # Formatting data into return data structure
         optics_detail = {}
         for intf_optic_item in optics_items:
+            interface_name = py23_compat.text_type(intf_optic_item[0])
             optics = dict(intf_optic_item[1])
-            if intf_optic_item[0] not in optics_detail:
-                optics_detail[intf_optic_item[0]] = {}
+            if interface_name not in optics_detail:
+                optics_detail[interface_name] = {}
 
             # Defaulting avg, min, max values to 0.0 since device does not
             # return these values
@@ -1327,7 +1347,7 @@ def get_optics(self):
                         }]
                     }
                 }
-            optics_detail[intf_optic_item[0]] = intf_optics
+            optics_detail[interface_name] = intf_optics
 
         return optics_detail
 
@@ -1353,3 +1373,60 @@ def get_config(self, retrieve='all'):
             rv['running'] = py23_compat.text_type(config.text.encode('ascii', 'replace'))
 
         return rv
+
+    def get_network_instances(self, name=''):
+
+        network_instances = {}
+
+        ri_table = junos_views.junos_nw_instances_table(self.device)
+        ri_table.get()
+        ri_entries = ri_table.items()
+
+        vrf_interfaces = []
+
+        for ri_entry in ri_entries:
+            ri_name = py23_compat.text_type(ri_entry[0])
+            ri_details = {
+                d[0]: d[1] for d in ri_entry[1]
+            }
+            ri_type = ri_details['instance_type']
+            if ri_type is None:
+                ri_type = 'default'
+            ri_rd = ri_details['route_distinguisher']
+            ri_interfaces = ri_details['interfaces']
+            network_instances[ri_name] = {
+                'name': ri_name,
+                'type': C.OC_NETWORK_INSTANCE_TYPE_MAP.get(ri_type, ri_type),  # default: return raw
+                'state': {
+                    'route_distinguisher': ri_rd if ri_rd else ''
+                },
+                'interfaces': {
+                    'interface': {
+                        intrf_name: {} for intrf_name in ri_interfaces if intrf_name
+                    }
+                }
+            }
+            vrf_interfaces.extend(network_instances[ri_name]['interfaces']['interface'].keys())
+
+        all_interfaces = self.get_interfaces().keys()
+        default_interfaces = list(set(all_interfaces) - set(vrf_interfaces))
+        if 'default' not in network_instances:
+            network_instances['default'] = {
+                'name': 'default',
+                'type': C.OC_NETWORK_INSTANCE_TYPE_MAP.get('default'),
+                'state': {
+                    'route_distinguisher': ''
+                },
+                'interfaces': {
+                    'interface': {
+                        py23_compat.text_type(intrf_name): {}
+                        for intrf_name in default_interfaces
+                    }
+                }
+            }
+
+        if not name:
+            return network_instances
+        if name not in network_instances:
+            return {}
+        return {name: network_instances[name]}

napalm_junos/templates/delete_ntp_servers.j2

@@ -0,0 +1,11 @@
+{% if (servers is defined) and servers %}
+system {
+  ntp {
+    {% for server in servers %}
+      {% if server %}
+        delete: server {{server}};
+      {% endif %}
+    {% endfor %}
+  }
+}
+{% endif %}

napalm_junos/templates/delete_snmp_config.j2

@@ -0,0 +1,24 @@
+snmp {
+  {% if (location is defined) and location %}
+  delete: location "{{location}}";
+  {% endif %}
+  {% if (contact is defined) and contact %}
+  delete: contact "{{contact}}";
+  {% endif %}
+  {% if (community is defined) and community %}
+  {% for comm_name, comm_details in community.iteritems() %}
+  delete: community {{comm_name}} {
+    {% if (comm_details is defined) and comm_details %}
+    {% if (comm_details.get('mode') is defined) and comm_details.get('mode') == 'rw' %}
+    authorization read-write;
+    {% else %}
+    authorization read-only;
+    {% endif %}
+    {% else %}
+    authorization read-only;
+    {% endif %}
+  }
+  {% endfor %}
+  {% endif %}
+}
+

napalm_junos/templates/set_ntp_servers.j2

@@ -0,0 +1,11 @@
+{% if (servers is defined) and servers %}
+system {
+  ntp {
+    {% for server in servers %}
+      {% if server %}
+        server {{server}};
+      {% endif %}
+    {% endfor %}
+  }
+}
+{% endif %}

napalm_junos/templates/snmp_config.j2

@@ -0,0 +1,23 @@
+snmp {
+  {% if (location is defined) and location %}
+  location "{{location}}";
+  {% endif %}
+  {% if (contact is defined) and contact %}
+  contact "{{contact}}";
+  {% endif %}
+  {% if (community is defined) and community %}
+  {% for comm_name, comm_details in community.iteritems() %}
+  community {{comm_name}} {
+    {% if (comm_details is defined) and comm_details %}
+    {% if (comm_details.get('mode') is defined) and comm_details.get('mode') == 'rw' %}
+    authorization read-write;
+    {% else %}
+    authorization read-only;
+    {% endif %}
+    {% else %}
+    authorization read-only;
+    {% endif %}
+  }
+  {% endfor %}
+  {% endif %}
+}