Merge pull request #924 from napalm-automation/develop

NAPALM Release 2.4.0

Author: ktbyers

.editorconfig

@@ -0,0 +1,31 @@
+# http://editorconfig.org
+#
+# This file contains directions for an editor (if it supports it)
+# about how to manage indents, new lines, etc
+# It aids in having consistency amongst developers
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+[*.py]
+max_line_length = 100
+
+[*.json]
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_size = 2
+
+# Makefiles always use tabs for indentation
+[Makefile]
+indent_style = tab
+
+[*.txt]
+insert_final_newline = false

.travis.yml

@@ -2,23 +2,27 @@ language: python
 
 python:
   - 2.7
-  - 3.4
   - 3.5
   - 3.6
 
 matrix:
   include:
-      - python: 3.6
-        env: TOXENV=sphinx
+  - python: 3.6
+    env: TOXENV=pylama
+  - python: 3.6
+    env: TOXENV=black
+  - python: 3.6
+    env: TOXENV=sphinx
 
 install:
-  - pip install tox==3.0.0 tox-travis coveralls
+  - pip install tox==3.7.0 tox-travis coveralls
 
 deploy:
   provider: pypi
   user: dbarroso
   password:
     secure: kt2RgomUtrf5zXo3CyF8B7SkolvKgALAO0s72WuMd0wTGmgOvoBlt10Vfc+G+wuVAYvW/JKdsYRceancAFyWLFgjLtNxbV4cJF2RXN956sYFSJ2VrtUiB19WuKZjX6024gMs780hC/3bdK1SDg/NAAHSR7u2cma3QgRcW6O+UG4=
+  distributions: "sdist bdist_wheel"
   on:
     tags: true
     branch: master

README.md

@@ -1,6 +1,7 @@
 [![PyPI](https://img.shields.io/pypi/v/napalm.svg)](https://pypi.python.org/pypi/napalm)
 [![Build Status](https://travis-ci.org/napalm-automation/napalm.svg?branch=master)](https://travis-ci.org/napalm-automation/napalm)
 [![Coverage Status](https://coveralls.io/repos/github/napalm-automation/napalm/badge.svg)](https://coveralls.io/github/napalm-automation/napalm)
+[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
 
 NAPALM

docs/conf.py

@@ -34,40 +34,37 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'
 
-autoclass_content = 'both'
+autoclass_content = "both"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'NAPALM'
-copyright = u'2016, David Barroso'
+project = u"NAPALM"
+copyright = u"2016, David Barroso"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0'
+version = "0"
 # The full version, including alpha/beta/rc tags.
-release = '1'
+release = "1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -81,7 +78,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', 'napalm_ansible_repo']
+exclude_patterns = ["_build", "napalm_ansible_repo"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -99,7 +96,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -112,14 +109,15 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
+
+    html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 else:
-    html_theme = 'default'
+    html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -148,7 +146,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -197,18 +195,16 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'napalmdoc'
+htmlhelp_basename = "napalmdoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     # 'preamble': '',
 }
@@ -217,8 +213,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'napalm.tex', u'NAPALM Documentation',
-   u'David Barroso', 'manual'),
+    ("index", "napalm.tex", u"NAPALM Documentation", u"David Barroso", "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -246,10 +241,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'napalm', u'NAPALM Documentation',
-     [u'David Barroso'], 1)
-]
+man_pages = [("index", "napalm", u"NAPALM Documentation", [u"David Barroso"], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -261,9 +253,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'napalm', u'NAPALM Documentation',
-   u'David Barroso', 'napalm', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        "index",
+        "napalm",
+        u"NAPALM Documentation",
+        u"David Barroso",
+        "napalm",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -282,26 +280,38 @@
 enable_pdf_build = False
 enable_epub_build = False
 
-EXCLUDE_METHODS = ('cli', 'close', 'commit_config', 'compare_config',
-                   'discard_config', 'load_merge_candidate',
-                   'load_replace_candidate', 'load_template', 'open',
-                   'rollback', 'compliance_report', 'connection_tests',
-                   'post_connection_tests', 'pre_connection_tests')
-
-EXCLUDE_IN_REPORT = ('test_method_signatures')
+EXCLUDE_METHODS = (
+    "cli",
+    "close",
+    "commit_config",
+    "compare_config",
+    "discard_config",
+    "load_merge_candidate",
+    "load_replace_candidate",
+    "load_template",
+    "open",
+    "rollback",
+    "compliance_report",
+    "connection_tests",
+    "post_connection_tests",
+    "pre_connection_tests",
+)
+
+EXCLUDE_IN_REPORT = "test_method_signatures"
 
 METHOD_ALIASES = {
-    'get_config_filtered': 'get_config',
+    "get_config_filtered": "get_config",
+    "get_arp_table_with_vrf": "get_arp_table",
 }
 
 
 def _merge_results(last, intermediate):
-    if intermediate == 'failed':
-        return 'failed'
-    elif intermediate == 'skipped':
-        return 'failed' if last == 'failed' else 'skipped'
-    elif intermediate == 'passed':
-        return 'ok' if last == 'ok' else last
+    if intermediate == "failed":
+        return "failed"
+    elif intermediate == "skipped":
+        return "failed" if last == "failed" else "skipped"
+    elif intermediate == "passed":
+        return "ok" if last == "ok" else last
     else:
         return last
 
@@ -310,23 +320,25 @@ def build_napalm_ansible_module_docs(app):
     """Create documentation for Ansible modules."""
 
     # Add script to clone napalm-ansible repo
-    status = subprocess.call("./build-ansible-module-docs.sh", stdout=sys.stdout, stderr=sys.stderr)
+    status = subprocess.call(
+        "./build-ansible-module-docs.sh", stdout=sys.stdout, stderr=sys.stderr
+    )
 
     if status != 0:
         print("Something bad happened when processing the Ansible modules.")
         sys.exit(-1)
 
     env = Environment(loader=FileSystemLoader("."))
 
-    modules_dir = './integrations/ansible/modules/source'
-    module_files = glob('{0}/*.json'.format(modules_dir))
+    modules_dir = "./integrations/ansible/modules/source"
+    module_files = glob("{0}/*.json".format(modules_dir))
     for module_file in module_files:
-        with open(module_file, 'r') as f:
-            module = module_file.split('/')[-1].split('.')[0]
+        with open(module_file, "r") as f:
+            module = module_file.split("/")[-1].split(".")[0]
             data = json.loads(f.read())
-            data['name'] = module
+            data["name"] = module
 
-        module_dir = './integrations/ansible/modules/{0}'.format(module)
+        module_dir = "./integrations/ansible/modules/{0}".format(module)
 
         try:
             os.stat(module_dir)
@@ -336,7 +348,7 @@ def build_napalm_ansible_module_docs(app):
         template_file = env.get_template("ansible-module.j2")
         rendered_template = template_file.render(**data)
 
-        with open('{0}/index.rst'.format(module_dir), 'w') as f:
+        with open("{0}/index.rst".format(module_dir), "w") as f:
             f.write(rendered_template)
 
 
@@ -349,26 +361,28 @@ def build_getters_support_matrix(app):
         sys.exit(-1)
 
     drivers = set()
-    matrix = {m: defaultdict(dict) for m in dir(NetworkDriver)
-              if not (m.startswith('_') or
-                      m in EXCLUDE_METHODS)}
+    matrix = {
+        m: defaultdict(dict)
+        for m in dir(NetworkDriver)
+        if not (m.startswith("_") or m in EXCLUDE_METHODS)
+    }
 
     regex_name = re.compile(r"(?P<driver>\w+)\/.*::test_(?P<getter>\w+)")
 
-    filename = './support/tests/report.json'
-    with open(filename, 'r') as f:
+    filename = "./support/tests/report.json"
+    with open(filename, "r") as f:
         data = json.loads(f.read())
         for test in data["report"]["tests"]:
-            match = regex_name.search(test['name'])
+            match = regex_name.search(test["name"])
             if match:
-                driver = match.group('driver')
+                driver = match.group("driver")
                 drivers.add(driver)
-                method = match.group('getter')
+                method = match.group("getter")
             else:
                 continue
             if method in EXCLUDE_IN_REPORT:
                 continue
-            result = test['outcome']
+            result = test["outcome"]
 
             if method in METHOD_ALIASES.keys():
                 method = METHOD_ALIASES[method]
@@ -380,17 +394,18 @@ def build_getters_support_matrix(app):
     drivers = sorted(drivers)
     env = Environment(loader=FileSystemLoader("."))
     template_file = env.get_template("matrix.j2")
-    rendered_template = template_file.render(matrix=matrix, drivers=drivers,
-                                             sorted_methods=sorted_methods)
+    rendered_template = template_file.render(
+        matrix=matrix, drivers=drivers, sorted_methods=sorted_methods
+    )
 
-    with open('support/matrix.rst', 'w') as f:
+    with open("support/matrix.rst", "w") as f:
         f.write(rendered_template)
 
 
 def setup(app):
     """Map methods to states of the documentation build."""
-    app.connect('builder-inited', build_getters_support_matrix)
-    app.connect('builder-inited', build_napalm_ansible_module_docs)
+    app.connect("builder-inited", build_getters_support_matrix)
+    app.connect("builder-inited", build_napalm_ansible_module_docs)
 
 
 build_getters_support_matrix(None)

docs/support/eos.rst

@@ -4,7 +4,7 @@ EOS
 Minimum Version
 ~~~~~~~~~~~~~~~
 
-To be able to support the ``compare_config`` method you will require to run at least EOS version `4.15.0F`.
+To be able to support the ``compare_config``, ``load_merge_candidate`` or ``load_replace_candidate`` methods you will require to run at least EOS version `4.15.0F`.
 
 Multi-line/HEREDOC
 ~~~~~~~~~~~~~~~~~~