feat: image checker extension API (podman-desktop#4662)

* feat: add image checker to api Signed-off-by: Philippe Martin <[email protected]> * feat: image checker api implementation Signed-off-by: Philippe Martin <[email protected]> * feat: image checker extension Signed-off-by: Philippe Martin <[email protected]> * feat: use image checker in UI Signed-off-by: Philippe Martin <[email protected]> * test: fix unit tests Signed-off-by: Philippe Martin <[email protected]> * refactor: move id initialization to internal Signed-off-by: Philippe Martin <[email protected]> * refactor: remove categories Signed-off-by: Philippe Martin <[email protected]> * refactor: move label to metadata Signed-off-by: Philippe Martin <[email protected]> * refactor: use ProviderResult Signed-off-by: Philippe Martin <[email protected]> * Apply suggestions from code review Co-authored-by: Florent BENOIT <[email protected]> Signed-off-by: Philippe Martin <[email protected]> * refactor: use async + fix return type Signed-off-by: Philippe Martin <[email protected]> * refactor: remove extension sample implementation Signed-off-by: Philippe Martin <[email protected]> * refactor: revert UI changes Signed-off-by: Philippe Martin <[email protected]> * feat: implement cancellation Signed-off-by: Philippe Martin <[email protected]> * test: unit tests Signed-off-by: Philippe Martin <[email protected]> --------- Signed-off-by: Philippe Martin <[email protected]> Co-authored-by: Florent BENOIT <[email protected]>
feloy · Nov 17, 2023 · bdcaff1 · bdcaff1
1 parent 83630c2
commit bdcaff1
Show file tree

Hide file tree

Showing 10 changed files with 447 additions and 0 deletions.
diff --git a/packages/extension-api/src/extension-api.d.ts b/packages/extension-api/src/extension-api.d.ts
@@ -136,6 +136,35 @@ declare module '@podman-desktop/api' {
     readonly storagePath: string;
   }
 
+  /**
+   * A provider result represents the values a provider, like the {@linkcode ImageCheckerProvider},
+   * may return. For once this is the actual result type `T`, like `ImageChecks`, or a Promise that resolves
+   * to that type `T`. In addition, `null` and `undefined` can be returned - either directly or from a
+   * Promise.
+   *
+   * The snippets below are all valid implementations of the {@linkcode ImageCheckerProvider}:
+   *
+   * ```ts
+   * let a: ImageCheckerProvider = {
+   *  check(image: ImageInfo, token?: CancellationToken): ProviderResult<ImageChecks> {
+   *    return new ImageChecks();
+   *  }
+   *
+   * let b: ImageCheckerProvider = {
+   *  async check(image: ImageInfo, token?: CancellationToken): ProviderResult<ImageChecks> {
+   * 		return new ImageChecks();
+   * 	}
+   * }
+   *
+   * let c: ImageCheckerProvider = {
+   *  check(image: ImageInfo, token?: CancellationToken): ProviderResult<ImageChecks> {
+   * 		return; // undefined
+   * 	}
+   * }
+   * ```
+   */
+  export type ProviderResult<T> = T | undefined | Promise<T | undefined>;
+
   export type ProviderStatus =
     | 'not-installed'
     | 'installed'
@@ -2488,4 +2517,30 @@ declare module '@podman-desktop/api' {
      */
     export function createCliTool(options: CliToolOptions): CliTool;
   }
+
+  export interface ImageCheck {
+    name: string;
+    status: 'success' | 'failed';
+    severity?: 'low' | 'medium' | 'high' | 'critical';
+    markdownDescription?: string;
+  }
+
+  export interface ImageChecks {
+    checks: ImageCheck[];
+  }
+
+  export interface ImageCheckerProvider {
+    check(image: ImageInfo, token?: CancellationToken): ProviderResult<ImageChecks>;
+  }
+
+  export interface ImageCheckerProviderMetadata {
+    readonly label: string;
+  }
+
+  export namespace imageChecker {
+    export function registerImageCheckerProvider(
+      imageCheckerProvider: ImageCheckerProvider,
+      metadata?: ImageCheckerProviderMetadata,
+    ): Disposable;
+  }
 }
diff --git a/packages/main/src/plugin/api/image-checker-info.ts b/packages/main/src/plugin/api/image-checker-info.ts
@@ -0,0 +1,9 @@
+export type ImageCheckerExtensionInfo = {
+  id: string;
+  label: string;
+};
+
+export interface ImageCheckerInfo {
+  id: string;
+  label: string;
+}
diff --git a/packages/main/src/plugin/authentication.spec.ts b/packages/main/src/plugin/authentication.spec.ts
@@ -55,6 +55,7 @@ import type { Exec } from './util/exec.js';
 import type { KubeGeneratorRegistry } from '/@/plugin/kube-generator-registry.js';
 import type { CliToolRegistry } from './cli-tool-registry.js';
 import type { NotificationRegistry } from './notification-registry.js';
+import type { ImageCheckerImpl } from './image-checker.js';
 
 vi.mock('../util.js', async () => {
   return {
@@ -276,6 +277,7 @@ suite('Authentication', () => {
       vi.fn() as unknown as KubeGeneratorRegistry,
       vi.fn() as unknown as CliToolRegistry,
       vi.fn() as unknown as NotificationRegistry,
+      vi.fn() as unknown as ImageCheckerImpl,
     );
     providerMock = {
       onDidChangeSessions: vi.fn(),

diff --git a/packages/main/src/plugin/cli-tool-registry.spec.ts b/packages/main/src/plugin/cli-tool-registry.spec.ts
@@ -47,6 +47,7 @@ import type { Proxy } from './proxy.js';
 import { afterEach } from 'node:test';
 import type { CliToolOptions } from '@podman-desktop/api';
 import type { NotificationRegistry } from './notification-registry.js';
+import type { ImageCheckerImpl } from './image-checker.js';
 
 const apiSender: ApiSenderType = {
   send: vi.fn(),
@@ -92,6 +93,7 @@ suite('cli module', () => {
       vi.fn() as unknown as KubeGeneratorRegistry,
       cliToolRegistry,
       vi.fn() as unknown as NotificationRegistry,
+      vi.fn() as unknown as ImageCheckerImpl,
     );
   });
 

diff --git a/packages/main/src/plugin/extension-loader.spec.ts b/packages/main/src/plugin/extension-loader.spec.ts
@@ -51,6 +51,7 @@ import { Exec } from './util/exec.js';
 import type { KubeGeneratorRegistry } from '/@/plugin/kube-generator-registry.js';
 import type { CliToolRegistry } from './cli-tool-registry.js';
 import type { NotificationRegistry } from './notification-registry.js';
+import type { ImageCheckerImpl } from './image-checker.js';
 
 class TestExtensionLoader extends ExtensionLoader {
   public async setupScanningDirectory(): Promise<void> {
@@ -150,6 +151,8 @@ const exec = new Exec(proxy);
 
 const notificationRegistry: NotificationRegistry = {} as unknown as NotificationRegistry;
 
+const imageCheckerImpl: ImageCheckerImpl = {} as unknown as ImageCheckerImpl;
+
 /* eslint-disable @typescript-eslint/no-empty-function */
 beforeAll(() => {
   extensionLoader = new TestExtensionLoader(
@@ -180,6 +183,7 @@ beforeAll(() => {
     kubernetesGeneratorRegistry,
     cliToolRegistry,
     notificationRegistry,
+    imageCheckerImpl,
   );
 });
 

diff --git a/packages/main/src/plugin/extension-loader.ts b/packages/main/src/plugin/extension-loader.ts
@@ -68,6 +68,7 @@ import { ExtensionLoaderSettings } from './extension-loader-settings.js';
 import type { KubeGeneratorRegistry, KubernetesGeneratorProvider } from '/@/plugin/kube-generator-registry.js';
 import type { CliToolRegistry } from './cli-tool-registry.js';
 import type { NotificationRegistry } from './notification-registry.js';
+import type { ImageCheckerImpl } from './image-checker.js';
 
 /**
  * Handle the loading of an extension
@@ -158,6 +159,7 @@ export class ExtensionLoader {
     private kubeGeneratorRegistry: KubeGeneratorRegistry,
     private cliToolRegistry: CliToolRegistry,
     private notificationRegistry: NotificationRegistry,
+    private imageCheckerProvider: ImageCheckerImpl,
   ) {
     this.pluginsDirectory = directories.getPluginsDirectory();
     this.pluginsScanDirectory = directories.getPluginsScanDirectory();
@@ -1036,6 +1038,17 @@ export class ExtensionLoader {
       },
     };
 
+    const imageCheckerProvider = this.imageCheckerProvider;
+    console.log('imageCheckerProvider', this.imageCheckerProvider);
+    const imageChecker: typeof containerDesktopAPI.imageChecker = {
+      registerImageCheckerProvider: (
+        provider: containerDesktopAPI.ImageCheckerProvider,
+        metadata?: containerDesktopAPI.ImageCheckerProviderMetadata,
+      ): containerDesktopAPI.Disposable => {
+        return imageCheckerProvider.registerImageCheckerProvider(extensionInfo, provider, metadata);
+      },
+    };
+
     return <typeof containerDesktopAPI>{
       // Types
       Disposable: Disposable,
@@ -1064,6 +1077,7 @@ export class ExtensionLoader {
       authentication,
       context: contextAPI,
       cli,
+      imageChecker,
     };
   }