- Notifications
You must be signed in to change notification settings - Fork1k
fix(agent/agentcontainers): improve testing of convertDockerInspect, return correct host port#16887
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from1 commit
Commits
Show all changes
12 commits Select commitHold shift + click to select a range
80ac9a3 chore(agent/agentcontainers): refactor runDockerInspect and convertDo…
johnstcn0ecceb0 chore(agent/agentcontainers): add dedicated test for convertDockerIns…
johnstcn55998d0 fix(agent/agentcontainers): fix incorrectly parsed port
johnstcnfb78d33 nolint paralleltest
johnstcna7d1ea4 chore: adjust testdata structure
johnstcn393f6e9 use a []byte instead of a string
johnstcn95b156e fix(agent/agentcontainers): create new WorkspaceAgentDevcontainerPort…
johnstcnf8f3000 fix(site): correct container port link
johnstcn999469f chore(site): add stories for AgentDevcontainerCard
johnstcn8338af3 make fmt lint
johnstcn2f0180e rm extraneous null check
johnstcn1ae6015 address PR comment
johnstcnFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
fix(agent/agentcontainers): create new WorkspaceAgentDevcontainerPort…
… type, return container and host port
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
commit95b156ec142cfcf1cd474e68346a33b85ca0eafe
There are no files selected for viewing
68 changes: 53 additions & 15 deletionsagent/agentcontainers/containers_dockercli.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -6,6 +6,7 @@ import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "net" | ||
| "os/user" | ||
| "slices" | ||
| "sort" | ||
| @@ -379,6 +380,19 @@ func convertDockerInspect(raw []byte) ([]codersdk.WorkspaceAgentDevcontainer, [] | ||
| } | ||
| outs := make([]codersdk.WorkspaceAgentDevcontainer, 0, len(ins)) | ||
| // Say you have two containers: | ||
| // - Container A with Host IP 127.0.0.1:8000 mapped to container port 8001 | ||
| // - Container B with Host IP [::1]:8000 mapped to container port 8001 | ||
| // A request to localhost:8000 may be routed to either container. | ||
| // We don't know which one for sure, so we need to surface this to the user. | ||
| // Keep track of all host ports we see. If we see the same host port | ||
| // mapped to multiple containers on different host IPs, we need to | ||
| // warn the user about this. | ||
| // Note that we only do this for loopback or unspecified IPs. | ||
| // We'll assume that the user knows what they're doing if they bind to | ||
| // a specific IP address. | ||
| hostPortContainers := make(map[int][]string) | ||
| for _, in := range ins { | ||
| out := codersdk.WorkspaceAgentDevcontainer{ | ||
| CreatedAt: in.Created, | ||
| @@ -387,7 +401,7 @@ func convertDockerInspect(raw []byte) ([]codersdk.WorkspaceAgentDevcontainer, [] | ||
| ID: in.ID, | ||
| Image: in.Config.Image, | ||
| Labels: in.Config.Labels, | ||
| Ports: make([]codersdk.WorkspaceAgentDevcontainerPort, 0), | ||
| Running: in.State.Running, | ||
| Status: in.State.String(), | ||
| Volumes: make(map[string]string, len(in.Mounts)), | ||
| @@ -399,35 +413,43 @@ func convertDockerInspect(raw []byte) ([]codersdk.WorkspaceAgentDevcontainer, [] | ||
| portKeys := maps.Keys(in.NetworkSettings.Ports) | ||
| // Sort the ports for deterministic output. | ||
| sort.Strings(portKeys) | ||
| //If we see the same port boundtoboth ipv4 and ipv6 loopback or unspecified | ||
| //interfaces tothesame container port, there is no point in adding it multiple times. | ||
| loopbackHostPortContainerPorts := make(map[int]uint16, 0) | ||
| for _, pk := range portKeys { | ||
| for _, p := range in.NetworkSettings.Ports[pk] { | ||
| cp, network, err := convertDockerPort(pk) | ||
| if err != nil { | ||
| warns = append(warns, fmt.Sprintf("convert docker port: %s", err.Error())) | ||
| // Default network to "tcp" if we can't parse it. | ||
| network = "tcp" | ||
| } | ||
| hp, err := strconv.Atoi(p.HostPort) | ||
| if err != nil { | ||
| warns = append(warns, fmt.Sprintf("convert dockerhostport: %s", err.Error())) | ||
| continue | ||
| } | ||
| if hp > 65535 || hp <1 { // invalid port | ||
| warns = append(warns, fmt.Sprintf("convert dockerhostport: invalid host port %d", hp)) | ||
| continue | ||
| } | ||
| // Deduplicate host ports for loopback and unspecified IPs. | ||
| if isLoopbackOrUnspecified(p.HostIP) { | ||
| if found, ok := loopbackHostPortContainerPorts[hp]; ok && found == cp { | ||
| // We've already seen this port, so skip it. | ||
| continue | ||
| } | ||
| loopbackHostPortContainerPorts[hp] = cp | ||
| // Also keep track of the host port and the container ID. | ||
| hostPortContainers[hp] = append(hostPortContainers[hp], in.ID) | ||
| } | ||
| out.Ports = append(out.Ports, codersdk.WorkspaceAgentDevcontainerPort{ | ||
| Network: network, | ||
| Port: cp, | ||
| HostPort: uint16(hp), | ||
| HostIP: p.HostIP, | ||
| }) | ||
| } | ||
| } | ||
| @@ -444,6 +466,13 @@ func convertDockerInspect(raw []byte) ([]codersdk.WorkspaceAgentDevcontainer, [] | ||
| outs = append(outs, out) | ||
| } | ||
| // Check if any host ports are mapped to multiple containers. | ||
| for hp, ids := range hostPortContainers { | ||
| if len(ids) > 1 { | ||
| warns = append(warns, fmt.Sprintf("host port %d is mapped to multiple containers on different interfaces: %s", hp, strings.Join(ids, ", "))) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Is ids here the sha or a human readable name? The latter may be easier on the eyes but both work as long as we surface the used value in the UI. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I used the ID here for specificity. FriendlyName might be a good call; I'll address that in a follow-up! | ||
| } | ||
| } | ||
| return outs, warns, nil | ||
| } | ||
| @@ -471,3 +500,12 @@ func convertDockerPort(in string) (uint16, string, error) { | ||
| return 0, "", xerrors.Errorf("invalid port format: %s", in) | ||
| } | ||
| } | ||
| // convenience function to check if an IP address is loopback or unspecified | ||
| func isLoopbackOrUnspecified(ips string) bool { | ||
| nip := net.ParseIP(ips) | ||
| if nip == nil { | ||
| return false // technically correct, I suppose | ||
| } | ||
| return nip.IsLoopback() || nip.IsUnspecified() | ||
| } | ||
89 changes: 70 additions & 19 deletionsagent/agentcontainers/containers_internal_test.go
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
51 changes: 51 additions & 0 deletionsagent/agentcontainers/testdata/container_sameportdiffip/docker_inspect.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| [ | ||
| { | ||
| "Id": "a", | ||
| "Created": "2025-03-11T17:56:34.842164541Z", | ||
| "State": { | ||
| "Running": true, | ||
| "ExitCode": 0, | ||
| "Error": "" | ||
| }, | ||
| "Name": "/a", | ||
| "Mounts": [], | ||
| "Config": { | ||
| "Image": "debian:bookworm", | ||
| "Labels": {} | ||
| }, | ||
| "NetworkSettings": { | ||
| "Ports": { | ||
| "8001/tcp": [ | ||
| { | ||
| "HostIp": "0.0.0.0", | ||
| "HostPort": "8000" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "Id": "b", | ||
| "Created": "2025-03-11T17:56:34.842164541Z", | ||
| "State": { | ||
| "Running": true, | ||
| "ExitCode": 0, | ||
| "Error": "" | ||
| }, | ||
| "Name": "/b", | ||
| "Config": { | ||
| "Image": "debian:bookworm", | ||
| "Labels": {} | ||
| }, | ||
| "NetworkSettings": { | ||
| "Ports": { | ||
| "8001/tcp": [ | ||
| { | ||
| "HostIp": "::", | ||
| "HostPort": "8000" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ] |
23 changes: 22 additions & 1 deletioncoderd/apidoc/docs.go
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.