Merge branch 'main' into bmw/zod

Author: bwateratmsft

README.md

@@ -1,8 +1,8 @@
-## Extensibility Packages for Docker extension for VS Code
-This repository contains several extensibility packages for the Docker extension for VS Code.
+## Extensibility Packages for Container Tools extension for VS Code
+This repository contains several extensibility packages for the Container Tools extension for VS Code.
 
 ### [vscode-container-client](https://github.com/microsoft/vscode-docker-extensibility/tree/main/packages/vscode-container-client)
-Library support for multiple Docker container runtimes.
+Library support for multiple container runtimes.
 
 ### [vscode-docker-registries](https://github.com/microsoft/vscode-docker-extensibility/tree/main/packages/vscode-docker-registries)
 Unified container registry provider model.

package-lock.json

@@ -1,3 +1,11 @@
+## 0.2.2 - 3 June 2025
+### Added
+* Added support for the `--platform` argument in `runContainer()`. [#258](https://github.com/microsoft/vscode-docker-extensibility/issues/258)
+
+## 0.2.1 - 11 March 2025
+### Added
+* Added the container stats command. This would previously always throw a `CommandNotSupportedError`. However, the typing has changed to a `VoidCommandResponse`. [#254](https://github.com/microsoft/vscode-docker-extensibility/issues/254)
+
 ## 0.2.0 - 10 February 2025
 ### Added
 * Added a client for Podman. [#221](https://github.com/microsoft/vscode-docker-extensibility/issues/221)

packages/vscode-container-client/CHANGELOG.md

@@ -1,7 +1,7 @@
 # vscode-container-client
 
 ## Overview
-This package adds support for various Docker container runtimes, abstracting away the details of the runtime and the way it is called, to provide a common interface for any Docker runtime (e.g. Docker in WSL, Docker Engine, Docker Desktop, etc.).
+This package adds support for various container runtimes, abstracting away the details of the runtime and the way it is called, to provide a common interface for any container runtime (e.g. Docker in WSL, Docker Engine, Docker Desktop, Podman, etc.).
 
 ## Usage
 Each of the runtime clients provide a command line to execute and a function to parse the output, for each relevant operation. These items are combined into a `CommandResponse` object. In addition, many helpful utility classes are provided, for building command lines, running the commands, and a handful of other scenarios.

packages/vscode-container-client/NOTICE.html

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-container-client",
     "author": "Microsoft Corporation",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "description": "Extensibility model for implementing container runtime providers (shared by VS and VS Code)",
     "license": "See LICENSE in the project root for license information.",
     "repository": {

packages/vscode-container-client/README.md

@@ -677,6 +677,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withNamedArg('--env-file', options.environmentFiles),
             withNamedArg('--entrypoint', options.entrypoint),
             withDockerExposePortsArg(options.exposePorts),
+            withDockerPlatformArg(options.platform),
             withVerbatimArg(options.customOptions),
             withArg(options.imageRef),
             typeof options.command === 'string' ? withVerbatimArg(options.command) : withArg(...(toArray(options.command || []))),
@@ -963,16 +964,11 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
         )();
     }
 
-    protected async parseStatsContainersCommandArgs(
-        options: ContainersStatsCommandOptions,
-        output: string,
-        strict: boolean,
-    ): Promise<string> {
-        return output;
-    }
-
-    async statsContainers(options: ContainersStatsCommandOptions): Promise<PromiseCommandResponse<string>> {
-        throw new CommandNotSupportedError('statsContainers is not supported for this runtime');
+    async statsContainers(options: ContainersStatsCommandOptions): Promise<VoidCommandResponse> {
+        return {
+            command: this.commandName,
+            args: this.getStatsContainersCommandArgs(options),
+        };
     }
 
     //#endregion

packages/vscode-container-client/package.json

@@ -722,6 +722,10 @@ export type RunContainerCommandOptions = CommonCommandOptions & {
      * Optional expose ports for the container
      */
     exposePorts?: Array<number>;
+    /**
+     * Target platform for the container
+     */
+    platform?: ContainerPlatform;
     /**
      * Additional custom options to pass
      */
@@ -1172,7 +1176,7 @@ type ContainersStatsCommand = {
      * Show running container stats
      * @param options Command options
      */
-    statsContainers(options: ContainersStatsCommandOptions): Promise<PromiseCommandResponse<string>>;
+    statsContainers(options: ContainersStatsCommandOptions): Promise<VoidCommandResponse>;
 };
 
 // #endregion

packages/vscode-container-client/src/clients/DockerClientBase/DockerClientBase.ts

@@ -197,4 +197,33 @@ describe('DockerClient (unit)', () => {
         expect(pwshQuoted).to.deep.equal(['container', 'run', 'someimage', 'sh', '-c', 'echo` hello` world']);
         expect(bashQuoted).to.deep.equal(['container', 'run', 'someimage', 'sh', '-c', 'echo\\ hello\\ world']);
     });
+
+    it('Should include platform flag when platform is specified', async () => {
+        const options: RunContainerCommandOptions = {
+            imageRef: 'someimage',
+            platform: {
+                os: 'linux',
+                architecture: 'arm64'
+            },
+        };
+
+        const commandResponse = await client.runContainer(options);
+        const args = commandResponse.args;
+
+        // Find the position of --platform flag
+        const platformFlagIndex = args.findIndex(arg => 
+            typeof arg === 'string' ? arg === '--platform' : arg.value === '--platform'
+        );
+        
+        // Verify that --platform flag is present
+        expect(platformFlagIndex).to.be.greaterThan(-1);
+        
+        // Verify that the value after --platform matches our expected platform
+        const platformValue = args[platformFlagIndex + 1];
+        const platformValueStr = typeof platformValue === 'string' 
+            ? platformValue 
+            : platformValue.value;
+        
+        expect(platformValueStr).to.equal('linux/arm64');
+    });
 });

packages/vscode-container-client/src/contracts/ContainerClient.ts

@@ -1,9 +1,9 @@
-# Docker for Visual Studio Code: Extensibility Model
+# Container Tools for Visual Studio Code: Extensibility Model
 
 ## Overview
-This package provides the necessary interfaces to implement a registry provider for the [Docker extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) for Visual Studio Code. Additionally, it also contains an implementation of a registry provider for the common [Docker Registry HTTP API V2](https://docs.docker.com/registry/spec/api/). Most implementations will be a fairly slim inheriting implementation of this.
+This package provides the necessary interfaces to implement a registry provider for the [Container Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) for Visual Studio Code. Additionally, it also contains an implementation of a registry provider for the common [Docker Registry HTTP API V2](https://docs.docker.com/registry/spec/api/). Most implementations will be a fairly slim inheriting implementation of this.
 
-In order to implement a provider, you must create a VS Code extension which will activate when the Docker explorer view is opened, and register itself with the Docker extension. The Docker extension will call into your provider to discover what nodes to show in the explorer view.
+In order to implement a provider, you must create a VS Code extension which will activate when the Container Explorer view is opened, and register itself with the Container Tools extension. The Container Tools extension will call into your provider to discover what nodes to show in the explorer view.
 
 ## When to implement a registry provider extension
 You should implement a registry provider extension if:
@@ -18,9 +18,9 @@ You should _not_ implement a registry provider extension if:
 
 ## How to implement a registry provider extension
 1. Create a new VS Code extension. [Learn more](https://code.visualstudio.com/api/get-started/your-first-extension)
-1. Add the following activation event to your extension's package.json: `onCommand:vscode-docker.activateRegistryProviders`. [Learn more](https://code.visualstudio.com/api/references/activation-events)
+1. Add the following activation event to your extension's package.json: `onCommand:vscode-containers.activateRegistryProviders`. [Learn more](https://code.visualstudio.com/api/references/activation-events)
 1. Implement the [`RegistryDataProvider`](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/contracts/RegistryDataProvider.ts) interface. The easiest way to do this is to extend either [`CommonRegistryDataProvider`](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/clients/Common/CommonRegistryDataProvider.ts) or, if your registry is compliant to the V2 registry spec, [`RegistryV2DataProvider`](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/clients/RegistryV2/RegistryV2DataProvider.ts).
-1. In your extension's `activate()` method, call into the Docker extension to register your provider. [Learn more](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/contracts/DockerExtension.ts)
+1. In your extension's `activate()` method, call into the Container Tools extension to register your provider. [Learn more](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/contracts/DockerExtension.ts)
 
 ## License
 [MIT](LICENSE)