chore(agent/agentssh): extract EnvInfoer #16603
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mafredri
approved these changes
Feb 18, 2025
| // UserHomeDir returns the home directory of the current user. | ||
| UserHomeDir() (string, error) | ||
| // UserShell returns the shell of the given user. | ||
| UserShell(username string) (string, error) |
There was a problem hiding this comment.
I feel like all these methods are related to the environment, figuring out the user, env, home and shell, so EnvInfo sounds like a pretty good name to me. Deps is a bit vague IMO and makes me think of dependency injection. 😄
We could also simplify this interface somewhat. All we really need are:
User()Environ()
We'd just make sure the returned user has the correct home directory and shell populated. Not sure if that'd be worth the lift, though.
There was a problem hiding this comment.
EnvInfoer it is!
I'd prefer to do the bare minimum here, but we can consolidate + simplify down the line!
mafredri
reviewed
Feb 18, 2025
| @@ -96,7 +96,7 @@ func TestNewServer_ExecuteShebang(t *testing.T) { | |||
| t.Run("Args", func(t *testing.T) { | |||
| t.Parallel() | |||
| cmd, err := s.CreateCommand(ctx, `#!/usr/bin/env bash | |||
| echo test`, nil) | |||
| echo test`, nil, nil) | |||
There was a problem hiding this comment.
Perhaps we should add a test for a custom implementation as well?
SasSwart
approved these changes
Feb 19, 2025
dannykopping
approved these changes
Feb 19, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extracts environment-level dependencies of
agentssh.Server.CreateCommand()to an interface to allow alternative implementations to be passed in.We'll need this so we can pass in an alternative implementation that can reference a running container instead of the agent's environment.
I'm not married to the naming convention and will rename the thing if anyone has a better name.