nuts 3.2.0__tar.gz → 3.3.0__tar.gz

{nuts-3.2.0 → nuts-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nuts
-Version: 3.2.0
+Version: 3.3.0
 Summary: Network Unit Testing System
 Home-page: https://github.com/network-unit-testing-system/nuts
 License: MIT
@@ -14,13 +14,14 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: System :: Networking
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: nornir (>=3.3.0,<4.0.0)
-Requires-Dist: nornir-napalm (>=0.4.0,<0.5.0)
+Requires-Dist: nornir-napalm (>=0.5.0,<0.6.0)
 Requires-Dist: nornir-netmiko (>=1.0.0,<2.0.0)
 Requires-Dist: nornir-utils (>=0.2.0,<0.3.0)
-Requires-Dist: pytest (>=7.3.0,<8.0.0)
+Requires-Dist: pytest (>=7,<8)
 Project-URL: Repository, https://github.com/network-unit-testing-system/nuts
 Description-Content-Type: text/markdown
 
@@ -76,6 +77,7 @@ Each test bundle contains the following structure:
   test_class: <name of the test class>
   label: <label to uniquely identify the test> # optional 
   test_execution: <additional data used to execute the test> # optional
+  test_extras: <additional data can be provided to the context for custom usage> # optional
   test_data: <data used to generate the test cases>
 ...
 ```
@@ -95,6 +97,9 @@ Therefore the key-value pairs must be consistent with the key-value pairs of the
 As an example, the test definition `napalm_ping.py` calls a nornir task to execute napalm's ping-command. 
 This allows the additional `max_drop` parameter in `test_execution`, since it is in turn pre-defined by napalm.
 
+`test_extras`: Additional data that can be accessed through the `nuts_parameters` property.
+These data are not internally utilized and can be passed for use in custom code.
+
 `test_data`: Data that is used to parametrize the tests in the test class which have the `pytest.mark.nuts` annotation. It is additionally part of the `nuts_parameters` property.
 
 ### Example: CDP Neighbors

{nuts-3.2.0 → nuts-3.3.0}/README.md

@@ -50,6 +50,7 @@ Each test bundle contains the following structure:
   test_class: <name of the test class>
   label: <label to uniquely identify the test> # optional 
   test_execution: <additional data used to execute the test> # optional
+  test_extras: <additional data can be provided to the context for custom usage> # optional
   test_data: <data used to generate the test cases>
 ...
 ```
@@ -69,6 +70,9 @@ Therefore the key-value pairs must be consistent with the key-value pairs of the
 As an example, the test definition `napalm_ping.py` calls a nornir task to execute napalm's ping-command. 
 This allows the additional `max_drop` parameter in `test_execution`, since it is in turn pre-defined by napalm.
 
+`test_extras`: Additional data that can be accessed through the `nuts_parameters` property.
+These data are not internally utilized and can be passed for use in custom code.
+
 `test_data`: Data that is used to parametrize the tests in the test class which have the `pytest.mark.nuts` annotation. It is additionally part of the `nuts_parameters` property.
 
 ### Example: CDP Neighbors

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_bgp_neighbors.py

@@ -1,5 +1,6 @@
 """Query BGP neighbors of a device or count them."""
-from typing import Dict, Callable, List, Any
+
+from typing import Dict, Callable, List, Any, Tuple
 
 import pytest
 from nornir.core.task import MultiResult, Result
@@ -12,15 +13,23 @@ from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 class BgpNeighborsExtractor(AbstractHostResultExtractor):
     def single_transform(
         self, single_result: MultiResult
-    ) -> Dict[str, Dict[str, NutsResult]]:
+    ) -> Dict[Tuple[str, str], Dict[str, NutsResult]]:
+        test_exectuion = self._nuts_ctx.nuts_parameters.get("test_execution")
+        if test_exectuion:
+            vrf = test_exectuion.get("vrf", "global")
+            if not vrf:
+                vrf = "global"
+        else:
+            vrf = "global"
+
         neighbors = self._simple_extract(single_result)["bgp_neighbors"]
-        if "global" not in neighbors:
+        if vrf not in neighbors:
             return {}
-        global_scope = neighbors["global"]
-        router_id = global_scope["router_id"]
+        scope = neighbors[vrf]
+        router_id = scope["router_id"]
         return {
             peer: self._add_local_id(details, router_id)
-            for peer, details in global_scope["peers"].items()
+            for peer, details in scope["peers"].items()
         }
 
     def _add_local_id(self, element: Dict[str, Any], router_id: str) -> Dict[str, Any]:
@@ -33,6 +42,8 @@ class BgpNeighborsContext(NornirNutsContext):
         return napalm_get
 
     def nuts_arguments(self) -> Dict[str, List[str]]:
+        # Overrides nuts_arguments.nuts_arguments
+        # "test_execution" is not passed to the nuts_task
         return {"getters": ["bgp_neighbors"]}
 
     def nuts_extractor(self) -> BgpNeighborsExtractor:
@@ -48,7 +59,9 @@ class TestNapalmBgpNeighborsCount:
         self, single_result: NutsResult, neighbor_count: int
     ) -> None:
         assert single_result.result is not None
-        assert len(single_result.result) == neighbor_count
+        assert (
+            len(single_result.result) == neighbor_count
+        ), f"Expected {neighbor_count}; got {len(single_result.result)}"
 
 
 class TestNapalmBgpNeighbors:

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_get_arp.py

@@ -1,4 +1,5 @@
 """Query arp table of a device."""
+
 from typing import Dict, Callable, List, Any, Text
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_get_config.py

@@ -1,4 +1,5 @@
 """Query config of a device."""
+
 from typing import Dict, Callable, List, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_get_users.py

@@ -1,4 +1,5 @@
 """Query users of a device."""
+
 from typing import Dict, Callable, List, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_get_vlans.py

@@ -1,4 +1,5 @@
 """Query vlans of a device."""
+
 from typing import Dict, Callable, List, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_interfaces.py

@@ -1,4 +1,5 @@
 """Query interfaces and their information of a device."""
+
 from typing import Dict, Callable, List, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_lldp_neighbors.py

@@ -1,4 +1,5 @@
 """Query LLDP neighbors of a device."""
+
 from typing import Dict, Callable, List, Any
 
 import pytest
@@ -28,9 +29,9 @@ class LldpNeighborsExtractor(AbstractHostResultExtractor):
         return element
 
     def _add_expanded_remote_port(self, element: Dict[str, Any]) -> Dict[str, Any]:
-        element[
-            "remote_port_expanded"
-        ] = InterfaceNameConverter().expand_interface_name(element["remote_port"])
+        element["remote_port_expanded"] = (
+            InterfaceNameConverter().expand_interface_name(element["remote_port"])
+        )
         return element
 
 

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_network_instances.py

@@ -1,4 +1,5 @@
 """Query network instances of a device."""
+
 from typing import Dict, List, Callable, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/napalm_ping.py

@@ -1,4 +1,5 @@
 """Let a device ping another device."""
+
 from enum import Enum
 from typing import Dict, Callable, Any, List
 

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/netmiko_cdp_neighbors.py

@@ -1,4 +1,5 @@
 """Query CDP neighbors of a device."""
+
 from typing import Callable, Dict, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/netmiko_ospf_neighbors.py

@@ -1,4 +1,5 @@
 """Query OSPF neighbors of a device or count them."""
+
 from typing import Callable, Dict, Any
 
 import pytest

{nuts-3.2.0 → nuts-3.3.0}/nuts/context.py

@@ -1,4 +1,5 @@
 """Provide necessary information that is needed for a specific test."""
+
 import pathlib
 from typing import Any, Callable, Optional, Dict, List
 from pytest import Config
@@ -202,6 +203,7 @@ class NornirNutsContext(NutsContext):
         )
 
         self.teardown()
+        selected_hosts.close_connections(on_good=True, on_failed=True)
         return overall_results
 
     def setup(self) -> None:

{nuts-3.2.0 → nuts-3.3.0}/nuts/helpers/context.py

@@ -1,6 +1,7 @@
 """
 Context helper functions
 """
+
 import types
 from nuts.context import NutsContext
 from typing import Dict, List, Any

{nuts-3.2.0 → nuts-3.3.0}/nuts/helpers/filters.py

@@ -2,6 +2,7 @@
 Functions to filter the nornir inventory and used in conjunction with
 a context's nornir_filter function.
 """
+
 from typing import Optional, Dict, Any, List, Union
 from nornir.core.filter import F, OR
 

{nuts-3.2.0 → nuts-3.3.0}/nuts/helpers/result.py

@@ -46,7 +46,7 @@ class NutsResult:
                 f"An exception has occurred while executing nornir:\n"
                 f"{header}\n"
                 f"{self._result}"
-            )
+            ) from self.exception
         if self.failed:
             raise NutsNornirError(f"Nornir execution has failed:\n" f"{self._result}")
 

nuts-3.3.0/nuts/hooks.py

@@ -0,0 +1,9 @@
+from pytest import FixtureRequest
+from nuts.context import NutsContext
+from nuts.helpers.result import NutsResult
+
+
+def pytest_nuts_single_result(
+    request: FixtureRequest, nuts_ctx: NutsContext, result: NutsResult
+) -> None:
+    """Called in the single result fixture"""

{nuts-3.2.0 → nuts-3.3.0}/nuts/index.py

@@ -1,4 +1,5 @@
 """Allows to indicate only the test class name in a test bundle."""
+
 from typing import Optional
 
 default_index = {
@@ -10,6 +11,7 @@ default_index = {
     "TestNapalmNetworkInstances": "nuts.base_tests.napalm_network_instances",
     "TestNapalmPing": "nuts.base_tests.napalm_ping",
     "TestNapalmUsers": "nuts.base_tests.napalm_get_users",
+    "TestNapalmOnlyDefinedUsersExist": "nuts.base_tests.napalm_get_users",
     "TestNapalmConfig": "nuts.base_tests.napalm_get_config",
     "TestNapalmVlans": "nuts.base_tests.napalm_get_vlans",
     "TestNapalmOnlyDefinedVlansExist": "nuts.base_tests.napalm_get_vlans",

{nuts-3.2.0 → nuts-3.3.0}/nuts/plugin.py

@@ -1,4 +1,5 @@
 """Fixtures"""
+
 from typing import Optional, Dict, Any
 from pathlib import Path
 
@@ -16,6 +17,12 @@ from nuts.helpers.result import NutsResult
 from nuts.yamlloader import NutsYamlFile, get_parametrize_data
 
 
+def pytest_addhooks(pluginmanager):
+    from nuts import hooks
+
+    pluginmanager.add_hookspecs(hooks)
+
+
 @pytest.fixture(scope="class")
 def nuts_ctx(request: FixtureRequest) -> NutsContext:
     params = request.node.params
@@ -26,7 +33,9 @@ def nuts_ctx(request: FixtureRequest) -> NutsContext:
 
 
 @pytest.fixture
-def single_result(nuts_ctx: NutsContext, nuts_test_entry: Dict[str, Any]) -> NutsResult:
+def single_result(
+    nuts_ctx: NutsContext, nuts_test_entry: Dict[str, Any], request: FixtureRequest
+) -> NutsResult:
     """
     Returns the result which belongs to a specific host
     out of the overall set of results that has been returned by nornir's task.
@@ -39,6 +48,12 @@ def single_result(nuts_ctx: NutsContext, nuts_test_entry: Dict[str, Any]) -> Nut
     """
     res = nuts_ctx.extractor.single_result(nuts_test_entry)
     res.validate()
+
+    # Invoke the pytest_nuts_single_result hook to extend result reports.
+    request.config.hook.pytest_nuts_single_result(
+        request=request, nuts_ctx=nuts_ctx, result=res
+    )
+
     return res
 
 
@@ -64,12 +79,12 @@ def pytest_collect_file(parent: Session, file_path: Path) -> Optional[Collector]
     """
     Performs the collection phase for the given pytest session.
     Collects all test bundles if available, i.e. files starting
-    with 'test' and ending in .yaml.
+    with 'test' and ending in .yaml or .yml.
     :param parent: pytest session object
     :param file_path: path to test file(s)
     :return: The pytest collector if found
     """
-    if file_path.suffix == ".yaml" and file_path.name.startswith("test"):
+    if file_path.suffix in [".yaml", ".yml"] and file_path.name.startswith("test"):
         return NutsYamlFile.from_parent(parent, path=file_path)
     return None
 

{nuts-3.2.0 → nuts-3.3.0}/nuts/yamlloader.py

@@ -1,6 +1,7 @@
 """Converts a test bundle (YAML file) into a test class for pytest.
 Based on https://docs.pytest.org/en/stable/example/nonpython.html#yaml-plugin
 """
+
 import importlib
 from nuts.helpers.context import load_context
 import types
@@ -106,12 +107,14 @@ class NutsTestFile(pytest.Module):
 
         test_data = self.test_entry.get("test_data", [])
         test_execution = self.test_entry.get("test_execution")
+        test_extras = self.test_entry.get("test_extras")
         yield NutsTestClass.from_parent(
             self,
             name=name,
             class_name=class_name,
             test_data=test_data,
             test_execution=test_execution,
+            test_extras=test_extras,
         )
 
 

{nuts-3.2.0 → nuts-3.3.0}/pyproject.toml

@@ -4,10 +4,17 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "nuts"
-version = "3.2.0"
+version = "3.3.0"
 description = "Network Unit Testing System"
-authors = ["Lukas Murer, Méline Sieber, Urs Baumann, Matthias Gabriel, Florian Bruhin", "Marco Martinez", "Severin Grimm"]
-maintainers = ["Marco Martinez <marco.maritnez@ost.ch>", "Urs Baumann <github@m.ubaumann.ch>"]
+authors = [
+    "Lukas Murer, Méline Sieber, Urs Baumann, Matthias Gabriel, Florian Bruhin",
+    "Marco Martinez",
+    "Severin Grimm",
+]
+maintainers = [
+    "Marco Martinez <marco.maritnez@ost.ch>",
+    "Urs Baumann <github@m.ubaumann.ch>",
+]
 classifiers = ["Framework :: Pytest", "Topic :: System :: Networking"]
 homepage = "https://github.com/network-unit-testing-system/nuts"
 repository = "https://github.com/network-unit-testing-system/nuts"
@@ -16,26 +23,26 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.8.1"
-pytest = "^7.3.0"
+pytest = "^7"
 PyYAML = "^6.0"
 nornir = "^3.3.0"
-nornir-napalm = "^0.4.0"
+nornir-napalm = "^0.5.0"
 nornir-netmiko = "^1.0.0"
 nornir-utils = "^0.2.0"
 
 [tool.poetry.dev-dependencies]
 tox = "^4.4.11"
 pytest-cov = "^4.0.0"
-black = "^23.3.0"
-sphinx = "^7.1.2"
+black = "^24.2.0"
+sphinx = "^7"
 mypy = "^1.0.1"
-flake8 = "^6.0.0"
+flake8 = "^7.0.0"
 types-PyYAML = "*"
 types-setuptools = "*"
 types-toml = "*"
 
 [tool.poetry.plugins."pytest11"]
-"nuts"="nuts.plugin"
+"nuts" = "nuts.plugin"
 # why "pytest11": https://github.com/pytest-dev/pytest/commit/ed03eef81b220199a819632a27f9c452b8e1fb81
 # https://docs.pytest.org/en/latest/how-to/writing_plugins.html#making-your-plugin-installable-by-others
 
@@ -50,12 +57,10 @@ filterwarnings = [
     "ignore:Using or importing the ABCs from 'collections':DeprecationWarning:jnpr\\.junos\\.factcache",
     "ignore:NutsYamlFile\\.fspath is deprecated and will be replaced by NutsYamlFile\\.path\\.",
 ]
-markers = [
-    "nuts_test_ctx: A NutsContext to be used in tests."
-]
+markers = ["nuts_test_ctx: A NutsContext to be used in tests."]
 
 [tool.mypy]
-python_version = 3.8
+python_version = "3.8"
 
 ### --strict
 warn_unused_configs = true
@@ -149,4 +154,3 @@ commands = pytest {posargs} --junitxml=test-reports/pytest.xml --cov="{envsitepa
 # envsitepackagesdir see: https://tox.readthedocs.io/en/latest/example/pytest.html
 
 """
-

{nuts-3.2.0 → nuts-3.3.0}/nuts/base_tests/netmiko_iperf.py

@@ -1,4 +1,5 @@
 """Query bandwidth performance between two devices."""
+
 import pytest
 import json
 from typing import Dict, Callable, Any
@@ -106,7 +107,6 @@ CONTEXT = IperfContext
 
 
 class IperfResultError(Error):
-
     """Error in iperf result JSON."""