pass ssh_config only if file exists (#538)

* pass ssh_config only if file exists

* added test that verifies non-existent files don't break

nornir/plugins/connections/netconf.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import Any, Dict, Optional
 
 from ncclient import manager
@@ -108,9 +109,10 @@ def open(
 
         if "ssh_config" not in extras:
             try:
-                parameters["ssh_config"] = configuration.ssh.config_file  # type: ignore
+                ssh_config_file = Path(configuration.ssh.config_file)  # type: ignore
+                if ssh_config_file.exists():
+                    parameters["ssh_config"] = ssh_config_file
             except AttributeError:
-                parameters["ssh_config"] = None
                 pass
 
         parameters.update(extras)

tests/inventory_data/netconf_hosts.yaml

@@ -11,3 +11,9 @@ netconf1.no_group:
                 hostkey_verify: False
                 look_for_keys: False
                 ssh_config: null
+
+netconf2.no_group:
+    hostname: localhost
+    username: netconf
+    password: netconf
+    port: 65025

tests/plugins/tasks/networking/test_netconf_capabilities.py

@@ -2,6 +2,9 @@
 
 
 def test_netconf_capabilities(netconf):
+    netconf = netconf.filter(name="netconf1.no_group")
+    assert netconf.inventory.hosts
+
     result = netconf.run(networking.netconf_capabilities)
 
     for _, v in result.items():

tests/plugins/tasks/networking/test_netconf_connection.py

@@ -0,0 +1,25 @@
+from nornir.core.task import Result, Task
+from nornir.plugins.tasks import networking
+
+
+def get_task(task: Task, path: str = "", filter_type: str = "xpath") -> Result:
+    manager = task.host.get_connection("netconf", task.nornir.config)
+    params = {}
+    if path:
+        params["filter"] = (filter_type, path)
+    result = manager.get(**params)
+
+    return Result(host=task.host, result=result.data_xml)
+
+
+class Test:
+    def test_netconf_connection_non_existent_ssh_config(self, netconf):
+        netconf = netconf.filter(name="netconf2.no_group")
+        assert netconf.inventory.hosts
+
+        netconf.config.ssh.config_file = "i dont exist"
+        result = netconf.run(networking.netconf_capabilities)
+        assert result
+
+        for _, v in result.items():
+            assert not isinstance(v.exception, FileNotFoundError)

tests/plugins/tasks/networking/test_netconf_edit_config.py

@@ -20,6 +20,9 @@
 
 
 def test_netconf_edit_config(netconf):
+    netconf = netconf.filter(name="netconf1.no_group")
+    assert netconf.inventory.hosts
+
     result = netconf.run(networking.netconf_get_config)
 
     for _, v in result.items():

tests/plugins/tasks/networking/test_netconf_get.py

@@ -2,13 +2,19 @@
 
 
 def test_netconf_get(netconf):
+    netconf = netconf.filter(name="netconf1.no_group")
+    assert netconf.inventory.hosts
+
     result = netconf.run(networking.netconf_get)
 
     for _, v in result.items():
         assert "<turing-machine" in v.result
 
 
 def test_netconf_get_subtree(netconf):
+    netconf = netconf.filter(name="netconf1.no_group")
+    assert netconf.inventory.hosts
+
     result = netconf.run(
         networking.netconf_get,
         path="<turing-machine></turing-machine>",

tests/plugins/tasks/networking/test_netconf_get_config.py

@@ -2,13 +2,19 @@
 
 
 def test_netconf_get_config(netconf):
+    netconf = netconf.filter(name="netconf1.no_group")
+    assert netconf.inventory.hosts
+
     result = netconf.run(networking.netconf_get_config, source="startup")
 
     for _, v in result.items():
         assert "<turing-machine" in v.result
 
 
 def test_netconf_get_config_subtree(netconf):
+    netconf = netconf.filter(name="netconf1.no_group")
+    assert netconf.inventory.hosts
+
     result = netconf.run(
         networking.netconf_get_config,
         source="startup",