Merge pull request #167 from napalm-automation/develop

Release 0.21.0

Author: dbarrosop

.gitignore

@@ -60,3 +60,5 @@ env
 
 test/unit/test_devices.py
 
+report.json
+tags

.travis.yml

@@ -24,4 +24,5 @@ script:
   - nosetests ./test/unit/TestGetNetworkDriver.py
   - nosetests ./test/unit/TestHelpers.py
   - nosetests ./test/unit/TestNapalmTestFramework.py
+  - py.test test/unit/validate/test_validate.py
   - pylama .

napalm_base/base.py

@@ -25,6 +25,8 @@
 
 import napalm_base.constants as c
 
+from napalm_base import validate
+
 
 class NetworkDriver(object):
 
@@ -1488,3 +1490,12 @@ def get_firewall_policies(self):
         }
         """
         raise NotImplementedError
+
+    def compliance_report(self, validation_file='validate.yml'):
+        """
+        Return a compliance report.
+
+        Verify that the device complies with the given validation file and writes a compliance
+        report file. See https://napalm.readthedocs.io/en/latest/validate.html.
+        """
+        return validate.compliance_report(self, validation_file=validation_file)

napalm_base/clitools/cl_napalm_configure.py

@@ -52,7 +52,7 @@ def run(vendor, hostname, user, password, strategy, optional_args, config_file,
 
 
 def main():
-    args = build_help()
+    args = build_help(configure=True)
     configure_logging(logger, args.debug)
 
     print(run(args.vendor, args.hostname, args.user, args.password, args.strategy,

napalm_base/clitools/cl_napalm_test.py

@@ -18,7 +18,7 @@
 # stdlib
 import sys
 import logging
-logger = logging.getLogger(__file__)
+logger = logging.getLogger('cl_napalm_test.py')
 
 
 def main():
@@ -30,13 +30,13 @@ def main():
 
     optional_args = parse_optional_args(args.optional_args)
     logger.debug('Connecting to device "{}" with user "{}" and optional_args={}'.format(
-                 device=args.hostname, user=args.user, optional_args=optional_args))
+                 args.hostname, args.user, optional_args))
 
     with driver(args.hostname,
                 args.user,
                 args.password,
                 optional_args=optional_args) as device:
-        logger.debug('Successfully connected to the device: {}'.format(device))
+        logger.debug('Successfully connected to the device: {}'.format(device.hostname))
         print('Successfully connected to the device')
     sys.exit(0)
 

napalm_base/clitools/cl_napalm_validate.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+'''
+NAPALM CLI Tools: validate
+===========================
+
+Validating deployments from the shell.
+'''
+
+# Python3 support
+from __future__ import print_function
+from __future__ import unicode_literals
+
+# import helpers
+from napalm_base import get_network_driver
+from napalm_base.clitools.helpers import build_help
+from napalm_base.clitools.helpers import configure_logging
+from napalm_base.clitools.helpers import parse_optional_args
+
+# stdlib
+import sys
+import json
+import logging
+logger = logging.getLogger('cl_napalm_validate.py')
+
+
+def main():
+    args = build_help(validate=True)
+    configure_logging(logger, args.debug)
+
+    logger.debug('Getting driver for OS "{driver}"'.format(driver=args.vendor))
+    driver = get_network_driver(args.vendor)
+
+    optional_args = parse_optional_args(args.optional_args)
+    logger.debug('Connecting to device "{}" with user "{}" and optional_args={}'.format(
+                 args.hostname, args.user, optional_args))
+
+    with driver(args.hostname, args.user, args.password, optional_args=optional_args) as device:
+        logger.debug('Generating compliance report')
+        print(json.dumps(device.compliance_report(args.validation_file), indent=4))
+        logger.debug('Closing session')
+    sys.exit(0)
+
+
+if __name__ == '__main__':
+    main()

napalm_base/clitools/helpers.py

@@ -16,7 +16,7 @@
 import argparse
 
 
-def build_help(connect_test=False):
+def build_help(connect_test=False, validate=False, configure=False):
     parser = argparse.ArgumentParser(
         description='Command line tool to handle configuration on devices using NAPALM.'
                     'The script will print the diff on the screen',
@@ -60,7 +60,7 @@ def build_help(connect_test=False):
         action='store_true',
         help='Enables debug mode; more verbosity.'
     )
-    if not connect_test:
+    if configure:
         parser.add_argument(
             '--strategy', '-s',
             dest='strategy',
@@ -81,6 +81,13 @@ def build_help(connect_test=False):
             default=None,
             help='Only returns diff, it does not deploy the configuration.',
         )
+    elif validate:
+        parser.add_argument(
+            '--validation_file', '-f',
+            dest='validation_file',
+            action='store',
+            help='Validation file containing resources derised states'
+        )
     args = parser.parse_args()
 
     if args.password is None:

napalm_base/exceptions.py

@@ -55,3 +55,7 @@ class TemplateNotImplemented(Exception):
 
 class TemplateRenderException(Exception):
     pass
+
+
+class ValidationException(Exception):
+    pass

napalm_base/test/conftest.py

@@ -7,7 +7,7 @@
 import json
 import os
 
-NAPALM_TEST_MOCK = os.getenv('NAPALM_TEST_MOCK', default=True)
+NAPALM_TEST_MOCK = eval("{}".format(os.getenv('NAPALM_TEST_MOCK', default=True)))
 NAPALM_HOSTNAME = os.getenv('NAPALM_HOSTNAME', default='127.0.0.1')
 NAPALM_USERNAME = os.getenv('NAPALM_USERNAME', default='vagrant')
 NAPALM_PASSWORD = os.getenv('NAPALM_PASSWORD', default='vagrant')

napalm_base/test/getters.py

@@ -116,27 +116,30 @@ def test_method_signatures(self):
         """Test that all methods have the same signature."""
         errors = {}
         cls = self.driver
-        attrs = [m for m in dir(cls)]
+        # Create fictional driver instance (py3 needs bound methods)
+        tmp_obj = cls(hostname='test', username='admin', password='pwd')
+        attrs = [m for m, v in inspect.getmembers(tmp_obj)]
         for attr in attrs:
-            func = getattr(cls, attr)
+            func = getattr(tmp_obj, attr)
             if attr.startswith('_') or not inspect.ismethod(func):
                 continue
-            orig = getattr(NetworkDriver, attr)
-
-            orig_spec = inspect.getargspec(orig)
+            try:
+                orig = getattr(NetworkDriver, attr)
+                orig_spec = inspect.getargspec(orig)
+            except AttributeError:
+                orig_spec = 'Method does not exist in napalm_base'
             func_spec = inspect.getargspec(func)
             if orig_spec != func_spec:
                 errors[attr] = (orig_spec, func_spec)
 
         EXTRA_METHODS = ['__init__', ]
         for method in EXTRA_METHODS:
-            if not method.startswith('_'):
-                orig_spec = inspect.getargspec(getattr(NetworkDriver, method))
-                func_spec = inspect.getargspec(getattr(cls, method))
-                if orig_spec != func_spec:
-                    errors[attr] = (orig_spec, func_spec)
+            orig_spec = inspect.getargspec(getattr(NetworkDriver, method))
+            func_spec = inspect.getargspec(getattr(cls, method))
+            if orig_spec != func_spec:
+                errors[attr] = (orig_spec, func_spec)
 
-        assert not errors, "Some method vary. \n{}".format(errors)
+        assert not errors, "Some methods vary. \n{}".format(errors.keys())
 
     @wrap_test_cases
     def test_is_alive(self, test_case):