Feature/contextdir optional (#236)

* feature: making contextdir optional Signed-off-by: axel7083 <[email protected]> * fix: prettier Signed-off-by: axel7083 <[email protected]> * fix: linter Signed-off-by: axel7083 <[email protected]> * fix: comments Signed-off-by: axel7083 <[email protected]> * fix: remove getParentDirectory logic Signed-off-by: axel7083 <[email protected]> * fix: linter Signed-off-by: axel7083 <[email protected]> * fix: linter Signed-off-by: axel7083 <[email protected]> * fix: applicationManager mocks Signed-off-by: axel7083 <[email protected]> --------- Signed-off-by: axel7083 <[email protected]>
containers · Feb 7, 2024 · 29f6940 · 29f6940
1 parent 4b8b789
commit 29f6940
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 18 deletions.
diff --git a/packages/backend/src/managers/applicationManager.spec.ts b/packages/backend/src/managers/applicationManager.spec.ts
@@ -36,7 +36,7 @@ import type { CatalogManager } from './catalogManager';
 
 const mocks = vi.hoisted(() => {
   return {
-    parseYamlMock: vi.fn(),
+    parseYamlFileMock: vi.fn(),
     builImageMock: vi.fn(),
     listImagesMock: vi.fn(),
     getImageInspectMock: vi.fn(),
@@ -52,7 +52,7 @@ const mocks = vi.hoisted(() => {
   };
 });
 vi.mock('../models/AIConfig', () => ({
-  parseYaml: mocks.parseYamlMock,
+  parseYamlFile: mocks.parseYamlFileMock,
 }));
 vi.mock('@podman-desktop/api', () => ({
   containerEngine: {
@@ -124,7 +124,7 @@ describe('pullApplication', () => {
     vi.spyOn(fs, 'readFileSync').mockImplementation((_path: string) => {
       return '';
     });
-    mocks.parseYamlMock.mockReturnValue({
+    mocks.parseYamlFileMock.mockReturnValue({
       application: {
         containers: [
           {
@@ -316,7 +316,7 @@ describe('pullApplication', () => {
       url: '',
     };
 
-    mocks.parseYamlMock.mockReturnValue({
+    mocks.parseYamlFileMock.mockReturnValue({
       application: {
         containers: [],
       },
@@ -437,7 +437,7 @@ describe('getConfiguration', () => {
         ],
       },
     };
-    mocks.parseYamlMock.mockReturnValue(aiConfig);
+    mocks.parseYamlFileMock.mockReturnValue(aiConfig);
 
     const result = manager.getConfiguration('config', 'local');
     expect(result.path).toEqual(path.join('local', 'config'));

diff --git a/packages/backend/src/managers/applicationManager.ts b/packages/backend/src/managers/applicationManager.ts
@@ -23,7 +23,7 @@ import * as path from 'node:path';
 import { type PodCreatePortOptions, containerEngine, type TelemetryLogger } from '@podman-desktop/api';
 import type { RecipeStatusRegistry } from '../registries/RecipeStatusRegistry';
 import type { AIConfig, AIConfigFile, ContainerConfig } from '../models/AIConfig';
-import { parseYaml } from '../models/AIConfig';
+import { parseYamlFile } from '../models/AIConfig';
 import type { Task } from '@shared/src/models/ITask';
 import { RecipeStatusUtils } from '../utils/recipeStatusUtils';
 import { getParentDirectory } from '../utils/pathUtils';
@@ -489,12 +489,12 @@ export class ApplicationManager {
 
     // Parsing the configuration
     console.log(`Reading configuration from ${configFile}.`);
-    const rawConfiguration = fs.readFileSync(configFile, 'utf-8');
     let aiConfig: AIConfig;
     try {
-      aiConfig = parseYaml(rawConfiguration, goarch());
+      aiConfig = parseYamlFile(configFile, goarch());
     } catch (err) {
-      throw new Error('Cannot load configuration file.');
+      console.error('Cannot load configure file.', err);
+      throw new Error(`Cannot load configuration file.`);
     }
 
     // Mark as success.

diff --git a/packages/backend/src/models/AIConfig.spec.ts b/packages/backend/src/models/AIConfig.spec.ts
@@ -0,0 +1,49 @@
+import { expect, test, describe, vi } from 'vitest';
+import fs from 'fs';
+import { type AIConfig, parseYamlFile } from './AIConfig';
+
+// Define mock file paths and contents
+const mockYamlPath = '/path/to/mock.yml';
+const mockYamlContent = `
+application:
+  containers:
+    - name: container1
+      contextdir: /path/to/dir1
+      arch: ["x86"]
+      model-service: true
+      gpu-env: ["env1", "env2"]
+    - name: container2
+      arch: ["arm"]
+`;
+
+const readFileSync = vi.spyOn(fs, 'readFileSync');
+
+describe('parseYaml', () => {
+  test('should parse valid YAML file', () => {
+    readFileSync.mockReturnValue(mockYamlContent);
+
+    const defaultArch = 'x64';
+    const expectedConfig: AIConfig = {
+      application: {
+        containers: [
+          {
+            name: 'container1',
+            contextdir: '/path/to/dir1',
+            arch: ['x86'],
+            modelService: true,
+            gpu_env: ['env1', 'env2'],
+          },
+          {
+            name: 'container2',
+            contextdir: '.',
+            arch: ['arm'],
+            modelService: false,
+            gpu_env: [],
+          },
+        ],
+      },
+    };
+
+    expect(parseYamlFile(mockYamlPath, defaultArch)).toEqual(expectedConfig);
+  });
+});
diff --git a/packages/backend/src/models/AIConfig.ts b/packages/backend/src/models/AIConfig.ts
@@ -17,6 +17,7 @@
  ***********************************************************************/
 
 import * as jsYaml from 'js-yaml';
+import fs from 'fs';
 
 export interface ContainerConfig {
   name: string;
@@ -46,7 +47,9 @@ export function assertString(value: unknown): string {
   throw new Error('value not a string');
 }
 
-export function parseYaml(raw: string, defaultArch: string): AIConfig {
+export function parseYamlFile(filepath: string, defaultArch: string): AIConfig {
+  const raw: string = fs.readFileSync(filepath, 'utf-8');
+
   const aiStudioConfig = jsYaml.load(raw);
   const application = aiStudioConfig?.['application'];
   if (!application) throw new Error('AIConfig has bad formatting.');
@@ -55,14 +58,25 @@ export function parseYaml(raw: string, defaultArch: string): AIConfig {
 
   return {
     application: {
-      containers: containers.map(container => ({
-        arch: Array.isArray(container['arch']) ? container['arch'] : [defaultArch],
-        modelService: container['model-service'] === true,
-        containerfile: isString(container['containerfile']) ? container['containerfile'] : undefined,
-        contextdir: assertString(container['contextdir']),
-        name: assertString(container['name']),
-        gpu_env: Array.isArray(container['gpu-env']) ? container['gpu-env'] : [],
-      })),
+      containers: containers.map(container => {
+        if (typeof container !== 'object') throw new Error('containers array malformed');
+
+        let contextdir: string;
+        if ('contextdir' in container) {
+          contextdir = assertString(container['contextdir']);
+        } else {
+          contextdir = '.';
+        }
+
+        return {
+          arch: Array.isArray(container['arch']) ? container['arch'] : [defaultArch],
+          modelService: container['model-service'] === true,
+          containerfile: isString(container['containerfile']) ? container['containerfile'] : undefined,
+          contextdir: contextdir,
+          name: assertString(container['name']),
+          gpu_env: Array.isArray(container['gpu-env']) ? container['gpu-env'] : [],
+        };
+      }),
     },
   };
 }