Merge pull request #17 from abrugaro/structural-improvements

🌱 Perform minimal structural improvements

.gitignore

@@ -94,4 +94,10 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-*.icloud
+*.icloud
+
+.env
+
+node_modules/
+playwright-report/
+test-results/

e2e/pages/vscode.pages.ts

@@ -3,33 +3,42 @@ import { execSync } from 'child_process';
 import { downloadLatestKAIPlugin } from '../utilities/download.utils';
 import { getKAIPluginPath } from '../utilities/utils';
 
-class LaunchVSCodePage {
-  private vscodeApp?: ElectronApplication;
-  private window?: Page;
+class VSCode {
+  private readonly vscodeApp?: ElectronApplication;
+  private readonly window?: Page;
 
   private constructor(vscodeApp: ElectronApplication, window: Page) {
     this.vscodeApp = vscodeApp;
     this.window = window;
   }
 
-  public static async launchVSCode(
-    executablePath: string
-  ): Promise<LaunchVSCodePage> {
+  /**
+   * Installs kai extensions from the VSIX path configured in the .env file and
+   * launches VSCode
+   * @param executablePath path to the vscode binary
+   */
+  public static async init(
+    executablePath: string,
+  ): Promise<VSCode> {
     try {
       const vsixFilePath = getKAIPluginPath();
-      console.log(`Installing extension from VSIX file: ${vsixFilePath}`);
-      await LaunchVSCodePage.installExtensionFromVSIX(vsixFilePath);
+      if (vsixFilePath) {
+        console.log(`Installing extension from VSIX file: ${vsixFilePath}`);
+        await VSCode.installExtensionFromVSIX(vsixFilePath);
+      } else {
+        console.warn(
+          'VSIX_FILE_PATH environment variable is not set. Skipping extension installation.',
+        );
+      }
 
       // Launch VSCode as an Electron app
       const vscodeApp = await electron.launch({
         executablePath: executablePath,
       });
 
-      // Get the main window
       const window = await vscodeApp.firstWindow();
 
-      // Return an instance of LaunchVSCodePage
-      return new LaunchVSCodePage(vscodeApp, window);
+      return new VSCode(vscodeApp, window);
     } catch (error) {
       console.error('Error launching VSCode:', error);
       throw error;
@@ -41,14 +50,14 @@ class LaunchVSCodePage {
    * This method is static because it is independent of the instance.
    */
   private static async installExtensionFromVSIX(
-    vsixFilePath: string
+    vsixFilePath: string,
   ): Promise<void> {
     await downloadLatestKAIPlugin();
 
     try {
       // Execute command to install VSIX file using VSCode CLI
       console.log(`Installing extension from ${vsixFilePath}...`);
-      execSync(`code --install-extension ${vsixFilePath}`, {
+      execSync(`code --install-extension '${vsixFilePath}'`, {
         stdio: 'inherit',
       });
       console.log('Extension installed successfully.');
@@ -83,4 +92,4 @@ class LaunchVSCodePage {
   }
 }
 
-export { LaunchVSCodePage };
+export { VSCode };

e2e/tests/vscode.test.ts

@@ -1,31 +1,27 @@
 import { test, expect } from '@playwright/test';
-import { LaunchVSCodePage } from '../pages/vscode.pages';
+import { VSCode } from '../pages/vscode.pages';
 
 test.describe('VSCode Tests', () => {
-  let vscodeApp: LaunchVSCodePage;
+  let vscodeApp: VSCode;
 
   test.beforeAll(async () => {
     const executablePath =
       process.env.VSCODE_EXECUTABLE_PATH || '/usr/share/code/code';
-    vscodeApp = await LaunchVSCodePage.launchVSCode(executablePath);
+    vscodeApp = await VSCode.init(executablePath);
   });
 
-  test.afterAll(async () => {
-    await vscodeApp.closeVSCode();
-  });
-
-  test('should launch VSCode and check window title', async () => {
+  test('Should launch VSCode and check window title', async () => {
     const window = vscodeApp.getWindow();
     const title = await window.title();
     expect(title).toContain('Visual Studio Code');
   });
 
-  test('should open Extensions tab and verify installed extension', async () => {
+  test('Should open Extensions tab and verify installed extension', async () => {
     const window = vscodeApp.getWindow();
     const kaiTab = await window.getByRole('tab', { name: 'Konveyor' });
     await kaiTab.click();
     // Assert if KAI explorer is opened.
-    const title = await window.getByRole('heading', {
+    const title = window.getByRole('heading', {
       name: 'KAI',
       exact: true,
     });