@eclipse-che/che-e2e 7.124.0-next → 7.124.0-next-6307b25

package/dist/utils/workspace/TestWorkspaceUtil.js

@@ -0,0 +1,212 @@
+"use strict";
+/** *******************************************************************
+ * copyright (c) 2019-2023 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
+ **********************************************************************/
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestWorkspaceUtil = void 0;
+require("reflect-metadata");
+const inversify_1 = require("inversify");
+const DriverHelper_1 = require("../DriverHelper");
+const WorkspaceStatus_1 = require("./WorkspaceStatus");
+const selenium_webdriver_1 = require("selenium-webdriver");
+const CheApiRequestHandler_1 = require("../request-handlers/CheApiRequestHandler");
+const inversify_types_1 = require("../../configs/inversify.types");
+const Logger_1 = require("../Logger");
+const axios_1 = __importDefault(require("axios"));
+const ApiUrlResolver_1 = require("./ApiUrlResolver");
+const TIMEOUT_CONSTANTS_1 = require("../../constants/TIMEOUT_CONSTANTS");
+let TestWorkspaceUtil = class TestWorkspaceUtil {
+    constructor(driverHelper, processRequestHandler, apiUrlResolver) {
+        this.driverHelper = driverHelper;
+        this.processRequestHandler = processRequestHandler;
+        this.apiUrlResolver = apiUrlResolver;
+        this.polling = TIMEOUT_CONSTANTS_1.TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
+        this.attempts = TIMEOUT_CONSTANTS_1.TIMEOUT_CONSTANTS.TS_DASHBOARD_WORKSPACE_STOP_TIMEOUT / this.polling;
+    }
+    async waitWorkspaceStatus(workspaceName, expectedWorkspaceStatus) {
+        Logger_1.Logger.debug();
+        const workspaceApiUrl = await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName);
+        let workspaceStatus = '';
+        let expectedStatus = false;
+        for (let i = 0; i < this.attempts; i++) {
+            let response;
+            try {
+                response = await this.processRequestHandler.get(workspaceApiUrl);
+            }
+            catch (err) {
+                // handle transient network errors (e.g. socket hang up) by retrying
+                Logger_1.Logger.warn(`waitWorkspaceStatus: transient error polling workspace status, retrying (attempt ${i + 1}): ${err}`);
+                await this.driverHelper.wait(this.polling);
+                continue;
+            }
+            if (response.status !== 200) {
+                throw new Error(`Can not get status of a workspace. Code: ${response.status} Data: ${response.data}`);
+            }
+            workspaceStatus = await response.data.status.phase;
+            if (workspaceStatus === expectedWorkspaceStatus) {
+                expectedStatus = true;
+                break;
+            }
+            await this.driverHelper.wait(this.polling);
+        }
+        if (!expectedStatus) {
+            const waitTime = this.attempts * this.polling;
+            throw new selenium_webdriver_1.error.TimeoutError(`The workspace was not stopped in ${waitTime} ms. Current status is: ${workspaceStatus}`);
+        }
+    }
+    async stopWorkspaceByName(workspaceName) {
+        Logger_1.Logger.debug(`${workspaceName}`);
+        const stopWorkspaceApiUrl = await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName);
+        let stopWorkspaceResponse;
+        try {
+            stopWorkspaceResponse = await this.processRequestHandler.patch(stopWorkspaceApiUrl, [
+                {
+                    op: 'replace',
+                    path: '/spec/started',
+                    value: false
+                }
+            ]);
+        }
+        catch (err) {
+            Logger_1.Logger.error(`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(workspaceName, WorkspaceStatus_1.WorkspaceStatus.STOPPED);
+        Logger_1.Logger.debug(`${workspaceName} stopped successfully`);
+    }
+    // delete a workspace without stopping phase (similar with force deleting)
+    async deleteWorkspaceByName(workspaceName) {
+        Logger_1.Logger.debug(`${workspaceName}`);
+        const deleteWorkspaceApiUrl = await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName);
+        let deleteWorkspaceResponse;
+        let deleteWorkspaceStatus = false;
+        try {
+            deleteWorkspaceResponse = await this.processRequestHandler.delete(deleteWorkspaceApiUrl);
+        }
+        catch (error) {
+            if (axios_1.default.isAxiosError(error) && error.response?.status === 404) {
+                Logger_1.Logger.info(`Workspace ${workspaceName} not found, already deleted`);
+                return;
+            }
+            Logger_1.Logger.error(`delete workspace call failed. URL used: ${deleteWorkspaceApiUrl}`);
+            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);
+                Logger_1.Logger.trace(`GET ${deleteWorkspaceApiUrl} returned status: ${deleteWorkspaceResponse.status}; data: ${deleteWorkspaceResponse.data}`);
+            }
+            catch (error) {
+                if (axios_1.default.isAxiosError(error) && (error.response?.status === 404 || error.response?.status === 500)) {
+                    deleteWorkspaceStatus = true;
+                    Logger_1.Logger.debug(`${workspaceName} deleted successfully`);
+                    break;
+                }
+                Logger_1.Logger.trace(`GET ${deleteWorkspaceApiUrl} threw error: ${error}`);
+            }
+            await this.driverHelper.wait(this.polling);
+        }
+        if (!deleteWorkspaceStatus) {
+            const waitTime = this.attempts * this.polling;
+            throw new selenium_webdriver_1.error.TimeoutError(`The workspace was not deleted in ${waitTime} ms.`);
+        }
+    }
+    // stop workspace before deleting with checking stopping phase
+    async stopAndDeleteWorkspaceByName(workspaceName) {
+        Logger_1.Logger.debug();
+        await this.stopWorkspaceByName(workspaceName);
+        await this.deleteWorkspaceByName(workspaceName);
+    }
+    // stop all run workspaces in the namespace
+    async stopAllRunningWorkspaces() {
+        Logger_1.Logger.debug();
+        const response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
+        for (let i = 0; i < response.data.items.length; i++) {
+            Logger_1.Logger.info('the project is being stopped: ' + response.data.items[i].metadata.name);
+            await this.stopWorkspaceByName(response.data.items[i].metadata.name);
+        }
+    }
+    // stop all run workspaces, check statuses and remove the workspaces
+    async stopAndDeleteAllRunningWorkspaces() {
+        Logger_1.Logger.debug();
+        const response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
+        await this.stopAllRunningWorkspaces();
+        for (let i = 0; i < response.data.items.length; i++) {
+            Logger_1.Logger.info('the project is being deleted: ' + response.data.items[i].metadata.name);
+            await this.deleteWorkspaceByName(response.data.items[i].metadata.name);
+        }
+    }
+    // stop all run workspaces without stopping and waiting for of 'Stopped' phase
+    // similar with 'force' deleting
+    async deleteAllWorkspaces() {
+        Logger_1.Logger.debug();
+        const response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
+        for (let i = 0; i < response.data.items.length; i++) {
+            Logger_1.Logger.info('the project is being deleted .......: ' + response.data.items[i].metadata.name);
+            await this.deleteWorkspaceByName(response.data.items[i].metadata.name);
+        }
+    }
+    /**
+     * set user preferences for Che   "security.workspace.trust.enabled": false using JS. in background mode
+     */
+    async switchOffTrustDialogWithJavaScript() {
+        const javaScriptExecCode = '(async function importData() {\n' +
+            '  const stub = "{\\"vscode-web-db\\":{\\"vscode-userdata-store\\":{\\"/User/settings.json\\":{\\"type\\":\\"Uint8Array\\",\\"value\\":\\"%7B%0A%20%20%20%20%22security.workspace.trust.enabled%22%3A%20false%0A%7D\\"}}}}";\n' +
+            '  for (const [dbName, dbData] of Object.entries(JSON.parse(stub))) {\n' +
+            '    const req = indexedDB.open(dbName);\n' +
+            '    req.onupgradeneeded = ({ target: { result: db } }) =>\n' +
+            '      Object.keys(dbData).forEach((name) => db.createObjectStore(name));\n' +
+            '    await new Promise((r) => (req.onsuccess = r));\n' +
+            '    for (const [storeName, storeData] of Object.entries(dbData)) {\n' +
+            '      const transaction = req.result.transaction(storeName, "readwrite");\n' +
+            '      const store = transaction.objectStore(storeName);\n' +
+            '      store.clear();\n' +
+            '      for (const [key, { type, value }] of Object.entries(storeData)) {\n' +
+            '        const str = decodeURIComponent(value);\n' +
+            '        store.put(type === "String" ? str : new TextEncoder().encode(str), key);\n' +
+            '      }\n' +
+            '      await new Promise((r) => (transaction.oncomplete = r));\n' +
+            '    }\n' +
+            '  }\n' +
+            '})().then(() => {});';
+        await this.driverHelper.getDriver().executeScript(javaScriptExecCode);
+    }
+};
+TestWorkspaceUtil = __decorate([
+    (0, inversify_1.injectable)(),
+    __param(0, (0, inversify_1.inject)(inversify_types_1.CLASSES.DriverHelper)),
+    __param(1, (0, inversify_1.inject)(inversify_types_1.CLASSES.CheApiRequestHandler)),
+    __param(2, (0, inversify_1.inject)(inversify_types_1.CLASSES.ApiUrlResolver)),
+    __metadata("design:paramtypes", [DriverHelper_1.DriverHelper,
+        CheApiRequestHandler_1.CheApiRequestHandler,
+        ApiUrlResolver_1.ApiUrlResolver])
+], TestWorkspaceUtil);
+exports.TestWorkspaceUtil = TestWorkspaceUtil;
+//# sourceMappingURL=TestWorkspaceUtil.js.map

package/dist/utils/workspace/TestWorkspaceUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestWorkspaceUtil.js","sourceRoot":"","sources":["../../../utils/workspace/TestWorkspaceUtil.ts"],"names":[],"mappings":";AAAA;;;;;;;;wEAQwE;;;;;;;;;;;;;;;;;;AAExE,4BAA0B;AAC1B,yCAA+C;AAC/C,kDAA+C;AAC/C,uDAAoD;AACpD,2DAA2C;AAC3C,mFAAgF;AAChF,mEAAwD;AACxD,sCAAmC;AACnC,kDAA6C;AAE7C,qDAAkD;AAClD,yEAAsE;AAG/D,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAI7B,YAEkB,YAA0B,EAE1B,qBAA2C,EAE3C,cAA8B;QAJ9B,iBAAY,GAAZ,YAAY,CAAc;QAE1B,0BAAqB,GAArB,qBAAqB,CAAsB;QAE3C,mBAAc,GAAd,cAAc,CAAgB;QATvC,YAAO,GAAW,qCAAiB,CAAC,2BAA2B,CAAC;QAChE,aAAQ,GAAW,qCAAiB,CAAC,mCAAmC,GAAG,IAAI,CAAC,OAAO,CAAC;IAS9F,CAAC;IAEJ,KAAK,CAAC,mBAAmB,CAAC,aAAqB,EAAE,uBAAwC;QACxF,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,MAAM,eAAe,GAAW,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAC5F,IAAI,eAAe,GAAW,EAAE,CAAC;QACjC,IAAI,cAAc,GAAY,KAAK,CAAC;QACpC,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI,QAAuB,CAAC;YAC5B,IAAI;gBACH,QAAQ,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;aACjE;YAAC,OAAO,GAAG,EAAE;gBACb,oEAAoE;gBACpE,eAAM,CAAC,IAAI,CAAC,oFAAoF,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;gBAClH,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC3C,SAAS;aACT;YAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC5B,MAAM,IAAI,KAAK,CAAC,4CAA4C,QAAQ,CAAC,MAAM,UAAU,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;aACtG;YAED,eAAe,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAEnD,IAAI,eAAe,KAAK,uBAAuB,EAAE;gBAChD,cAAc,GAAG,IAAI,CAAC;gBACtB,MAAM;aACN;YAED,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC3C;QAED,IAAI,CAAC,cAAc,EAAE;YACpB,MAAM,QAAQ,GAAW,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACtD,MAAM,IAAI,0BAAK,CAAC,YAAY,CAAC,oCAAoC,QAAQ,2BAA2B,eAAe,EAAE,CAAC,CAAC;SACvH;IACF,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,aAAqB;QAC9C,eAAM,CAAC,KAAK,CAAC,GAAG,aAAa,EAAE,CAAC,CAAC;QAEjC,MAAM,mBAAmB,GAAW,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAChG,IAAI,qBAAoC,CAAC;QAEzC,IAAI;YACH,qBAAqB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,mBAAmB,EAAE;gBACnF;oBACC,EAAE,EAAE,SAAS;oBACb,IAAI,EAAE,eAAe;oBACrB,KAAK,EAAE,KAAK;iBACZ;aACD,CAAC,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACb,eAAM,CAAC,KAAK,CAAC,yCAAyC,mBAAmB,EAAE,CAAC,CAAC;YAC7E,MAAM,GAAG,CAAC;SACV;QAED,IAAI,qBAAqB,CAAC,MAAM,KAAK,GAAG,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,gCAAgC,qBAAqB,CAAC,MAAM,UAAU,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;SACpH;QAED,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,iCAAe,CAAC,OAAO,CAAC,CAAC;QACvE,eAAM,CAAC,KAAK,CAAC,GAAG,aAAa,uBAAuB,CAAC,CAAC;IACvD,CAAC;IAED,0EAA0E;IAC1E,KAAK,CAAC,qBAAqB,CAAC,aAAqB;QAChD,eAAM,CAAC,KAAK,CAAC,GAAG,aAAa,EAAE,CAAC,CAAC;QAEjC,MAAM,qBAAqB,GAAW,MAAM,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAClG,IAAI,uBAAsC,CAAC;QAC3C,IAAI,qBAAqB,GAAY,KAAK,CAAC;QAC3C,IAAI;YACH,uBAAuB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;SACzF;QAAC,OAAO,KAAK,EAAE;YACf,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE;gBAChE,eAAM,CAAC,IAAI,CAAC,aAAa,aAAa,6BAA6B,CAAC,CAAC;gBACrE,OAAO;aACP;YACD,eAAM,CAAC,KAAK,CAAC,2CAA2C,qBAAqB,EAAE,CAAC,CAAC;YACjF,MAAM,KAAK,CAAC;SACZ;QAED,IAAI,uBAAuB,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3C,MAAM,IAAI,KAAK,CAAC,mCAAmC,uBAAuB,CAAC,MAAM,UAAU,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;SAC3H;QAED,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI;gBACH,uBAAuB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;gBACtF,eAAM,CAAC,KAAK,CACX,OAAO,qBAAqB,qBAAqB,uBAAuB,CAAC,MAAM,WAAW,uBAAuB,CAAC,IAAI,EAAE,CACxH,CAAC;aACF;YAAC,OAAO,KAAK,EAAE;gBACf,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,CAAC,EAAE;oBACpG,qBAAqB,GAAG,IAAI,CAAC;oBAC7B,eAAM,CAAC,KAAK,CAAC,GAAG,aAAa,uBAAuB,CAAC,CAAC;oBACtD,MAAM;iBACN;gBACD,eAAM,CAAC,KAAK,CAAC,OAAO,qBAAqB,iBAAiB,KAAK,EAAE,CAAC,CAAC;aACnE;YACD,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC3C;QAED,IAAI,CAAC,qBAAqB,EAAE;YAC3B,MAAM,QAAQ,GAAW,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACtD,MAAM,IAAI,0BAAK,CAAC,YAAY,CAAC,oCAAoC,QAAQ,MAAM,CAAC,CAAC;SACjF;IACF,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,4BAA4B,CAAC,aAAqB;QACvD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;IACjD,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,wBAAwB;QAC7B,eAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,QAAQ,GAAkB,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACtH,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5D,eAAM,CAAC,IAAI,CAAC,gCAAgC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrF,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SACrE;IACF,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,iCAAiC;QACtC,eAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,QAAQ,GAAkB,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACtH,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACtC,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5D,eAAM,CAAC,IAAI,CAAC,gCAAgC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrF,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SACvE;IACF,CAAC;IAED,8EAA8E;IAC9E,gCAAgC;IAChC,KAAK,CAAC,mBAAmB;QACxB,eAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,QAAQ,GAAkB,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC;QAEtH,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5D,eAAM,CAAC,IAAI,CAAC,wCAAwC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7F,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SACvE;IACF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kCAAkC;QACvC,MAAM,kBAAkB,GACvB,kCAAkC;YAClC,+NAA+N;YAC/N,wEAAwE;YACxE,2CAA2C;YAC3C,6DAA6D;YAC7D,4EAA4E;YAC5E,sDAAsD;YACtD,sEAAsE;YACtE,6EAA6E;YAC7E,2DAA2D;YAC3D,wBAAwB;YACxB,2EAA2E;YAC3E,kDAAkD;YAClD,oFAAoF;YACpF,WAAW;YACX,iEAAiE;YACjE,SAAS;YACT,OAAO;YACP,sBAAsB,CAAC;QACxB,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;IACvE,CAAC;CACD,CAAA;AA7LY,iBAAiB;IAD7B,IAAA,sBAAU,GAAE;IAMV,WAAA,IAAA,kBAAM,EAAC,yBAAO,CAAC,YAAY,CAAC,CAAA;IAE5B,WAAA,IAAA,kBAAM,EAAC,yBAAO,CAAC,oBAAoB,CAAC,CAAA;IAEpC,WAAA,IAAA,kBAAM,EAAC,yBAAO,CAAC,cAAc,CAAC,CAAA;qCAHA,2BAAY;QAEH,2CAAoB;QAE3B,+BAAc;GAVpC,iBAAiB,CA6L7B;AA7LY,8CAAiB"}

package/dist/utils/workspace/WorkspaceStatus.js

@@ -0,0 +1,19 @@
+"use strict";
+/** *******************************************************************
+ * copyright (c) 2019-2023 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
+ **********************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceStatus = void 0;
+var WorkspaceStatus;
+(function (WorkspaceStatus) {
+    WorkspaceStatus["RUNNING"] = "Running";
+    WorkspaceStatus["STOPPED"] = "Stopped";
+    WorkspaceStatus["STARTING"] = "Starting";
+})(WorkspaceStatus = exports.WorkspaceStatus || (exports.WorkspaceStatus = {}));
+//# sourceMappingURL=WorkspaceStatus.js.map

package/dist/utils/workspace/WorkspaceStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkspaceStatus.js","sourceRoot":"","sources":["../../../utils/workspace/WorkspaceStatus.ts"],"names":[],"mappings":";AAAA;;;;;;;;wEAQwE;;;AAExE,IAAY,eAIX;AAJD,WAAY,eAAe;IAC1B,sCAAmB,CAAA;IACnB,sCAAmB,CAAA;IACnB,wCAAqB,CAAA;AACtB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}

package/index.ts

@@ -5,19 +5,19 @@ export * from './configs/mocharc';
 export * from './driver/ChromeDriver';
 export * from './driver/IDriver';
 export * from './utils/BrowserTabsUtil';
-export * from './utils/DevfilesHelper';
 export * from './utils/DevWorkspaceConfigurationHelper';
+export * from './utils/DevfilesHelper';
 export * from './utils/DriverHelper';
 export * from './utils/IContextParams';
 export * from './utils/IKubernetesCommandLineToolsExecutor';
 export * from './utils/KubernetesCommandLineToolsExecutor';
 export * from './utils/Logger';
-export * from './utils/request-handlers/CheApiRequestHandler';
-export * from './utils/request-handlers/headers/CheMultiuserAuthorizationHeaderHandler';
-export * from './utils/request-handlers/headers/IAuthorizationHeaderHandler';
 export * from './utils/ScreenCatcher';
 export * from './utils/ShellExecutor';
 export * from './utils/StringUtil';
+export * from './utils/request-handlers/CheApiRequestHandler';
+export * from './utils/request-handlers/headers/CheMultiuserAuthorizationHeaderHandler';
+export * from './utils/request-handlers/headers/IAuthorizationHeaderHandler';
 export * from './utils/workspace/ApiUrlResolver';
 export * from './utils/workspace/ITestWorkspaceUtil';
 export * from './utils/workspace/TestWorkspaceUtil';
@@ -26,8 +26,8 @@ export * from './pageobjects/dashboard/CreateWorkspace';
 export * from './pageobjects/dashboard/Dashboard';
 export * from './pageobjects/dashboard/TrustAuthorPopup';
 export * from './pageobjects/dashboard/UserPreferences';
-export * from './pageobjects/dashboard/workspace-details/WorkspaceDetails';
 export * from './pageobjects/dashboard/Workspaces';
+export * from './pageobjects/dashboard/workspace-details/WorkspaceDetails';
 export * from './pageobjects/git-providers/OauthPage';
 export * from './pageobjects/ide/AiCodeSignInDialog';
 export * from './pageobjects/ide/CheCodeLocatorLoader';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@eclipse-che/che-e2e",
-	"version": "7.124.0-next",
+	"version": "7.124.0-next-6307b25",
 	"description": "",
 	"main": "dist/index.js",
 	"scripts": {

package/pageobjects/dashboard/CreateWorkspace.ts

@@ -28,6 +28,10 @@ export class CreateWorkspace {
 	private static readonly CREATE_NEW_WORKPACE_CHECKBOX: By = By.css('label[for="create-new-if-exist-switch"]');
 	private static readonly CREATE_NEW_WORKPACE_CHECKBOX_VALUE: By = By.id('create-new-if-exist-switch');
 
+	private static readonly AI_PROVIDER_SELECTOR_HEADING: By = By.xpath('//h3[text()="AI Provider Selector"]');
+	private static readonly AI_PROVIDER_CHOOSE_TOGGLE: By = By.id('accordion-item-ai-selector');
+	private static readonly AI_PROVIDER_KEY_CONFIGURED_BADGE: By = By.xpath('//span[text()=" Key configured"]');
+
 	constructor(
 		@inject(CLASSES.DriverHelper)
 		private readonly driverHelper: DriverHelper,
@@ -186,6 +190,47 @@ export class CreateWorkspace {
 		await this.driverHelper.scrollToAndClick(CreateWorkspace.CREATE_NEW_WORKPACE_CHECKBOX, timeout);
 	}
 
+	async waitAiProviderSectionVisible(timeout: number = TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT): Promise<void> {
+		Logger.debug();
+
+		await this.driverHelper.waitVisibility(CreateWorkspace.AI_PROVIDER_SELECTOR_HEADING, timeout);
+	}
+
+	async expandChooseAiProviderSection(): Promise<void> {
+		Logger.debug();
+
+		const toggle: By = CreateWorkspace.AI_PROVIDER_CHOOSE_TOGGLE;
+		await this.driverHelper.waitAndClick(toggle);
+		await this.driverHelper.waitAttributeValue(toggle, 'aria-expanded', 'true', TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT);
+	}
+
+	async isAiProviderSectionVisible(): Promise<boolean> {
+		Logger.debug();
+
+		return await this.driverHelper.isVisible(CreateWorkspace.AI_PROVIDER_SELECTOR_HEADING);
+	}
+
+	async isAiProviderCardVisible(providerId: string): Promise<boolean> {
+		Logger.debug(`providerId: "${providerId}"`);
+
+		return await this.driverHelper.isVisible(this.getAiProviderCardLocator(providerId));
+	}
+
+	async waitAiProviderCardVisible(
+		providerId: string,
+		timeout: number = TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT
+	): Promise<void> {
+		Logger.debug(`providerId: "${providerId}"`);
+
+		await this.driverHelper.waitVisibility(this.getAiProviderCardLocator(providerId), timeout);
+	}
+
+	async isAiProviderKeyConfiguredBadgeVisible(): Promise<boolean> {
+		Logger.debug();
+
+		return await this.driverHelper.isVisible(CreateWorkspace.AI_PROVIDER_KEY_CONFIGURED_BADGE);
+	}
+
 	private getEditorsDropdownListLocator(sampleName: string): By {
 		return By.xpath(`//div[text()=\'${sampleName}\']//parent::article//button`);
 	}
@@ -215,6 +260,11 @@ export class CreateWorkspace {
 		return By.xpath(`//div[contains(@id, 'sample-card') and text()='${sampleName}']`);
 	}
 
+	private getAiProviderCardLocator(providerId: string): By {
+		const cardId: string = providerId.replace(/\//g, '-');
+		return By.id(`ai-provider-card-${cardId}`);
+	}
+
 	private getGitBranchListItemLocator(branchName: string): By {
 		return By.xpath(`//ul[@role="listbox"]//span[text()="${branchName}"]`);
 	}

package/pageobjects/dashboard/UserPreferences.ts

@@ -54,6 +54,15 @@ export class UserPreferences {
 	private static readonly DELETE_CONFIRMATION_CHECKBOX: By = By.id('revoke-warning-info-check');
 	private static readonly DELETE_ITEM_BUTTON_ENABLED: By = By.css('button[data-testid="revoke-button"]:not([disabled])');
 
+	private static readonly AI_PROVIDER_KEYS_TAB: By = By.xpath('//button[text()="AI Providers Keys"]');
+	private static readonly AI_ADD_KEY_EMPTY_STATE_BUTTON: By = By.css('button[aria-label="Add AI Provider Key"]');
+	private static readonly AI_ADD_EDIT_MODAL: By = By.css('div[aria-label="add-edit-ai-provider-key"]');
+	private static readonly AI_PROVIDER_SELECT_TOGGLE: By = By.css('div[aria-label="add-edit-ai-provider-key"] button.pf-v6-c-menu-toggle');
+	private static readonly AI_API_KEY_INPUT: By = By.id('ai-provider-api-key');
+	private static readonly AI_SAVE_BUTTON: By = By.css('button[data-testid="save-button"]');
+	private static readonly AI_BULK_DELETE_BUTTON: By = By.css('button[data-testid="bulk-delete-ai-key-button"]');
+	private static readonly AI_DELETE_CONFIRM_CHECKBOX: By = By.id('delete-ai-key-warning-checkbox');
+
 	constructor(
 		@inject(CLASSES.DriverHelper)
 		readonly driverHelper: DriverHelper
@@ -286,6 +295,87 @@ export class UserPreferences {
 		Logger.info('SSH keys have been deleted');
 	}
 
+	async openAiProviderKeysTab(): Promise<void> {
+		Logger.debug();
+
+		await this.driverHelper.waitAndClick(UserPreferences.AI_PROVIDER_KEYS_TAB);
+	}
+
+	async waitAiProviderKeysTab(timeout: number = TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT): Promise<void> {
+		Logger.debug();
+
+		await this.driverHelper.waitVisibility(UserPreferences.AI_PROVIDER_KEYS_TAB, timeout);
+	}
+
+	async isAiProviderKeyPresent(providerId: string): Promise<boolean> {
+		Logger.debug(`providerId: "${providerId}"`);
+
+		return await this.driverHelper.isVisible(this.getAiProviderRowLocator(providerId));
+	}
+
+	async waitAiProviderKeyPresent(
+		providerId: string,
+		timeout: number = TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT
+	): Promise<void> {
+		Logger.debug(`providerId: "${providerId}"`);
+
+		await this.driverHelper.waitVisibility(this.getAiProviderRowLocator(providerId), timeout);
+	}
+
+	async addAiProviderKey(providerName: string, apiKey: string): Promise<void> {
+		Logger.debug(`providerName: "${providerName}"`);
+
+		await this.driverHelper.waitAndClick(UserPreferences.AI_ADD_KEY_EMPTY_STATE_BUTTON);
+		await this.driverHelper.waitVisibility(UserPreferences.AI_ADD_EDIT_MODAL);
+		await this.selectAiProvider(providerName);
+		await this.driverHelper.waitVisibility(UserPreferences.AI_API_KEY_INPUT);
+		await this.driverHelper.enterValue(UserPreferences.AI_API_KEY_INPUT, apiKey);
+		await this.driverHelper.waitAndClick(UserPreferences.AI_SAVE_BUTTON);
+
+		const attempts: number = Math.ceil(
+			TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT / TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING
+		);
+		await this.driverHelper.waitDisappearance(
+			UserPreferences.AI_ADD_EDIT_MODAL,
+			attempts,
+			TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING
+		);
+	}
+
+	async selectAiProvider(providerName: string): Promise<void> {
+		Logger.debug(`providerName: "${providerName}"`);
+
+		await this.driverHelper.waitAndClick(UserPreferences.AI_PROVIDER_SELECT_TOGGLE);
+		await this.driverHelper.waitAndClick(this.getAiProviderSelectOptionLocator(providerName));
+	}
+
+	async getAiProviderEnvVarName(providerId: string): Promise<string> {
+		Logger.debug(`providerId: "${providerId}"`);
+
+		return await this.driverHelper.waitAndGetText(this.getAiProviderEnvVarLocator(providerId));
+	}
+
+	async deleteAiProviderKeys(providerName: string): Promise<void> {
+		Logger.debug(`providerName: "${providerName}"`);
+
+		Logger.info('Deleting AI Provider keys');
+		const rows: By = By.css('table[aria-label="AI Provider Keys"] tbody tr input[type="checkbox"]');
+		const hasRows: boolean = await this.driverHelper.isVisible(rows);
+
+		if (!hasRows) {
+			Logger.info('No AI Provider keys to delete');
+			return;
+		}
+
+		const selectAllCheckbox: By = By.css('table[aria-label="AI Provider Keys"] thead input[type="checkbox"]');
+		await this.driverHelper.waitAndClick(selectAllCheckbox);
+		await this.driverHelper.waitAndClick(UserPreferences.AI_BULK_DELETE_BUTTON);
+		await this.driverHelper.waitAndClick(UserPreferences.AI_DELETE_CONFIRM_CHECKBOX);
+		await this.driverHelper.waitAndClick(this.getAiDeleteConfirmButtonLocator(providerName));
+		await this.driverHelper.waitDisappearance(rows);
+		Logger.info('AI Provider keys have been deleted');
+	}
+
 	getServiceConfig(service: string): string {
 		const gitService: { [key: string]: string } = {
 			[GitProviderType.GITHUB]: 'GitHub',
@@ -302,4 +392,20 @@ export class UserPreferences {
 	private getServicesListItemLocator(servicesName: string): By {
 		return By.xpath(`//tr[td[text()='${servicesName}']]//input`);
 	}
+
+	private getAiProviderRowLocator(providerId: string): By {
+		return By.css(`tr[data-testid="${providerId}"]`);
+	}
+
+	private getAiProviderSelectOptionLocator(providerName: string): By {
+		return By.xpath(`//button[@role="option"]//span[text()="${providerName}"]`);
+	}
+
+	private getAiProviderEnvVarLocator(providerId: string): By {
+		return By.xpath(`//tr[@data-testid="${providerId}"]//td[@data-label="Environment Variable"]//code`);
+	}
+
+	private getAiDeleteConfirmButtonLocator(providerName: string): By {
+		return By.xpath(`//div[@aria-label="Delete ${providerName} API Key"]//span[text()="Delete"]`);
+	}
 }