Enclose the whole interaction with the EditorAction menu in the

conditional wait

to avoid having some stale reference when trying to click on them after
we found them.

Signed-off-by: Aurélien Pupier <[email protected]>

Author: apupier

src/ui-test/tests/actions.requirements.test.ts

@@ -16,11 +16,11 @@
  */
 
 import path from "path";
-import { ActivityBar, EditorActionDropdown, EditorView, SideBarView, VSBrowser, WebDriver, Workbench } from "vscode-extension-tester";
+import { ActivityBar, EditorView, SideBarView, VSBrowser, WebDriver, Workbench } from "vscode-extension-tester";
 import { CAMEL_ROUTE_YAML_WITH_SPACE, CAMEL_RUN_ACTION_LABEL, CAMEL_RUN_DEBUG_ACTION_LABEL, CAMEL_RUN_DEBUG_FOLDER_ACTION_LABEL, CAMEL_RUN_DEBUG_WORKSPACE_ACTION_LABEL, CAMEL_RUN_FOLDER_ACTION_LABEL, CAMEL_RUN_WORKSPACE_ACTION_LABEL } from "../variables";
 import { expect } from "chai";
 import { notificationCenterContains, waitUntilNotificationShows } from "../utils";
-import { actionAvailable } from './helper/Awaiters';
+import { selectDropDownMenuEditorAction } from './helper/Awaiters';
 
 describe('Check actions requirements to run/debug', function () {
     this.timeout(90000);
@@ -77,10 +77,7 @@ describe('Check actions requirements to run/debug', function () {
     });
 
     async function clickButtonAndVerifyNotification(actionLabel: string) {
-        await actionAvailable(editorView, "Run or Debug...");
-        const action = (await editorView.getAction("Run or Debug...")) as EditorActionDropdown;
-        const menu = await action.open();
-        await menu.select(actionLabel);
+        await selectDropDownMenuEditorAction(editorView, "Run or Debug...", actionLabel);
         await waitUntilNotificationShows(driver, NOTIFICATION_TEXT);
         expect(await notificationCenterContains(NOTIFICATION_TEXT)).to.be.true;
         const center = await new Workbench().openNotificationsCenter();

src/ui-test/tests/deploy.kubernetes.run.test.ts

@@ -18,13 +18,12 @@ import { resolve, join } from 'node:path';
 import {
     after,
     before,
-    EditorAction,
     EditorView,
     VSBrowser,
 } from 'vscode-extension-tester';
 import { killTerminal, waitUntilTerminalHasText } from '../utils';
 import { CAMEL_ROUTE_YAML_WITH_SPACE } from '../variables';
-import { actionAvailable } from './helper/Awaiters';
+import { clickOnEditorAction } from './helper/Awaiters';
 
 /**
  * Note: OC login needs to be done before executing this test for deployment into OpenShift
@@ -52,10 +51,8 @@ describe('Camel standalone file deployment using Camel JBang Kubernetes Run', fu
 
     it('Deploy integration to OpenShift or Kubernetes (Minikube)', async function () {
         await VSBrowser.instance.driver.sleep(500);
-        await actionAvailable(editorView, 'Deploy Integration with Apache Camel Kubernetes Run');
-        const action = (await editorView.getAction('Deploy Integration with Apache Camel Kubernetes Run')) as EditorAction;
-        await action.click();
-        await waitUntilTerminalHasText(action.getDriver(), ['Hello Camel from'], 10_000, 900_000);
+        await clickOnEditorAction(editorView, 'Deploy Integration with Apache Camel Kubernetes Run');
+        await waitUntilTerminalHasText(VSBrowser.instance.driver, ['Hello Camel from'], 10_000, 900_000);
     });
 
 });

src/ui-test/tests/editor.actions.test.ts

@@ -34,7 +34,7 @@ import {
     isCamelVersionProductized,
 } from '../utils';
 import { CAMEL_RUN_DEBUG_FOLDER_ACTION_LABEL, CAMEL_RUN_DEBUG_WORKSPACE_ACTION_LABEL, CAMEL_RUN_FOLDER_ACTION_LABEL, CAMEL_RUN_WORKSPACE_ACTION_LABEL, TOP_ROUTE_1 } from '../variables';
-import { actionAvailable } from './helper/Awaiters';
+import { openDropDownMenuEditorAction, selectDropDownMenuEditorAction } from './helper/Awaiters';
 
 describe('Camel file editor test', function () {
 
@@ -68,26 +68,22 @@ describe('Camel file editor test', function () {
             if (process.platform === "darwin"){
                 this.skip();
             }
-            await actionAvailable(editorView, "Run or Debug...");
-            const action = (await editorView.getAction("Run or Debug...")) as EditorActionDropdown;
-            const menu = await action.open();
-            expect(await menu.hasItem(CAMEL_RUN_ACTION_LABEL)).true;
-            expect(await menu.hasItem(CAMEL_RUN_WORKSPACE_ACTION_LABEL)).true;
-            expect(await menu.hasItem(CAMEL_RUN_FOLDER_ACTION_LABEL)).true;
-            await menu.close();
+            const menu = await openDropDownMenuEditorAction(editorView, "Run or Debug...");
+            expect(await menu?.hasItem(CAMEL_RUN_ACTION_LABEL)).true;
+            expect(await menu?.hasItem(CAMEL_RUN_WORKSPACE_ACTION_LABEL)).true;
+            expect(await menu?.hasItem(CAMEL_RUN_FOLDER_ACTION_LABEL)).true;
+            await menu?.close();
         });
 
         it('Debug and Run actions are available', async function () {
             if (process.platform === "darwin"){
                 this.skip();
             }
-            await actionAvailable(editorView, "Run or Debug...");
-            const action = (await editorView.getAction("Run or Debug...")) as EditorActionDropdown;
-            const menu = await action.open();
-            expect(await menu.hasItem(CAMEL_RUN_DEBUG_ACTION_LABEL)).true;
-            expect(await menu.hasItem(CAMEL_RUN_DEBUG_WORKSPACE_ACTION_LABEL)).true;
-            expect(await menu.hasItem(CAMEL_RUN_DEBUG_FOLDER_ACTION_LABEL)).true;
-            await menu.close();
+            const menu = await openDropDownMenuEditorAction(editorView, "Run or Debug...");
+            expect(await menu?.hasItem(CAMEL_RUN_DEBUG_ACTION_LABEL)).true;
+            expect(await menu?.hasItem(CAMEL_RUN_DEBUG_WORKSPACE_ACTION_LABEL)).true;
+            expect(await menu?.hasItem(CAMEL_RUN_DEBUG_FOLDER_ACTION_LABEL)).true;
+            await menu?.close();
         });
 
         const runActionLabels = [
@@ -101,10 +97,7 @@ describe('Camel file editor test', function () {
                 if (process.platform === "darwin") {
                     this.skip();
                 }
-                await actionAvailable(editorView, "Run or Debug...");
-                const action = (await editorView.getAction("Run or Debug...")) as EditorActionDropdown;
-                const menu = await action.open();
-                await menu.select(runActionLabels.label);
+                await selectDropDownMenuEditorAction(editorView, "Run or Debug...", runActionLabels.label);
                 await waitUntilTerminalHasText(driver, runActionLabels.terminalText, 2000, 120000);
                 await killTerminal();
             });
@@ -124,10 +117,7 @@ describe('Camel file editor test', function () {
                 if (process.platform === "darwin"){
                     this.skip();
                 }
-                await actionAvailable(editorView, "Run or Debug...");
-                const action = (await editorView.getAction("Run or Debug...")) as EditorActionDropdown;
-                const menu = await action.open();
-                await menu.select(debugActionLabels.label);
+                await selectDropDownMenuEditorAction(editorView, "Run or Debug...", debugActionLabels.label);
 
                 await waitUntilTerminalHasText(driver, debugActionLabels.terminalText, 2000, 120000);
 

src/ui-test/tests/helper/Awaiters.ts

@@ -1,13 +1,56 @@
 import waitUntil from 'async-wait-until';
-import { EditorView } from 'vscode-extension-tester';
+import { ContextMenu, EditorView } from 'vscode-extension-tester';
 
 
-export async function actionAvailable(editorView: EditorView, actionLabel: string) {
+export async function clickOnEditorAction(editorView: EditorView, actionLabel: string) {
     await waitUntil(async () => {
         try {
-            return await editorView.getAction(actionLabel) !== undefined;
+            const action = await editorView.getAction(actionLabel);
+            if (action !== undefined) {
+                await action.click();
+                return true;
+            } else {
+                return false;
+            }
         } catch {
             return false;
         }
     });
 }
+
+export async function openDropDownMenuEditorAction(editorView: EditorView, actionLabel: string) :Promise<ContextMenu | undefined>{
+    let contextMenu : ContextMenu | undefined = undefined;
+    await waitUntil(async () => {
+        try {
+            const action = await editorView.getAction(actionLabel);
+            if (action !== undefined) {
+                contextMenu = await action.open();
+                return true;
+            } else {
+                return false;
+            }
+        } catch {
+            return false;
+        }
+    });
+    return contextMenu;
+}
+
+export async function selectDropDownMenuEditorAction(editorView: EditorView, actionLabel: string, subActionLabel: string) :Promise<ContextMenu | undefined>{
+    let contextMenu : ContextMenu | undefined = undefined;
+    await waitUntil(async () => {
+        try {
+            const action = await editorView.getAction(actionLabel);
+            if (action !== undefined) {
+                contextMenu = await action.open();
+                await contextMenu.select(subActionLabel);
+                return true;
+            } else {
+                return false;
+            }
+        } catch {
+            return false;
+        }
+    });
+    return contextMenu;
+}