Add a client for Podman

packages/vscode-container-client/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.0 - 10 February 2025
+### Added
+* Added a client for Podman. [#221](https://github.com/microsoft/vscode-docker-extensibility/issues/221)
+
+### Changed
+* Some properties on certain objects have become optional, due to Podman not containing them. For example, network ID on network listing is not present on Podman v3.
+
 ## 0.1.2 - 1 August 2024
 ### Fixed
 * Listing files fails due to new Bash behavior. [#231](https://github.com/microsoft/vscode-docker-extensibility/issues/231)

packages/vscode-container-client/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-container-client",
     "author": "Microsoft Corporation",
-    "version": "0.1.2",
+    "version": "0.2.0",
     "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/src/clients/DockerClient/DockerClient.ts

@@ -48,7 +48,7 @@ export class DockerClient extends DockerClientBase implements IContainersClient
     private getListContextsCommandArgs(options: ListContextsCommandOptions): CommandLineArgs {
         return composeArgs(
             withArg('context', 'ls'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
@@ -156,7 +156,7 @@ export class DockerClient extends DockerClientBase implements IContainersClient
     private getInspectContextsCommandArgs(options: InspectContextsCommandOptions): CommandLineArgs {
         return composeArgs(
             withArg('context', 'inspect'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
             withArg(...options.contexts),
         )();
     }

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

@@ -132,14 +132,19 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
      */
     public readonly defaultTag: string = 'latest';
 
+    /**
+     * The default argument given to `--format`
+     */
+    protected readonly defaultFormatForJson: string = "{{json .}}";
+
     //#region Information Commands
 
     protected getInfoCommandArgs(
         options: InfoCommandOptions,
     ): CommandLineArgs {
         return composeArgs(
             withArg('info'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
@@ -173,7 +178,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
     protected getVersionCommandArgs(options: VersionCommandOptions): CommandLineArgs {
         return composeArgs(
             withArg('version'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
@@ -243,7 +248,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withDockerLabelFilterArgs(options.labels),
             withDockerFilterArg(options.types?.map((type) => `type=${type}`)),
             withDockerFilterArg(options.events?.map((event) => `event=${event}`)),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
@@ -391,7 +396,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withDockerFilterArg(options.references?.map((reference) => `reference=${reference}`)),
             withDockerLabelFilterArgs(options.labels),
             withDockerNoTruncArg,
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
@@ -462,7 +467,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
 
     protected getRemoveImagesCommandArgs(options: RemoveImagesCommandOptions): CommandLineArgs {
         return composeArgs(
-            withArg('image', 'remove'),
+            withArg('image', 'rm'), // Docker supports both `remove` and `rm`, but Podman supports only `rm`
             withFlagArg('--force', options.force),
             withArg(...options.imageRefs),
         )();
@@ -602,7 +607,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
     ): CommandLineArgs {
         return composeArgs(
             withArg('image', 'inspect'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
             withArg(...options.imageRefs),
         )();
     }
@@ -770,7 +775,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withDockerFilterArg(options.volumes?.map((volume) => `volume=${volume}`)),
             withDockerFilterArg(options.networks?.map((network) => `network=${network}`)),
             withDockerNoTruncArg,
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
             withDockerIgnoreSizeArg,
         )();
     }
@@ -1046,7 +1051,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
     ): CommandLineArgs {
         return composeArgs(
             withArg('container', 'inspect'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
             withArg(...options.containers)
         )();
     }
@@ -1117,7 +1122,6 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withArg('volume', 'create'),
             withNamedArg('--driver', options.driver),
             withArg(options.name),
-            withDockerJsonFormatArg,
         )();
     }
 
@@ -1138,11 +1142,11 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withDockerBooleanFilterArg('dangling', options.dangling),
             withDockerFilterArg(options.driver ? `driver=${options.driver}` : undefined),
             withDockerLabelFilterArgs(options.labels),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
-    protected async parseListVolumesCommandOputput(
+    protected async parseListVolumesCommandOutput(
         options: ListVolumesCommandOptions,
         output: string,
         strict: boolean,
@@ -1198,7 +1202,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
         return {
             command: this.commandName,
             args: this.getListVolumesCommandArgs(options),
-            parse: (output, strict) => this.parseListVolumesCommandOputput(options, output, strict),
+            parse: (output, strict) => this.parseListVolumesCommandOutput(options, output, strict),
         };
     }
 
@@ -1292,7 +1296,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
     ): CommandLineArgs {
         return composeArgs(
             withArg('volume', 'inspect'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
             withArg(...options.volumes),
         )();
     }
@@ -1375,7 +1379,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
             withArg('network', 'ls'),
             withDockerLabelFilterArgs(options.labels),
             withDockerNoTruncArg,
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
         )();
     }
 
@@ -1495,7 +1499,7 @@ export abstract class DockerClientBase extends ConfigurableClient implements ICo
     ): CommandLineArgs {
         return composeArgs(
             withArg('network', 'inspect'),
-            withDockerJsonFormatArg,
+            withDockerJsonFormatArg(this.defaultFormatForJson),
             withArg(...options.networks),
         )();
     }

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

@@ -5,4 +5,6 @@
 
 import { withNamedArg } from '../../utils/commandLineBuilder';
 
-export const withDockerJsonFormatArg = withNamedArg('--format', '{{json .}}');
+export function withDockerJsonFormatArg(jsonFormat: string = '{{json .}}') {
+    return withNamedArg('--format', jsonFormat);
+}