fix: add strict rule to kind and docker extensions (podman-desktop#7425)

* fix: add strict rule to kind and docker extensions

Signed-off-by: lstocchi <[email protected]>

* fix: fix test

Signed-off-by: lstocchi <[email protected]>

* fix: typecheck

Signed-off-by: lstocchi <[email protected]>

---------

Signed-off-by: lstocchi <[email protected]>

Author: lstocchi

extensions/docker/src/docker-cli.spec.ts

@@ -54,5 +54,5 @@ test('should return docker version', async () => {
   const installedDocker = await getDockerInstallation();
 
   expect(installedDocker).toBeDefined();
-  expect(installedDocker.version).toBe('25.0.2');
+  expect(installedDocker?.version).toBe('25.0.2');
 });

extensions/docker/src/docker-cli.ts

@@ -19,7 +19,7 @@ import * as extensionApi from '@podman-desktop/api';
 
 const macosExtraPath = '/usr/local/bin:/opt/homebrew/bin:/opt/local/bin';
 
-export function getInstallationPath(): string {
+export function getInstallationPath(): string | undefined {
   const env = process.env;
   if (extensionApi.env.isMac) {
     if (!env.PATH) {

extensions/docker/src/extension.ts

@@ -103,7 +103,7 @@ async function monitorDaemon(extensionContext: extensionApi.ExtensionContext): P
       if (err instanceof Error) {
         extensionApi.env.createTelemetryLogger().logError(err);
       } else {
-        extensionApi.env.createTelemetryLogger().logError(err.toString());
+        extensionApi.env.createTelemetryLogger().logError(String(err));
       }
     });
   }
@@ -173,7 +173,7 @@ export async function activate(extensionContext: extensionApi.ExtensionContext):
     if (err instanceof Error) {
       extensionApi.env.createTelemetryLogger().logError(err);
     } else {
-      extensionApi.env.createTelemetryLogger().logError(err.toString());
+      extensionApi.env.createTelemetryLogger().logError(String(err));
     }
   });
 }

extensions/docker/tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "strict": true,
     "lib": ["ES2017", "webworker"],
     "sourceMap": true,
     "rootDir": "src",

extensions/kind/src/create-cluster.spec.ts

@@ -63,18 +63,18 @@ test('expect error is cli returns non zero exit code', async () => {
   const error = { exitCode: -1, message: 'error' } as extensionApi.RunError;
   try {
     (extensionApi.process.exec as Mock).mockRejectedValue(error);
-    await createCluster({}, undefined, '', telemetryLoggerMock, undefined);
+    await createCluster({}, '', telemetryLoggerMock, undefined, undefined);
   } catch (err) {
     expect(err).to.be.a('Error');
-    expect(err.message).equal('Failed to create kind cluster. error');
+    expect((err as Error).message).equal('Failed to create kind cluster. error');
     expect(telemetryLogUsageMock).toBeCalledWith('createCluster', expect.objectContaining({ error: error }));
     expect(telemetryLogErrorMock).not.toBeCalled();
   }
 });
 
 test('expect cluster to be created', async () => {
   (extensionApi.process.exec as Mock).mockReturnValue({} as extensionApi.RunResult);
-  await createCluster({}, undefined, '', telemetryLoggerMock, undefined);
+  await createCluster({}, '', telemetryLoggerMock, undefined, undefined);
   expect(telemetryLogUsageMock).toHaveBeenNthCalledWith(
     1,
     'createCluster',
@@ -91,7 +91,7 @@ test('expect cluster to be created with ingress', async () => {
     error: vi.fn(),
     warn: vi.fn(),
   };
-  await createCluster({ 'kind.cluster.creation.ingress': 'on' }, logger, '', telemetryLoggerMock, undefined);
+  await createCluster({ 'kind.cluster.creation.ingress': 'on' }, '', telemetryLoggerMock, logger, undefined);
   expect(telemetryLogUsageMock).toHaveBeenNthCalledWith(
     1,
     'createCluster',
@@ -110,11 +110,11 @@ test('expect error if Kubernetes reports error', async () => {
       warn: vi.fn(),
     };
     (extensionApi.kubernetes.createResources as Mock).mockRejectedValue(error);
-    await createCluster({ 'kind.cluster.creation.ingress': 'on' }, logger, '', telemetryLoggerMock, undefined);
+    await createCluster({ 'kind.cluster.creation.ingress': 'on' }, '', telemetryLoggerMock, logger, undefined);
   } catch (err) {
     expect(extensionApi.kubernetes.createResources).toBeCalled();
     expect(err).to.be.a('Error');
-    expect(err.message).equal('Failed to create kind cluster. Kubernetes error');
+    expect((err as Error).message).equal('Failed to create kind cluster. Kubernetes error');
     expect(telemetryLogErrorMock).not.toBeCalled();
     expect(telemetryLogUsageMock).toBeCalledWith('createCluster', expect.objectContaining(error));
   }
@@ -129,12 +129,12 @@ test('check cluster configuration generation', async () => {
 });
 
 test('check cluster configuration empty string image', async () => {
-  const conf = getKindClusterConfig(undefined, undefined, undefined, '');
+  const conf = getKindClusterConfig('cluster', 80, 80, '');
   expect(conf).to.not.contains('image:');
 });
 
 test('check cluster configuration null string image', async () => {
-  const conf = getKindClusterConfig(undefined, undefined, undefined, undefined);
+  const conf = getKindClusterConfig('cluster', 80, 80, undefined);
   expect(conf).to.not.contains('image:');
 });
 

extensions/kind/src/create-cluster.ts

@@ -102,9 +102,9 @@ export async function connectionAuditor(provider: string, items: AuditRequestIte
 export async function createCluster(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   params: { [key: string]: any },
-  logger: extensionApi.Logger,
   kindCli: string,
   telemetryLogger: extensionApi.TelemetryLogger,
+  logger?: extensionApi.Logger,
   token?: CancellationToken,
 ): Promise<void> {
   let clusterName = 'kind';
@@ -118,7 +118,7 @@ export async function createCluster(
     provider = params['kind.cluster.creation.provider'];
   }
 
-  const env = Object.assign({}, process.env);
+  const env = Object.assign({}, process.env) as { [key: string]: string };
   // add KIND_EXPERIMENTAL_PROVIDER env variable if needed
   if (provider === 'podman') {
     env['KIND_EXPERIMENTAL_PROVIDER'] = 'podman';
@@ -158,7 +158,7 @@ export async function createCluster(
   await fs.promises.writeFile(tmpFilePath, kindClusterConfig, 'utf8');
 
   // update PATH to include kind
-  env.PATH = getKindPath();
+  env.PATH = getKindPath() ?? '';
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const telemetryOptions: Record<string, any> = {
@@ -173,15 +173,15 @@ export async function createCluster(
   try {
     await extensionApi.process.exec(kindCli, ['create', 'cluster', '--config', tmpFilePath], { env, logger, token });
     if (ingressController) {
-      logger.log('Creating ingress controller resources');
+      logger?.log('Creating ingress controller resources');
       await setupIngressController(clusterName);
     }
   } catch (error) {
     telemetryOptions.error = error;
-    let errorMessage: string;
+    let errorMessage: string = '';
 
-    if (typeof error === 'object' && 'message' in error) {
-      errorMessage = error.message.toString();
+    if (error && typeof error === 'object' && 'message' in error) {
+      errorMessage = String(error.message);
     } else if (typeof error === 'string') {
       errorMessage = error;
     }

extensions/kind/src/extension.spec.ts

@@ -22,7 +22,8 @@ import type * as extensionApi from '@podman-desktop/api';
 import * as podmanDesktopApi from '@podman-desktop/api';
 import { beforeEach, expect, test, vi } from 'vitest';
 
-import { createProvider, moveImage, refreshKindClustersOnProviderConnectionUpdate } from './extension';
+import { activate, moveImage, refreshKindClustersOnProviderConnectionUpdate } from './extension';
+import * as util from './util';
 
 vi.mock('./image-handler', async () => {
   return {
@@ -59,6 +60,11 @@ vi.mock('@podman-desktop/api', async () => {
     context: {
       setValue: vi.fn(),
     },
+    env: {
+      createTelemetryLogger: vi.fn().mockReturnValue({
+        logUsage: vi.fn(),
+      } as unknown as extensionApi.TelemetryLogger),
+    },
   };
 });
 
@@ -113,15 +119,14 @@ test('Ensuring a progress task is created when calling kind.image.move command',
   const contextSetValueMock = vi.fn();
   (podmanDesktopApi.context as any).setValue = contextSetValueMock;
 
-  await createProvider(
+  vi.spyOn(util, 'detectKind').mockResolvedValue('kind');
+
+  await activate(
     vi.mocked<extensionApi.ExtensionContext>({
       subscriptions: {
         push: vi.fn(),
       },
     } as unknown as extensionApi.ExtensionContext),
-    vi.mocked<extensionApi.TelemetryLogger>({
-      logUsage: vi.fn(),
-    } as unknown as extensionApi.TelemetryLogger),
   );
 
   // ensure the command has been registered

extensions/kind/src/extension.ts

@@ -58,8 +58,12 @@ async function registerProvider(
   const disposable = provider.setKubernetesProviderConnectionFactory(
     {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      create: (params: { [key: string]: any }, logger?: Logger, token?: CancellationToken) =>
-        createCluster(params, logger, kindCli, telemetryLogger, token),
+      create: (params: { [key: string]: any }, logger?: Logger, token?: CancellationToken) => {
+        if (kindCli) {
+          return createCluster(params, kindCli, telemetryLogger, logger, token);
+        }
+        return Promise.reject(new Error('Unable to create kind cluster. No kind cli detected'));
+      },
       creationDisplayName: 'Kind cluster',
     },
     {
@@ -160,12 +164,14 @@ async function updateClusters(
           await extensionApi.containerEngine.stopContainer(cluster.engineId, cluster.id);
         },
         delete: async (logger): Promise<void> => {
-          const env = Object.assign({}, process.env);
+          const env = Object.assign({}, process.env) as { [key: string]: string };
           if (cluster.engineType === 'podman') {
             env['KIND_EXPERIMENTAL_PROVIDER'] = 'podman';
           }
-          env.PATH = getKindPath();
-          await extensionApi.process.exec(kindCli, ['delete', 'cluster', '--name', cluster.name], { env, logger });
+          env.PATH = getKindPath() ?? '';
+          if (kindCli) {
+            await extensionApi.process.exec(kindCli, ['delete', 'cluster', '--name', cluster.name], { env, logger });
+          }
         },
       };
       // create a new connection
@@ -296,7 +302,7 @@ export async function moveImage(
   image: unknown,
 ): Promise<void> {
   // as the command receive an "any" value we check that it contains an id and an engineId as they are mandatory
-  if (!(typeof image === 'object' && 'id' in image && 'engineId' in image)) {
+  if (!(kindCli && image && typeof image === 'object' && 'id' in image && 'engineId' in image)) {
     throw new Error('Image selection not supported yet');
   }
 

extensions/kind/src/image-handler.spec.ts

@@ -54,19 +54,19 @@ beforeEach(() => {
 
 test('expect error to be raised if no image is given', async () => {
   try {
-    await imageHandler.moveImage({ engineId: 'dummy' }, [], undefined);
+    await imageHandler.moveImage({ engineId: 'dummy' }, [], 'kind');
   } catch (err) {
     expect(err).to.be.a('Error');
-    expect(err.message).equal('Image selection not supported yet');
+    expect((err as Error).message).equal('Image selection not supported yet');
   }
 });
 
 test('expect error to be raised if no clusters are given', async () => {
   try {
-    await imageHandler.moveImage({ engineId: 'dummy', name: 'myimage' }, [], undefined);
+    await imageHandler.moveImage({ engineId: 'dummy', name: 'myimage' }, [], 'kind');
   } catch (err) {
     expect(err).to.be.a('Error');
-    expect(err.message).equal('No Kind clusters to push to');
+    expect((err as Error).message).equal('No Kind clusters to push to');
   }
 });
 
@@ -78,7 +78,7 @@ test('expect image name to be given', async () => {
   await imageHandler.moveImage(
     { engineId: 'dummy', name: 'myimage' },
     [{ name: 'c1', engineType: 'podman', status: 'started', apiPort: 9443 }],
-    undefined,
+    'kind',
   );
   expect(extensionApi.containerEngine.saveImage).toBeCalledWith('dummy', 'myimage', expect.anything());
 });
@@ -91,7 +91,7 @@ test('expect getting showInformationMessage when image is pushed', async () => {
   await imageHandler.moveImage(
     { engineId: 'dummy', name: 'myimage' },
     [{ name: 'c1', engineType: 'podman', status: 'started', apiPort: 9443 }],
-    undefined,
+    'kind',
   );
   expect(extensionApi.window.showInformationMessage).toBeCalledWith('Image myimage pushed to Kind cluster: c1');
 });
@@ -104,7 +104,7 @@ test('expect image name and tag to be given', async () => {
   await imageHandler.moveImage(
     { engineId: 'dummy', name: 'myimage', tag: '1.0' },
     [{ name: 'c1', engineType: 'podman', status: 'started', apiPort: 9443 }],
-    undefined,
+    'kind',
   );
   expect(extensionApi.containerEngine.saveImage).toBeCalledWith('dummy', 'myimage:1.0', expect.anything());
 });
@@ -119,7 +119,7 @@ test('expect cli is called with right PATH', async () => {
   await imageHandler.moveImage(
     { engineId: 'dummy', name: 'myimage' },
     [{ name: 'c1', engineType: 'podman', status: 'started', apiPort: 9443 }],
-    undefined,
+    'kind',
   );
   expect(getKindPath).toBeCalled();
 

extensions/kind/src/image-handler.ts

@@ -36,7 +36,7 @@ export class ImageHandler {
 
     // Retrieve all the Kind clusters available.
     const clusters = kindClusters.filter(cluster => cluster.status === 'started');
-    let selectedCluster: { label: string; engineType: string };
+    let selectedCluster: { label: string; engineType: string } | undefined;
 
     // Throw an error if there is no clusters,
     // but if there are multiple ones, prompt the user to select one
@@ -56,8 +56,8 @@ export class ImageHandler {
     // Only proceed if a cluster was selected
     if (selectedCluster) {
       let name = image.name;
-      let filename: string;
-      const env = Object.assign({}, process.env);
+      let filename: string | undefined;
+      const env = Object.assign({}, process.env) as { [key: string]: string };
 
       // Create a name:tag string for the image
       if (image.tag) {
@@ -71,7 +71,7 @@ export class ImageHandler {
         env['KIND_EXPERIMENTAL_PROVIDER'] = 'docker';
       }
 
-      env.PATH = getKindPath();
+      env.PATH = getKindPath() ?? '';
       try {
         // Create a temporary file to store the image
         filename = await tmpName();

extensions/kind/src/kind-installer.spec.ts

@@ -55,7 +55,7 @@ vi.mock('sudo-prompt', () => {
             | { name?: string; icns?: string; env?: { [key: string]: string } },
           callback?: (error?: Error, stdout?: string | Buffer, stderr?: string | Buffer) => void,
         ) => {
-          callback(undefined);
+          callback?.(undefined);
         },
       ),
   };
@@ -124,7 +124,7 @@ test('expect showNotification to be called', async () => {
     report: (): void => {},
   };
   vi.spyOn(extensionApi.window, 'withProgress').mockImplementation((options, task) => {
-    return task(progress, undefined);
+    return task(progress, {} as extensionApi.CancellationToken);
   });
   vi.spyOn(installer, 'getAssetInfo').mockReturnValue(Promise.resolve({ id: 0, name: 'kind' }));
   // eslint-disable-next-line @typescript-eslint/no-empty-function

extensions/kind/src/kind-installer.ts

@@ -59,7 +59,7 @@ const MACOS_ARM64_ASSET_NAME = 'kind-darwin-arm64';
 export class KindInstaller {
   private assetNames = new Map<string, string>();
 
-  private assetPromise: Promise<AssetInfo>;
+  private assetPromise: Promise<AssetInfo | undefined> | undefined;
 
   constructor(
     private readonly storagePath: string,
@@ -72,7 +72,7 @@ export class KindInstaller {
     this.assetNames.set(MACOS_ARM64_PLATFORM, MACOS_ARM64_ASSET_NAME);
   }
 
-  findAssetInfo(data: GitHubRelease[], assetName: string): AssetInfo {
+  findAssetInfo(data: GitHubRelease[], assetName: string): AssetInfo | undefined {
     for (const release of data) {
       for (const asset of release.assets) {
         if (asset.name === assetName) {
@@ -86,9 +86,12 @@ export class KindInstaller {
     return undefined;
   }
 
-  async getAssetInfo(): Promise<AssetInfo> {
+  async getAssetInfo(): Promise<AssetInfo | undefined> {
     if (!(await this.assetPromise)) {
       const assetName = this.assetNames.get(os.platform().concat('-').concat(os.arch()));
+      if (assetName === undefined) {
+        return undefined;
+      }
       const octokit = new Octokit();
       this.assetPromise = octokit.repos
         .listReleases({ owner: githubOrganization, repo: githubRepo })
@@ -169,6 +172,7 @@ export class KindInstaller {
           } finally {
             progress.report({ increment: -1 });
           }
+          return false;
         },
       );
     } else {