Skip to content

feat(agent/agentcontainers): add ContainerEnvInfoer #16623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 24, 2025
Merged

feat(agent/agentcontainers): add ContainerEnvInfoer #16623

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8c357b4
feat(agent/agentcontainers): add ContainerEnvInfoer
johnstcn Feb 19, 2025
e76af04
ctud
johnstcn Feb 19, 2025
7fd24be
Apply suggestions from code review
johnstcn Feb 19, 2025
5e57035
address mafcode review comments
johnstcn Feb 19, 2025
d52d0c1
fix issue with docker homedir and env clobbering real env for cmd
johnstcn Feb 19, 2025
467a6e8
env from devcontainer metadata
johnstcn Feb 19, 2025
06b9b7e
re-add comment
johnstcn Feb 19, 2025
bf101d3
PR comments again
johnstcn Feb 24, 2025
f06105a
strings.Builder
johnstcn Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
PR comments again
  • Loading branch information
@johnstcn
johnstcn committed Feb 24, 2025
commit bf101d336118734ef74db633e61b8043bbfdd8c7
43 changes: 21 additions & 22 deletions agent/agentcontainers/containers_dockercli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,19 @@ func NewDocker(execer agentexec.Execer) Lister {
}
}

// ContainerEnvInfoer is an implementation of agentssh.EnvInfoer that returns
// DockerEnvInfoer is an implementation of agentssh.EnvInfoer that returns
// information about a container.
type ContainerEnvInfoer struct {
type DockerEnvInfoer struct {
container string
user *user.User
userShell string
env []string
}

// EnvInfo returns information about the environment of a container.
func EnvInfo(ctx context.Context, execer agentexec.Execer, container, containerUser string) (*ContainerEnvInfoer, error) {
var cei ContainerEnvInfoer
cei.container = container
func EnvInfo(ctx context.Context, execer agentexec.Execer, container, containerUser string) (*DockerEnvInfoer, error) {
var dei DockerEnvInfoer
dei.container = container

if containerUser == "" {
// Get the "default" user of the container if no user is specified.
Expand Down Expand Up @@ -93,22 +93,22 @@ func EnvInfo(ctx context.Context, execer agentexec.Execer, container, containerU
return nil, xerrors.Errorf("get container user: invalid line in /etc/passwd: %q", foundLine)
}

// The fourth entry in /etc/passwd contains GECOS information, which is a
// The fifth entry in /etc/passwd contains GECOS information, which is a
// comma-separated list of fields. The first field is the user's full name.
gecos := strings.Split(passwdFields[4], ",")
fullName := ""
if len(gecos) > 1 {
fullName = gecos[0]
}

cei.user = &user.User{
dei.user = &user.User{
Gid: passwdFields[3],
HomeDir: passwdFields[5],
Name: fullName,
Uid: passwdFields[2],
Username: containerUser,
}
cei.userShell = passwdFields[6]
dei.userShell = passwdFields[6]

// We need to inspect the container labels for remoteEnv and append these to
// the resulting docker exec command.
Expand All @@ -117,58 +117,57 @@ func EnvInfo(ctx context.Context, execer agentexec.Execer, container, containerU
if err != nil { // best effort.
return nil, xerrors.Errorf("read devcontainer remoteEnv: %w", err)
}
cei.env = env
dei.env = env

return &cei, nil
return &dei, nil
}

func (cei *ContainerEnvInfoer) CurrentUser() (*user.User, error) {
func (dei *DockerEnvInfoer) CurrentUser() (*user.User, error) {
// Clone the user so that the caller can't modify it
u := *cei.user
u := *dei.user
return &u, nil
}

func (*ContainerEnvInfoer) Environ() []string {
func (*DockerEnvInfoer) Environ() []string {
// Return a clone of the environment so that the caller can't modify it
return os.Environ()
}

func (*ContainerEnvInfoer) UserHomeDir() (string, error) {
func (*DockerEnvInfoer) UserHomeDir() (string, error) {
// We default the working directory of the command to the user's home
// directory. Since this came from inside the container, we cannot guarantee
// that this exists on the host. Return the "real" home directory of the user
// instead.
return os.UserHomeDir()
}

func (cei *ContainerEnvInfoer) UserShell(string) (string, error) {
return cei.userShell, nil
func (dei *DockerEnvInfoer) UserShell(string) (string, error) {
return dei.userShell, nil
}

func (cei *ContainerEnvInfoer) ModifyCommand(cmd string, args ...string) (string, []string) {
func (dei *DockerEnvInfoer) ModifyCommand(cmd string, args ...string) (string, []string) {
// Wrap the command with `docker exec` and run it as the container user.
// There is some additional munging here regarding the container user and environment.
// return WrapDockerExecPTY(dei.container, dei.user.Username)(cmd, args...)
dockerArgs := []string{
"exec",
// The assumption is that this command will be a shell command, so allocate a PTY.
"--interactive",
"--tty",
// Run the command as the user in the container.
"--user",
cei.user.Username,
dei.user.Username,
// Set the working directory to the user's home directory as a sane default.
"--workdir",
cei.user.HomeDir,
dei.user.HomeDir,
}

// Append the environment variables from the container.
for _, e := range cei.env {
for _, e := range dei.env {
dockerArgs = append(dockerArgs, "--env", e)
}

// Append the container name and the command.
dockerArgs = append(dockerArgs, cei.container, cmd)
dockerArgs = append(dockerArgs, dei.container, cmd)
return "docker", append(dockerArgs, args...)
}

Expand Down
Loading