unit tests for playground manager (#193)

* unit tests for playground manager

* add missing license headers

* fix postMessage result

packages/backend/src/managers/modelsManager.spec.ts

@@ -1,3 +1,21 @@
+/**********************************************************************
+ * Copyright (C) 2024 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
 import { type MockInstance, beforeEach, describe, expect, test, vi } from 'vitest';
 import os from 'os';
 import fs from 'node:fs';

packages/backend/src/managers/modelsManager.ts

@@ -1,3 +1,21 @@
+/**********************************************************************
+ * Copyright (C) 2024 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
 import type { LocalModelInfo } from '@shared/src/models/ILocalModelInfo';
 import fs from 'fs';
 import * as https from 'node:https';

packages/backend/src/managers/playground.spec.ts

@@ -0,0 +1,148 @@
+/**********************************************************************
+ * Copyright (C) 2024 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { beforeEach, expect, test, vi } from 'vitest';
+import { PlayGroundManager } from './playground';
+import type { ImageInfo, Webview } from '@podman-desktop/api';
+
+const mocks = vi.hoisted(() => ({
+  postMessage: vi.fn(),
+  getContainerConnections: vi.fn(),
+  pullImage: vi.fn(),
+  createContainer: vi.fn(),
+  stopContainer: vi.fn(),
+  getFreePort: vi.fn(),
+}));
+
+vi.mock('@podman-desktop/api', async () => {
+  return {
+    provider: {
+      getContainerConnections: mocks.getContainerConnections,
+    },
+    containerEngine: {
+      pullImage: mocks.pullImage,
+      createContainer: mocks.createContainer,
+      stopContainer: mocks.stopContainer,
+    },
+  };
+});
+
+vi.mock('../utils/ports', async () => {
+  return {
+    getFreePort: mocks.getFreePort,
+  };
+});
+
+let manager: PlayGroundManager;
+
+beforeEach(() => {
+  vi.resetAllMocks();
+
+  manager = new PlayGroundManager({
+    postMessage: mocks.postMessage,
+  } as unknown as Webview);
+});
+
+test('startPlayground should fail if no provider', async () => {
+  mocks.postMessage.mockResolvedValue(undefined);
+  mocks.getContainerConnections.mockReturnValue([]);
+  await expect(manager.startPlayground('model1', '/path/to/model')).rejects.toThrowError(
+    'Unable to find an engine to start playground',
+  );
+});
+
+test('startPlayground should download image if not present then create container', async () => {
+  mocks.postMessage.mockResolvedValue(undefined);
+  mocks.getContainerConnections.mockReturnValue([
+    {
+      connection: {
+        type: 'podman',
+        status: () => 'started',
+      },
+    },
+  ]);
+  vi.spyOn(manager, 'selectImage')
+    .mockResolvedValueOnce(undefined)
+    .mockResolvedValueOnce({
+      Id: 'image1',
+      engineId: 'engine1',
+    } as ImageInfo);
+  mocks.createContainer.mockReturnValue({
+    id: 'container1',
+  });
+  mocks.getFreePort.mockResolvedValue(8085);
+  await manager.startPlayground('model1', '/path/to/model');
+  expect(mocks.pullImage).toHaveBeenCalledOnce();
+  expect(mocks.createContainer).toHaveBeenNthCalledWith(1, 'engine1', {
+    Cmd: ['--models-path', '/models', '--context-size', '700', '--threads', '4'],
+    Detach: true,
+    Env: ['MODEL_PATH=/models/model'],
+    ExposedPorts: {
+      '8085': {},
+    },
+    HostConfig: {
+      AutoRemove: true,
+      Mounts: [
+        {
+          Source: '/path/to',
+          Target: '/models',
+          Type: 'bind',
+        },
+      ],
+      PortBindings: {
+        '8000/tcp': [
+          {
+            HostPort: '8085',
+          },
+        ],
+      },
+    },
+    Image: 'image1',
+    Labels: {
+      'ia-studio-model': 'model1',
+    },
+  });
+});
+
+test('stopPlayground should fail if no playground is running', async () => {
+  await expect(manager.stopPlayground('unknown-model')).rejects.toThrowError('model is not running');
+});
+
+test('stopPlayground should stop a started playground', async () => {
+  mocks.postMessage.mockResolvedValue(undefined);
+  mocks.getContainerConnections.mockReturnValue([
+    {
+      connection: {
+        type: 'podman',
+        status: () => 'started',
+      },
+    },
+  ]);
+  vi.spyOn(manager, 'selectImage').mockResolvedValue({
+    Id: 'image1',
+    engineId: 'engine1',
+  } as ImageInfo);
+  mocks.createContainer.mockReturnValue({
+    id: 'container1',
+  });
+  mocks.stopContainer.mockResolvedValue(undefined);
+  mocks.getFreePort.mockResolvedValue(8085);
+  await manager.startPlayground('model1', '/path/to/model');
+  await manager.stopPlayground('model1');
+  expect(mocks.stopContainer).toHaveBeenNthCalledWith(1, 'engine1', 'container1');
+});