Revert "NAPALM 4.1.0 Release (#1936)" (#1937)

This reverts commit 02a7657.
napalm-automation · May 23, 2023 · f5000c7 · f5000c7
1 parent 02a7657
commit f5000c7
Show file tree

Hide file tree

Showing 89 changed files with 728 additions and 1,997 deletions.
diff --git a/.github/workflows/commit.yaml b/.github/workflows/commit.yaml
@@ -10,14 +10,14 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.7, 3.8, 3.9, 3.10.9, 3.11]
+        python-version: [3.7, 3.8, 3.9, 3.10.0]
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
 
       - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -54,20 +54,20 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2
 
       - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install -e .
-          python -m pip install -r docs/requirements.txt
-          pip install -r requirements-dev.txt
           pip install -r requirements.txt
+          pip install -r requirements-dev.txt
+          python -m pip install -r docs/requirements.txt
 
       - name: Doctests
         run: |

diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -12,20 +12,19 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v1
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v1
       with:
         python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel
-    - name: Build
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
         python setup.py sdist bdist_wheel
-    - name: Publish
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_TOKEN }}
+        twine upload dist/*
diff --git a/.gitignore b/.gitignore
@@ -65,7 +65,6 @@ env
 
 test/unit/test_devices.py
 
-.report.json
 report.json
 tags
 .pytest_cache/

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -14,10 +14,9 @@ formats: all
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.8
+  version: 3.7
   install:
     - method: pip
       path: .
     - requirements: docs/requirements.txt
-    - requirements: requirements-dev.txt
     - requirements: requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -371,13 +371,13 @@ def build_getters_support_matrix(app):
         if not (m.startswith("_") or m in EXCLUDE_METHODS)
     }
 
-    regex_name = re.compile(r"test.*/(?P<driver>\w+)\/.*::test_(?P<getter>\w+)")
+    regex_name = re.compile(r"(?P<driver>\w+)\/.*::test_(?P<getter>\w+)")
 
     filename = "./support/tests/report.json"
     with open(filename, "r") as f:
         data = json.loads(f.read())
-        for test in data["tests"]:
-            match = regex_name.search(test["nodeid"])
+        for test in data["report"]["tests"]:
+            match = regex_name.search(test["name"])
             if match:
                 driver = match.group("driver")
                 drivers.add(driver)

diff --git a/docs/development/testing_framework.rst b/docs/development/testing_framework.rst
@@ -1,7 +1,7 @@
 Testing Framework
 -----------------
 
-As NAPALM consists of multiple drivers and all of them have to provide similar functionality, we have developed a testing framework to provide a consistent test suite for all the drivers.
+As napalm consists of multiple drivers and all of them have to provide similar functionality, we have developed a testing framework to provide a consistent test suite for all the drivers.
 
 Features
 ________
@@ -42,7 +42,7 @@ By default, the tests are going to be run against mocked data but you can change
 * ``NAPALM_USERNAME``
 * ``NAPALM_PASSWORD``
 * ``NAPALM_OPTIONAL_ARGS``
-
+    
 Mocking the ``open`` method
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -56,29 +56,29 @@ Multiple test cases::
     (napalm) ➜  napalm-eos git:(test_framework) ✗ ls test/unit/mocked_data/test_get_bgp_neighbors
     lots_of_peers no_peers      normal
     (napalm) ➜  napalm-eos git:(test_framework) ✗ py.test test/unit/test_getters.py::TestGetter::test_get_bgp_neighbors
-    ...
+    ... 
     test/unit/test_getters.py::TestGetter::test_get_bgp_neighbors[lots_of_peers] <- ../napalm/napalm.base/test/getters.py PASSED
     test/unit/test_getters.py::TestGetter::test_get_bgp_neighbors[no_peers] <- ../napalm/napalm.base/test/getters.py PASSED
     test/unit/test_getters.py::TestGetter::test_get_bgp_neighbors[normal] <- ../napalm/napalm.base/test/getters.py PASSED
-
+    
 Missing test cases::
 
     (napalm) ➜  napalm-eos git:(test_framework) ✗ ls test/unit/mocked_data/test_get_bgp_neighbors
     ls: test/unit/mocked_data/test_get_bgp_neighbors: No such file or directory
     (napalm) ➜  napalm-eos git:(test_framework) ✗ py.test test/unit/test_getters.py::TestGetter::test_get_bgp_neighbors
-    ...
+    ... 
     test/unit/test_getters.py::TestGetter::test_get_bgp_neighbors[no_test_case_found] <- ../napalm/napalm.base/test/getters.py FAILED
-
+    
     ========================================================= FAILURES ==========================================================
     ___________________________________ TestGetter.test_get_bgp_neighbors[no_test_case_found] ___________________________________
-
+    
     cls = <test_getters.TestGetter instance at 0x10ed5eb90>, test_case = 'no_test_case_found'
-
+    
         @functools.wraps(func)
         def wrapper(cls, test_case):
             cls.device.device.current_test = func.__name__
             cls.device.device.current_test_case = test_case
-
+    
             try:
                 # This is an ugly, ugly, ugly hack because some python objects don't load
                 # as expected. For example, dicts where integers are strings
@@ -87,7 +87,7 @@ Missing test cases::
                 if test_case == "no_test_case_found":
     >               pytest.fail("No test case for '{}' found".format(func.__name__))
     E               Failed: No test case for 'test_get_bgp_neighbors' found
-
+    
     ../napalm/napalm.base/test/getters.py:64: Failed
     ================================================= 1 failed in 0.12 seconds ==================================================
 
@@ -96,41 +96,8 @@ Method not implemented::
     (napalm) ➜  napalm-eos git:(test_framework) ✗ py.test test/unit/test_getters.py::TestGetter::test_get_probes_config
     ...
     test/unit/test_getters.py::TestGetter::test_get_probes_config[no_test_case_found] <- ../napalm/napalm.base/test/getters.py SKIPPED
-
+    
     ================================================= 1 skipped in 0.09 seconds =================================================
 
-Testing Matrix
---------------
-
-NAPALM leverages [Github Actions](https://docs.github.com/en/actions) to test and lint code on commits and pull requests.
-If you want to test prior to opening a pull request, you can use [nektos/act](https://github.com/nektos/act) and Docker to locally run the tests
-
-.. code-block:: console
-
-    $ act -j std_tests
-    [build/std_tests-4] 🚀  Start image=catthehacker/ubuntu:act-latest
-    [build/std_tests-3] 🚀  Start image=catthehacker/ubuntu:act-latest
-    [build/std_tests-1] 🚀  Start image=catthehacker/ubuntu:act-latest
-    [build/std_tests-2] 🚀  Start image=catthehacker/ubuntu:act-latest
-    [build/std_tests-5] 🚀  Start image=catthehacker/ubuntu:act-latest
-    [build/std_tests-4]   🐳  docker pull image=catthehacker/ubuntu:act-latest platform= username= forcePull=true
-    [build/std_tests-1]   🐳  docker pull image=catthehacker/ubuntu:act-latest platform= username= forcePull=true
-    [build/std_tests-3]   🐳  docker pull image=catthehacker/ubuntu:act-latest platform= username= forcePull=true
-    [build/std_tests-5]   🐳  docker pull image=catthehacker/ubuntu:act-latest platform= username= forcePull=true
-    [build/std_tests-2]   🐳  docker pull image=catthehacker/ubuntu:act-latest platform= username= forcePull=true
-
-    ...
-
-    | ---------------------------------------------------------------------
-    | TOTAL                                    9258   1836    80%
-    |
-    | ================= 619 passed, 80 skipped, 3 warnings in 19.97s =================
-    [build/std_tests-5]   ✅  Success - Main Run Tests
-    [build/std_tests-5] ⭐ Run Post Setup Python 3.11
-    [build/std_tests-5]   🐳  docker exec cmd=[node /var/run/act/actions/actions-setup-python@v2/dist/cache-save/index.js] user= workdir=
-    [build/std_tests-5]   ✅  Success - Post Setup Python 3.11
-    [build/std_tests-5] 🏁  Job succeeded
-
-
 .. _`test_getters.py`: https://github.com/napalm-automation/napalm-eos/blob/a2fc2cf6a98b0851efe4cba907086191b8f1df02/test/unit/test_getters.py
 .. _`conftest.py`: https://github.com/napalm-automation/napalm-eos/blob/a2fc2cf6a98b0851efe4cba907086191b8f1df02/test/unit/conftest.py
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,9 +1,4 @@
-urllib3==1.26.15 # https://github.com/readthedocs/readthedocs.org/issues/10290
-sphinx==1.8.6
-sphinx-rtd-theme==1.2.0
-sphinxcontrib-napoleon==0.7
-invoke==2.0.0
-jinja2==2.11.3
-MarkupSafe==2.0.1
-pytest==7.2.2
-ansible==4.10.0
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-napoleon
+invoke
diff --git a/docs/support/index.rst b/docs/support/index.rst
@@ -13,7 +13,7 @@ General support matrix
   =====================   ==========  =============  ====================  ==================  ============  ============  ============
   **Driver Name**         eos         junos          iosxr_netconf         iosxr               nxos          nxos_ssh      ios
   **Structured data**     Yes         Yes            Yes                   No                  Yes           No            No
-  **Minimum version**     4.15.0F     12.1           7.0                   5.1.0               6.1 [#g1]_    6.3.2         12.4(20)T
+  **Minimum version**     4.15.0F     12.1           7.0                   5.1.0               6.1 [#g1]_    12.4(20)T     6.3.2
   **Backend library**     `pyeapi`_   `junos-eznc`_  `ncclient`_           `pyIOSXR`_          `pynxos`_     `netmiko`_    `netmiko`_
   **Caveats**             :doc:`eos`                 :doc:`iosxr_netconf`                      :doc:`nxos`   :doc:`nxos`   :doc:`ios`
   =====================   ==========  =============  ====================  ==================  ============  ============  ============
@@ -141,7 +141,6 @@ ____________________________________
 * :code:`eos_fn0039_config` (eos) - Transform old style configuration to the new style, available beginning with EOS release 4.23.0, as per FN 0039. Beware
   that enabling this option will change the configuration you're loading through NAPALM. Default: ``False`` (won't change your configuration commands).
   .. versionadded:: 3.0.1
-* :code:`force_cfg_session_invalid` (eos) - Force the config_session to be cleared in case of issues, like `discard_config` failure. (default: ``False``)
 
 The transport argument
 ______________________

diff --git a/docs/support/ios.rst b/docs/support/ios.rst
@@ -116,7 +116,7 @@ File Operation Prompts
 ______________________
 
 By default IOS will prompt for confirmation on file operations. These prompts need to be disabled before the NAPALM-ios driver performs any such operation on the device.
-This can be controlled using the `auto_file_prompt` optional argument:
+This can be controlled using the `auto_file_prompt` optional arguement:
 
 * `auto_file_prompt=True` (default): NAPALM will automatically add `file prompt quiet` to the device configuration before performing file operations,
   and un-configure it again afterwards. If the device already had the command in its configuration then it will be silently removed as a result, and

diff --git a/docs/support/nxos.rst b/docs/support/nxos.rst
@@ -71,7 +71,7 @@ One caveat of using netutils diff of configurations is that the diff is performe
 
 Example assuming that the device config contains:
 
-.. code-block:: bash
+.. code-block::
 
     interface loopback0
       ip address 10.1.4.4/32

diff --git a/docs/test.sh b/docs/test.sh
@@ -1,12 +1,14 @@
 #!/bin/bash
 CWD=`pwd`
 TEST_RESULTS_PATH="$CWD/support/tests"
-REPOBASE=$CWD/..
 
-if [ ! -f ".report.json" ]; then
+if [ ! -f "report.json" ]; then
     set -e
-    pytest --rootdir $REPOBASE -c /dev/null --json-report --cov=./ -vs $REPOBASE/test*/*/test_getters.py
+    pip install -r ../requirements.txt -r ../requirements-dev.txt
 
+    set +e
+    py.test -c /dev/null --cov=./ -vs --json=report.json ../test*/*/test_getters.py
     set -e
-    cp .report.json $TEST_RESULTS_PATH/report.json
+
+    cp report.json $TEST_RESULTS_PATH/report.json
 fi
diff --git a/napalm/base/base.py b/napalm/base/base.py
@@ -19,7 +19,6 @@
 from typing_extensions import Literal
 
 from netmiko import ConnectHandler, NetMikoTimeoutException
-from netutils.interface import canonical_interface_name
 
 # local modules
 import napalm.base.exceptions
@@ -648,8 +647,7 @@ def get_bgp_config(
         :param neighbor: Returns the configuration of a specific BGP neighbor.
 
         Main dictionary keys represent the group name and the values represent a dictionary having
-        the keys below.  A default group named "_" will contain information regarding global
-        settings and any neighbors that are not members of a group.
+        the keys below. Neighbors which aren't members of a group will be stored in a key named "_":
 
             * type (string)
             * description (string)
@@ -1806,6 +1804,8 @@ def compliance_report(
     def _canonical_int(self, interface: str) -> str:
         """Expose the helper function within this class."""
         if self.use_canonical_interface is True:
-            return canonical_interface_name(interface, addl_name_map=None)
+            return napalm.base.helpers.canonical_interface_name(
+                interface, addl_name_map=None
+            )
         else:
             return interface