Add support for SSH endpoint lookup by VM name

[devin-ai-integration]

Add support for SSH endpoint lookup by VM name

This PR adds the ability to get the SSH endpoint of a VM by name in addition to the existing functionality of getting it by VM ID.

Changes

• Modified the vm ssh-endpoint command to accept either VM ID or VM name
• Implemented a function to look up VM ID from VM name
• Added tab completion for both VM IDs and VM names
• Updated command documentation to reflect the new functionality

Testing

• Verified the build works: make build
• Ran linter: go fmt ./...
• Ran unit and integration tests: make test-unit && make test-integration

Link to Devin run: https://app.devin.ai/sessions/cfe3ddd734084631a3ae23a8d2a48178
Requested by: [email protected]

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring

[marccampbell]

remove these 3 unused vars (they are unused, right?)

[squizzi]

Seems to work well as well in my testing.

My only issue with this is that it lists and therefore completes VMs that are not yet in running state which may result in an issue when the user tries to use that specific VM but perhaps the UX around not completing something a user would expect to get completed is more annoying then only completing "running" state VMs.

We should either only return running VMs to the completion OR provide a useful error back to the user that the vm is not yet in running state.

The error we get now if we do try to ssh to a VM that isn't yet "running" is:

./bin/replicated vm ssh-endpoint intelligent_varahamihira
Error: VM 4ef40195 does not have SSH endpoint configured

which might be confusing to a user.

[squizzi]

Since we're already here and the change was made to only filter running VMs let's update the Long help text to specify that ssh endpoints can only be retrieved from running VMs.

[AmberAlston]

what happens if there's multiple vms with the same name? it's possible today to have multiple vms with the same name but different ids

[AmberAlston]

On that new error message it would be nice to also add something like "To view all VM IDs run replicated vm ls"

[divolgin]

getVMIDFromArg function will mask valid errors from the user. If GetVM returns ErrNotFound or ErrForbidden, then we can call ListVMs. Otherwise this function should fail. ErrForbidden can be returned due to RBAC rules.