@eclipse-che/che-e2e 7.121.0-next → 7.121.0-next-afa8d43

package/dist/utils/CheReporter.js

@@ -0,0 +1,238 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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 __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var CheReporter_1;
+/** *******************************************************************
+ * 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
+ **********************************************************************/
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+const chromeHar = __importStar(require("chrome-har"));
+const mocha = __importStar(require("mocha"));
+const inversify_types_1 = require("../configs/inversify.types");
+const fs = __importStar(require("fs"));
+const rm = __importStar(require("rimraf"));
+const DriverHelper_1 = require("./DriverHelper");
+const ScreenCatcher_1 = require("./ScreenCatcher");
+const TIMEOUT_CONSTANTS_1 = require("../constants/TIMEOUT_CONSTANTS");
+const Logger_1 = require("./Logger");
+const StringUtil_1 = require("./StringUtil");
+const BASE_TEST_CONSTANTS_1 = require("../constants/BASE_TEST_CONSTANTS");
+const CHROME_DRIVER_CONSTANTS_1 = require("../constants/CHROME_DRIVER_CONSTANTS");
+const OAUTH_CONSTANTS_1 = require("../constants/OAUTH_CONSTANTS");
+const REPORTER_CONSTANTS_1 = require("../constants/REPORTER_CONSTANTS");
+const PLUGIN_TEST_CONSTANTS_1 = require("../constants/PLUGIN_TEST_CONSTANTS");
+const inversify_1 = require("inversify");
+const inversify_inject_decorators_1 = __importDefault(require("inversify-inject-decorators"));
+const inversify_config_1 = require("../configs/inversify.config");
+const { lazyInject } = (0, inversify_inject_decorators_1.default)(inversify_config_1.e2eContainer);
+let CheReporter = CheReporter_1 = class CheReporter extends mocha.reporters.Spec {
+    constructor(runner, options) {
+        super(runner, options);
+        runner.on('start', () => {
+            let launchInformation = `################## Launch Information ##################
+
+      TS_SELENIUM_BASE_URL: ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL}
+      TS_SELENIUM_HEADLESS: ${CHROME_DRIVER_CONSTANTS_1.CHROME_DRIVER_CONSTANTS.TS_SELENIUM_HEADLESS}
+      TS_SELENIUM_OCP_USERNAME: ${OAUTH_CONSTANTS_1.OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME}
+      TS_SELENIUM_EDITOR:   ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_SELENIUM_EDITOR}
+
+      TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME: ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME}
+      TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS: ${REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS}
+      TS_SELENIUM_REPORT_FOLDER: ${REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER}
+      TS_SELENIUM_EXECUTION_SCREENCAST: ${REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_EXECUTION_SCREENCAST}
+      DELETE_SCREENCAST_IF_TEST_PASS: ${REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.DELETE_SCREENCAST_IF_TEST_PASS}
+      TS_SELENIUM_REMOTE_DRIVER_URL: ${CHROME_DRIVER_CONSTANTS_1.CHROME_DRIVER_CONSTANTS.TS_SELENIUM_REMOTE_DRIVER_URL}
+      DELETE_WORKSPACE_ON_FAILED_TEST: ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.DELETE_WORKSPACE_ON_FAILED_TEST}
+      TS_SELENIUM_LOG_LEVEL: ${REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL}
+      TS_SELENIUM_LAUNCH_FULLSCREEN: ${CHROME_DRIVER_CONSTANTS_1.CHROME_DRIVER_CONSTANTS.TS_SELENIUM_LAUNCH_FULLSCREEN}
+
+      ${process.env.TS_SELENIUM_PROXY_SERVER ? 'TS_SELENIUM_PROXY_SERVER: ' + process.env.TS_SELENIUM_PROXY_SERVER : ''}
+
+      TS_COMMON_DASHBOARD_WAIT_TIMEOUT: ${TIMEOUT_CONSTANTS_1.TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT}
+      TS_SELENIUM_START_WORKSPACE_TIMEOUT: ${TIMEOUT_CONSTANTS_1.TIMEOUT_CONSTANTS.TS_SELENIUM_START_WORKSPACE_TIMEOUT}
+      TS_WAIT_LOADER_PRESENCE_TIMEOUT: ${TIMEOUT_CONSTANTS_1.TIMEOUT_CONSTANTS.TS_WAIT_LOADER_PRESENCE_TIMEOUT}
+
+      TS_SAMPLE_LIST: ${PLUGIN_TEST_CONSTANTS_1.PLUGIN_TEST_CONSTANTS.TS_SAMPLE_LIST}
+
+      ${process.env.MOCHA_DIRECTORY ? 'MOCHA_DIRECTORY: ' + process.env.MOCHA_DIRECTORY : 'MOCHA_DIRECTORY is not set'}
+      ${process.env.USERSTORY ? 'USERSTORY: ' + process.env.USERSTORY : 'USERSTORY is not set'}
+`;
+            if (REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_PRINT_TIMEOUT_VARIABLES) {
+                launchInformation += '\n      TS_SELENIUM_PRINT_TIMEOUT_VARIABLES is set to true: \n';
+                Object.entries(TIMEOUT_CONSTANTS_1.TIMEOUT_CONSTANTS).forEach(([key, value]) => (launchInformation += `\n         ${key}: ${value}`));
+            }
+            else {
+                launchInformation += '\n      to output timeout variables, set TS_SELENIUM_PRINT_TIMEOUT_VARIABLES to true';
+            }
+            launchInformation += '\n ######################################################## \n';
+            console.log(launchInformation);
+            rm.sync(REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+        });
+        runner.on('test', async (test) => {
+            if (!REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_EXECUTION_SCREENCAST) {
+                return;
+            }
+            CheReporter_1.methodIndex = CheReporter_1.methodIndex + 1;
+            const currentMethodIndex = CheReporter_1.methodIndex;
+            let iterationIndex = 1;
+            while (!(test.state === 'passed' || test.state === 'failed')) {
+                await this.screenCatcher.catchMethodScreen(test.title, currentMethodIndex, iterationIndex);
+                iterationIndex = iterationIndex + 1;
+                await this.driverHelper.wait(REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS);
+            }
+        });
+        runner.on('pass', (test) => {
+            if (BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_LOAD_TESTS) {
+                const loadTestReportFolder = REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_LOAD_TEST_REPORT_FOLDER;
+                const loadTestFilePath = loadTestReportFolder + '/load-test-results.txt';
+                const report = test.title + ': ' + test.duration + '\r';
+                if (!fs.existsSync(loadTestReportFolder)) {
+                    fs.mkdirSync(loadTestReportFolder);
+                }
+                fs.appendFileSync(loadTestFilePath, report);
+            }
+        });
+        runner.on('end', () => {
+            // delete screencast folder if conditions matched
+            if (CheReporter_1.deleteScreencast && REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.DELETE_SCREENCAST_IF_TEST_PASS) {
+                rm.sync(REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+            }
+        });
+        runner.on('fail', async (test) => {
+            Logger_1.Logger.error(`CheReporter runner.on.fail: ${test.fullTitle()} failed after ${test.duration}ms`);
+            // raise flag for keeping the screencast
+            CheReporter_1.deleteScreencast = false;
+            Logger_1.Logger.trace(`FullTitle:${test.fullTitle()}`);
+            const testFullTitle = StringUtil_1.StringUtil.sanitizeTitle(test.fullTitle());
+            Logger_1.Logger.trace(`FullTitleSanitized:${testFullTitle}`);
+            Logger_1.Logger.trace(`TestTitle:${test.title}`);
+            const testTitle = StringUtil_1.StringUtil.sanitizeTitle(test.title);
+            Logger_1.Logger.trace(`TestTitleSanitized:${testTitle}`);
+            const testReportDirPath = `${REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER}/${testFullTitle}`;
+            const screenshotFileName = `${testReportDirPath}/screenshot-${testTitle}.png`;
+            const pageSourceFileName = `${testReportDirPath}/pagesource-${testTitle}.html`;
+            const browserLogsFileName = `${testReportDirPath}/browserlogs-${testTitle}.txt`;
+            const harFileName = `${testReportDirPath}/har-${testTitle}.har`;
+            // create reporter dir if not exist
+            const reportDirExists = fs.existsSync(REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+            if (!reportDirExists) {
+                fs.mkdirSync(REPORTER_CONSTANTS_1.REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+            }
+            // create dir for failed test report if not exist
+            const testReportDirExists = fs.existsSync(testReportDirPath);
+            if (!testReportDirExists) {
+                fs.mkdirSync(testReportDirPath);
+            }
+            // take screenshot and write to file
+            const screenshot = await this.driverHelper.getDriver().takeScreenshot();
+            const screenshotStream = fs.createWriteStream(screenshotFileName);
+            screenshotStream.write(Buffer.from(screenshot, 'base64'), () => screenshotStream.end());
+            // take page source and write to file
+            const pageSource = await this.driverHelper.getDriver().getPageSource();
+            const pageSourceStream = fs.createWriteStream(pageSourceFileName);
+            pageSourceStream.write(Buffer.from(pageSource), () => pageSourceStream.end());
+            // take browser console logs and write to file
+            const browserLogsEntries = await this.driverHelper.getDriver().manage().logs().get('browser');
+            let browserLogs = '';
+            browserLogsEntries.forEach((log) => {
+                browserLogs += `\"${log.level}\" \"${log.type}\" \"${log.message}\"\n`;
+            });
+            const browserLogsStream = fs.createWriteStream(browserLogsFileName);
+            browserLogsStream.write(Buffer.from(browserLogs), () => {
+                browserLogsStream.end();
+            });
+            // take networking logs and write to file
+            const networkLogsEntries = await this.driverHelper.getDriver().manage().logs().get('performance');
+            const events = networkLogsEntries.map((entry) => JSON.parse(entry.message).message);
+            const har = chromeHar.harFromMessages(events, { includeTextFromResponseBody: true });
+            this.redactHarContent(har);
+            const networkLogsStream = fs.createWriteStream(harFileName);
+            networkLogsStream.write(Buffer.from(JSON.stringify(har)), () => {
+                networkLogsStream.end();
+            });
+        });
+    }
+    redactHarContent(har) {
+        har.log?.entries?.forEach((entry) => {
+            let text = entry.request?.postData?.text;
+            if (text) {
+                text = StringUtil_1.StringUtil.updateUrlQueryValue(text, 'csrf', '<REDACTED>');
+                text = StringUtil_1.StringUtil.updateUrlQueryValue(text, 'username', '<REDACTED>');
+                entry.request.postData.text = StringUtil_1.StringUtil.updateUrlQueryValue(text, 'password', '<REDACTED>');
+            }
+            const cookies = entry.request?.cookies;
+            if (cookies) {
+                cookies.forEach((cookie) => {
+                    if (cookie.name?.startsWith('_oauth_proxy')) {
+                        cookie.value = '<REDACTED>';
+                    }
+                });
+            }
+            const headers = entry.request?.headers;
+            if (headers) {
+                headers.forEach((header) => {
+                    if (header.name?.toLowerCase() === 'cookie') {
+                        header.value = StringUtil_1.StringUtil.updateCookieValue(header.value, '_oauth_proxy', '<REDACTED>');
+                        header.value = StringUtil_1.StringUtil.updateCookieValue(header.value, '_oauth_proxy_csrf', '<REDACTED>');
+                    }
+                });
+            }
+        });
+    }
+};
+CheReporter.methodIndex = 0;
+CheReporter.deleteScreencast = true;
+__decorate([
+    lazyInject(inversify_types_1.CLASSES.DriverHelper),
+    __metadata("design:type", DriverHelper_1.DriverHelper)
+], CheReporter.prototype, "driverHelper", void 0);
+__decorate([
+    lazyInject(inversify_types_1.CLASSES.ScreenCatcher),
+    __metadata("design:type", ScreenCatcher_1.ScreenCatcher)
+], CheReporter.prototype, "screenCatcher", void 0);
+CheReporter = CheReporter_1 = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [mocha.Runner, Object])
+], CheReporter);
+module.exports = CheReporter;
+//# sourceMappingURL=CheReporter.js.map

package/dist/utils/CheReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheReporter.js","sourceRoot":"","sources":["../../utils/CheReporter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;wEAQwE;AACxE,6DAA6D;AAC7D,aAAa;AACb,sDAAwC;AACxC,6CAA+B;AAC/B,gEAAqD;AACrD,uCAAyB;AAEzB,2CAA6B;AAE7B,iDAA8C;AAC9C,mDAAgD;AAChD,sEAAmE;AACnE,qCAAkC;AAClC,6CAA0C;AAC1C,0EAAuE;AACvE,kFAA+E;AAC/E,kEAA+D;AAC/D,wEAAqE;AACrE,8EAA2E;AAC3E,yCAAuC;AACvC,8FAAwD;AACxD,kEAA2D;AAE3D,MAAM,EAAE,UAAU,EAAE,GAAG,IAAA,qCAAa,EAAC,+BAAY,CAAC,CAAC;AAEnD,IACM,WAAW,mBADjB,MACM,WAAY,SAAQ,KAAK,CAAC,SAAS,CAAC,IAAI;IAQ7C,YAAY,MAAoB,EAAE,OAA2B;QAC5D,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAS,EAAE;YAC7B,IAAI,iBAAiB,GAAW;;8BAEL,yCAAmB,CAAC,oBAAoB;8BACxC,iDAAuB,CAAC,oBAAoB;kCACxC,iCAAe,CAAC,wBAAwB;8BAC5C,yCAAmB,CAAC,kBAAkB;;+CAErB,yCAAmB,CAAC,qCAAqC;+CACzD,uCAAkB,CAAC,qCAAqC;mCACpE,uCAAkB,CAAC,yBAAyB;0CACrC,uCAAkB,CAAC,gCAAgC;wCACrD,uCAAkB,CAAC,8BAA8B;uCAClD,iDAAuB,CAAC,6BAA6B;yCACnD,yCAAmB,CAAC,+BAA+B;+BAC7D,uCAAkB,CAAC,qBAAqB;uCAChC,iDAAuB,CAAC,6BAA6B;;QAEpF,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC,4BAA4B,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE;;0CAE7E,qCAAiB,CAAC,gCAAgC;6CAC/C,qCAAiB,CAAC,mCAAmC;yCACzD,qCAAiB,CAAC,+BAA+B;;wBAElE,6CAAqB,CAAC,cAAc;;QAEpD,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,4BAA4B;QAC9G,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,sBAAsB;CAC7F,CAAC;YAEC,IAAI,uCAAkB,CAAC,mCAAmC,EAAE;gBAC3D,iBAAiB,IAAI,gEAAgE,CAAC;gBACtF,MAAM,CAAC,OAAO,CAAC,qCAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAU,EAAE,CAAC,CAAC,iBAAiB,IAAI,cAAc,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;aAC1H;iBAAM;gBACN,iBAAiB,IAAI,sFAAsF,CAAC;aAC5G;YAED,iBAAiB,IAAI,gEAAgE,CAAC;YAEtF,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YAE/B,EAAE,CAAC,IAAI,CAAC,uCAAkB,CAAC,yBAAyB,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAgB,EAAiB,EAAE;YAC3D,IAAI,CAAC,uCAAkB,CAAC,gCAAgC,EAAE;gBACzD,OAAO;aACP;YAED,aAAW,CAAC,WAAW,GAAG,aAAW,CAAC,WAAW,GAAG,CAAC,CAAC;YACtD,MAAM,kBAAkB,GAAW,aAAW,CAAC,WAAW,CAAC;YAC3D,IAAI,cAAc,GAAW,CAAC,CAAC;YAE/B,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,EAAE;gBAC7D,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAkB,EAAE,cAAc,CAAC,CAAC;gBAC3F,cAAc,GAAG,cAAc,GAAG,CAAC,CAAC;gBAEpC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,uCAAkB,CAAC,qCAAqC,CAAC,CAAC;aACvF;QACF,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAgB,EAAQ,EAAE;YAC5C,IAAI,yCAAmB,CAAC,aAAa,EAAE;gBACtC,MAAM,oBAAoB,GAAW,uCAAkB,CAAC,mCAAmC,CAAC;gBAC5F,MAAM,gBAAgB,GAAW,oBAAoB,GAAG,wBAAwB,CAAC;gBACjF,MAAM,MAAM,GAAW,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAChE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE;oBACzC,EAAE,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;iBACnC;gBACD,EAAE,CAAC,cAAc,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;aAC5C;QACF,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAS,EAAE;YAC3B,iDAAiD;YACjD,IAAI,aAAW,CAAC,gBAAgB,IAAI,uCAAkB,CAAC,8BAA8B,EAAE;gBACtF,EAAE,CAAC,IAAI,CAAC,uCAAkB,CAAC,yBAAyB,CAAC,CAAC;aACtD;QACF,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAgB,EAAiB,EAAE;YAC3D,eAAM,CAAC,KAAK,CAAC,+BAA+B,IAAI,CAAC,SAAS,EAAE,iBAAiB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;YAChG,wCAAwC;YACxC,aAAW,CAAC,gBAAgB,GAAG,KAAK,CAAC;YAErC,eAAM,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC9C,MAAM,aAAa,GAAW,uBAAU,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;YACzE,eAAM,CAAC,KAAK,CAAC,sBAAsB,aAAa,EAAE,CAAC,CAAC;YACpD,eAAM,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;YACxC,MAAM,SAAS,GAAW,uBAAU,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/D,eAAM,CAAC,KAAK,CAAC,sBAAsB,SAAS,EAAE,CAAC,CAAC;YAEhD,MAAM,iBAAiB,GAAW,GAAG,uCAAkB,CAAC,yBAAyB,IAAI,aAAa,EAAE,CAAC;YACrG,MAAM,kBAAkB,GAAW,GAAG,iBAAiB,eAAe,SAAS,MAAM,CAAC;YACtF,MAAM,kBAAkB,GAAW,GAAG,iBAAiB,eAAe,SAAS,OAAO,CAAC;YACvF,MAAM,mBAAmB,GAAW,GAAG,iBAAiB,gBAAgB,SAAS,MAAM,CAAC;YACxF,MAAM,WAAW,GAAW,GAAG,iBAAiB,QAAQ,SAAS,MAAM,CAAC;YAExE,mCAAmC;YACnC,MAAM,eAAe,GAAY,EAAE,CAAC,UAAU,CAAC,uCAAkB,CAAC,yBAAyB,CAAC,CAAC;YAE7F,IAAI,CAAC,eAAe,EAAE;gBACrB,EAAE,CAAC,SAAS,CAAC,uCAAkB,CAAC,yBAAyB,CAAC,CAAC;aAC3D;YAED,iDAAiD;YACjD,MAAM,mBAAmB,GAAY,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;YAEtE,IAAI,CAAC,mBAAmB,EAAE;gBACzB,EAAE,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;aAChC;YAED,oCAAoC;YACpC,MAAM,UAAU,GAAW,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,cAAc,EAAE,CAAC;YAChF,MAAM,gBAAgB,GAAgB,EAAE,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAC/E,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,GAAS,EAAE,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;YAE9F,qCAAqC;YACrC,MAAM,UAAU,GAAW,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,aAAa,EAAE,CAAC;YAC/E,MAAM,gBAAgB,GAAgB,EAAE,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAC/E,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAS,EAAE,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;YAEpF,8CAA8C;YAC9C,MAAM,kBAAkB,GAAoB,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC/G,IAAI,WAAW,GAAW,EAAE,CAAC;YAE7B,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAQ,EAAE;gBACxC,WAAW,IAAI,KAAK,GAAG,CAAC,KAAK,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,OAAO,MAAM,CAAC;YACxE,CAAC,CAAC,CAAC;YAEH,MAAM,iBAAiB,GAAgB,EAAE,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;YACjF,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,GAAS,EAAE;gBAC5D,iBAAiB,CAAC,GAAG,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC;YAEH,yCAAyC;YACzC,MAAM,kBAAkB,GAAoB,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACnH,MAAM,MAAM,GAAU,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAS,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;YAClG,MAAM,GAAG,GAAQ,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,2BAA2B,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1F,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YAE3B,MAAM,iBAAiB,GAAgB,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;YACzE,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAS,EAAE;gBACpE,iBAAiB,CAAC,GAAG,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,gBAAgB,CAAC,GAAQ;QACxB,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,KAAU,EAAQ,EAAE;YAC9C,IAAI,IAAI,GAAuB,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC;YAC7D,IAAI,IAAI,EAAE;gBACT,IAAI,GAAG,uBAAU,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;gBAClE,IAAI,GAAG,uBAAU,CAAC,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;gBACtE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,GAAG,uBAAU,CAAC,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;aAC7F;YAED,MAAM,OAAO,GAAQ,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;YAC5C,IAAI,OAAO,EAAE;gBACZ,OAAO,CAAC,OAAO,CAAC,CAAC,MAAW,EAAQ,EAAE;oBACrC,IAAI,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,EAAE;wBAC5C,MAAM,CAAC,KAAK,GAAG,YAAY,CAAC;qBAC5B;gBACF,CAAC,CAAC,CAAC;aACH;YAED,MAAM,OAAO,GAAQ,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;YAC5C,IAAI,OAAO,EAAE;gBACZ,OAAO,CAAC,OAAO,CAAC,CAAC,MAAW,EAAQ,EAAE;oBACrC,IAAI,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,QAAQ,EAAE;wBAC5C,MAAM,CAAC,KAAK,GAAG,uBAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;wBACxF,MAAM,CAAC,KAAK,GAAG,uBAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,mBAAmB,EAAE,YAAY,CAAC,CAAC;qBAC7F;gBACF,CAAC,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;;AA1Lc,uBAAW,GAAW,CAAC,CAAC;AACxB,4BAAgB,GAAY,IAAI,CAAC;AAChD;IAAC,UAAU,CAAC,yBAAO,CAAC,YAAY,CAAC;8BACD,2BAAY;iDAAC;AAC7C;IAAC,UAAU,CAAC,yBAAO,CAAC,aAAa,CAAC;8BACD,6BAAa;kDAAC;AAN1C,WAAW;IADhB,IAAA,sBAAU,GAAE;qCASQ,KAAK,CAAC,MAAM;GAR3B,WAAW,CA4LhB;AAED,iBAAS,WAAW,CAAC"}

package/dist/utils/DevWorkspaceConfigurationHelper.js

@@ -0,0 +1,145 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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 __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevWorkspaceConfigurationHelper = void 0;
+/** *******************************************************************
+ * copyright (c) 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
+ **********************************************************************/
+const main_1 = require("@eclipse-che/che-devworkspace-generator/lib/main");
+const yaml_1 = __importDefault(require("yaml"));
+const axios = __importStar(require("axios"));
+const Logger_1 = require("./Logger");
+const ShellExecutor_1 = require("./ShellExecutor");
+const API_TEST_CONSTANTS_1 = require("../constants/API_TEST_CONSTANTS");
+const BASE_TEST_CONSTANTS_1 = require("../constants/BASE_TEST_CONSTANTS");
+const inversify_1 = require("inversify");
+const inversify_config_1 = require("../configs/inversify.config");
+const inversify_types_1 = require("../configs/inversify.types");
+const inversify_inject_decorators_1 = __importDefault(require("inversify-inject-decorators"));
+const { lazyInject } = (0, inversify_inject_decorators_1.default)(inversify_config_1.e2eContainer);
+let DevWorkspaceConfigurationHelper = class DevWorkspaceConfigurationHelper {
+    constructor(params) {
+        // check if all undefined
+        if (!(params.editorPath || params.editorEntry || params.editorContent)) {
+            params.editorEntry = 'che-incubator/che-code/latest';
+        }
+        // check if one or both has value
+        if (API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_UDI_IMAGE || params.defaultComponentImage) {
+            params.injectDefaultComponent = 'true';
+            // check if not explicitly passed than assign value from the constants
+            if (!params.defaultComponentImage) {
+                params.defaultComponentImage = API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_UDI_IMAGE;
+            }
+        }
+        // assign value from the constants if not explicitly passed
+        if (API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_PLUGIN_REGISTRY_URL && !params.pluginRegistryUrl) {
+            params.pluginRegistryUrl = API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_PLUGIN_REGISTRY_URL;
+        }
+        if (API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI && !params.editorContent) {
+            params.editorContent = this.shellExecutor.curl(API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI).stdout;
+        }
+        this.params = params;
+    }
+    async generateDevfileContext() {
+        Logger_1.Logger.debug();
+        if (!this.params.projects) {
+            this.params.projects = [];
+        }
+        const devfileContext = await this.generator.generateDevfileContext({
+            ...this.params,
+            projects: this.params.projects
+        }, axios.default);
+        if (BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME() === 'devspaces') {
+            this.addMissedDevWorkspaceConfigAttributes(devfileContext);
+        }
+        return devfileContext;
+    }
+    // write templates and then DevWorkspace in a single file
+    getDevWorkspaceConfigurationYamlAsString(context) {
+        Logger_1.Logger.debug();
+        const allContentArray = context.devWorkspaceTemplates.map((template) => yaml_1.default.stringify(template));
+        allContentArray.push(yaml_1.default.stringify(context.devWorkspace));
+        return allContentArray.join('---\n');
+    }
+    getDevWorkspaceConfigurationsAsYaml(allContentString) {
+        Logger_1.Logger.debug();
+        const content = {};
+        const contentArray = allContentString.split('---\n');
+        contentArray.forEach((e) => {
+            e = yaml_1.default.parse(e);
+            e.kind === 'DevWorkspace'
+                ? (content.DevWorkspace = e)
+                : e.kind === 'DevWorkspaceTemplate'
+                    ? (content.DevWorkspaceTemplate = e)
+                    : Logger_1.Logger.error('Problems with configuration parsing, string should be in format "DevWorkspace\\n---\\nDevWorkspaceTemplate"');
+        });
+        return content;
+    }
+    /**
+     * add missed attributes to fix issues CRW-8922, CRW-9187.
+     */
+    addMissedDevWorkspaceConfigAttributes(devfileContextDevWorkspace, storageType = API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_TEST_STORAGE_TYPE) {
+        Logger_1.Logger.debug();
+        devfileContextDevWorkspace.devWorkspace?.spec?.template &&
+            (devfileContextDevWorkspace.devWorkspace.spec.template.attributes = yaml_1.default.parse(`
+                    controller.devfile.io/devworkspace-config:
+                      name: devworkspace-config
+                      namespace: openshift-devspaces
+                    controller.devfile.io/scc: container-build
+                    controller.devfile.io/storage-type: ${storageType}`));
+    }
+};
+__decorate([
+    lazyInject(inversify_types_1.EXTERNAL_CLASSES.Generator),
+    __metadata("design:type", main_1.Main)
+], DevWorkspaceConfigurationHelper.prototype, "generator", void 0);
+__decorate([
+    lazyInject(inversify_types_1.CLASSES.ShellExecutor),
+    __metadata("design:type", ShellExecutor_1.ShellExecutor)
+], DevWorkspaceConfigurationHelper.prototype, "shellExecutor", void 0);
+DevWorkspaceConfigurationHelper = __decorate([
+    (0, inversify_1.injectable)(),
+    __metadata("design:paramtypes", [Object])
+], DevWorkspaceConfigurationHelper);
+exports.DevWorkspaceConfigurationHelper = DevWorkspaceConfigurationHelper;
+//# sourceMappingURL=DevWorkspaceConfigurationHelper.js.map

package/dist/utils/DevWorkspaceConfigurationHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevWorkspaceConfigurationHelper.js","sourceRoot":"","sources":["../../utils/DevWorkspaceConfigurationHelper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;wEAQwE;AACxE,2EAAqF;AAGrF,gDAAwB;AACxB,6CAA+B;AAC/B,qCAAkC;AAClC,mDAAgD;AAChD,wEAAqE;AACrE,0EAAuE;AACvE,yCAAuC;AAEvC,kEAA2D;AAC3D,gEAAuE;AACvE,8FAAwD;AAExD,MAAM,EAAE,UAAU,EAAE,GAAG,IAAA,qCAAa,EAAC,+BAAY,CAAC,CAAC;AAG5C,IAAM,+BAA+B,GAArC,MAAM,+BAA+B;IAO3C,YAAY,MAAsB;QACjC,yBAAyB;QACzB,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,aAAa,CAAC,EAAE;YACvE,MAAM,CAAC,WAAW,GAAG,+BAA+B,CAAC;SACrD;QACD,iCAAiC;QACjC,IAAI,uCAAkB,CAAC,qBAAqB,IAAI,MAAM,CAAC,qBAAqB,EAAE;YAC7E,MAAM,CAAC,sBAAsB,GAAG,MAAM,CAAC;YACvC,sEAAsE;YACtE,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE;gBAClC,MAAM,CAAC,qBAAqB,GAAG,uCAAkB,CAAC,qBAAqB,CAAC;aACxE;SACD;QACD,2DAA2D;QAC3D,IAAI,uCAAkB,CAAC,+BAA+B,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACpF,MAAM,CAAC,iBAAiB,GAAG,uCAAkB,CAAC,+BAA+B,CAAC;SAC9E;QACD,IAAI,uCAAkB,CAAC,uCAAuC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YACxF,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uCAAkB,CAAC,uCAAuC,CAAC,CAAC,MAAM,CAAC;SAClH;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,sBAAsB;QAC3B,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;SAC1B;QAED,MAAM,cAAc,GAAmB,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,CACjF;YACC,GAAG,IAAI,CAAC,MAAM;YACd,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;SAC9B,EACD,KAAK,CAAC,OAAc,CACpB,CAAC;QAEF,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,KAAK,WAAW,EAAE;YACnE,IAAI,CAAC,qCAAqC,CAAC,cAAc,CAAC,CAAC;SAC3D;QAED,OAAO,cAAc,CAAC;IACvB,CAAC;IAED,yDAAyD;IACzD,wCAAwC,CAAC,OAAuB;QAC/D,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,MAAM,eAAe,GAAU,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,QAAsC,EAAU,EAAE,CACnH,cAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CACxB,CAAC;QACF,eAAe,CAAC,IAAI,CAAC,cAAI,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;QAE3D,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,mCAAmC,CAAC,gBAAwB;QAC3D,eAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,MAAM,YAAY,GAAa,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,YAAY,CAAC,OAAO,CAAC,CAAC,CAAM,EAAQ,EAAE;YACrC,CAAC,GAAG,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC,CAAC,IAAI,KAAK,cAAc;gBACxB,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,GAAG,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,sBAAsB;oBAClC,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,GAAG,CAAC,CAAC;oBACpC,CAAC,CAAC,eAAM,CAAC,KAAK,CACZ,6GAA6G,CAC7G,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,qCAAqC,CACpC,0BAA0C,EAC1C,cAAkC,uCAAkB,CAAC,wBAAwB;QAE7E,eAAM,CAAC,KAAK,EAAE,CAAC;QACf,0BAA0B,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ;YACtD,CAAC,0BAA0B,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,cAAI,CAAC,KAAK,CAAC;;;;;0DAKxB,WAAW,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC;CACD,CAAA;AAjGA;IAAC,UAAU,CAAC,kCAAgB,CAAC,SAAS,CAAC;8BACV,WAAS;kEAAC;AACvC;IAAC,UAAU,CAAC,yBAAO,CAAC,aAAa,CAAC;8BACD,6BAAa;sEAAC;AAJnC,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CAkG3C;AAlGY,0EAA+B"}

package/dist/utils/DevfilesHelper.js

@@ -0,0 +1,177 @@
+"use strict";
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevfilesHelper = void 0;
+/** *******************************************************************
+ * copyright (c) 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
+ **********************************************************************/
+const axios_1 = __importDefault(require("axios"));
+const Logger_1 = require("./Logger");
+const yaml_1 = __importDefault(require("yaml"));
+const API_TEST_CONSTANTS_1 = require("../constants/API_TEST_CONSTANTS");
+const inversify_1 = require("inversify");
+const BASE_TEST_CONSTANTS_1 = require("../constants/BASE_TEST_CONSTANTS");
+const inversify_config_1 = require("../configs/inversify.config");
+const inversify_types_1 = require("../configs/inversify.types");
+let DevfilesHelper = class DevfilesHelper {
+    getInternalClusterURLToDevFile(devFileName) {
+        const devfileSampleURIPrefix = `/dashboard/api/airgap-sample/devfile/download?id=${devFileName}`;
+        return `http://devspaces-dashboard.openshift-devspaces.svc:8080${devfileSampleURIPrefix}`;
+    }
+    /**
+     * grab devfile content from the Dashboard pod (currently, in the image of dashboard builds with devfile content and we use it for getting devfile description)
+     * @param podName
+     * @param containerName
+     * @param devFileName
+     */
+    obtainDevFileContentUsingPod(podName, containerName, devFileName) {
+        const clusterURL = this.getInternalClusterURLToDevFile(devFileName);
+        this.getShellExecutor().executeCommand(`oc exec -i ${podName} -n  ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} -c ${containerName} -- sh -c 'curl -o /tmp/${devFileName}-devfile.yaml ${clusterURL}'`);
+        return this.getShellExecutor()
+            .executeArbitraryShellScript(`oc exec -i ${podName} -n  ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} -c ${containerName} -- cat /tmp/${devFileName}-devfile.yaml`)
+            .toString();
+    }
+    /**
+     * grab devfile content from the Che config map
+     * @param configMapName
+     */
+    obtainCheDevFileEditorFromCheConfigMap(configMapName) {
+        return this.getShellExecutor().executeCommand(`oc get configmap ${configMapName} -o jsonpath="{.data.che-code\\.yaml}" -n ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()}`);
+    }
+    /**
+     * find the Dashboard pod and container name and grab devfile content from it
+     * @param devSample
+     */
+    getDevfileContent(devSample) {
+        const command = `oc get pods -n ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()}`;
+        console.log(`command: ${command}`);
+        const podName = this.getShellExecutor()
+            .executeArbitraryShellScript(`oc get pods -n ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} --field-selector status.phase=Running | grep dashboard | awk \'{print $1}\'`)
+            .trim();
+        const containerName = this.getShellExecutor().executeArbitraryShellScript(`oc get pod -n ${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM}-${BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME()} ${podName} -o jsonpath=\'{.spec.containers[*].name}\'`);
+        const devfileContent = this.obtainDevFileContentUsingPod(podName, containerName, devSample);
+        return devfileContent;
+    }
+    /**
+     * @deprecated applicable only for inbuilt devfiles
+     * @param sampleNamePatterns
+     */
+    async getInbuiltDevfilesRegistryContent(sampleNamePatterns) {
+        Logger_1.Logger.trace();
+        return this.filterSamples(sampleNamePatterns, await this.getContent(API_TEST_CONSTANTS_1.SUPPORTED_DEVFILE_REGISTRIES.INBUILT_APPLICATION_DEVFILE_REGISTRY_URL()));
+    }
+    async getGitHubCheDevfileRegistryContent() {
+        Logger_1.Logger.trace();
+        const url = API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL() === ''
+            ? API_TEST_CONSTANTS_1.SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL
+            : API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL();
+        return await this.getContent(url);
+    }
+    /**
+     *
+     * @deprecated applicable only for inbuilt devfiles
+     * @param isInbuilt
+     * @param sampleNamePatterns
+     */
+    async collectPathsToDevfilesFromRegistry(isInbuilt, sampleNamePatterns) {
+        Logger_1.Logger.debug();
+        const devfileSamples = [];
+        const sampleNames = [];
+        if (!isInbuilt) {
+            {
+                const content = await this.getGitHubCheDevfileRegistryContent();
+                content.forEach((e) => {
+                    if (e.name[0] !== '.') {
+                        sampleNames.push(e.name);
+                    }
+                });
+                for (const sample of sampleNames) {
+                    const sampleEndpoint = `${API_TEST_CONSTANTS_1.SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL}${sample}/meta.yaml`;
+                    const sampleEndpointContent = await this.getContent(sampleEndpoint);
+                    const decodedFileContent = Buffer.from(sampleEndpointContent.content, 'base64').toString();
+                    const metaYamlContent = yaml_1.default.parse(decodedFileContent);
+                    devfileSamples.push({
+                        name: sample,
+                        link: metaYamlContent.links.v2
+                    });
+                }
+                Logger_1.Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+            }
+        }
+        else if (isInbuilt) {
+            {
+                const content = await this.getInbuiltDevfilesRegistryContent(sampleNamePatterns);
+                const devfileRegistryPrefix = BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_PLATFORM === BASE_TEST_CONSTANTS_1.Platform.OPENSHIFT
+                    ? BASE_TEST_CONSTANTS_1.BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL + '/devfile-registry'
+                    : '';
+                for (const sample of content) {
+                    const linkToDevWorkspaceYaml = `${devfileRegistryPrefix}${sample.links.devWorkspaces['che-incubator/che-code/latest']}`;
+                    devfileSamples.push({
+                        name: sample.displayName,
+                        devWorkspaceConfigurationString: await this.getContent(linkToDevWorkspaceYaml)
+                    });
+                }
+                Logger_1.Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+            }
+        }
+        else {
+            {
+                Logger_1.Logger.error(`unsupported registry url - ${API_TEST_CONSTANTS_1.API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL()}\n
+                supported registries: ${JSON.stringify(API_TEST_CONSTANTS_1.SUPPORTED_DEVFILE_REGISTRIES)}`);
+            }
+        }
+        return devfileSamples;
+    }
+    filterSamples(sampleNamePatterns, content) {
+        if (sampleNamePatterns) {
+            const commonSampleNamePattern = new RegExp(sampleNamePatterns.join('|'), 'i');
+            content = content.filter((e) => commonSampleNamePattern.test(e.displayName));
+        }
+        return content;
+    }
+    getShellExecutor() {
+        return inversify_config_1.e2eContainer.get(inversify_types_1.CLASSES.ShellExecutor);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async getContent(url, headers) {
+        Logger_1.Logger.trace(`${url}`);
+        if (API_TEST_CONSTANTS_1.SUPPORTED_DEVFILE_REGISTRIES.TS_GIT_API_AUTH_TOKEN.length !== 0) {
+            /**
+             * if we use - https://api.github.com/repos/eclipse-che/che-devfile-registry/contents/devfiles/ URL
+             * for generating devfiles we can get a problem with rate limits to GitHub API,
+             * but we can pass auth. token for increase the limit and avoiding problems
+             */
+            headers = {
+                headers: { Authorization: API_TEST_CONSTANTS_1.SUPPORTED_DEVFILE_REGISTRIES.TS_GIT_API_AUTH_TOKEN }
+            };
+        }
+        let response;
+        try {
+            response = await axios_1.default.get(url, headers);
+        }
+        catch (error) {
+            Logger_1.Logger.error(`${error} + ${url}`);
+            throw error;
+        }
+        return response?.data;
+    }
+};
+DevfilesHelper = __decorate([
+    (0, inversify_1.injectable)()
+], DevfilesHelper);
+exports.DevfilesHelper = DevfilesHelper;
+//# sourceMappingURL=DevfilesHelper.js.map

package/dist/utils/DevfilesHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevfilesHelper.js","sourceRoot":"","sources":["../../utils/DevfilesHelper.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;;wEAQwE;AACxE,kDAA6C;AAC7C,qCAAkC;AAClC,gDAAwB;AACxB,wEAAmG;AACnG,yCAAuC;AACvC,0EAAiF;AAEjF,kEAA2D;AAC3D,gEAAqD;AAG9C,IAAM,cAAc,GAApB,MAAM,cAAc;IACnB,8BAA8B,CAAC,WAAmB;QACxD,MAAM,sBAAsB,GAAW,oDAAoD,WAAW,EAAE,CAAC;QAEzG,OAAO,0DAA0D,sBAAsB,EAAE,CAAC;IAC3F,CAAC;IAED;;;;;OAKG;IACI,4BAA4B,CAAC,OAAe,EAAE,aAAqB,EAAE,WAAmB;QAC9F,MAAM,UAAU,GAAW,IAAI,CAAC,8BAA8B,CAAC,WAAW,CAAC,CAAC;QAC5E,IAAI,CAAC,gBAAgB,EAAE,CAAC,cAAc,CACrC,cAAc,OAAO,QAAQ,yCAAmB,CAAC,WAAW,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,OAAO,aAAa,2BAA2B,WAAW,iBAAiB,UAAU,GAAG,CACtM,CAAC;QACF,OAAO,IAAI,CAAC,gBAAgB,EAAE;aAC5B,2BAA2B,CAC3B,cAAc,OAAO,QAAQ,yCAAmB,CAAC,WAAW,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,OAAO,aAAa,gBAAgB,WAAW,eAAe,CAC5K;aACA,QAAQ,EAAE,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,sCAAsC,CAAC,aAAqB;QAClE,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,cAAc,CAC5C,oBAAoB,aAAa,6CAA6C,yCAAmB,CAAC,WAAW,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,EAAE,CACjK,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,SAAiB;QACzC,MAAM,OAAO,GAAW,kBAAkB,yCAAmB,CAAC,WAAW,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,EAAE,CAAC;QAC9H,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,EAAE,CAAC,CAAC;QACnC,MAAM,OAAO,GAAW,IAAI,CAAC,gBAAgB,EAAE;aAC7C,2BAA2B,CAC3B,kBAAkB,yCAAmB,CAAC,WAAW,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,8EAA8E,CACjL;aACA,IAAI,EAAE,CAAC;QACT,MAAM,aAAa,GAAW,IAAI,CAAC,gBAAgB,EAAE,CAAC,2BAA2B,CAChF,iBAAiB,yCAAmB,CAAC,WAAW,IAAI,yCAAmB,CAAC,wBAAwB,EAAE,IAAI,OAAO,6CAA6C,CAC1J,CAAC;QACF,MAAM,cAAc,GAAW,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACpG,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iCAAiC,CAAC,kBAA6B;QACpE,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,OAAO,IAAI,CAAC,aAAa,CACxB,kBAAkB,EAClB,MAAM,IAAI,CAAC,UAAU,CAAC,iDAA4B,CAAC,wCAAwC,EAAE,CAAC,CAC9F,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kCAAkC;QACvC,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,MAAM,GAAG,GACR,uCAAkB,CAAC,mCAAmC,EAAE,KAAK,EAAE;YAC9D,CAAC,CAAC,iDAA4B,CAAC,gCAAgC;YAC/D,CAAC,CAAC,uCAAkB,CAAC,mCAAmC,EAAE,CAAC;QAC7D,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kCAAkC,CAAC,SAAkB,EAAE,kBAA6B;QACzF,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,EAAE;YACf;gBACC,MAAM,OAAO,GAAa,MAAM,IAAI,CAAC,kCAAkC,EAAE,CAAC;gBAC1E,OAAO,CAAC,OAAO,CAAC,CAAC,CAAM,EAAQ,EAAE;oBAChC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;wBACtB,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;qBACzB;gBACF,CAAC,CAAC,CAAC;gBAEH,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE;oBACjC,MAAM,cAAc,GAAW,GAAG,iDAA4B,CAAC,gCAAgC,GAAG,MAAM,YAAY,CAAC;oBACrH,MAAM,qBAAqB,GAAkB,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;oBACnF,MAAM,kBAAkB,GAAW,MAAM,CAAC,IAAI,CAAE,qBAA6B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;oBAC5G,MAAM,eAAe,GAAQ,cAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC;wBACnB,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE;qBAC9B,CAAC,CAAC;iBACH;gBACD,eAAM,CAAC,KAAK,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;aAChE;SACD;aAAM,IAAI,SAAS,EAAE;YACrB;gBACC,MAAM,OAAO,GAAa,MAAM,IAAI,CAAC,iCAAiC,CAAC,kBAAkB,CAAC,CAAC;gBAC3F,MAAM,qBAAqB,GAC1B,yCAAmB,CAAC,WAAW,KAAK,8BAAQ,CAAC,SAAS;oBACrD,CAAC,CAAC,yCAAmB,CAAC,oBAAoB,GAAG,mBAAmB;oBAChE,CAAC,CAAC,EAAE,CAAC;gBACP,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;oBAC7B,MAAM,sBAAsB,GAAQ,GAAG,qBAAqB,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,+BAA+B,CAAC,EAAE,CAAC;oBAC7H,cAAc,CAAC,IAAI,CAAC;wBACnB,IAAI,EAAE,MAAM,CAAC,WAAW;wBACxB,+BAA+B,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;qBAC9E,CAAC,CAAC;iBACH;gBACD,eAAM,CAAC,KAAK,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;aAChE;SACD;aAAM;YACN;gBACC,eAAM,CAAC,KAAK,CAAC,8BAA8B,uCAAkB,CAAC,mCAAmC,EAAE;wCAC/D,IAAI,CAAC,SAAS,CAAC,iDAA4B,CAAC,EAAE,CAAC,CAAC;aACpF;SACD;QACD,OAAO,cAAc,CAAC;IACvB,CAAC;IAEO,aAAa,CAAC,kBAAwC,EAAE,OAAY;QAC3E,IAAI,kBAAkB,EAAE;YACvB,MAAM,uBAAuB,GAAW,IAAI,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;YACtF,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAM,EAAW,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;SAC3F;QACD,OAAO,OAAO,CAAC;IAChB,CAAC;IACO,gBAAgB;QACvB,OAAO,+BAAY,CAAC,GAAG,CAAC,yBAAO,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;IACD,6DAA6D;IACrD,KAAK,CAAC,UAAU,CAAC,GAAW,EAAE,OAAgB;QACrD,eAAM,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;QACvB,IAAI,iDAA4B,CAAC,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE;YACpE;;;;eAIG;YACH,OAAO,GAAG;gBACT,OAAO,EAAE,EAAE,aAAa,EAAE,iDAA4B,CAAC,qBAAqB,EAAE;aAC9E,CAAC;SACF;QACD,IAAI,QAAmC,CAAC;QACxC,IAAI;YACH,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACzC;QAAC,OAAO,KAAK,EAAE;YACf,eAAM,CAAC,KAAK,CAAC,GAAG,KAAK,MAAM,GAAG,EAAE,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;SACZ;QACD,OAAO,QAAQ,EAAE,IAAI,CAAC;IACvB,CAAC;CACD,CAAA;AAtKY,cAAc;IAD1B,IAAA,sBAAU,GAAE;GACA,cAAc,CAsK1B;AAtKY,wCAAc"}