feat: Fallback to first PASSTHROUGH config when no matches found (#102)

* feat: Fallback to first PASSTHROUGH config when no matches found
* fix: workaround for python3.11 support for task runner

Author: reubenmiller

c8ylp/cli/core.py

@@ -438,7 +438,9 @@ def get_config_id(ctx: click.Context, mor: Dict[str, Any], config: str) -> str:
 
     Args:
         mor (Dict[str, Any]): Device managed object
-        config (str): Expected configuration type
+        config (str): Expected configuration name. If no matching name
+            is found, but there are other PASSTHROUGH configuration available it will
+            use the first config (and log a warning)
 
     Returns:
         str: Remote access configuration id
@@ -483,16 +485,28 @@ def extract_config_id(matching_config):
         if item.get("name", "").casefold() == config.casefold()
     ]
 
-    if not matches:
-        logging.error(
-            'Provided config name "%s" for "%s" was not found or none with protocal set to "%s"',
-            config,
-            device_name,
+    if matches:
+        return extract_config_id(matches[0])
+
+    if valid_configs:
+        # Fallback to using the first valid config (if not matches names were found)
+        logging.warning(
+            "No matching %s configs found (name=%s), so falling back to first config (name=%s)",
             PASSTHROUGH,
+            config,
+            valid_configs[0].get("name", ""),
         )
-        ctx.exit(ExitCodes.DEVICE_NO_MATCHING_PASSTHROUGH_CONFIG)
+        return extract_config_id(valid_configs[0])
 
-    return extract_config_id(matches[0])
+    # Technically it should never reach here, however leave in place in
+    # case the above logic is changed
+    logging.error(
+        'Provided config name "%s" for "%s" was not found or none with protocol set to "%s"',
+        config,
+        device_name,
+        PASSTHROUGH,
+    )
+    ctx.exit(ExitCodes.DEVICE_NO_MATCHING_PASSTHROUGH_CONFIG)
 
 
 def run_proxy_in_background(

tasks.py

@@ -21,6 +21,15 @@
 import shutil
 import subprocess
 import sys
+
+# WORKAROUND
+# Workaround until python 3.11 is supported by py-invoke
+# https://github.com/pyinvoke/invoke/issues/833#issuecomment-1293148106
+import inspect
+
+if not hasattr(inspect, "getargspec"):
+    inspect.getargspec = inspect.getfullargspec
+
 from invoke import task
 from pathlib import Path
 

tests/c8ylp/cli/connect/test_ssh.py

@@ -329,14 +329,23 @@ def run():
             "exit_code": ExitCodes.DEVICE_NO_PASSTHROUGH_CONFIG,
         },
         {
-            "description": "Missing matching PASSTHROUGH name",
+            "description": "Not an exact PASSTHROUGH name match",
             "fragments": {
                 REMOTE_ACCESS_FRAGMENT: [
                     {"id": 1, "name": "example-ssh", "protocol": "ssh"},
                     {"id": 2, "name": "custom-passthrough", "protocol": PASSTHROUGH},
                 ]
             },
-            "exit_code": ExitCodes.DEVICE_NO_MATCHING_PASSTHROUGH_CONFIG,
+            "exit_code": ExitCodes.MISSING_ROLE_REMOTE_ACCESS_ADMIN,
+        },
+        {
+            "description": "Missing matching PASSTHROUGH name",
+            "fragments": {
+                REMOTE_ACCESS_FRAGMENT: [
+                    {"id": 1, "name": "example-ssh", "protocol": "ssh"},
+                ]
+            },
+            "exit_code": ExitCodes.DEVICE_NO_PASSTHROUGH_CONFIG,
         },
         {
             "description": "Custom PASSTHROUGH name matching but still missing role",