Agent Executor (AX) is Google's open agentic orchestration runtime
Go
fix(cli): honour ax ssh --help and stop global flag parsing at -- (#411)
Anzal Husain Abidi0126b7261d17
diff --git a/cmd/ax/main.go b/cmd/ax/main.goindex db06a87..c8733f8 100644--- a/cmd/ax/main.go+++ b/cmd/ax/main.go@@ -45,53 +45,16 @@ func main() {os.Exit(1)}+ opts := parseGlobalArgs(os.Args[1:])var (- cmd string- cleanArgs []string- atespace = "default"- explicitServer = ""- kubeContext = ""- axNamespace = v1alpha1.DefaultSystemNamespace+ cmd = opts.cmd+ cleanArgs = opts.args+ atespace = opts.atespace+ explicitServer = opts.server+ kubeContext = opts.kubeContext+ axNamespace = opts.namespace)- args := os.Args[1:]- for i := 0; i < len(args); i++ {- arg := args[i]- if arg == "-a" || arg == "--atespace" {- if i+1 < len(args) {- atespace = args[i+1]- i++- }- } else if strings.HasPrefix(arg, "--atespace=") {- atespace = strings.TrimPrefix(arg, "--atespace=")- } else if arg == "--server" {- if i+1 < len(args) {- explicitServer = args[i+1]- i++- }- } else if strings.HasPrefix(arg, "--server=") {- explicitServer = strings.TrimPrefix(arg, "--server=")- } else if arg == "--context" {- if i+1 < len(args) {- kubeContext = args[i+1]- i++- }- } else if strings.HasPrefix(arg, "--context=") {- kubeContext = strings.TrimPrefix(arg, "--context=")- } else if arg == "-n" || arg == "--namespace" {- if i+1 < len(args) {- axNamespace = args[i+1]- i++- }- } else if strings.HasPrefix(arg, "--namespace=") {- axNamespace = strings.TrimPrefix(arg, "--namespace=")- } else if cmd == "" && !strings.HasPrefix(arg, "-") {- cmd = arg- } else {- cleanArgs = append(cleanArgs, arg)- }- }-if cmd == "" {printUsage()os.Exit(1)@@ -117,6 +80,17 @@ func main() {os.Exit(1)}return+ case "ssh":+ // Answer help and usage errors before resolving the server, which may+ // start a port-forward to the cluster.+ if _, _, help, err := parseSSHArgs(cleanArgs); help || err != nil {+ fmt.Println(sshUsage)+ if err != nil {+ fmt.Fprintf(os.Stderr, "Error: %v\n", err)+ os.Exit(1)+ }+ return+ }}// Resolve the AX server URL (auto-tunneling to active kube context if not explicitly set)@@ -159,6 +133,64 @@ func main() {}}+// globalArgs holds the command name, the flags shared by every command, and the+// remaining arguments for the command itself.+type globalArgs struct {+ cmd string+ args []string+ atespace string+ server string+ kubeContext string+ namespace string+}++// parseGlobalArgs extracts the command name and the global flags from args. It+// stops interpreting flags at "--", so everything after it (for example the+// command run by `ax ssh <task> -- ...`) is passed through to the command intact.+func parseGlobalArgs(args []string) globalArgs {+ g := globalArgs{atespace: "default", namespace: v1alpha1.DefaultSystemNamespace}+ for i := 0; i < len(args); i++ {+ arg := args[i]+ if arg == "--" {+ g.args = append(g.args, args[i:]...)+ break+ } else if arg == "-a" || arg == "--atespace" {+ if i+1 < len(args) {+ g.atespace = args[i+1]+ i+++ }+ } else if strings.HasPrefix(arg, "--atespace=") {+ g.atespace = strings.TrimPrefix(arg, "--atespace=")+ } else if arg == "--server" {+ if i+1 < len(args) {+ g.server = args[i+1]+ i+++ }+ } else if strings.HasPrefix(arg, "--server=") {+ g.server = strings.TrimPrefix(arg, "--server=")+ } else if arg == "--context" {+ if i+1 < len(args) {+ g.kubeContext = args[i+1]+ i+++ }+ } else if strings.HasPrefix(arg, "--context=") {+ g.kubeContext = strings.TrimPrefix(arg, "--context=")+ } else if arg == "-n" || arg == "--namespace" {+ if i+1 < len(args) {+ g.namespace = args[i+1]+ i+++ }+ } else if strings.HasPrefix(arg, "--namespace=") {+ g.namespace = strings.TrimPrefix(arg, "--namespace=")+ } else if g.cmd == "" && !strings.HasPrefix(arg, "-") {+ g.cmd = arg+ } else {+ g.args = append(g.args, arg)+ }+ }+ return g+}+func printUsage() {fmt.Println(`AX CLI - Autonomous agent execution control@@ -959,24 +991,50 @@ func runTunnel(args []string) error {}}-func runSSH(serverURL, atespace, kubeContext string, args []string) error {- if len(args) == 0 {- return fmt.Errorf("usage: ax ssh <task-name> [-- command...]")+const sshUsage = `Usage:+ ax ssh <task-name> [-- command...]++Run a command inside a running task's container, or /bin/sh when no command is+given. The task must be Running and have spec.debug: true.++Examples:+ ax ssh task123+ ax ssh task123 -- ls -la /workspace+ ax ssh -a my-atespace task123 -- python3 main.py`++// parseSSHArgs splits the arguments of `ax ssh` into the task name and the command+// to run, defaulting the command to /bin/sh. help reports a -h or --help given in+// place of the task name. Arguments after the task name form the command, passed+// verbatim, with or without a separating "--" directly after the task name.+func parseSSHArgs(args []string) (taskName string, command []string, help bool, err error) {+ if len(args) == 0 || args[0] == "--" {+ return "", nil, false, errors.New("missing task name")+ }+ if args[0] == "-h" || args[0] == "--help" {+ return "", nil, true, nil+ }+ if strings.HasPrefix(args[0], "-") {+ return "", nil, false, fmt.Errorf("unknown flag %q", args[0])}- taskName := args[0]- var cmdToRun []string- for i := 1; i < len(args); i++ {- if args[i] == "--" {- cmdToRun = args[i+1:]- break- } else {- cmdToRun = append(cmdToRun, args[i])- }+ taskName = args[0]+ // Only a "--" directly after the task name is the separator. Any later "--"+ // belongs to the remote command (for example `git log -- file`).+ rest := args[1:]+ if len(rest) > 0 && rest[0] == "--" {+ rest = rest[1:]+ }+ command = append(command, rest...)+ if len(command) == 0 {+ command = []string{"/bin/sh"}}+ return taskName, command, false, nil+}- if len(cmdToRun) == 0 {- cmdToRun = []string{"/bin/sh"}+func runSSH(serverURL, atespace, kubeContext string, args []string) error {+ taskName, cmdToRun, _, err := parseSSHArgs(args)+ if err != nil {+ return err}client, conn, err := getAXClient(serverURL)diff --git a/cmd/ax/main_test.go b/cmd/ax/main_test.goindex 2040aa5..c0b7785 100644--- a/cmd/ax/main_test.go+++ b/cmd/ax/main_test.go@@ -20,6 +20,7 @@ import ("net""os""path/filepath"+ "reflect""strings""testing""time"@@ -278,3 +279,104 @@ func TestRunDeleteTask(t *testing.T) {t.Fatalf("expected task to be NotFound after deletion, got %v", err)}}++func TestParseGlobalArgs(t *testing.T) {+ tests := []struct {+ name string+ args []string+ want globalArgs+ }{+ {+ name: "flags before and after the command",+ args: []string{"-a", "team", "get", "tasks", "--namespace=ax"},+ want: globalArgs{cmd: "get", args: []string{"tasks"}, atespace: "team", namespace: "ax"},+ },+ {+ name: "flags after -- belong to the remote command",+ args: []string{"ssh", "task123", "--", "grep", "-n", "foo", "-a", "file"},+ want: globalArgs{+ cmd: "ssh",+ args: []string{"task123", "--", "grep", "-n", "foo", "-a", "file"},+ atespace: "default",+ namespace: "ax-system",+ },+ },+ {+ name: "global flags before -- still apply",+ args: []string{"ssh", "-a", "team", "task123", "--", "ls", "--context=x"},+ want: globalArgs{+ cmd: "ssh",+ args: []string{"task123", "--", "ls", "--context=x"},+ atespace: "team",+ namespace: "ax-system",+ },+ },+ }+ for _, tt := range tests {+ t.Run(tt.name, func(t *testing.T) {+ if got := parseGlobalArgs(tt.args); !reflect.DeepEqual(got, tt.want) {+ t.Errorf("parseGlobalArgs(%q) = %+v, want %+v", tt.args, got, tt.want)+ }+ })+ }+}++func TestParseSSHArgs(t *testing.T) {+ tests := []struct {+ name string+ args []string+ wantTask string+ wantCommand []string+ wantHelp bool+ wantErr bool+ }{+ {name: "long help", args: []string{"--help"}, wantHelp: true},+ {name: "short help", args: []string{"-h"}, wantHelp: true},+ {name: "no args", args: nil, wantErr: true},+ {name: "no task before --", args: []string{"--", "ls"}, wantErr: true},+ {name: "unknown flag", args: []string{"--verbose", "task123"}, wantErr: true},+ {name: "default shell", args: []string{"task123"}, wantTask: "task123", wantCommand: []string{"/bin/sh"}},+ {+ name: "command after --",+ args: []string{"task123", "--", "ls", "-la", "/workspace"},+ wantTask: "task123",+ wantCommand: []string{"ls", "-la", "/workspace"},+ },+ {+ name: "command without --",+ args: []string{"task123", "python3", "main.py"},+ wantTask: "task123",+ wantCommand: []string{"python3", "main.py"},+ },+ {+ name: "later -- is kept with leading --",+ args: []string{"task123", "--", "git", "log", "--", "file"},+ wantTask: "task123",+ wantCommand: []string{"git", "log", "--", "file"},+ },+ {+ name: "later -- is kept without leading --",+ args: []string{"task123", "git", "log", "--", "file"},+ wantTask: "task123",+ wantCommand: []string{"git", "log", "--", "file"},+ },+ {+ name: "help after the task name goes to the remote command",+ args: []string{"task123", "--", "git", "--help"},+ wantTask: "task123",+ wantCommand: []string{"git", "--help"},+ },+ }+ for _, tt := range tests {+ t.Run(tt.name, func(t *testing.T) {+ task, command, help, err := parseSSHArgs(tt.args)+ if (err != nil) != tt.wantErr {+ t.Fatalf("parseSSHArgs(%q) error = %v, wantErr %v", tt.args, err, tt.wantErr)+ }+ if task != tt.wantTask || help != tt.wantHelp || !reflect.DeepEqual(command, tt.wantCommand) {+ t.Errorf("parseSSHArgs(%q) = (%q, %q, %v), want (%q, %q, %v)",+ tt.args, task, command, help, tt.wantTask, tt.wantCommand, tt.wantHelp)+ }+ })+ }+}