@eclipse-che/che-e2e 7.74.0-dev-1d09cb7 → 7.74.0-dev-aace77a

package/utils/Logger.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
@@ -7,137 +7,114 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  **********************************************************************/
-import { ReporterConstants } from '../constants/ReporterConstants';
+import { REPORTER_CONSTANTS } from '../constants/REPORTER_CONSTANTS';
 
 export abstract class Logger {
-  /**
-   * Uses for logging of fatal errors.
-   * @param text log text
-   * @param indentLevel log level
-   */
-  static error(text: string = '', indentLevel: number = 1): void {
-    const callerInfo: string = this.getCallerInfo();
-    const logLevelSymbol: string = '[ERROR] ';
-    this.logText(
-      indentLevel,
-      logLevelSymbol,
-      `${this.getFullMessage(callerInfo, text)}`
-    );
-  }
+	/**
+	 * uses for logging of fatal errors.
+	 * @param text log text
+	 * @param indentLevel log level
+	 */
+	static error(text: string = '', indentLevel: number = 1): void {
+		const callerInfo: string = this.getCallerInfo();
+		const logLevelSymbol: string = '[ERROR] ';
+		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+	}
 
-  /**
-   * Uses for logging of recoverable errors and general warnings.
-   * @param text log text
-   * @param indentLevel log level
-   */
-  static warn(text: string = '', indentLevel: number = 1): void {
-    if (ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR') {
-      return;
-    }
-    const callerInfo: string = this.getCallerInfo();
-    const logLevelSymbol: string = '[WARN] ';
-    this.logText(
-      indentLevel,
-      logLevelSymbol,
-      `${this.getFullMessage(callerInfo, text)}`
-    );
-  }
+	/**
+	 * uses for logging of recoverable errors and general warnings.
+	 * @param text log text
+	 * @param indentLevel log level
+	 */
+	static warn(text: string = '', indentLevel: number = 1): void {
+		if (REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'ERROR') {
+			return;
+		}
+		const callerInfo: string = this.getCallerInfo();
+		const logLevelSymbol: string = '[WARN] ';
+		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+	}
 
-  /**
-   * Uses for logging of the public methods of the pageobjects.
-   * @param text log text
-   * @param indentLevel log level
-   */
-  static info(text: string = '', indentLevel: number = 3): void {
-    if (
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'WARN'
-    ) {
-      return;
-    }
-    const callerInfo: string = this.getCallerInfo();
-    const logLevelSymbol: string = '• ';
-    this.logText(
-      indentLevel,
-      logLevelSymbol,
-      `${this.getFullMessage(callerInfo, text)}`
-    );
-  }
+	/**
+	 * uses for logging of the public methods of the pageobjects.
+	 * @param text log text
+	 * @param indentLevel log level
+	 */
+	static info(text: string = '', indentLevel: number = 3): void {
+		if (REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'ERROR' || REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'WARN') {
+			return;
+		}
+		const callerInfo: string = this.getCallerInfo();
+		const logLevelSymbol: string = '• ';
+		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+	}
 
-  /**
-   * Uses for logging of the public methods of the pageobjects.
-   * @param text log text
-   * @param indentLevel log level
-   */
-  static debug(text: string = '', indentLevel: number = 5): void {
-    if (
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'WARN' ||
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'INFO'
-    ) {
-      return;
-    }
-    const callerInfo: string = this.getCallerInfo();
-    const logLevelSymbol: string = '▼ ';
-    this.logText(
-      indentLevel,
-      logLevelSymbol,
-      `${this.getFullMessage(callerInfo, text)}`
-    );
-  }
+	/**
+	 * uses for logging of the public methods of the pageobjects.
+	 * @param text log text
+	 * @param indentLevel log level
+	 */
+	static debug(text: string = '', indentLevel: number = 5): void {
+		if (
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'WARN' ||
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'INFO'
+		) {
+			return;
+		}
+		const callerInfo: string = this.getCallerInfo();
+		const logLevelSymbol: string = '▼ ';
+		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+	}
 
-  /**
-   * Uses for logging of the public methods of the {@link DriverHelper} or
-   * private methods inside of pageobjects.
-   * @param text log text
-   * @param indentLevel log level
-   */
-  static trace(text: string = '', indentLevel: number = 6): void {
-    if (
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'WARN' ||
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'INFO' ||
-      ReporterConstants.TS_SELENIUM_LOG_LEVEL === 'DEBUG'
-    ) {
-      return;
-    }
-    const callerInfo: string = this.getCallerInfo();
-    const logLevelSymbol: string = '‣ ';
-    this.logText(
-      indentLevel,
-      logLevelSymbol,
-      `${this.getFullMessage(callerInfo, text)}`
-    );
-  }
+	/**
+	 * uses for logging of the public methods of the {@link DriverHelper} or
+	 * private methods inside of pageobjects.
+	 * @param text log text
+	 * @param indentLevel log level
+	 */
+	static trace(text: string = '', indentLevel: number = 6): void {
+		if (
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'WARN' ||
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'INFO' ||
+			REPORTER_CONSTANTS.TS_SELENIUM_LOG_LEVEL === 'DEBUG'
+		) {
+			return;
+		}
+		const callerInfo: string = this.getCallerInfo();
+		const logLevelSymbol: string = '‣ ';
+		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+	}
 
-  private static getFullMessage(callerInfo: string, text: string): string {
-    return `${callerInfo}${this.separator(text, callerInfo)}${text}`;
-  }
+	private static getFullMessage(callerInfo: string, text: string): string {
+		return `${callerInfo}${this.separator(text, callerInfo)}${text}`;
+	}
 
-  private static logText(messageIndentationLevel: number, logLevelSymbol: string, text: string): void {
-    if (text) {
-      // start group for every level
-      for (let i: number = 0; i < messageIndentationLevel; i++) {
-        console.group();
-      }
-      // print the trimmed text
-      // if multiline, the message should be properly padded
-      console.log(logLevelSymbol + text);
-      // end group for every level
-      for (let i: number = 0; i < messageIndentationLevel; i++) {
-        console.groupEnd();
-      }
-    }
-  }
+	private static logText(messageIndentationLevel: number, logLevelSymbol: string, text: string): void {
+		if (text) {
+			// start group for every level
+			for (let i: number = 0; i < messageIndentationLevel; i++) {
+				console.group();
+			}
+			// print the trimmed text
+			// if multiline, the message should be properly padded
+			console.log(logLevelSymbol + text);
+			// end group for every level
+			for (let i: number = 0; i < messageIndentationLevel; i++) {
+				console.groupEnd();
+			}
+		}
+	}
 
-  private static getCallerInfo(): string {
-    const e: Error = new Error();
-    const stack: string[] = e.stack ? e.stack.split('\n') : [];
-    // " at functionName ( ..." => "functionName"
-    return stack[3].includes('.<anonymous') ? '' : stack[3].replace(/^\s+at\s+(.+?)\s.+/g, '$1');
-  }
+	private static getCallerInfo(): string {
+		const e: Error = new Error();
+		const stack: string[] = e.stack ? e.stack.split('\n') : [];
+		// " at functionName ( ..." => "functionName"
+		return stack[3].includes('.<anonymous') ? '' : stack[3].replace(/^\s+at\s+(.+?)\s.+/g, '$1');
+	}
 
-  private static separator(text: string, caller: string): string {
-    return text ? caller ? ' - ' : '' : '';
-  }
+	private static separator(text: string, caller: string): string {
+		return text ? (caller ? ' - ' : '') : '';
+	}
 }

package/utils/ScreenCatcher.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2021-2023 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2021-2023 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -14,61 +14,72 @@ import { CLASSES } from '../configs/inversify.types';
 import { DriverHelper } from './DriverHelper';
 import { error } from 'selenium-webdriver';
 import { StringUtil } from './StringUtil';
-import { ReporterConstants } from '../constants/ReporterConstants';
+import { REPORTER_CONSTANTS } from '../constants/REPORTER_CONSTANTS';
 
 @injectable()
 export class ScreenCatcher {
-  constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper) { }
+	constructor(
+		@inject(CLASSES.DriverHelper)
+		private readonly driverHelper: DriverHelper
+	) {}
 
-  async catchMethodScreen(methodName: string, methodIndex: number, screenshotIndex: number): Promise<void> {
-    const executionScreenCastDir: string = `${ReporterConstants.TS_SELENIUM_REPORT_FOLDER}/executionScreencast`;
-    const executionScreenCastErrorsDir: string = `${ReporterConstants.TS_SELENIUM_REPORT_FOLDER}/executionScreencastErrors`;
-    const formattedMethodIndex: string = new Intl.NumberFormat('en-us', { minimumIntegerDigits: 3 }).format(methodIndex);
-    const formattedScreenshotIndex: string = new Intl.NumberFormat('en-us', { minimumIntegerDigits: 5 }).format(screenshotIndex).replace(/,/g, '');
+	async catchMethodScreen(methodName: string, methodIndex: number, screenshotIndex: number): Promise<void> {
+		const executionScreenCastDir: string = `${REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER}/executionScreencast`;
+		const executionScreenCastErrorsDir: string = `${REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER}/executionScreencastErrors`;
+		const formattedMethodIndex: string = new Intl.NumberFormat('en-us', {
+			minimumIntegerDigits: 3
+		}).format(methodIndex);
+		const formattedScreenshotIndex: string = new Intl.NumberFormat('en-us', { minimumIntegerDigits: 5 })
+			.format(screenshotIndex)
+			.replace(/,/g, '');
 
-    if (!fs.existsSync(ReporterConstants.TS_SELENIUM_REPORT_FOLDER)) {
-      fs.mkdirSync(ReporterConstants.TS_SELENIUM_REPORT_FOLDER);
-    }
+		if (!fs.existsSync(REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER)) {
+			fs.mkdirSync(REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
+		}
 
-    if (!fs.existsSync(executionScreenCastDir)) {
-      fs.mkdirSync(executionScreenCastDir);
-    }
+		if (!fs.existsSync(executionScreenCastDir)) {
+			fs.mkdirSync(executionScreenCastDir);
+		}
 
-    const date: Date = new Date();
-    const timeStr: string = date.toLocaleTimeString('en-us', { hour12: false }) + '.' + new Intl.NumberFormat('en-us', { minimumIntegerDigits: 3 }).format(date.getMilliseconds());
+		const date: Date = new Date();
+		const timeStr: string =
+			date.toLocaleTimeString('en-us', { hour12: false }) +
+			'.' +
+			new Intl.NumberFormat('en-us', { minimumIntegerDigits: 3 }).format(date.getMilliseconds());
 
-    const screenshotPath: string = `${executionScreenCastDir}/${formattedMethodIndex}-${formattedScreenshotIndex}--(${StringUtil.sanitizeTitle(timeStr)})_${StringUtil.sanitizeTitle(methodName)}.png`;
+		const screenshotPath: string = `${executionScreenCastDir}/${formattedMethodIndex}-${formattedScreenshotIndex}--(${StringUtil.sanitizeTitle(
+			timeStr
+		)})_${StringUtil.sanitizeTitle(methodName)}.png`;
 
-    try {
-      await this.catchScreen(screenshotPath);
-    } catch (err) {
-      if (!fs.existsSync(executionScreenCastErrorsDir)) {
-        fs.mkdirSync(executionScreenCastErrorsDir);
-      }
+		try {
+			await this.catchScreen(screenshotPath);
+		} catch (err) {
+			if (!fs.existsSync(executionScreenCastErrorsDir)) {
+				fs.mkdirSync(executionScreenCastErrorsDir);
+			}
 
-      let errorLogFilePath: string = screenshotPath.replace('.png', '.txt');
-      errorLogFilePath = errorLogFilePath.replace(executionScreenCastDir, executionScreenCastErrorsDir);
-      if (err instanceof error.IError) {
-        await this.writeErrorLog(errorLogFilePath, err);
-      }
-    }
-  }
+			let errorLogFilePath: string = screenshotPath.replace('.png', '.txt');
+			errorLogFilePath = errorLogFilePath.replace(executionScreenCastDir, executionScreenCastErrorsDir);
+			if (err instanceof error.IError) {
+				this.writeErrorLog(errorLogFilePath, err);
+			}
+		}
+	}
 
-  async catchScreen(screenshotPath: string): Promise<void> {
-    const screenshot: string = await this.driverHelper.getDriver().takeScreenshot();
-    const screenshotStream: WriteStream = fs.createWriteStream(screenshotPath);
-    screenshotStream.write(Buffer.from(screenshot, 'base64'));
-    screenshotStream.end();
-  }
+	async catchScreen(screenshotPath: string): Promise<void> {
+		const screenshot: string = await this.driverHelper.getDriver().takeScreenshot();
+		const screenshotStream: WriteStream = fs.createWriteStream(screenshotPath);
+		screenshotStream.write(Buffer.from(screenshot, 'base64'));
+		screenshotStream.end();
+	}
 
-  async writeErrorLog(errorLogPath: string, err: error.IError): Promise<void> {
-    console.log(`Failed to save screenshot, additional information in the ${errorLogPath}`);
-
-    if (err.stack) {
-      const screenshotStream: WriteStream = fs.createWriteStream(errorLogPath);
-      screenshotStream.write(Buffer.from(err.stack, 'utf8'));
-      screenshotStream.end();
-    }
-  }
+	writeErrorLog(errorLogPath: string, err: error.IError): void {
+		console.log(`Failed to save screenshot, additional information in the ${errorLogPath}`);
 
+		if (err.stack) {
+			const screenshotStream: WriteStream = fs.createWriteStream(errorLogPath);
+			screenshotStream.write(Buffer.from(err.stack, 'utf8'));
+			screenshotStream.end();
+		}
+	}
 }

package/utils/ShellExecutor.ts

@@ -1,17 +1,28 @@
-import { echo, exec, ShellString } from 'shelljs';
+/** *******************************************************************
+ * 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 { exec, ShellString } from 'shelljs';
+import { Logger } from './Logger';
+import { injectable } from 'inversify';
 
+@injectable()
 export class ShellExecutor {
+	wait(seconds: number): void {
+		this.executeCommand(`sleep ${seconds}s`);
+	}
 
-  static wait(seconds: number): void {
-    this.execWithLog(`sleep ${seconds}s`);
-  }
+	curl(link: string): ShellString {
+		return this.executeCommand(`curl -k ${link}`);
+	}
 
-  static curl(link: string): ShellString {
-    return this.execWithLog(`curl -k ${link}`);
-  }
-
-  protected static execWithLog(command: string): ShellString {
-    echo(command);
-    return exec(command);
-  }
+	executeCommand(command: string): ShellString {
+		Logger.debug(command);
+		return exec(command);
+	}
 }

package/utils/StringUtil.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2019 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -8,42 +8,55 @@
  * SPDX-License-Identifier: EPL-2.0
  **********************************************************************/
 
-import { injectable } from 'inversify';
 import { Logger } from './Logger';
+import { injectable } from 'inversify';
 
 @injectable()
 export class StringUtil {
-  /**
-   * Method extracts a test repo name from git clone https url;
-   * it splits the url into string[] by "/" or ".", deletes empty elements and elements that contains just "git", "main" or "tree" word, than returns the last one;
-   * please, avoid to call the test repo as just "git" or to use dots in the name, like: github.com/user/git.git, github.com/user/name.with.dots.
-   * @param url git https url (which using for "git clone")
-   * @return project name
-   */
-  static getProjectNameFromGitUrl(url: string): string {
-    Logger.debug(`${url}`);
-    if (url.includes('?')) {
-      url = url.substring(0, url.indexOf('?'));
-    }
-    if (url.includes('/tree/')) {
-      url = url.split('/').slice(0, -2).join('/');
-    }
-    const projectName: string = url.split(/[\/.]/).filter((e: string) => !['git', ''].includes(e)).reverse()[0];
-    Logger.debug(`${projectName}`);
-    return projectName;
-  }
-
-  static sanitizeTitle(arg: string): string {
-    return arg.replace(/\//g, '+').replace(/,/g, '.').replace(/:/g, '-').replace(/['"]/g, '').replace(/[^a-z0-9+\-.()\[\]_]/gi, '_');
-  }
-
-  /**
-   * Replaces ${ENV}, $ENV to "$ENV"
-   * @param command string command with environmental variables in unsupported format
-   * @return updated command with environmental variables in supported format
-   */
-
-  static updateCommandEnvsToShStyle(command: string): string {
-    return command.replace(/[{}]/g, '').replace(/(?<!")\${?[a-zA-Z0-9_+\-\s]+\b}?/gm, `"\$&"`);
-  }
+	/**
+	 * method extracts a test repo name from git clone https url;
+	 * it splits the url into string[] by "/" or ".", deletes empty elements and elements that contains just "git", "main" or "tree" word, than returns the last one;
+	 * please, avoid to call the test repo as just "git" or to use dots in the name, like: github.com/user/git.git, github.com/user/name.with.dots.
+	 * @param url git https url (which using for "git clone")
+	 * @return project name
+	 */
+	static getProjectNameFromGitUrl(url: string): string {
+		Logger.debug(`${url}`);
+
+		if (url.includes('?')) {
+			url = url.substring(0, url.indexOf('?'));
+		}
+		if (url.includes('/tree/')) {
+			url = url.split('/').slice(0, -2).join('/');
+		}
+		const projectName: string = url
+			.split(/[\/.]/)
+			.filter((e: string): boolean => !['git', ''].includes(e))
+			.reverse()[0];
+		Logger.debug(`${projectName}`);
+		return projectName;
+	}
+
+	static sanitizeTitle(arg: string): string {
+		Logger.trace();
+
+		return arg
+			.replace(/\//g, '+')
+			.replace(/,/g, '.')
+			.replace(/:/g, '-')
+			.replace(/['"]/g, '')
+			.replace(/[^a-z0-9+\-.()\[\]_]/gi, '_');
+	}
+
+	/**
+	 * replaces ${ENV}, $ENV to "$ENV"
+	 * @param command string command with environmental variables in unsupported format
+	 * @return updated command with environmental variables in supported format
+	 */
+
+	static updateCommandEnvsToShStyle(command: string): string {
+		Logger.trace();
+
+		return command.replace(/[{}]/g, '').replace(/(?<!")\${?[a-zA-Z0-9_+\-\s]+\b}?/gm, '"$&"');
+	}
 }