@eclipse-che/che-e2e 7.50.0-dev-25a3c8c → 7.50.0

package/tests/plugins/VscodeXmlPlugin.spec.ts

@@ -10,6 +10,7 @@
 
 import { Key } from 'selenium-webdriver';
 import { e2eContainer } from '../../inversify.config';
+import { Ide } from '../../pageobjects/ide/Ide';
 import { CLASSES } from '../../inversify.types';
 import { ProjectTree } from '../../pageobjects/ide/ProjectTree';
 import { Editor } from '../../pageobjects/ide/Editor';
@@ -20,10 +21,12 @@ import CheReporter from '../../driver/CheReporter';
 import { BrowserTabsUtil } from '../../utils/BrowserTabsUtil';
 import { PreferencesHandler } from '../../utils/PreferencesHandler';
 import { ProjectAndFileTests } from '../../testsLibrary/ProjectAndFileTests';
+import { TimeoutConstants } from '../../TimeoutConstants';
 
 const projectAndFileTests: ProjectAndFileTests = e2eContainer.get(CLASSES.ProjectAndFileTests);
 const projectTree: ProjectTree = e2eContainer.get(CLASSES.ProjectTree);
 const editor: Editor = e2eContainer.get(CLASSES.Editor);
+const ide: Ide = e2eContainer.get(CLASSES.Ide);
 const browserTabsUtil: BrowserTabsUtil = e2eContainer.get(CLASSES.BrowserTabsUtil);
 const workspaceHandlingTests: WorkspaceHandlingTests = e2eContainer.get(CLASSES.WorkspaceHandlingTests);
 const preferencesHandler: PreferencesHandler = e2eContainer.get(CLASSES.PreferencesHandler);
@@ -45,10 +48,23 @@ suite('The "VscodeXmlPlugin" userstory', async () => {
         projectAndFileTests.waitWorkspaceReadiness(projectName, subRootFolder);
 
         test('Wait until created workspace is started', async () => {
+            WorkspaceHandlingTests.setWorkspaceName(workspaceName);
             CheReporter.registerRunningWorkspace(workspaceName);
 
             await preferencesHandler.setPreferenceUsingUI('application.confirmExit', 'never');
         });
+
+        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);
+        });
+    });
+
+    suite('Check workspace readiness to work', async () => {
+        test('Wait until project is imported', async () => {
+            await projectTree.openProjectTreeContainer();
+            await projectTree.waitProjectImported(projectName, 'app');
+        });
     });
 
     suite('Check the "vscode-xml" plugin', async () => {
@@ -101,7 +117,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

@@ -20,6 +20,8 @@ import { DialogWindow } from '../pageobjects/ide/DialogWindow';
 import { DriverHelper } from '../utils/DriverHelper';
 import { Logger } from '../utils/Logger';
 import { QuickOpenContainer } from '../pageobjects/ide/QuickOpenContainer';
+import { WorkspaceHandlingTests } from './WorkspaceHandlingTests';
+import { BrowserTabsUtil } from '../utils/BrowserTabsUtil';
 
 @injectable()
 export class CodeExecutionTests {
@@ -32,7 +34,9 @@ export class CodeExecutionTests {
         @inject(CLASSES.Ide) private readonly ide: Ide,
         @inject(CLASSES.DialogWindow) private readonly dialogWindow: DialogWindow,
         @inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
-        @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 () => {
@@ -62,6 +66,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);
         });
     }
@@ -103,6 +108,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);
             await this.driverHelper.wait(5_000);
             CodeExecutionTests.lastApplicationUrl = await this.driverHelper.getDriver().getCurrentUrl();
@@ -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');
             await this.driverHelper.wait(5_000);
             CodeExecutionTests.lastApplicationUrl = await this.driverHelper.getDriver().getCurrentUrl();
@@ -126,6 +133,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);
             await this.driverHelper.wait(5_000);
             CodeExecutionTests.lastApplicationUrl = await this.driverHelper.getDriver().getCurrentUrl();

package/testsLibrary/WorkspaceHandlingTests.ts

@@ -15,46 +15,109 @@ 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 { ApiUrlResolver } from '../utils/workspace/ApiUrlResolver';
+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.BrowserTabsUtil) private readonly browserTabsUtil: BrowserTabsUtil,
+        @inject(CLASSES.ApiUrlResolver) private readonly apiUrlResolver: ApiUrlResolver,
+        @inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
+        @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();
+            Logger.debug(`Fetching user kubernetes namespace, storing auth token by getting workspaces API URL.`);
+            await this.apiUrlResolver.getWorkspacesApiUrl();
             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();
+            Logger.debug(`Fetching user kubernetes namespace, storing auth token by getting workspaces API URL.`);
+            await this.apiUrlResolver.getWorkspacesApiUrl();
             await this.dashboard.clickWorkspacesButton();
             await this.workspaces.waitPage();
             await this.workspaces.clickOpenButton(workspaceName);
         });
     }
 
+    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(TimeoutConstants.TS_IDE_LOAD_TIMEOUT);
+                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.debug(`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);

package/utils/requestHandlers/CheApiRequestHandler.ts

@@ -100,7 +100,7 @@ export class CheApiRequestHandler {
     }
 
     async patch(relativeUrl: string, patchParams: object): Promise<AxiosResponse> {
-       return await axios.patch(this.assembleUrl(relativeUrl), patchParams, await this.headerHandler.get());
+        return await axios.patch(this.assembleUrl(relativeUrl), patchParams, await this.headerHandler.get());
     }
 
     private assembleUrl(relativeUrl: string): string {

package/utils/requestHandlers/headers/CheMultiuserAuthorizationHeaderHandler.ts

@@ -12,13 +12,28 @@ import { IAuthorizationHeaderHandler } from './IAuthorizationHeaderHandler';
 import { inject, injectable } from 'inversify';
 import { DriverHelper } from '../../DriverHelper';
 import { CLASSES } from '../../../inversify.types';
+import { Logger } from '../../Logger';
 
 @injectable()
 export class CheMultiuserAuthorizationHeaderHandler implements IAuthorizationHeaderHandler {
+    private authorizationToken: string = '';
+
     constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper) { }
 
     async get(): Promise<AxiosRequestConfig> {
-        let token = await this.driverHelper.getDriver().manage().getCookie('_oauth_proxy');
-        return { headers: { 'cookie': `_oauth_proxy=${token.value}` } };
+        try {
+            let token = await this.driverHelper.getDriver().manage().getCookie('_oauth_proxy');
+            if (this.authorizationToken !== token.value) {
+                this.authorizationToken = token.value;
+            }
+        } catch (err) {
+            if (this.authorizationToken.length > 0) {
+                Logger.warn(`Could not obtain _oauth_proxy cookie from chromedriver, browser session may have been killed. Using stored value.`);
+            } else {
+                throw new Error(`Could not obtain _oauth_proxy cookie from chromedriver, browser session may have been killed. No stored token present!`);
+            }
+        }
+
+        return { headers: { 'cookie': `_oauth_proxy=${this.authorizationToken}` } };
     }
 }

package/utils/workspace/ApiUrlResolver.ts

@@ -1,5 +1,3 @@
-import { IApiUrlResolver } from './IApiUrlResolver';
-
 /*********************************************************************
  * Copyright (c) 2019 Red Hat, Inc.
  *
@@ -9,19 +7,44 @@ import { IApiUrlResolver } from './IApiUrlResolver';
  *
  * SPDX-License-Identifier: EPL-2.0
  **********************************************************************/
-import { injectable } from 'inversify';
-
+import { inject, injectable } from 'inversify';
+import { CLASSES } from '../../inversify.types';
+import { Logger } from '../Logger';
+import { CheApiRequestHandler } from '../requestHandlers/CheApiRequestHandler';
 
 @injectable()
-export class ApiUrlResolver implements IApiUrlResolver {
-    private  dashboardApiUrl: string = 'dashboard/api/namespace';
+export class ApiUrlResolver {
+    private static readonly DASHBOARD_API_URL: string = 'dashboard/api/namespace';
+    private static readonly KUBERNETES_API_URL: string = 'api/kubernetes/namespace';
+
+    private userNamespace: string = '';
 
-    public getWorkspaceApiUrl(namespace: string, workspaceName: string) {
-        return `${this.getWorkspacesApiUrl(namespace)}/${workspaceName}`;
+    constructor(@inject(CLASSES.CheApiRequestHandler) private readonly processRequestHandler: CheApiRequestHandler) {}
+
+    public async getWorkspaceApiUrl(workspaceName: string): Promise<string> {
+        return `${await this.getWorkspacesApiUrl()}/${workspaceName}`;
     }
 
-    public getWorkspacesApiUrl(namespace: string) {
-        return `${this.dashboardApiUrl}/${namespace}-che/devworkspaces`;
+    public async getWorkspacesApiUrl(): Promise<string> {
+        const namespace = await this.obtainUserNamespace();
+        return `${ApiUrlResolver.DASHBOARD_API_URL}/${namespace}/devworkspaces`;
     }
-}
 
+    public getKubernetesApiUrl(): string {
+        return ApiUrlResolver.KUBERNETES_API_URL;
+    }
+
+    private async obtainUserNamespace() : Promise<string> {
+        Logger.debug(`ApiUrlResolver.obtainUserNamespace ${this.userNamespace}`);
+        if (this.userNamespace.length === 0) {
+            Logger.trace(`ApiUrlResolver.obtainUserNamespace USER_NAMESPACE.length = 0, calling kubernetes API`);
+            const kubernetesResponse = await this.processRequestHandler.get(ApiUrlResolver.KUBERNETES_API_URL);
+            if (kubernetesResponse.status !== 200) {
+                throw new Error(`Cannot get user namespace from kubernetes API. Code: ${kubernetesResponse.status} Data: ${kubernetesResponse.data}`);
+            }
+            this.userNamespace = kubernetesResponse.data[0].name;
+            Logger.debug(`ApiUrlResolver.obtainUserNamespace kubeapi success: ${this.userNamespace}`);
+        }
+        return this.userNamespace;
+    }
+}

package/utils/workspace/ITestWorkspaceUtil.ts

@@ -0,0 +1,98 @@
+/*********************************************************************
+ * Copyright (c) 2019 Red Hat, Inc.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+import { WorkspaceStatus } from './WorkspaceStatus';
+import { che } from '@eclipse-che/api';
+
+export interface ITestWorkspaceUtil {
+    waitWorkspaceStatus(namespace: string, workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus) : void;
+
+    stopWorkspaceByName(workspaceName: string) : void;
+
+    /**
+     * Delete a worksapce without stopping phase (similar with force deleting)
+     */
+    deleteWorkspaceByName(workspaceName: string) : void;
+
+    /**
+     * Stop workspace before deleting with checking stopping phase
+     */
+    stopAndDeleteWorkspaceByName(workspaceName: string) : void;
+
+    /**
+     * Stop all run workspaces in the namespace
+     */
+    stopAllRunningWorkspaces(namespace: string) : void;
+
+    /**
+     * Stop all run workspaces, check statused and remove the workspaces
+     */
+    stopAndDeleteAllRunningWorkspaces(namespace: string) : void;
+
+    /**
+     * Stop all run workspaces without stopping and waiting for of 'Stopped' phase
+     * Similar with 'force' deleting
+     */
+    deleteAllWorkspaces(namespace: string) : void;
+
+    /*=====================
+     * DEPRECATED METHODS *
+     *====================*/
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    cleanUpAllWorkspaces() : void;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    cleanUpRunningWorkspace(workspaceName: string) : void;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    waitPluginAdding(namespace: string, workspaceName: string, pluginId: string) : void;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    removeWorkspaceById(id: string) : void;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    stopWorkspaceById(id: string) : void;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    getIdOfRunningWorkspace(workspaceName: string): Promise<string>;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    getIdOfRunningWorkspaces(): Promise<Array<string>>;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    createWsFromDevFile(customTemplate: che.workspace.devfile.Devfile): void;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    getBaseDevfile(): Promise<che.workspace.devfile.Devfile>;
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
+    startWorkspace(workspaceId: string): void;
+}