@eclipse-che/che-e2e 7.74.0-dev-1d09cb7 → 7.74.0-dev-41d1364

package/utils/CheReporter.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019-2023 Red Hat, Inc.
+/** *******************************************************************
+ * 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
@@ -15,15 +15,15 @@ import * as rm from 'rimraf';
 import { logging } from 'selenium-webdriver';
 import { DriverHelper } from './DriverHelper';
 import { ScreenCatcher } from './ScreenCatcher';
-import { TimeoutConstants } from '../constants/TimeoutConstants';
+import { TIMEOUT_CONSTANTS } from '../constants/TIMEOUT_CONSTANTS';
 import { Logger } from './Logger';
 import { e2eContainer } from '../configs/inversify.config';
 import { StringUtil } from './StringUtil';
-import { BaseTestConstants } from '../constants/BaseTestConstants';
-import { ChromeDriverConstants } from '../constants/ChromeDriverConstants';
-import { OAuthConstants } from '../constants/OAuthConstants';
-import { ReporterConstants } from '../constants/ReporterConstants';
-import { PluginsTestConstants } from '../constants/PluginsTestConstants';
+import { BASE_TEST_CONSTANTS } from '../constants/BASE_TEST_CONSTANTS';
+import { CHROME_DRIVER_CONSTANTS } from '../constants/CHROME_DRIVER_CONSTANTS';
+import { OAUTH_CONSTANTS } from '../constants/OAUTH_CONSTANTS';
+import { REPORTER_CONSTANTS } from '../constants/REPORTER_CONSTANTS';
+import { PLUGIN_TEST_CONSTANTS } from '../constants/PLUGIN_TEST_CONSTANTS';
 
 const driverHelper: DriverHelper = e2eContainer.get(CLASSES.DriverHelper);
 const screenCatcher: ScreenCatcher = e2eContainer.get(CLASSES.ScreenCatcher);
@@ -31,153 +31,149 @@ let methodIndex: number = 0;
 let deleteScreencast: boolean = true;
 
 class CheReporter extends mocha.reporters.Spec {
+	constructor(runner: mocha.Runner, options: mocha.MochaOptions) {
+		super(runner, options);
 
-  constructor(runner: mocha.Runner, options: mocha.MochaOptions) {
-    super(runner, options);
+		runner.on('start', (): void => {
+			let launchInformation: string = `################## Launch Information ##################
 
-    runner.on('start', async (): Promise<void> => {
-      let launchInformation: string =
-        `################## Launch Information ##################
+      TS_SELENIUM_BASE_URL: ${BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL}
+      TS_SELENIUM_HEADLESS: ${CHROME_DRIVER_CONSTANTS.TS_SELENIUM_HEADLESS}
+      TS_SELENIUM_OCP_USERNAME: ${OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME}
+      TS_SELENIUM_EDITOR:   ${BASE_TEST_CONSTANTS.TS_SELENIUM_EDITOR}
 
-      TS_SELENIUM_BASE_URL: ${BaseTestConstants.TS_SELENIUM_BASE_URL}
-      TS_SELENIUM_HEADLESS: ${ChromeDriverConstants.TS_SELENIUM_HEADLESS}
-      TS_SELENIUM_OCP_USERNAME: ${OAuthConstants.TS_SELENIUM_OCP_USERNAME}
-      TS_SELENIUM_EDITOR:   ${BaseTestConstants.TS_SELENIUM_EDITOR}
+      TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME: ${BASE_TEST_CONSTANTS.TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME}
+      TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS: ${REPORTER_CONSTANTS.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS}
+      TS_SELENIUM_REPORT_FOLDER: ${REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER}
+      TS_SELENIUM_EXECUTION_SCREENCAST: ${REPORTER_CONSTANTS.TS_SELENIUM_EXECUTION_SCREENCAST}
+      DELETE_SCREENCAST_IF_TEST_PASS: ${REPORTER_CONSTANTS.DELETE_SCREENCAST_IF_TEST_PASS}
+      TS_SELENIUM_REMOTE_DRIVER_URL: ${CHROME_DRIVER_CONSTANTS.TS_SELENIUM_REMOTE_DRIVER_URL}
+      DELETE_WORKSPACE_ON_FAILED_TEST: ${BASE_TEST_CONSTANTS.DELETE_WORKSPACE_ON_FAILED_TEST}
+      TS_SELENIUM_LOG_LEVEL: ${REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL}
+      TS_SELENIUM_LAUNCH_FULLSCREEN: ${CHROME_DRIVER_CONSTANTS.TS_SELENIUM_LAUNCH_FULLSCREEN}
 
-      TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME: ${BaseTestConstants.TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME}
-      TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS: ${ReporterConstants.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS}
-      TS_SELENIUM_REPORT_FOLDER: ${ReporterConstants.TS_SELENIUM_REPORT_FOLDER}
-      TS_SELENIUM_EXECUTION_SCREENCAST: ${ReporterConstants.TS_SELENIUM_EXECUTION_SCREENCAST}
-      DELETE_SCREENCAST_IF_TEST_PASS: ${ReporterConstants.DELETE_SCREENCAST_IF_TEST_PASS}
-      TS_SELENIUM_REMOTE_DRIVER_URL: ${ChromeDriverConstants.TS_SELENIUM_REMOTE_DRIVER_URL}
-      DELETE_WORKSPACE_ON_FAILED_TEST: ${BaseTestConstants.DELETE_WORKSPACE_ON_FAILED_TEST}
-      TS_SELENIUM_LOG_LEVEL: ${ReporterConstants.TS_SELENIUM_LOG_LEVEL}
-      TS_SELENIUM_LAUNCH_FULLSCREEN: ${ChromeDriverConstants.TS_SELENIUM_LAUNCH_FULLSCREEN}
+      TS_COMMON_DASHBOARD_WAIT_TIMEOUT: ${TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT}
+      TS_SELENIUM_START_WORKSPACE_TIMEOUT: ${TIMEOUT_CONSTANTS.TS_SELENIUM_START_WORKSPACE_TIMEOUT}
+      TS_WAIT_LOADER_PRESENCE_TIMEOUT: ${TIMEOUT_CONSTANTS.TS_WAIT_LOADER_PRESENCE_TIMEOUT}
 
-      TS_COMMON_DASHBOARD_WAIT_TIMEOUT: ${TimeoutConstants.TS_COMMON_DASHBOARD_WAIT_TIMEOUT}
-      TS_SELENIUM_START_WORKSPACE_TIMEOUT: ${TimeoutConstants.TS_SELENIUM_START_WORKSPACE_TIMEOUT}
-      TS_WAIT_LOADER_PRESENCE_TIMEOUT: ${TimeoutConstants.TS_WAIT_LOADER_PRESENCE_TIMEOUT}
-
-      TS_SAMPLE_LIST: ${PluginsTestConstants.TS_SAMPLE_LIST}
+      TS_SAMPLE_LIST: ${PLUGIN_TEST_CONSTANTS.TS_SAMPLE_LIST}
 
       ${process.env.MOCHA_DIRECTORY ? 'MOCHA_DIRECTORY: ' + process.env.MOCHA_DIRECTORY : 'MOCHA_DRIRECTORY is not set'}
       ${process.env.USERSTORY ? 'USERSTORY: ' + process.env.USERSTORY : 'USERSTORY is not set'}
 `;
 
-      if (ReporterConstants.TS_SELENIUM_PRINT_TIMEOUT_VARIABLES) {
-        launchInformation += `\n      TS_SELENIUM_PRINT_TIMEOUT_VARIABLES is set to true: \n`;
-        Object.entries(TimeoutConstants).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(ReporterConstants.TS_SELENIUM_REPORT_FOLDER);
-    });
-
-    runner.on('test', async function(test: mocha.Test): Promise<void> {
-      if (!ReporterConstants.TS_SELENIUM_EXECUTION_SCREENCAST) {
-        return;
-      }
-
-      methodIndex = methodIndex + 1;
-      const currentMethodIndex: number = methodIndex;
-      let iterationIndex: number = 1;
-
-      while (!(test.state === 'passed' || test.state === 'failed')) {
-        await screenCatcher.catchMethodScreen(test.title, currentMethodIndex, iterationIndex);
-        iterationIndex = iterationIndex + 1;
-
-        await driverHelper.wait(ReporterConstants.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS);
-      }
-    });
-
-    runner.on('pass', async (test: mocha.Test) => {
-      if (BaseTestConstants.TS_LOAD_TESTS) {
-        const loadTestReportFolder: string = ReporterConstants.TS_SELENIUM_LOAD_TEST_REPORT_FOLDER;
-        const loadTestFilePath: string = loadTestReportFolder + '/load-test-results.txt';
-        const report: string = test.title + ': ' + test.duration + '\r';
-        if (!fs.existsSync(loadTestReportFolder)) {
-          fs.mkdirSync(loadTestReportFolder);
-        }
-        fs.appendFileSync(loadTestFilePath, report);
-      }
-    });
-
-    runner.on('end', async function(): Promise<void> {
-      // ensure that fired events done
-      await driverHelper.wait(5000);
-
-      // close driver
-      await driverHelper.getDriver().quit();
-
-      // delete screencast folder if conditions matched
-      if (deleteScreencast && ReporterConstants.DELETE_SCREENCAST_IF_TEST_PASS) {
-        rm.sync(ReporterConstants.TS_SELENIUM_REPORT_FOLDER);
-      }
-    });
-
-    runner.on('fail', async function(test: mocha.Test): Promise<void> {
-      Logger.error(`CheReporter runner.on.fail: ${test.fullTitle()} failed after ${test.duration}ms`);
-      // raise flag for keeping the screencast
-      deleteScreencast = false;
-
-      Logger.trace(`FullTitle:${test.fullTitle()}`);
-      const testFullTitle: string = StringUtil.sanitizeTitle(test.fullTitle());
-      Logger.trace(`FullTitleSanitized:${testFullTitle}`);
-      Logger.trace(`TestTitle:${test.title}`);
-      const testTitle: string = StringUtil.sanitizeTitle(test.title);
-      Logger.trace(`TestTitleSanitized:${testTitle}`);
-
-      const testReportDirPath: string = `${ReporterConstants.TS_SELENIUM_REPORT_FOLDER}/${testFullTitle}`;
-      const screenshotFileName: string = `${testReportDirPath}/screenshot-${testTitle}.png`;
-      const pageSourceFileName: string = `${testReportDirPath}/pagesource-${testTitle}.html`;
-      const browserLogsFileName: string = `${testReportDirPath}/browserlogs-${testTitle}.txt`;
-
-      // create reporter dir if not exist
-      const reportDirExists: boolean = fs.existsSync(ReporterConstants.TS_SELENIUM_REPORT_FOLDER);
-
-      if (!reportDirExists) {
-        fs.mkdirSync(ReporterConstants.TS_SELENIUM_REPORT_FOLDER);
-      }
-
-      // create dir for failed test report if not exist
-      const testReportDirExists: boolean = fs.existsSync(testReportDirPath);
-
-      if (!testReportDirExists) {
-        fs.mkdirSync(testReportDirPath);
-      }
-
-      // take screenshot and write to file
-      const screenshot: string = await driverHelper.getDriver().takeScreenshot();
-      const screenshotStream: WriteStream = fs.createWriteStream(screenshotFileName);
-      screenshotStream.write(Buffer.from(screenshot, 'base64'));
-      screenshotStream.end();
-
-      // take page source and write to file
-      const pageSource: string = await driverHelper.getDriver().getPageSource();
-      const pageSourceStream: WriteStream = fs.createWriteStream(pageSourceFileName);
-      pageSourceStream.write(Buffer.from(pageSource));
-      pageSourceStream.end();
-
-      // take browser console logs and write to file
-      const browserLogsEntries: logging.Entry[] = await driverHelper.getDriver().manage().logs().get('browser');
-      let browserLogs: string = '';
-
-      browserLogsEntries.forEach(log => {
-        browserLogs += `\"${log.level}\" \"${log.type}\" \"${log.message}\"\n`;
-      });
-
-      const browserLogsStream: WriteStream = fs.createWriteStream(browserLogsFileName);
-      browserLogsStream.write(Buffer.from(browserLogs));
-      browserLogsStream.end();
-
-    });
-  }
+			if (REPORTER_CONSTANTS.TS_SELENIUM_PRINT_TIMEOUT_VARIABLES) {
+				launchInformation += '\n      TS_SELENIUM_PRINT_TIMEOUT_VARIABLES is set to true: \n';
+				Object.entries(TIMEOUT_CONSTANTS).forEach(([key, value]): string => (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.TS_SELENIUM_REPORT_FOLDER);
+		});
+
+		runner.on('test', async function (test: mocha.Test): Promise<void> {
+			if (!REPORTER_CONSTANTS.TS_SELENIUM_EXECUTION_SCREENCAST) {
+				return;
+			}
+
+			methodIndex = methodIndex + 1;
+			const currentMethodIndex: number = methodIndex;
+			let iterationIndex: number = 1;
+
+			while (!(test.state === 'passed' || test.state === 'failed')) {
+				await screenCatcher.catchMethodScreen(test.title, currentMethodIndex, iterationIndex);
+				iterationIndex = iterationIndex + 1;
+
+				await driverHelper.wait(REPORTER_CONSTANTS.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS);
+			}
+		});
+
+		runner.on('pass', (test: mocha.Test): void => {
+			if (BASE_TEST_CONSTANTS.TS_LOAD_TESTS) {
+				const loadTestReportFolder: string = REPORTER_CONSTANTS.TS_SELENIUM_LOAD_TEST_REPORT_FOLDER;
+				const loadTestFilePath: string = loadTestReportFolder + '/load-test-results.txt';
+				const report: string = test.title + ': ' + test.duration + '\r';
+				if (!fs.existsSync(loadTestReportFolder)) {
+					fs.mkdirSync(loadTestReportFolder);
+				}
+				fs.appendFileSync(loadTestFilePath, report);
+			}
+		});
+
+		runner.on('end', async (): Promise<void> => {
+			// ensure that fired events done
+			await driverHelper.wait(5000);
+
+			// close driver
+			await driverHelper.getDriver().quit();
+
+			// delete screencast folder if conditions matched
+			if (deleteScreencast && REPORTER_CONSTANTS.DELETE_SCREENCAST_IF_TEST_PASS) {
+				rm.sync(REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+			}
+		});
+
+		runner.on('fail', async function (test: mocha.Test): Promise<void> {
+			Logger.error(`CheReporter runner.on.fail: ${test.fullTitle()} failed after ${test.duration}ms`);
+			// raise flag for keeping the screencast
+			deleteScreencast = false;
+
+			Logger.trace(`FullTitle:${test.fullTitle()}`);
+			const testFullTitle: string = StringUtil.sanitizeTitle(test.fullTitle());
+			Logger.trace(`FullTitleSanitized:${testFullTitle}`);
+			Logger.trace(`TestTitle:${test.title}`);
+			const testTitle: string = StringUtil.sanitizeTitle(test.title);
+			Logger.trace(`TestTitleSanitized:${testTitle}`);
+
+			const testReportDirPath: string = `${REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER}/${testFullTitle}`;
+			const screenshotFileName: string = `${testReportDirPath}/screenshot-${testTitle}.png`;
+			const pageSourceFileName: string = `${testReportDirPath}/pagesource-${testTitle}.html`;
+			const browserLogsFileName: string = `${testReportDirPath}/browserlogs-${testTitle}.txt`;
+
+			// create reporter dir if not exist
+			const reportDirExists: boolean = fs.existsSync(REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+
+			if (!reportDirExists) {
+				fs.mkdirSync(REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+			}
+
+			// create dir for failed test report if not exist
+			const testReportDirExists: boolean = fs.existsSync(testReportDirPath);
+
+			if (!testReportDirExists) {
+				fs.mkdirSync(testReportDirPath);
+			}
+
+			// take screenshot and write to file
+			const screenshot: string = await driverHelper.getDriver().takeScreenshot();
+			const screenshotStream: WriteStream = fs.createWriteStream(screenshotFileName);
+			screenshotStream.write(Buffer.from(screenshot, 'base64'));
+			screenshotStream.end();
+
+			// take page source and write to file
+			const pageSource: string = await driverHelper.getDriver().getPageSource();
+			const pageSourceStream: WriteStream = fs.createWriteStream(pageSourceFileName);
+			pageSourceStream.write(Buffer.from(pageSource));
+			pageSourceStream.end();
+
+			// take browser console logs and write to file
+			const browserLogsEntries: logging.Entry[] = await driverHelper.getDriver().manage().logs().get('browser');
+			let browserLogs: string = '';
+
+			browserLogsEntries.forEach((log): void => {
+				browserLogs += `\"${log.level}\" \"${log.type}\" \"${log.message}\"\n`;
+			});
+
+			const browserLogsStream: WriteStream = fs.createWriteStream(browserLogsFileName);
+			browserLogsStream.write(Buffer.from(browserLogs));
+			browserLogsStream.end();
+		});
+	}
 }
 
 export = CheReporter;

package/utils/DevWorkspaceConfigurationHelper.ts

@@ -1,3 +1,12 @@
+/** *******************************************************************
+ * 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
+ **********************************************************************/
 import { Main as Generator } from '@eclipse-che/che-devworkspace-generator/lib/main';
 import { DevfileContext } from '@eclipse-che/che-devworkspace-generator/lib/api/devfile-context';
 import { V1alpha2DevWorkspaceTemplate } from '@devfile/api';
@@ -5,7 +14,7 @@ import YAML from 'yaml';
 import * as axios from 'axios';
 import { Logger } from './Logger';
 import { ShellExecutor } from './ShellExecutor';
-import { APITestConstants } from '../constants/APITestConstants';
+import { API_TEST_CONSTANTS } from '../constants/API_TEST_CONSTANTS';
 
 /**
  * to see more about IContextParams and generateDevfileContext(params) check README.md in "@eclipse-che/che-devworkspace-generator;
@@ -13,71 +22,71 @@ import { APITestConstants } from '../constants/APITestConstants';
  */
 
 interface IContextParams {
-  devfilePath?: string | undefined;
-  devfileUrl?: string | undefined;
-  devfileContent?: string | undefined;
-  outputFile?: string | undefined;
-  editorPath?: string | undefined;
-  editorContent?: string | undefined;
-  editorEntry?: string | undefined;
-  pluginRegistryUrl?: string | undefined;
-  projects?: {
-    name: string;
-    location: string;
-  }[];
-  injectDefaultComponent?: string | undefined;
-  defaultComponentImage?: string | undefined;
+	devfilePath?: string | undefined;
+	devfileUrl?: string | undefined;
+	devfileContent?: string | undefined;
+	outputFile?: string | undefined;
+	editorPath?: string | undefined;
+	editorContent?: string | undefined;
+	editorEntry?: string | undefined;
+	pluginRegistryUrl?: string | undefined;
+	projects?: {
+		name: string;
+		location: string;
+	}[];
+	injectDefaultComponent?: string | undefined;
+	defaultComponentImage?: string | undefined;
 }
 
 export class DevWorkspaceConfigurationHelper {
-  private generator: Generator = new Generator();
-  private readonly params: IContextParams;
+	private generator: Generator = new Generator();
+	private readonly params: IContextParams;
 
-  constructor(params: IContextParams) {
-    // 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 (APITestConstants.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 = APITestConstants.TS_API_TEST_UDI_IMAGE;
-      }
-    }
-    // assign value from the constants if not explicitly passed
-    if (APITestConstants.TS_API_TEST_PLUGIN_REGISTRY_URL && !params.pluginRegistryUrl) {
-      params.pluginRegistryUrl = APITestConstants.TS_API_TEST_PLUGIN_REGISTRY_URL;
-    }
-    if (APITestConstants.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI && !params.editorContent) {
-      params.editorContent = ShellExecutor.curl(APITestConstants.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI).stdout;
-    }
-    this.params = params;
-  }
+	constructor(params: IContextParams) {
+		// 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.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.TS_API_TEST_UDI_IMAGE;
+			}
+		}
+		// assign value from the constants if not explicitly passed
+		if (API_TEST_CONSTANTS.TS_API_TEST_PLUGIN_REGISTRY_URL && !params.pluginRegistryUrl) {
+			params.pluginRegistryUrl = API_TEST_CONSTANTS.TS_API_TEST_PLUGIN_REGISTRY_URL;
+		}
+		if (API_TEST_CONSTANTS.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI && !params.editorContent) {
+			params.editorContent = ShellExecutor.curl(API_TEST_CONSTANTS.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI).stdout;
+		}
+		this.params = params;
+	}
 
-  async generateDevfileContext(): Promise<DevfileContext> {
-    Logger.debug();
-    if (!this.params.projects) {
-      this.params.projects = [];
-    }
-    return await this.generator.generateDevfileContext(
-      {
-        ...this.params,
-        projects: this.params.projects
-      },
-      axios.default as any
-    );
-  }
+	async generateDevfileContext(): Promise<DevfileContext> {
+		Logger.debug();
+		if (!this.params.projects) {
+			this.params.projects = [];
+		}
+		return await this.generator.generateDevfileContext(
+			{
+				...this.params,
+				projects: this.params.projects
+			},
+			axios.default as any
+		);
+	}
 
-  // write templates and then DevWorkspace in a single file
-  async getDevWorkspaceConfigurationYamlAsString(context: DevfileContext): Promise<string> {
-    Logger.debug();
-    const allContentArray: any[] = context.devWorkspaceTemplates.map(
-      (template: V1alpha2DevWorkspaceTemplate) => YAML.stringify(template)
-    );
-    allContentArray.push(YAML.stringify(context.devWorkspace));
+	// write templates and then DevWorkspace in a single file
+	getDevWorkspaceConfigurationYamlAsString(context: DevfileContext): string {
+		Logger.debug();
+		const allContentArray: any[] = context.devWorkspaceTemplates.map((template: V1alpha2DevWorkspaceTemplate): string =>
+			YAML.stringify(template)
+		);
+		allContentArray.push(YAML.stringify(context.devWorkspace));
 
-    return allContentArray.join('---\n');
-  }
+		return allContentArray.join('---\n');
+	}
 }

package/utils/DevfilesRegistryHelper.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2023 Red Hat, Inc.
+/** *******************************************************************
+ * 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
@@ -10,68 +10,77 @@
 import axios, { AxiosResponse } from 'axios';
 import { Logger } from './Logger';
 import YAML from 'yaml';
-import { APITestConstants, SupportedDevfilesRegistries } from '../constants/APITestConstants';
+import { API_TEST_CONSTANTS, SUPPORTED_DEVFILE_REGISTRIES } from '../constants/API_TEST_CONSTANTS';
 
 export class DevfilesRegistryHelper {
+	async getInbuiltDevfilesRegistryContent(): Promise<AxiosResponse> {
+		Logger.debug();
+		return await this.getContent(SUPPORTED_DEVFILE_REGISTRIES.INBUILT_APPLICATION_DEVFILE_REGISTRY_URL());
+	}
 
-  async getInbuiltDevfilesRegistryContent(): Promise<AxiosResponse> {
-    Logger.debug();
-    return await this.getContent(SupportedDevfilesRegistries.INBUILT_APPLICATION_DEVFILE_REGISTRY_URL());
-  }
+	async getGitHubCheDevfileRegistryContent(): Promise<AxiosResponse> {
+		Logger.debug();
+		return await this.getContent(SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL);
+	}
 
-  async getGitHubCheDevfileRegistryContent(): Promise<AxiosResponse> {
-    Logger.debug();
-    return await this.getContent(SupportedDevfilesRegistries.GIT_HUB_CHE_DEVFILE_REGISTRY_URL);
-  }
+	async collectPathsToDevfilesFromRegistry(): Promise<object[]> {
+		Logger.debug();
+		const devfileSamples: object[] = [];
+		const sampleNames: string[] = [];
+		switch (API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL()) {
+			case SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL:
+				{
+					const content: any[any] = await this.getGitHubCheDevfileRegistryContent();
+					content.forEach((e: any): void => {
+						if (e.name[0] !== '.') {
+							sampleNames.push(e.name);
+						}
+					});
 
-  async collectPathsToDevfilesFromRegistry(): Promise<object[]> {
-    Logger.debug();
-    const devfileSamples: object[] = [];
-    const sampleNames: string[] = [];
-    switch (APITestConstants.TS_API_ACCEPTANCE_TEST_REGISTRY_URL()) {
-      case (SupportedDevfilesRegistries.GIT_HUB_CHE_DEVFILE_REGISTRY_URL): {
-        const content: any[any] = await this.getGitHubCheDevfileRegistryContent();
-        content.forEach((e: any) => {
-          if (e.name[0] !== '.') { sampleNames.push(e.name); }
-        });
+					for (const sample of sampleNames) {
+						const sampleEndpoint: string = `${SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL}${sample}/meta.yaml`;
+						const sampleEndpointContent: AxiosResponse = await this.getContent(sampleEndpoint);
+						const decodedFileContent: string = Buffer.from((sampleEndpointContent as any).content, 'base64').toString();
+						const metaYamlContent: any = YAML.parse(decodedFileContent);
+						devfileSamples.push({
+							name: sample,
+							link: metaYamlContent.links.v2
+						});
+					}
+					Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+				}
+				break;
+			case SUPPORTED_DEVFILE_REGISTRIES.INBUILT_APPLICATION_DEVFILE_REGISTRY_URL():
+				{
+					const content: any[any] = await this.getInbuiltDevfilesRegistryContent();
 
-        for (const sample of sampleNames) {
-          const sampleEndpoint: string = `${SupportedDevfilesRegistries.GIT_HUB_CHE_DEVFILE_REGISTRY_URL}${sample}/meta.yaml`;
-          const sampleEndpointContent: AxiosResponse = await this.getContent(sampleEndpoint);
-          const decodedFileContent: string = Buffer.from((sampleEndpointContent as any).content, 'base64').toString();
-          const metaYamlContent: any = YAML.parse(decodedFileContent);
-          devfileSamples.push({ name: sample, link: metaYamlContent.links.v2 });
-        }
-        Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
-      }
-        break;
-      case (SupportedDevfilesRegistries.INBUILT_APPLICATION_DEVFILE_REGISTRY_URL()): {
-        const content: any[any] = await this.getInbuiltDevfilesRegistryContent();
+					for (const sample of content) {
+						devfileSamples.push({
+							name: sample.displayName,
+							link: sample.links.v2
+						});
+					}
+					Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+				}
+				break;
+			default: {
+				Logger.error(`unsupported registry url - ${API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL()}\n
+                supported registries: ${JSON.stringify(SUPPORTED_DEVFILE_REGISTRIES)}`);
+			}
+		}
+		return devfileSamples;
+	}
 
-        for (const sample of content) {
-          devfileSamples.push({ name: sample.displayName, link: sample.links.v2 });
-        }
-        Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
-      }
-        break;
-      default: {
-        Logger.error(`unsupported registry url - ${APITestConstants.TS_API_ACCEPTANCE_TEST_REGISTRY_URL()}\n
-                supported registries: ${JSON.stringify(SupportedDevfilesRegistries)}`);
-      }
-    }
-    return devfileSamples;
-  }
+	private async getContent(url: string, headers?: object): Promise<AxiosResponse> {
+		Logger.debug(`${url}`);
 
-  private async getContent(url: string, headers?: object): Promise<AxiosResponse> {
-    Logger.debug(`${url}`);
-
-    let response: AxiosResponse | undefined;
-    try {
-      response = await axios.get(url, headers);
-    } catch (error) {
-      Logger.error(`${error} + ${url}`);
-      throw error;
-    }
-    return response?.data;
-  }
+		let response: AxiosResponse | undefined;
+		try {
+			response = await axios.get(url, headers);
+		} catch (error) {
+			Logger.error(`${error} + ${url}`);
+			throw error;
+		}
+		return response?.data;
+	}
 }