Add port mappings to container list output by beena352 · Pull Request #14438 · microsoft/WSL

beena352 · 2026-03-16T06:01:00Z

Summary of the Pull Request

Add port mappings to container list output. When containers are created with -p, the PORTS column in container list now displays the mapped ports.

PR Checklist

Closes: Link to issue #xxx
Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
[x ] Tests: Added/updated if needed and all pass
Localization: All end user facing strings can be localized
Dev docs: Added/updated if needed
Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

Added Ports and PortsCount fields to WSLAContainerEntry in the IDL
Added WSLAPortProtocol enum (TCP/UDP) and Protocol field to WSLAPortMapping in the IDL
Populated port data in ListContainers on the service side
Added PortInformation struct and FormatPorts() on the CLI side
Added PORTS column to container list table output
Wired up -p/--publish argument to pass ports during container creation via AddPort()
Updated SDK to pass Protocol field

Validation Steps Performed

Ran PortMappingsNat test — verified ListContainers returns correct HostPort, ContainerPort, and Family for both AF_INET and AF_INET6 mappings, across Bridged and Host network modes

Copilot

Pull request overview

This PR adds port mapping information to the container list output. When containers are created with -p/--publish, the mapped ports now appear in a new PORTS column in the table view and in JSON output.

Changes:

Extended the IDL with WSLAPortProtocol enum and added Ports/PortsCount fields to WSLAContainerEntry, plus Protocol to WSLAPortMapping
Added CLI-side port parsing from --publish args, FormatPorts() formatting, and PortInformation/PortOption model structs
Populated port data in ListContainers on the service side and added cleanup handling for the nested COM-allocated ports array

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/windows/wslaservice/inc/wslaservice.idl	Added `WSLAPortProtocol` enum, `Protocol` to `WSLAPortMapping`, `Ports`/`PortsCount` to `WSLAContainerEntry`
src/windows/wslasession/WSLASession.cpp	Populate port data in `ListContainers` with error cleanup scope guard
src/windows/wslasession/WSLAContainer.h	Declared `GetPorts()` accessor
src/windows/wslasession/WSLAContainer.cpp	Implemented `GetPorts()` returning `m_mappedPorts`
src/windows/common/WSLAContainerLauncher.cpp	Set `Protocol` field in `AddPort()`
src/windows/WslcSDK/wslcsdk.cpp	Pass `Protocol` field through SDK
src/windows/wslc/services/ContainerModel.h	Added `PortOption`, `PortInformation` structs with JSON serialization
src/windows/wslc/services/ContainerService.h	Declared `FormatPorts()`
src/windows/wslc/services/ContainerService.cpp	Implemented `FormatPorts()`, extract ports in `List()`, pass ports in `CreateInternal()`
src/windows/wslc/tasks/ContainerTasks.cpp	Parse `--publish` args, add PORTS column to table output
test/windows/WSLATests.cpp	Added port mapping assertions to `PortMappingsNat` test and zero-port checks to existing tests

You can also share your feedback on Copilot code review. Take the survey.

src/windows/wslc/tasks/ContainerTasks.cpp

src/windows/wslc/services/ContainerService.cpp

test/windows/WSLATests.cpp

Copilot

Pull request overview

This PR adds port mapping information to the container list output. When containers are created with -p, the PORTS column now displays mapped ports in the format host:port->container_port/protocol. The changes span the IDL, service, CLI, SDK, and test layers.

Changes:

Extended WSLAContainerEntry and WSLAPortMapping IDL structs with Ports/PortsCount and Protocol fields; added WSLAPortProtocol enum.
Wired port data through the service (ListContainers), CLI (FormatPorts, -p argument parsing via AddPort), and SDK layers.
Added test verification that ListContainers returns correct port data for containers created with port mappings.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/windows/wslaservice/inc/wslaservice.idl	Added `WSLAPortProtocol` enum, `Protocol` to `WSLAPortMapping`, and `Ports`/`PortsCount` to `WSLAContainerEntry`.
src/windows/wslasession/WSLASession.cpp	Populates port data in `ListContainers` with error-cleanup scope guard.
src/windows/wslasession/WSLAContainer.h	Declares `GetPorts()` accessor.
src/windows/wslasession/WSLAContainer.cpp	Implements `GetPorts()` returning `m_mappedPorts`.
src/windows/common/WSLAContainerLauncher.cpp	Sets `Protocol = WSLAPortProtocolTCP` in `AddPort`.
src/windows/WslcSDK/wslcsdk.cpp	Passes `Protocol` field when converting SDK port mappings to IDL.
src/windows/wslc/services/ContainerModel.h	Adds `PortOption`, `PortInformation` structs and `Ports` to `ContainerOptions`/`ContainerInformation`.
src/windows/wslc/services/ContainerService.h	Declares `FormatPorts()`.
src/windows/wslc/services/ContainerService.cpp	Implements `FormatPorts()`, extracts/frees port data in `List()`, wires ports through `CreateInternal`.
src/windows/wslc/tasks/ContainerTasks.cpp	Parses `-p`/`--publish`, adds `PORTS` column to table output.
test/windows/WSLATests.cpp	Adds `PortsCount` assertions and new `ListContainers` port verification block in `PortMappingsNat`.

You can also share your feedback on Copilot code review. Take the survey.

test/windows/WSLATests.cpp

src/windows/wslc/tasks/ContainerTasks.cpp

… into user/beenachauhan/container-port-mappings

Copilot

Pull request overview

Adds port mapping visibility end-to-end so wsl --container list can display published ports in a new PORTS column, backed by service-side ListContainers data.

Changes:

Extends WSLAContainerEntry (IDL) to include Ports/PortsCount and populates that data in WSLASession::ListContainers.
Propagates ports through the CLI model and adds formatting + a PORTS column to table output.
Updates/extends WSLA tests to validate port mappings are returned by ListContainers.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
test/windows/WSLATests.cpp	Adds assertions for `PortsCount` and validates port mapping data returned by `ListContainers`.
src/windows/wslc/tasks/ContainerTasks.cpp	Adds `PORTS` column to `container list` table output.
src/windows/wslc/services/ContainerService.h	Declares `FormatPorts()` helper for CLI display.
src/windows/wslc/services/ContainerService.cpp	Implements `FormatPorts()` and extracts/frees port mappings returned from `ListContainers`.
src/windows/wslc/services/ContainerModel.h	Adds `PortInformation` to the CLI model and includes it in JSON serialization.
src/windows/wslasession/WSLASession.cpp	Allocates and returns port mapping arrays per container in `ListContainers`, with cleanup on error.
src/windows/wslasession/WSLAContainer.h	Exposes `GetPorts()` accessor on container implementation.
src/windows/wslasession/WSLAContainer.cpp	Implements `GetPorts()` accessor.
src/windows/service/inc/wslaservice.idl	Extends `WSLAContainerEntry` with `Ports` and `PortsCount`.

src/windows/wslc/services/ContainerModel.h

test/windows/WSLATests.cpp

src/windows/wslasession/WSLASession.cpp

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

src/windows/wslc/services/ContainerService.cpp

src/windows/wslc/services/ContainerModel.h

src/windows/wslc/services/ContainerService.cpp

src/windows/wslc/services/ContainerModel.h

src/windows/wslc/services/ContainerService.cpp

… into user/beenachauhan/container-port-mappings

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

src/windows/service/inc/wslaservice.idl

src/windows/wslasession/WSLAContainer.cpp

src/windows/wslc/services/ContainerService.cpp

src/windows/wslasession/WSLASession.cpp

test/windows/WSLATests.cpp

…port-mappings

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

src/windows/wslasession/WSLAContainer.h

src/windows/wslasession/WSLASession.cpp

src/windows/wslc/services/ContainerService.cpp

src/windows/service/inc/wslaservice.idl

…port-mappings

…ations

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

src/windows/wslc/services/ContainerModel.h

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 5 comments.

Copilot · 2026-03-25T21:20:04Z

test/windows/WSLATests.cpp

+                VERIFY_ARE_EQUAL(2, containerPorts.size());
+                VERIFY_ARE_EQUAL(1234, containerPorts[0].HostPort);
+                VERIFY_ARE_EQUAL(8000, containerPorts[0].ContainerPort);
+                VERIFY_ARE_EQUAL(AF_INET, containerPorts[0].Family);
+                VERIFY_ARE_EQUAL(1234, containerPorts[1].HostPort);
+                VERIFY_ARE_EQUAL(8000, containerPorts[1].ContainerPort);
+                VERIFY_ARE_EQUAL(AF_INET6, containerPorts[1].Family);


This new assertion block assumes the port mappings are returned in a stable order (containerPorts[0] is AF_INET and [1] is AF_INET6). Since ListContainers builds allPorts by iterating internal vectors, the ordering may not be guaranteed and could lead to flaky tests. Please match port mappings by key (e.g., find entries by Family/HostPort/ContainerPort/Protocol) or sort the results before indexing.

Copilot · 2026-03-25T21:20:04Z

src/windows/WslcSDK/wslcsdk.cpp

            // TODO: Consider using standard protocol numbers instead of our own enum.
            convertedPort.Protocol = internalPort.protocol == WSLC_PORT_PROTOCOL_TCP ? IPPROTO_TCP : IPPROTO_UDP;
-            convertedPort.BindingAddress = "127.0.0.1";
+            strcpy_s(convertedPort.BindingAddress, "127.0.0.1");


strcpy_s returns an error code that is ignored here. Even though the source literal is currently small enough, it’s safer/consistent with other updates in this PR to check the return value (or use a helper that throws on failure) so unexpected future changes (e.g., different default address) don’t silently truncate or fail.

Suggested change

strcpy_s(convertedPort.BindingAddress, "127.0.0.1");

errno_t copyResult = strcpy_s(convertedPort.BindingAddress, "127.0.0.1");

if (copyResult != 0)

{

return HRESULT_FROM_WIN32(copyResult);

}

Copilot · 2026-03-25T21:20:05Z

src/windows/service/inc/wslaservice.idl

 typedef struct _WSLAContainerEntry
 {
    char Name[WSLA_MAX_CONTAINER_NAME_LENGTH + 1];
    char Image[WSLA_MAX_IMAGE_NAME_LENGTH + 1];
    WSLAContainerId Id;
    ULONGLONG StateChangedAt;
    ULONGLONG CreatedAt;
    WSLAContainerState State;
 } WSLAContainerEntry;

+typedef struct _WSLAContainerPortMapping
+{
+    WSLAContainerId Id;
+    WSLAPortMapping PortMapping;
+} WSLAContainerPortMapping;


PR description says ports were added as fields on WSLAContainerEntry and that a WSLAPortProtocol enum was added in the IDL. In the actual IDL change, WSLAContainerEntry is unchanged and a separate WSLAContainerPortMapping array is introduced, and the protocol is still an int. Please update the PR description to match the implemented contract (or adjust the IDL to match the stated design) to avoid confusion for SDK/service consumers.

src/windows/service/inc/wslaservice.idl

Copilot · 2026-03-25T21:20:05Z

src/windows/wslasession/WSLASession.cpp


    *Count = 0;
    *Containers = nullptr;
+    *Ports = nullptr;
+    *PortsCount = 0;


WSLASession::ListContainers dereferences all four out-parameters unconditionally (*Count = 0, etc.). Other methods in this file use THROW_HR_IF(E_POINTER, ...) / THROW_HR_IF_NULL to validate pointers before dereferencing. Please add E_POINTER validation for Containers, Count, Ports, and PortsCount up front so a bad caller doesn’t AV the COM server process.

Add port mappings to container list output

aac55ae

Copilot AI review requested due to automatic review settings March 16, 2026 06:01

Copilot started reviewing on behalf of beena352 March 16, 2026 06:01 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

src/windows/wslc/tasks/ContainerTasks.cpp Outdated Show resolved Hide resolved

src/windows/wslc/services/ContainerService.cpp Outdated Show resolved Hide resolved

test/windows/WSLATests.cpp Outdated Show resolved Hide resolved

Fix port validation and add Protocol field test

8f9e2f3

beena352 marked this pull request as ready for review March 16, 2026 22:20

beena352 requested a review from a team as a code owner March 16, 2026 22:20

Copilot AI review requested due to automatic review settings March 16, 2026 22:20

Copilot started reviewing on behalf of beena352 March 16, 2026 22:22 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

test/windows/WSLATests.cpp Show resolved Hide resolved

AmelBawa-msft reviewed Mar 16, 2026

View reviewed changes

src/windows/wslc/tasks/ContainerTasks.cpp Outdated Show resolved Hide resolved

Add scope_exit cleanup for nested port memory in test

1c3c77f

beena352 marked this pull request as draft March 18, 2026 17:40

beena352 added 2 commits March 22, 2026 14:57

Merge branch 'feature/wsl-for-apps' of https://github.com/microsoft/WSL…

0a24110

… into user/beenachauhan/container-port-mappings

Resolve merge conflicts

fd8a3ff

Copilot AI review requested due to automatic review settings March 23, 2026 16:24

Copilot started reviewing on behalf of beena352 March 23, 2026 16:24 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

Apply copilot feedback

f6a5ab1

beena352 marked this pull request as ready for review March 23, 2026 17:00

Copilot AI review requested due to automatic review settings March 23, 2026 17:00

Copilot started reviewing on behalf of beena352 March 23, 2026 17:01 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

src/windows/wslc/services/ContainerService.cpp Outdated Show resolved Hide resolved

src/windows/wslc/services/ContainerService.cpp Outdated Show resolved Hide resolved

src/windows/wslc/services/ContainerModel.h Outdated Show resolved Hide resolved

dkbennett reviewed Mar 23, 2026

View reviewed changes

src/windows/wslc/services/ContainerService.cpp Outdated Show resolved Hide resolved

Apply PR feedback

a053a1f

AmelBawa-msft reviewed Mar 24, 2026

View reviewed changes

src/windows/wslc/services/ContainerModel.h Show resolved Hide resolved

src/windows/wslc/services/ContainerService.cpp Outdated Show resolved Hide resolved

Merge branch 'feature/wsl-for-apps' of https://github.com/microsoft/WSL…

e9a4fce

… into user/beenachauhan/container-port-mappings

Copilot AI review requested due to automatic review settings March 24, 2026 17:55

Copilot started reviewing on behalf of beena352 March 24, 2026 18:00 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

beena352 added 3 commits March 24, 2026 11:11

Remove Family field from PortInformation

3119329

Only show port mappings for running containers

6bbbc98

Merge branch 'feature/wsl-for-apps' into user/beenachauhan/container-…

dc991ae

…port-mappings

Copilot AI review requested due to automatic review settings March 24, 2026 21:28

Copilot started reviewing on behalf of beena352 March 24, 2026 21:29 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

src/windows/wslasession/WSLAContainer.h Show resolved Hide resolved

src/windows/wslasession/WSLASession.cpp Show resolved Hide resolved

Format

2cc1ef2

OneBlue reviewed Mar 25, 2026

View reviewed changes

src/windows/wslasession/WSLASession.cpp Outdated Show resolved Hide resolved

src/windows/wslc/services/ContainerService.cpp Outdated Show resolved Hide resolved

src/windows/service/inc/wslaservice.idl Outdated Show resolved Hide resolved

Merge branch 'feature/wsl-for-apps' into user/beenachauhan/container-…

fb45413

…port-mappings

Copilot AI review requested due to automatic review settings March 25, 2026 20:56

Copilot started reviewing on behalf of beena352 March 25, 2026 20:57 View session

Simplify port mappings in ListContainers by removing nested COM alloc…

4584d93

…ations

Copilot AI reviewed Mar 25, 2026

View reviewed changes

src/windows/wslc/services/ContainerModel.h Show resolved Hide resolved

Fix macro mismatch in ContainerInformation

d454c39

Copilot AI review requested due to automatic review settings March 25, 2026 21:13

Copilot started reviewing on behalf of beena352 March 25, 2026 21:14 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

-            strcpy_s(convertedPort.BindingAddress, "127.0.0.1");
+            errno_t copyResult = strcpy_s(convertedPort.BindingAddress, "127.0.0.1");
+            if (copyResult != 0)
+            {
+                return HRESULT_FROM_WIN32(copyResult);
+            }

Conversation

beena352 commented Mar 16, 2026

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 25, 2026