Merge pull request #53 from INSRapperswil/51-move_xxxNornirNutsContext.nornir_filter_up_to_base_class

51 move xxx nornir nuts context.nornir filter up to base class

Author: lucmurer

nuts/base_tests/napalm_bgp_neighbors.py

@@ -2,12 +2,10 @@
 from typing import Dict, Callable, List, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_napalm.plugins.tasks import napalm_get
 
 from nuts.context import NornirNutsContext
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 
 
@@ -37,9 +35,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, List[str]]:
         return {"getters": ["bgp_neighbors"]}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> BgpNeighborsExtractor:
         return BgpNeighborsExtractor(self)
 

nuts/base_tests/napalm_get_users.py

@@ -2,12 +2,10 @@
 from typing import Dict, Callable, List, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_napalm.plugins.tasks import napalm_get
 
 from nuts.context import NornirNutsContext
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 
 
@@ -23,9 +21,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, List[str]]:
         return {"getters": ["users"]}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> UsersExtractor:
         return UsersExtractor(self)
 

nuts/base_tests/napalm_interfaces.py

@@ -2,12 +2,10 @@
 from typing import Dict, Callable, List, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_napalm.plugins.tasks import napalm_get
 
 from nuts.context import NornirNutsContext
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 
 
@@ -23,9 +21,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, List[str]]:
         return {"getters": ["interfaces"]}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> InterfacesExtractor:
         return InterfacesExtractor(self)
 

nuts/base_tests/napalm_lldp_neighbors.py

@@ -2,13 +2,11 @@
 from typing import Dict, Callable, List, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_napalm.plugins.tasks import napalm_get
 
 from nuts.context import NornirNutsContext
 from nuts.helpers.converters import InterfaceNameConverter
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 
 
@@ -43,9 +41,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, List[str]]:
         return {"getters": ["lldp_neighbors_detail"]}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> LldpNeighborsExtractor:
         return LldpNeighborsExtractor(self)
 

nuts/base_tests/napalm_network_instances.py

@@ -2,11 +2,9 @@
 from typing import Dict, List, Callable, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_napalm.plugins.tasks import napalm_get
 
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 from nuts.context import NornirNutsContext
 
@@ -35,9 +33,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, List[str]]:
         return {"getters": ["network_instances"]}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> NetworkInstancesExtractor:
         return NetworkInstancesExtractor(self)
 

nuts/base_tests/napalm_ping.py

@@ -4,12 +4,10 @@
 
 import pytest
 from nornir.core import Task
-from nornir.core.filter import F
 from nornir.core.task import Result
 from nornir_napalm.plugins.tasks import napalm_ping
 
 from nuts.context import NornirNutsContext
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import (
     NutsResult,
     AbstractHostDestResultExtractor,
@@ -110,9 +108,6 @@ def napalm_ping_multi_dests(self, task: Task, **kwargs: Any) -> Result:
             result[0].destination = destination  # type: ignore[attr-defined]
         return Result(host=task.host, result="All pings executed")
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> PingExtractor:
         return PingExtractor(self)
 

nuts/base_tests/netmiko_cdp_neighbors.py

@@ -2,11 +2,9 @@
 from typing import Callable, Dict, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_netmiko import netmiko_send_command
 
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 from nuts.context import NornirNutsContext
 
@@ -24,9 +22,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, Any]:
         return {"command_string": "show cdp neighbors detail", "use_textfsm": True}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> CdpNeighborsExtractor:
         return CdpNeighborsExtractor(self)
 

nuts/base_tests/netmiko_iperf.py

@@ -4,12 +4,11 @@
 from typing import Dict, Callable, Any
 import shlex
 
-from nornir.core.filter import F
 from nornir.core.task import Task, Result
+from nornir.core.filter import F
 from nornir_netmiko import netmiko_send_command
 
 from nuts.context import NornirNutsContext
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.errors import Error
 from nuts.helpers.result import NutsResult, AbstractHostDestResultExtractor
 
@@ -70,9 +69,6 @@ def netmiko_run_iperf(self, task: Task) -> Result:
             result[0].destination = destination  # type: ignore[attr-defined]
         return Result(host=task.host, result=f"iperf executed for {task.host}")
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def setup(self) -> None:
         """
         Sets up the all destinations to act as iperf servers.

nuts/base_tests/netmiko_ospf_neighbors.py

@@ -2,12 +2,10 @@
 from typing import Callable, Dict, Any
 
 import pytest
-from nornir.core.filter import F
 from nornir.core.task import MultiResult, Result
 from nornir_netmiko import netmiko_send_command
 
 from nuts.context import NornirNutsContext
-from nuts.helpers.filters import filter_hosts
 from nuts.helpers.result import AbstractHostResultExtractor, NutsResult
 
 
@@ -24,9 +22,6 @@ def nuts_task(self) -> Callable[..., Result]:
     def nuts_arguments(self) -> Dict[str, Any]:
         return {"command_string": "show ip ospf neighbor", "use_textfsm": True}
 
-    def nornir_filter(self) -> F:
-        return filter_hosts(self.nuts_parameters["test_data"])
-
     def nuts_extractor(self) -> OspfNeighborsExtractor:
         return OspfNeighborsExtractor(self)
 

nuts/context.py

@@ -10,6 +10,7 @@
 
 from nuts.helpers.errors import NutsSetupError
 from nuts.helpers.result import AbstractResultExtractor
+from nuts.helpers.filters import filter_hosts
 
 
 class NutsContext:
@@ -109,11 +110,11 @@ def nuts_task(self) -> Callable[..., Result]:
         """
         raise NotImplementedError
 
-    def nornir_filter(self) -> Optional[F]:
+    def nornir_filter(self) -> F:
         """
         :return: A nornir filter that is applied to the nornir instance
         """
-        return None
+        return filter_hosts(self.nuts_parameters["test_data"])
 
     def general_result(self) -> AggregatedResult:
         """