Merge pull request #179 from SimonThalvorsen/main

Updated behaviour of cfengine run-command

Author: olehermanse

src/cfengine_cli/cfengine_wrapper/cfengine_commands.py

@@ -1,13 +1,135 @@
+import os
+import logging
+
 from cfbs.commands import build_command
 from cf_remote.commands import deploy as deploy_command
 from cf_remote.commands import install as install_command
 from cf_remote.commands import destroy as destroy_command
+from cf_remote.remote import run_command, transfer_file
 
+from cfengine_cli.utils import UserError
+from cfengine_cli.cfengine_wrapper.cfengine_objects import (
+    Executable,
+    _ensure_default_agent_flags,
+)
 from cfengine_cli.cfengine_wrapper.cfengine_utils import (
+    extract_agent_file,
+    prompt_two_options,
     require_executable,
     require_installation,
 )
 
+_DEFAULT_CFENGINE_INPUTS_DIR = "/var/cfengine/inputs"
+
+
+# ---------------------------------------------------------------------------
+# File-resolution helpers for run()
+# ---------------------------------------------------------------------------
+
+
+def _remote_path_exists(host: str, path: str) -> bool:
+    return run_command(host, f"test -f {path}", sudo=False) is not None
+
+
+def _replace_file_token(command: str, old: str, new: str) -> str:
+    tokens = command.split()
+    return " ".join(new if t == old else t for t in tokens)
+
+
+def _resolve_bare_filename_local(command: str, file_arg: str) -> str:
+    cwd_path = os.path.join(os.getcwd(), file_arg)
+    inputs_path = os.path.join(_DEFAULT_CFENGINE_INPUTS_DIR, file_arg)
+    cwd_exists = os.path.isfile(cwd_path)
+    inputs_exists = os.path.isfile(inputs_path)
+
+    if not cwd_exists and not inputs_exists:
+        raise UserError(
+            f"Could not find '{file_arg}' in the current directory or in "
+            f"{_DEFAULT_CFENGINE_INPUTS_DIR}."
+        )
+
+    if cwd_exists and inputs_exists:
+        choice = prompt_two_options(
+            f"'{file_arg}' exists both in the current directory and in "
+            f"{_DEFAULT_CFENGINE_INPUTS_DIR}.",
+            f"the copy in the current directory ({cwd_path})",
+            f"the copy already in {_DEFAULT_CFENGINE_INPUTS_DIR} ({inputs_path})",
+        )
+        use_cwd = choice != "b"
+    else:
+        use_cwd = cwd_exists
+
+    return _replace_file_token(command, file_arg, cwd_path) if use_cwd else command
+
+
+def _remote_home_dir(location: str) -> str:
+    user = location.split("@", 1)[0]
+    return "/root" if user == "root" else f"/home/{user}"
+
+
+def _resolve_file_remote(location: str, command: str, file_arg: str) -> str:
+    local_exists = os.path.isfile(file_arg)
+
+    local_home = os.path.expanduser("~")
+    remote_home = _remote_home_dir(location)
+
+    if file_arg.startswith(local_home + os.sep):
+        # e.g. "~/update.cf", shell expands to /home/{user}/update.cf
+        rel = file_arg[len(local_home) + 1 :]
+        remote_path = f"{remote_home}/{rel}"
+    elif file_arg.startswith("/"):
+        remote_path = file_arg
+    else:
+        remote_path = f"{_DEFAULT_CFENGINE_INPUTS_DIR}/{file_arg}"
+
+    remote_exists = _remote_path_exists(location, remote_path)
+
+    if not local_exists and not remote_exists:
+        raise UserError(
+            f"Could not find '{file_arg}' locally or on {location} (checked {remote_path})."
+        )
+
+    if local_exists and remote_exists:
+        choice = prompt_two_options(
+            f"'{file_arg}' exists both locally and on {location} (at {remote_path}).\nUse the:",
+            "local copy (uploads it, possibly overwriting the remote copy)",
+            f"copy already on {location}, unchanged",
+        )
+    elif local_exists:
+        choice = "a"
+    else:
+        choice = "b"
+
+    if choice == "b":
+        return _replace_file_token(command, file_arg, remote_path)
+
+    uploaded_path = f"{remote_home}/{os.path.basename(file_arg)}"
+    logging.warning(f"Uploading {file_arg} to {location}:{uploaded_path}")
+    transfer_file(location, file_arg)
+    return _replace_file_token(command, file_arg, uploaded_path)
+
+
+def _resolve_command_for_agent(agent: Executable, command: str) -> str:
+    if agent.name != "cf-agent":
+        return command
+
+    command = _ensure_default_agent_flags(command)
+    file_arg = extract_agent_file(command)
+    if not file_arg:
+        return command
+
+    if agent.is_local:
+        if "/" in file_arg:
+            return command  # no ambiguity for a local target
+        return _resolve_bare_filename_local(command, file_arg)
+
+    return _resolve_file_remote(agent.location, command, file_arg)
+
+
+# ---------------------------------------------------------------------------
+# Commands
+# ---------------------------------------------------------------------------
+
 
 def report(target: str | None = None) -> int:  # TODO? ENT-14122
     installation = require_installation(target)
@@ -21,9 +143,10 @@ def report(target: str | None = None) -> int:  # TODO? ENT-14122
 
 def run(*args, target: str | None = None) -> int:
     agent = require_executable("cf-agent", target)
-    if args:
-        return agent.run(*args)
-    return agent.run("-KIf update.cf", "-KI")
+    if not args:
+        return agent.run("-KIf update.cf", "-KI")
+    resolved = [_resolve_command_for_agent(agent, command) for command in args]
+    return agent.run(*resolved)
 
 
 def install() -> int:  # TODO ENT-14117

src/cfengine_cli/cfengine_wrapper/cfengine_utils.py

@@ -12,6 +12,34 @@
 from cf_remote.utils import read_json
 
 
+def prompt_two_options(header: str, option_a: str, option_b: str) -> str:
+    print(header)
+    print(f"  1) {option_a}")
+    print(f"  2) {option_b}")
+    while True:
+        choice = input("Select [1-2]: ").strip()
+        if choice == "1":
+            return "a"
+        if choice == "2":
+            return "b"
+        print("Invalid selection, try again.")
+
+
+def extract_agent_file(command: str) -> str | None:
+    """
+    Best-effort extraction of the filename cf-agent would read as policy
+    input, from an already-flagged command string (e.g. "-KIf update.cf").
+    Returns None if there's no file argument to check at all (e.g. plain
+    "-KI"), in which case there's nothing to resolve.
+    """
+    tokens = command.split()
+    for i, token in enumerate(tokens):
+        if token.startswith("-") and not token.startswith("--") and "f" in token:
+            if i + 1 < len(tokens):
+                return tokens[i + 1]
+    return None
+
+
 def _find_local_path(binary_name: str) -> str | None:
     candidate = bin(binary_name)
     if os.path.isfile(candidate) and os.access(candidate, os.X_OK):
@@ -95,7 +123,9 @@ def _find_all_paired() -> list[Installation]:
     for host, aliases in _known_hosts(role_filter="hub"):
         try:
             data = get_info(host)
-        except Exception:
+        except (Exception, SystemExit) as e:
+            # Same reasoning as _find_all()
+            logging.warning(f"Skipping {host}: {e}")
             continue
         if not data:
             continue