x/build/cmd/gomote: CLI UI improvements tracking issue

[mknyszek]

Goal: fix up the gomote UI by tackling the following GitHub issues,

• x/build/cmd/gomote: make environment complete enough to be usable #32430 gomote takes several commands for very common setup
• x/build/cmd/gomote: configure instance by an environment variable #29037 gomote commands are too long (kind of, this issue is more about the SSH environment, but the common steps of "push, make.bash" are so common they should probably have a shortcut)
• x/build/cmd/gomote: rethink the puttar command argument structure #53273 puttar is confusing

and directly add support for the common use-case of stress testing across several gomotes, a la

• https://github.com/mknyszek/goswarm

Proposed list of changes to the frontend:

• Add stateful gomote "groups" that can be used to both shorten gomote commands and manipulate several gomotes at once
  • State will be stored in os.UserConfigDir + "/gomote/groups"
  • Existing commands can either apply to individual gomote instances or groups via the -group flag or GOMOTE_GROUP
  • Add the -count flag to the "create" subcommand for creating multiple gomotes
  • Add the -setup flag to the "create" subcommand for automatically pushing and running ./make.ba{sh|t}
  • Add the -until= flag to the "run" subcommand
  • Add the -collect flag to automatically "gettar" after a "run."
  • Make "gettar" no longer write to stdout by default.
  • Make "puttar" have a nicer argument structure.

The example below demonstrates the new functionality. Following examples build on each other.

$ GOROOT=/path/to/goroot gomote group start my-group
Started gomote group my-group
$ gomote group list
Name          Instances       GOROOT
my-group    (none)
$ gomote -group=my-group create -count=2 -setup linux-amd64
Creating linux-amd64 gomote (1)...
Creating linux-amd64 gomote (2)...
Pushing GOROOT to user-mknyszek-linux-amd64-0...
Pushing GOROOT to user-mknyszek-linux-amd64-1...
Running ./make.bash on user-mknyszek-linux-amd64-0...
Running ./make.bash on user-mknyszek-linux-amd64-1...
$ export GOMOTE_SESSION=my-group
$ gomote create -count=1 -setup windows-amd64
Creating windows-amd64 gomote (1)...
Pushing GOROOT to user-mknyszek-windows-amd64-0...
Running ./make.bat on user-mknyszek-windows-amd64-0...
$ gomote group list
Name          Instances                        GOROOT
my-group    user-mknyszek-linux-amd64-0      /path/to/goroot
              user-mknyszek-linux-amd64-1
              user-mknyszek-windows-amd64-0
$ gomote run go/bin/go test -run="FlakyTest" -count=1000 runtime
PASS
$ gomote run -until-failure='unexpected return pc' go/bin/go test -run="FlakyTest" -count=1000 runtime
runtime: unexpected return pc
...
FAIL

• Factor out high-level gomote instance manipulation into a library.

[gopherbot]

Change https://go.dev/cl/418154 mentions this issue: cmd/gomote: add sessions

[gopherbot]

Change https://go.dev/cl/418275 mentions this issue: cmd/gomote: add support for sessions to destroy

[gopherbot]

Change https://go.dev/cl/418274 mentions this issue: cmd/gomote: add support for sessions to create

[mknyszek]

FWIW, I'm not 100% convinced myself that "sessions" are the right name or abstraction; they are a bit clunky. But, at the very least it makes working with just 1 gomote a bit easier than before.

I'm thinking I might rename them to groups. And maybe add a flag such that you can create a bunch of gomotes and add them to a new group directly.

[gopherbot]

Change https://go.dev/cl/418297 mentions this issue: cmd/gomote: add support for groups to run

[gopherbot]

Change https://go.dev/cl/418296 mentions this issue: cmd/gomote: add support for groups to push

[gopherbot]

Change https://go.dev/cl/418295 mentions this issue: cmd/gomote: add support for groups to list

[gopherbot]

Change https://go.dev/cl/418300 mentions this issue: cmd/gomote: factor out run into doRun

[gopherbot]

Change https://go.dev/cl/418301 mentions this issue: cmd/gomote: add -setup flag to create

[gopherbot]

Change https://go.dev/cl/418299 mentions this issue: cmd/gomote: add -count flag to create

[gopherbot]

Change https://go.dev/cl/418302 mentions this issue: cmd/gomote: add -new-group flag to create

[gopherbot]

Change https://go.dev/cl/418784 mentions this issue: cmd/gomote: use doPing instead of direct InstanceAlive requests

[gopherbot]

Change https://go.dev/cl/418781 mentions this issue: cmd/gomote: add -collect flag to run and refactor output writing

[gopherbot]

Change https://go.dev/cl/418782 mentions this issue: cmd/gomote: add support for groups to the gettar command

[gopherbot]

Change https://go.dev/cl/418783 mentions this issue: cmd/gomote: add support for groups to ping

[gopherbot]

Change https://go.dev/cl/418785 mentions this issue: cmd/gomote: add support for groups to ls

[gopherbot]

Change https://go.dev/cl/418786 mentions this issue: cmd/gomote: switch to specifying v2 via env var instead of by prefix

[gopherbot]

Change https://go.dev/cl/418780 mentions this issue: cmd/gomote: surface the command that failed for v2 commands

[gopherbot]

Change https://go.dev/cl/418787 mentions this issue: cmd/gomote: add -destroy-group flag to destroy

[gopherbot]

Change https://go.dev/cl/418788 mentions this issue: cmd/gomote: make "create" create a new group from GOMOTE_GROUP

[gopherbot]

Change https://go.dev/cl/418790 mentions this issue: cmd/gomote: add documentation for gomote v2

[gopherbot]

Change https://go.dev/cl/418894 mentions this issue: cmd/gomote: add -until flag to the run command

[gopherbot]

Change https://go.dev/cl/418934 mentions this issue: cmd/gomote: add support for groups to puttar and improve interface

[mknyszek]

I scaled down the scope a little bit as the week comes to an end. One enticing proposition out of all this is I have now factored out most of the gomote control bits from the actual command glue, so those can pretty easily turn into a high-level gomote control library for "scripting" purposes.

[mknyszek]

The main changes landed. (There could be a bit more refactoring and cleanup, but it seems OK for now.) Closing this issue.