@eclipse-che/che-e2e 7.45.0 → 7.46.1-dev-5e33fd3

package/tests/plugins/VscodeXmlPlugin.spec.ts

@@ -10,7 +10,6 @@
 
 import { Key } from 'selenium-webdriver';
 import { e2eContainer } from '../../inversify.config';
-import { WorkspaceNameHandler } from '../../utils/WorkspaceNameHandler';
 import { Ide } from '../../pageobjects/ide/Ide';
 import { CLASSES } from '../../inversify.types';
 import { ProjectTree } from '../../pageobjects/ide/ProjectTree';
@@ -19,7 +18,6 @@ import { TestConstants } from '../../TestConstants';
 import { TimeoutConstants } from '../../TimeoutConstants';
 import { WorkspaceHandlingTests } from '../../testsLibrary/WorkspaceHandlingTests';
 import { Logger } from '../../utils/Logger';
-import CheReporter from '../../driver/CheReporter';
 import { BrowserTabsUtil } from '../../utils/BrowserTabsUtil';
 
 const ide: Ide = e2eContainer.get(CLASSES.Ide);
@@ -27,14 +25,12 @@ const projectTree: ProjectTree = e2eContainer.get(CLASSES.ProjectTree);
 const editor: Editor = e2eContainer.get(CLASSES.Editor);
 const browserTabsUtil: BrowserTabsUtil = e2eContainer.get(CLASSES.BrowserTabsUtil);
 const workspaceHandlingTests: WorkspaceHandlingTests = e2eContainer.get(CLASSES.WorkspaceHandlingTests);
-const workspaceNameHandler: WorkspaceNameHandler = e2eContainer.get(CLASSES.WorkspaceNameHandler);
 
 const devfileUrl: string = 'https://raw.githubusercontent.com/eclipse/che/main/tests/e2e/files/devfiles/plugins/VscodeXmlPlugin.yaml';
 const factoryUrl: string = `${TestConstants.TS_SELENIUM_BASE_URL}/f?url=${devfileUrl}`;
 const projectName: string = 'nodejs-web-app';
 const pathToFile: string = `${projectName}`;
 const xmlFileName: string = 'hello.xml';
-let workspaceName: string = '';
 
 suite('The "VscodeXmlPlugin" userstory', async () => {
     suite('Create workspace', async () => {
@@ -42,11 +38,9 @@ suite('The "VscodeXmlPlugin" userstory', async () => {
             await browserTabsUtil.navigateTo(factoryUrl);
         });
 
-        test('Wait until created workspace is started', async () => {
-            await ide.waitAndSwitchToIdeFrame();
-            workspaceName = await workspaceNameHandler.getNameFromUrl();
-            CheReporter.registerRunningWorkspace(workspaceName);
+        workspaceHandlingTests.obtainWorkspaceNameFromStartingPage();
 
+        test('Wait until created workspace is started', async () => {
             await ide.waitIde(TimeoutConstants.TS_SELENIUM_START_WORKSPACE_TIMEOUT);
             await ide.waitNotificationAndClickOnButton('Do you trust the authors of', 'Yes, I trust', 60_000);
         });
@@ -109,7 +103,7 @@ suite('The "VscodeXmlPlugin" userstory', async () => {
     suite('Delete workspace', async () => {
         test('Stop and remove workspace', async () => {
             if (TestConstants.TS_DELETE_PLUGINS_TEST_WORKSPACE === 'true') {
-                await workspaceHandlingTests.stopAndRemoveWorkspace(workspaceName);
+                await workspaceHandlingTests.stopAndRemoveWorkspace(WorkspaceHandlingTests.getWorkspaceName());
                 return;
             }
 

package/tests/plugins/VscodeYamlPlugin.spec.ts

@@ -16,7 +16,6 @@ import { Editor } from '../../pageobjects/ide/Editor';
 import { TestConstants } from '../../TestConstants';
 import { Logger } from '../../utils/Logger';
 import { WorkspaceHandlingTests } from '../../testsLibrary/WorkspaceHandlingTests';
-import CheReporter from '../../driver/CheReporter';
 import { BrowserTabsUtil } from '../../utils/BrowserTabsUtil';
 import { PreferencesHandler } from '../../utils/PreferencesHandler';
 import { ProjectAndFileTests } from '../../testsLibrary/ProjectAndFileTests';
@@ -36,19 +35,17 @@ const pathToFile: string = `${projectName}`;
 const yamlFileName: string = 'routes.yaml';
 const yamlSchema = { 'yaml-schema.json': '*.yaml' };
 
-let workspaceName: string = 'yaml-plugin';
-
 suite('The "VscodeYamlPlugin" userstory', async () => {
     suite('Create workspace', async () => {
         test('Create workspace using factory', async () => {
             await browserTabsUtil.navigateTo(factoryUrl);
         });
 
-        projectAndFileTests.waitWorkspaceReadiness(projectName, subRootFolder);
+        workspaceHandlingTests.obtainWorkspaceNameFromStartingPage();
 
-        test('Wait until created workspace is started', async () => {
-            CheReporter.registerRunningWorkspace(workspaceName);
+        projectAndFileTests.waitWorkspaceReadiness(projectName, subRootFolder);
 
+        test('Set confirmExit preference to never', async () => {
             await preferencesHandler.setPreferenceUsingUI('application.confirmExit', 'never');
         });
     });
@@ -97,7 +94,7 @@ suite('The "VscodeYamlPlugin" userstory', async () => {
     suite('Delete workspace', async () => {
         test('Stop and remove workspace', async () => {
             if (TestConstants.TS_DELETE_PLUGINS_TEST_WORKSPACE === 'true') {
-                await workspaceHandlingTests.stopAndRemoveWorkspace(workspaceName);
+                await workspaceHandlingTests.stopAndRemoveWorkspace(WorkspaceHandlingTests.getWorkspaceName());
                 return;
             }
 

package/testsLibrary/CodeExecutionTests.ts

@@ -22,6 +22,8 @@ import { PreviewWidget } from '../pageobjects/ide/PreviewWidget';
 import { RightToolBar } from '../pageobjects/ide/RightToolBar';
 import { Logger } from '../utils/Logger';
 import { QuickOpenContainer } from '../pageobjects/ide/QuickOpenContainer';
+import { WorkspaceHandlingTests } from './WorkspaceHandlingTests';
+import { BrowserTabsUtil } from '../utils/BrowserTabsUtil';
 
 @injectable()
 export class CodeExecutionTests {
@@ -36,7 +38,9 @@ export class CodeExecutionTests {
         @inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
         @inject(CLASSES.PreviewWidget) private readonly previewWidget: PreviewWidget,
         @inject(CLASSES.RightToolBar) private readonly rightToolBar: RightToolBar,
-        @inject(CLASSES.QuickOpenContainer) private readonly quickOpenContainer: QuickOpenContainer) {}
+        @inject(CLASSES.QuickOpenContainer) private readonly quickOpenContainer: QuickOpenContainer,
+        @inject(CLASSES.BrowserTabsUtil) private readonly browserTabsUtil: BrowserTabsUtil,
+        @inject(CLASSES.WorkspaceHandlingTests) private readonly workspaceHandlingTests: WorkspaceHandlingTests) {}
 
     public runTask(taskName: string, timeout: number) {
         test(`Run command '${taskName}'`, async () => {
@@ -66,6 +70,7 @@ export class CodeExecutionTests {
     public runTaskWithDialogShellAndOpenLink(taskName: string, expectedDialogText: string, timeout: number) {
         test(`Run command '${taskName}' expecting dialog shell`, async () => {
             await this.runTaskUsingQuickOpenContainer(taskName);
+            this.workspaceHandlingTests.setWindowHandle(await this.browserTabsUtil.getCurrentWindowHandle());
             await this.dialogWindow.waitDialogAndOpenLink(expectedDialogText, timeout);
         });
     }
@@ -107,6 +112,7 @@ export class CodeExecutionTests {
         test(`Run command '${taskName}' expecting notification`, async () => {
             await this.runTaskUsingQuickOpenContainer(taskName);
             await this.ide.waitNotification(notificationText, timeout);
+            this.workspaceHandlingTests.setWindowHandle(await this.browserTabsUtil.getCurrentWindowHandle());
             await this.ide.clickOnNotificationButton(notificationText, buttonText);
             CodeExecutionTests.lastApplicationUrl = await this.previewWidget.getUrl();
         });
@@ -116,6 +122,7 @@ export class CodeExecutionTests {
         test(`Run command '${taskName}' expecting notification`, async () => {
             await this.runTaskUsingQuickOpenContainer(taskName);
             await this.ide.waitNotification(notificationText, timeout);
+            this.workspaceHandlingTests.setWindowHandle(await this.browserTabsUtil.getCurrentWindowHandle());
             await this.ide.clickOnNotificationButton(notificationText, 'Open In Preview');
             CodeExecutionTests.lastApplicationUrl = await this.previewWidget.getUrl();
         });
@@ -125,6 +132,7 @@ export class CodeExecutionTests {
         test(`Run command '${taskName}' expecting notification with unexposed port`, async () => {
             await this.runTaskUsingQuickOpenContainer(taskName);
             await this.ide.waitNotificationAndConfirm(notificationText, timeout);
+            this.workspaceHandlingTests.setWindowHandle(await this.browserTabsUtil.getCurrentWindowHandle());
             await this.ide.waitNotificationAndOpenLink(portOpenText, timeout);
             CodeExecutionTests.lastApplicationUrl = await this.previewWidget.getUrl();
         });

package/testsLibrary/WorkspaceHandlingTests.ts

@@ -15,39 +15,56 @@ import { Dashboard } from '../pageobjects/dashboard/Dashboard';
 import { CreateWorkspace } from '../pageobjects/dashboard/CreateWorkspace';
 import { Workspaces } from '../pageobjects/dashboard/Workspaces';
 import { BrowserTabsUtil } from '../utils/BrowserTabsUtil';
-import { Logger } from '..';
+import { Logger } from '../utils/Logger';
+import { TimeoutConstants } from '../TimeoutConstants';
+import { DriverHelper } from '../utils/DriverHelper';
+import { Ide } from '../pageobjects/ide/Ide';
+import { By, error } from 'selenium-webdriver';
 
 @injectable()
 export class WorkspaceHandlingTests {
 
+    private static START_WORKSPACE_PAGE_NAME_LOCATOR: By = By.xpath(`//div[@class="ui-container"]/div[@class="pf-c-page"]//div[@class="pf-c-content"]/h1`);
     private static workspaceName: string = 'undefined';
+    private static parentGUID: string;
 
     public static getWorkspaceName(): string {
         return WorkspaceHandlingTests.workspaceName;
     }
 
+    public static setWorkspaceName(workspaceName: string) {
+        WorkspaceHandlingTests.workspaceName = workspaceName;
+    }
+
+    public setWindowHandle(guid: string) {
+        WorkspaceHandlingTests.parentGUID = guid;
+    }
+
+    public getWindowHandle(): string {
+        return WorkspaceHandlingTests.parentGUID;
+    }
+
     constructor(
         @inject(CLASSES.Dashboard) private readonly dashboard: Dashboard,
         @inject(CLASSES.CreateWorkspace) private readonly createWorkspace: CreateWorkspace,
         @inject(CLASSES.Workspaces) private readonly workspaces: Workspaces,
-        @inject(CLASSES.BrowserTabsUtil) private readonly browserTabsUtil: BrowserTabsUtil) {}
+        @inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
+        @inject(CLASSES.BrowserTabsUtil) private readonly browserTabsUtil: BrowserTabsUtil,
+        @inject(CLASSES.Ide) private readonly ide: Ide) {}
 
     public createAndOpenWorkspace(stack: string) {
-        test(`Open 'New Workspace' page`, async () => {
+        test(`Create and open new workspace, stack:${stack}`, async () => {
             await this.dashboard.waitPage();
             await this.dashboard.clickCreateWorkspaceButton();
             await this.createWorkspace.waitPage();
-            const parentGUID = await this.browserTabsUtil.getCurrentWindowHandle();
+            WorkspaceHandlingTests.parentGUID = await this.browserTabsUtil.getCurrentWindowHandle();
             await this.createWorkspace.clickOnSample(stack);
-            await this.browserTabsUtil.switchToWindow(parentGUID);
-            WorkspaceHandlingTests.workspaceName = await this.dashboard.getRecentWorkspaceName(10000);
-            Logger.debug(`Workspace Name is: ${WorkspaceHandlingTests.workspaceName}`);
-            await this.browserTabsUtil.waitAndSwitchToAnotherWindow(parentGUID, 10000);
+            await this.browserTabsUtil.waitAndSwitchToAnotherWindow(WorkspaceHandlingTests.parentGUID, TimeoutConstants.TS_IDE_LOAD_TIMEOUT);
         });
     }
 
     public openExistingWorkspace(workspaceName: string) {
-        test('Start workspace', async () => {
+        test('Open and start existing workspace', async () => {
             await this.dashboard.waitPage();
             await this.dashboard.clickWorkspacesButton();
             await this.workspaces.waitPage();
@@ -55,6 +72,46 @@ export class WorkspaceHandlingTests {
         });
     }
 
+    public obtainWorkspaceNameFromStartingPage() {
+        test('Obtain workspace name from workspace loader page', async() => {
+            try {
+                await this.driverHelper.waitVisibility(WorkspaceHandlingTests.START_WORKSPACE_PAGE_NAME_LOCATOR, TimeoutConstants.TS_WAIT_LOADER_PRESENCE_TIMEOUT);
+                // it takes a while to update the element with the workspace name
+                await this.driverHelper.wait(10_000);
+                let startingWorkspaceLineContent = await this.driverHelper.getDriver().findElement(WorkspaceHandlingTests.START_WORKSPACE_PAGE_NAME_LOCATOR).getAttribute('innerHTML');
+                // cutting away leading text
+                WorkspaceHandlingTests.workspaceName = startingWorkspaceLineContent.substring('Starting workspace '.length).trim();
+                Logger.info(`Obtained workspace name from workspace loader page: ${WorkspaceHandlingTests.workspaceName}`);
+            } catch (err) {
+                Logger.error(`Failed to obtain workspace name from workspace loader page: ${err}`);
+                throw err;
+            }
+        });
+    }
+
+    public switchBackToFirstOpenIdeTabFromLeftToRight() {
+        test('WorkspaceHandlingTests.switchBackToIdeTab', async () => {
+            let tabs = await this.driverHelper.getDriver().getAllWindowHandles();
+            Logger.trace(`WorkspaceHandlingTests.switchBackToIdeTab Found ${tabs.length} window handles, iterating...`);
+            for (let i = 0; i < tabs.length; i++) {
+                await this.browserTabsUtil.switchToWindow(tabs[i]);
+                try {
+                    await this.ide.waitIde(TimeoutConstants.TS_IDE_LOAD_TIMEOUT);
+                    Logger.info(`WorkspaceHandlingTests.switchBackToIdeTab located and switched to IDE tab`);
+                    return;
+                } catch (err) {
+                    if (err instanceof error.TimeoutError) {
+                        Logger.warn(`WorkspaceHandlingTests.switchBackToIdeTab Locator timed out, trying with another window handle.`);
+                        continue;
+                    }
+                    Logger.error(`WorkspaceHandlingTests.switchBackToIdeTab Received unexpected exception while trying to locate IDE tab:${err}`);
+                    throw err;
+                }
+            }
+            Logger.error(`WorkspaceHandlingTests.switchBackToIdeTab Failed to locate IDE tab, out of window handles.`);
+        });
+    }
+
     public async stopWorkspace(workspaceName: string) {
         await this.dashboard.openDashboard();
         await this.dashboard.stopWorkspaceByUI(workspaceName);