feat(runagent): list running agent IDs (#789)

Press TAB to complete -m/--module-id option with agent IDs.

Author: DavidePrincipi

core/imageroot/etc/profile.d/runagent.sh

@@ -10,3 +10,35 @@ if [ -n "${AGENT_STATE_DIR}" ] && [ -f "${AGENT_STATE_DIR}/agent.env" ]; then
    . ${AGENT_STATE_DIR}/agent.env
    export PATH
 fi
+
+if [ -z "$BASH" ]; then
+    return
+fi
+
+_runagent_wastyped()
+{
+    local xword checkword="$1"
+    for xword in "${COMP_WORDS[@]}"; do
+        if [[ "${xword}" == "${checkword}" ]]; then
+            return 0
+        fi
+    done
+    return 1
+}
+
+_runagent_completions()
+{
+    local cword="$2"
+    local agents=()
+
+    if _runagent_wastyped "-l" || _runagent_wastyped "--list-modules"; then
+        :
+    elif _runagent_wastyped "-m" || _runagent_wastyped "--module-id" ; then
+        agents+=($(runagent --list-modules | sort | grep ^"${cword}"))
+        COMPREPLY+=($(compgen -W "${agents[*]}" -- "${cword}"))
+    else
+        COMPREPLY+=($(compgen -W "--list-modules --module-id --current-dir --help" -- "${cword}"))
+    fi
+}
+
+complete -F _runagent_completions runagent

core/imageroot/usr/local/bin/runagent

@@ -25,9 +25,12 @@ import sys
 import argparse
 import agent
 import pwd
+import subprocess
 
 argp = argparse.ArgumentParser(description="Run COMMAND in the agent environment of MODULE_ID")
-argp.add_argument("-m", "--module-id", help="MODULE_ID, a module identifier (e.g. \"module1\", \"node\"). Default is \"cluster\". Only root can use this flag", default="cluster")
+argx = argp.add_mutually_exclusive_group()
+argx.add_argument("-l", "--list-modules", action="store_true", help="List running modules")
+argx.add_argument("-m", "--module-id", help="MODULE_ID, a module identifier (e.g. \"module1\", \"node\"). Default is \"cluster\". Only root can use this flag", default="cluster")
 argp.add_argument("-c", "--current-dir", action="store_true", help="Run COMMAND in current directory, instead of changing directory to AGENT_STATE_DIR")
 argp.add_argument('COMMAND', nargs='?', help="Command to run in the agent environment")
 argp.add_argument('ARGS', nargs=argparse.REMAINDER, help="Additional arguments for COMMAND")
@@ -40,6 +43,23 @@ def read_env(file_path):
     env = agent.read_envfile(file_path)
     os.environ.update(env)
 
+if args.list_modules:
+    for line in subprocess.check_output(['pgrep', '-x', 'agent', '-a'], text=True).split("\n"):
+        if not line:
+            break
+        fields = line.split()
+        if len(fields) < 3:
+            break
+        if fields[1] != '/usr/local/bin/agent':
+            continue
+        if fields[2] == '--agentid=cluster':
+            print("cluster")
+        elif fields[2].startswith('--agentid=module/'):
+            print(fields[2].removeprefix('--agentid=module/'))
+        elif fields[2].startswith('--agentid=node/'):
+            print("node")
+    sys.exit(0)
+
 mid = args.module_id
 
 if os.geteuid() != 0: