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

package/utils/requestHandlers/CheApiRequestHandler.ts

@@ -35,6 +35,7 @@ export class CheApiRequestHandler {
                         return request;
                     }
                     request_censored.headers.Authorization = 'CENSORED';
+                    request_censored.headers.Cookie = 'CENSORED';
                     Logger.info(`RequestHandler request:\n` + request_censored);
                 } catch (err) {
                     Logger.error(`RequestHandler request: Failed to deep clone AxiosRequestConfig:` + err);
@@ -69,6 +70,7 @@ export class CheApiRequestHandler {
                         return response;
                     }
                     response_censored.config.headers.Authorization = 'CENSORED';
+                    response_censored.config.headers.Cookie = 'CENSORED';
                     if (response_censored.data.access_token != null) {
                         response_censored.data.access_token = 'CENSORED';
                     }
@@ -97,6 +99,10 @@ export class CheApiRequestHandler {
         return await axios.delete(this.assembleUrl(relativeUrl), await this.headerHandler.get());
     }
 
+    async patch(relativeUrl: string, patchParams: object): Promise<AxiosResponse> {
+       return await axios.patch(this.assembleUrl(relativeUrl), patchParams, await this.headerHandler.get());
+    }
+
     private assembleUrl(relativeUrl: string): string {
         return `${TestConstants.TS_SELENIUM_BASE_URL}/${relativeUrl}`;
     }

package/utils/requestHandlers/headers/CheMultiuserAuthorizationHeaderHandler.ts

@@ -9,13 +9,16 @@
  **********************************************************************/
 import { AxiosRequestConfig } from 'axios';
 import { IAuthorizationHeaderHandler } from './IAuthorizationHeaderHandler';
-import { injectable } from 'inversify';
+import { inject, injectable } from 'inversify';
+import { DriverHelper } from '../../DriverHelper';
+import { CLASSES } from '../../../inversify.types';
 
 @injectable()
 export class CheMultiuserAuthorizationHeaderHandler implements IAuthorizationHeaderHandler {
+    constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper) { }
 
     async get(): Promise<AxiosRequestConfig> {
-        //  to-do : Fetch the cookies from user api and pass it here
-        return { headers: { 'cookie': `` } };
+        let token = await this.driverHelper.getDriver().manage().getCookie('_oauth_proxy');
+        return { headers: { 'cookie': `_oauth_proxy=${token.value}` } };
     }
 }

package/utils/workspace/ApiUrlResolver.ts

@@ -0,0 +1,27 @@
+import { IApiUrlResolver } from './IApiUrlResolver';
+
+/*********************************************************************
+ * 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 { injectable } from 'inversify';
+
+
+@injectable()
+export class ApiUrlResolver implements IApiUrlResolver {
+    private  dashboardApiUrl: string = 'dashboard/api/namespace';
+
+    public getWorkspaceApiUrl(namespace: string, workspaceName: string) {
+        return `${this.getWorkspacesApiUrl(namespace)}/${workspaceName}`;
+    }
+
+    public getWorkspacesApiUrl(namespace: string) {
+        return `${this.dashboardApiUrl}/${namespace}-che/devworkspaces`;
+    }
+}
+

package/utils/workspace/IApiUrlResolver.ts

@@ -0,0 +1,15 @@
+/*********************************************************************
+ * 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
+ **********************************************************************/
+
+export interface IApiUrlResolver {
+    getWorkspaceApiUrl(namespace: string, workspacename: string): string;
+    getWorkspacesApiUrl(namespace: string): string;
+
+}

package/utils/workspace/TestWorkspaceUtil.ts

@@ -12,52 +12,158 @@ import { che } from '@eclipse-che/api';
 import { TestConstants } from '../../TestConstants';
 import { injectable, inject } from 'inversify';
 import { DriverHelper } from '../DriverHelper';
+import { ApiUrlResolver } from './ApiUrlResolver';
 import 'reflect-metadata';
 import { WorkspaceStatus } from './WorkspaceStatus';
-import { ITestWorkspaceUtil } from './ITestWorkspaceUtil';
 import { error } from 'selenium-webdriver';
 import { CheApiRequestHandler } from '../requestHandlers/CheApiRequestHandler';
 import { CLASSES } from '../../inversify.types';
 import { Logger } from '../Logger';
+import axios from 'axios';
 
 @injectable()
-export class TestWorkspaceUtil implements ITestWorkspaceUtil {
-
-    static readonly WORKSPACE_API_URL: string = 'api/workspace';
+export class TestWorkspaceUtil {
 
+    static readonly WORKSPACE_API_URL: string = 'dashboard/api/namespace';
+    readonly attempts: number = TestConstants.TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS;
+    readonly polling: number = TestConstants.TS_SELENIUM_WORKSPACE_STATUS_POLLING;
     constructor(
         @inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
-        @inject(CLASSES.CheApiRequestHandler) private readonly processRequestHandler: CheApiRequestHandler
+        @inject(CLASSES.CheApiRequestHandler) private readonly processRequestHandler: CheApiRequestHandler,
+        @inject(CLASSES.ApiUrlResolver) private readonly apiUrlResolver: ApiUrlResolver
     ) { }
 
     public async waitWorkspaceStatus(namespace: string, workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus) {
         Logger.debug('TestWorkspaceUtil.waitWorkspaceStatus');
 
-        const workspaceStatusApiUrl: string = `${TestWorkspaceUtil.WORKSPACE_API_URL}/${namespace}:${workspaceName}`;
-        const attempts: number = TestConstants.TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS;
-        const polling: number = TestConstants.TS_SELENIUM_WORKSPACE_STATUS_POLLING;
         let workspaceStatus: string = '';
-
-        for (let i = 0; i < attempts; i++) {
-            const response = await this.processRequestHandler.get(workspaceStatusApiUrl);
+        let expectedStatus: boolean = false;
+        for (let i = 0; i < this.attempts; i++) {
+            const response = await this.processRequestHandler.get(this.apiUrlResolver.getWorkspaceApiUrl(namespace, workspaceName));
 
             if (response.status !== 200) {
-                await this.driverHelper.wait(polling);
-                continue;
+                throw new Error(`Can not get status of a workspace. Code: ${response.status} Data: ${response.data}`);
             }
 
-            workspaceStatus = await response.data.status;
+            workspaceStatus = await response.data.status.phase;
 
             if (workspaceStatus === expectedWorkspaceStatus) {
-                return;
+                expectedStatus = true;
+                break;
             }
 
-            await this.driverHelper.wait(polling);
+            await this.driverHelper.wait(this.polling);
         }
 
-        throw new error.TimeoutError(`Exceeded the maximum number of checking attempts, workspace status is: '${workspaceStatus}' different to '${expectedWorkspaceStatus}'`);
+        if (!expectedStatus) {
+            let waitTime = this.attempts * this.polling;
+            throw new error.TimeoutError(`The workspace was not stopped in ${waitTime} ms. Currnet status is: ${workspaceStatus}`);
+        }
     }
 
+    public async stopWorkspaceByName(namespace: string, workspaceName: string) {
+        Logger.debug('TestWorkspaceUtil.stopWorkspaceByName');
+
+        const stopWorkspaceApiUrl: string = this.apiUrlResolver.getWorkspaceApiUrl(namespace, workspaceName);
+        let stopWorkspaceResponse;
+
+        try {
+            stopWorkspaceResponse = await this.processRequestHandler.patch(stopWorkspaceApiUrl, [{'op': 'replace', 'path': '/spec/started', 'value': false}]);
+        } catch (err) {
+            console.log(`Stop workspace call failed. URL used: ${stopWorkspaceApiUrl}`);
+            throw err;
+        }
+
+        if (stopWorkspaceResponse.status !== 200) {
+            throw new Error(`Cannot stop workspace. Code: ${stopWorkspaceResponse.status} Data: ${stopWorkspaceResponse.data}`);
+        }
+
+        await this.waitWorkspaceStatus(namespace, workspaceName, WorkspaceStatus.STOPPED);
+    }
+
+    // delete a worksapce without stopping phase (similar with force deleting)
+    public async deleteWorkspaceByName(namespace: string, workspaceName: string) {
+        Logger.debug(`TestWorkspaceUtil.deleteWorkspaceByName ${workspaceName}` );
+
+        const deleteWorkspaceApiUrl: string = this.apiUrlResolver.getWorkspaceApiUrl(namespace, workspaceName);
+        let deleteWorkspaceResponse;
+        let deleteWorkspaceStatus: boolean = false;
+        try {
+            deleteWorkspaceResponse = await this.processRequestHandler.delete(deleteWorkspaceApiUrl);
+        } catch (error) {
+            if (axios.isAxiosError(error) && error.response?.status === 404) {
+                Logger.error(`The workspace :${workspaceName} not found`);
+                throw error;
+            }
+            Logger.error(`Delete workspace call failed. URL used: ${deleteWorkspaceStatus}`);
+            throw error;
+        }
+
+        if (deleteWorkspaceResponse.status !== 204) {
+            throw new Error(`Can not delete workspace. Code: ${deleteWorkspaceResponse.status} Data: ${deleteWorkspaceResponse.data}`);
+        }
+
+        for (let i = 0; i < this.attempts; i++) {
+            try {
+                deleteWorkspaceResponse = await this.processRequestHandler.get(deleteWorkspaceApiUrl);
+            } catch (error) {
+                if (axios.isAxiosError(error) && error.response?.status === 404) {
+                    deleteWorkspaceStatus = true;
+                    break;
+                }
+            }
+        }
+
+        if (!deleteWorkspaceStatus) {
+            let waitTime = this.attempts * this.polling;
+            throw new error.TimeoutError(`The workspace was not stopped in ${waitTime} ms.`);
+        }
+    }
+
+    // stop workspace before deleting with checking stopping phase
+    public async stopAndDeleteWorkspaceByName(namespace: string, workspaceName: string) {
+        Logger.debug('TestWorkspaceUtil.stopAndDeleteWorkspaceByName');
+
+        await this.stopWorkspaceByName(namespace, workspaceName);
+        await this.deleteWorkspaceByName(namespace, workspaceName);
+    }
+
+    // stop all run workspaces in the namespace
+    public async stopAllRunningWorkspaces(namespace: string) {
+        Logger.debug('TestWorkspaceUtil.stopAllRunProjects');
+        let response = await this.processRequestHandler.get(this.apiUrlResolver.getWorkspacesApiUrl(namespace));
+        for (let i = 0; i < response.data.items.length; i++) {
+            Logger.info('The project is being stopped: ' +  response.data.items[i].metadata.name);
+            await this.stopWorkspaceByName(namespace, response.data.items[i].metadata.name);
+        }
+    }
+
+    // stop all run workspaces, check statused and remove the workspaces
+    public async stopAndDeleteAllRunningWorkspaces(namespace: string) {
+        Logger.debug('TestWorkspaceUtil.stopAndDeleteAllRunProjects');
+        let response = await this.processRequestHandler.get(this.apiUrlResolver.getWorkspacesApiUrl(namespace));
+        await this.stopAllRunningWorkspaces(namespace);
+        for (let i = 0; i < response.data.items.length; i++) {
+            Logger.info('The project is being deleted: ' +  response.data.items[i].metadata.name);
+            await this.deleteWorkspaceByName(namespace, response.data.items[i].metadata.name);
+        }
+    }
+
+    // stop all run workspaces without stopping and waiting for of 'Stopped' phase
+    // similar with 'force' deleting
+    public async deleteAllWorkspaces(namespace: string) {
+        Logger.debug('TestWorkspaceUtil.deleteAllRunProjects');
+        let response = await this.processRequestHandler.get(this.apiUrlResolver.getWorkspacesApiUrl(namespace));
+
+        for (let i = 0; i < response.data.items.length; i++) {
+            Logger.info('The project is being deleted .......: ' +  response.data.items[i].metadata.name);
+            await this.deleteWorkspaceByName(namespace, response.data.items[i].metadata.name);
+        }
+    }
+
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async waitPluginAdding(namespace: string, workspaceName: string, pluginName: string) {
         Logger.debug('TestWorkspaceUtil.waitPluginAdding');
 
@@ -88,6 +194,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async getListOfWorkspaceId(): Promise<string[]> {
         Logger.debug('TestWorkspaceUtil.getListOfWorkspaceId');
 
@@ -109,6 +218,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         return wsList;
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async getIdOfRunningWorkspace(wsName: string): Promise<string> {
         Logger.debug('TestWorkspaceUtil.getIdOfRunningWorkspace');
 
@@ -117,6 +229,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
 
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async getIdOfRunningWorkspaces(): Promise<Array<string>> {
         Logger.debug('TestWorkspaceUtil.getIdOfRunningWorkspaces');
 
@@ -144,13 +259,15 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async removeWorkspaceById(id: string) {
         Logger.debug('TestWorkspaceUtil.removeWorkspaceById');
 
         const workspaceIdUrl: string = `${TestWorkspaceUtil.WORKSPACE_API_URL}/${id}`;
         try {
             const deleteWorkspaceResponse = await this.processRequestHandler.delete(workspaceIdUrl);
-            // response code 204: "No Content" expected
             if (deleteWorkspaceResponse.status !== 204) {
                 throw new Error(`Can not remove workspace. Code: ${deleteWorkspaceResponse.status} Data: ${deleteWorkspaceResponse.data}`);
             }
@@ -160,6 +277,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async stopWorkspaceById(id: string) {
         Logger.debug('TestWorkspaceUtil.stopWorkspaceById');
 
@@ -167,20 +287,13 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         let stopWorkspaceResponse;
 
         try {
-            stopWorkspaceResponse = await this.processRequestHandler.delete(`${stopWorkspaceApiUrl}/runtime`);
+            stopWorkspaceResponse = await this.processRequestHandler.delete(`${stopWorkspaceApiUrl}`);
         } catch (err) {
-            console.log(`Stop workspace call failed. URL used: ${stopWorkspaceApiUrl}/runtime`);
+            console.log(`Stop workspace call failed. URL used: ${stopWorkspaceApiUrl}`);
             throw err;
         }
 
-        // if workspace is already stopped, it will return 409: "Conflict"
-        if (stopWorkspaceResponse.status === 409) {
-            Logger.warn(`TestWorkspaceUtil.stopWorkspaceById Workspace {${id}} is already STOPPED`);
-            return;
-        }
-
-        // response code 204: "No Content" expected
-        if (stopWorkspaceResponse.status !== 204) {
+        if (stopWorkspaceResponse.status !== 200) {
             throw new Error(`Can not stop workspace. Code: ${stopWorkspaceResponse.status} Data: ${stopWorkspaceResponse.data}`);
         }
 
@@ -188,7 +301,7 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         let wsStatus = await this.processRequestHandler.get(stopWorkspaceApiUrl);
         for (let i = 0; i < TestConstants.TS_SELENIUM_PLUGIN_PRECENCE_ATTEMPTS; i++) {
             wsStatus = await this.processRequestHandler.get(stopWorkspaceApiUrl);
-            if (wsStatus.data.status === 'STOPPED') {
+            if (wsStatus.data.status === WorkspaceStatus.STOPPED) {
                 stopped = true;
                 break;
             }
@@ -201,6 +314,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async cleanUpAllWorkspaces() {
         Logger.debug('TestWorkspaceUtil.cleanUpAllWorkspaces');
 
@@ -217,6 +333,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
 
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     public async cleanUpRunningWorkspace(workspaceName: string) {
         if (workspaceName === undefined || workspaceName.length === 0) {
           Logger.warn(`Could nod delete workspace because workspaceName is undefined or empty`);
@@ -237,6 +356,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         await this.removeWorkspaceById(workspaceID);
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     async createWsFromDevFile(customTemplate: che.workspace.devfile.Devfile) {
         Logger.debug('TestWorkspaceUtil.createWsFromDevFile');
 
@@ -248,6 +370,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     async getBaseDevfile(): Promise<che.workspace.devfile.Devfile> {
         Logger.debug('TestWorkspaceUtil.getBaseDevfile');
 
@@ -261,6 +386,9 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         return baseDevfile;
     }
 
+    /**
+     * @deprecated Method deprecated. Works with CHE server only
+     */
     async startWorkspace(workspaceId: string) {
         Logger.debug('TestWorkspaceUtil.startWorkspace');
 

package/utils/workspace/WorkspaceStatus.ts

@@ -9,7 +9,7 @@
  **********************************************************************/
 
  export enum WorkspaceStatus {
-    RUNNING = 'RUNNING',
-    STOPPED = 'STOPPED',
-    STARTING = 'STARTING'
+    RUNNING = 'Running',
+    STOPPED = 'Stopped',
+    STARTING = 'Starting'
 }

package/utils/workspace/ITestWorkspaceUtil.ts

@@ -1,26 +0,0 @@
-/*********************************************************************
- * 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 {
-    cleanUpAllWorkspaces() : void;
-    cleanUpRunningWorkspace(workspaceName: string) : void;
-    waitWorkspaceStatus(namespace: string, workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus) : void;
-    waitPluginAdding(namespace: string, workspaceName: string, pluginId: string) : void;
-    removeWorkspaceById(id: string) : void;
-    stopWorkspaceById(id: string) : void;
-    getIdOfRunningWorkspace(workspaceName: string): Promise<string>;
-    getIdOfRunningWorkspaces(): Promise<Array<string>>;
-    createWsFromDevFile(customTemplate: che.workspace.devfile.Devfile): void;
-    getBaseDevfile(): Promise<che.workspace.devfile.Devfile>;
-    startWorkspace(workspaceId: string): void;
-}