@eclipse-che/che-e2e 7.76.0 → 7.77.0

package/utils/BrowserTabsUtil.ts

@@ -76,7 +76,14 @@ export class BrowserTabsUtil {
 	async getCurrentUrl(): Promise<string> {
 		Logger.trace();
 
-		return await this.driverHelper.getDriver().getCurrentUrl();
+		let currentUrl: string = '';
+		try {
+			currentUrl = await this.driverHelper.getDriver().getCurrentUrl();
+		} catch (e) {
+			Logger.trace('cannot get current url');
+		}
+
+		return currentUrl;
 	}
 
 	async waitURL(expectedUrl: string, timeout: number): Promise<void> {

package/utils/DevWorkspaceConfigurationHelper.ts

@@ -56,6 +56,7 @@ export class DevWorkspaceConfigurationHelper {
 
 	async generateDevfileContext(): Promise<DevfileContext> {
 		Logger.debug();
+
 		if (!this.params.projects) {
 			this.params.projects = [];
 		}
@@ -71,6 +72,7 @@ export class DevWorkspaceConfigurationHelper {
 	// 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)
 		);
@@ -80,7 +82,7 @@ export class DevWorkspaceConfigurationHelper {
 	}
 
 	getDevWorkspaceConfigurationsAsYaml(allContentString: string): string {
-		Logger.debug(`${this.constructor.name}.${this.getDevWorkspaceConfigurationsAsYaml.name}`);
+		Logger.debug();
 		const content: any = {};
 		const contentArray: string[] = allContentString.split('---\n');
 		contentArray.forEach((e: any): void => {
@@ -97,6 +99,7 @@ export class DevWorkspaceConfigurationHelper {
 		return content;
 	}
 	patchDevWorkspaceConfigWithBuildContainerAttribute(devfileContextDevWorkspace: any): void {
+		Logger.debug();
 		devfileContextDevWorkspace.spec.template.attributes = YAML.parse(`
                     controller.devfile.io/devworkspace-config:
                       name: devworkspace-config

package/utils/DevfilesRegistryHelper.ts

@@ -28,54 +28,56 @@ export class DevfilesRegistryHelper {
 	async getGitHubCheDevfileRegistryContent(): Promise<AxiosResponse> {
 		Logger.trace();
 
-		return await this.getContent(SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL);
+		const url: string =
+			API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL() === ''
+				? SUPPORTED_DEVFILE_REGISTRIES.GIT_HUB_CHE_DEVFILE_REGISTRY_URL
+				: API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL();
+		return await this.getContent(url);
 	}
 
-	async collectPathsToDevfilesFromRegistry(isInbuilt: boolean = true, sampleNamePatterns?: string[]): Promise<object[]> {
+	async collectPathsToDevfilesFromRegistry(isInbuilt: boolean, sampleNamePatterns?: string[]): Promise<object[]> {
 		Logger.debug();
 
 		const devfileSamples: object[] = [];
 		const sampleNames: string[] = [];
-		switch (isInbuilt) {
-			case false:
-				{
-					const content: any[any] = await this.getGitHubCheDevfileRegistryContent();
-					content.forEach((e: any): void => {
-						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
-						});
+		if (!isInbuilt) {
+			{
+				const content: any[any] = await this.getGitHubCheDevfileRegistryContent();
+				content.forEach((e: any): void => {
+					if (e.name[0] !== '.') {
+						sampleNames.push(e.name);
 					}
-					Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+				});
+
+				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
+					});
 				}
-				break;
-			case true:
-				{
-					const content: any[any] = await this.getInbuiltDevfilesRegistryContent(sampleNamePatterns);
-					for (const sample of content) {
-						const linkToDevWorkspaceYaml: any =
-							BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL +
-							'/devfile-registry' +
-							sample.links.devWorkspaces['che-incubator/che-code/latest'];
-						devfileSamples.push({
-							name: sample.displayName,
-							devWorkspaceConfigurationString: await this.getContent(linkToDevWorkspaceYaml)
-						});
-					}
-					Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+				Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+			}
+		} else if (isInbuilt) {
+			{
+				const content: any[any] = await this.getInbuiltDevfilesRegistryContent(sampleNamePatterns);
+				for (const sample of content) {
+					const linkToDevWorkspaceYaml: any =
+						BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL +
+						'/devfile-registry' +
+						sample.links.devWorkspaces['che-incubator/che-code/latest'];
+					devfileSamples.push({
+						name: sample.displayName,
+						devWorkspaceConfigurationString: await this.getContent(linkToDevWorkspaceYaml)
+					});
 				}
-				break;
-			default: {
+				Logger.debug(`samples list: ${JSON.stringify(devfileSamples)}`);
+			}
+		} else {
+			{
 				Logger.error(`unsupported registry url - ${API_TEST_CONSTANTS.TS_API_ACCEPTANCE_TEST_REGISTRY_URL()}\n
                 supported registries: ${JSON.stringify(SUPPORTED_DEVFILE_REGISTRIES)}`);
 			}

package/utils/DriverHelper.ts

@@ -742,4 +742,10 @@ export class DriverHelper {
 
 		await this.getDriver().navigate().to(url);
 	}
+
+	async quit(): Promise<void> {
+		Logger.trace();
+
+		await this.getDriver().quit();
+	}
 }

package/utils/KubernetesCommandLineToolsExecutor.ts

@@ -46,14 +46,14 @@ export class KubernetesCommandLineToolsExecutor implements IKubernetesCommandLin
 	}
 
 	get namespace(): string | undefined {
-		this._namespace =
-			this._namespace !== undefined
-				? this._namespace
-				: BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL.includes('devspaces')
-				? OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME + '-devspaces'
-				: BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL.includes('che')
-				? OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME + '-che'
-				: 'default';
+		if (!this._namespace) {
+			const applicationName: string = BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME();
+			if (applicationName === 'default') {
+				this._namespace = applicationName;
+			} else {
+				this._namespace = OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME + '-' + applicationName;
+			}
+		}
 		return this._namespace;
 	}
 

package/utils/Logger.ts

@@ -8,17 +8,23 @@
  * SPDX-License-Identifier: EPL-2.0
  **********************************************************************/
 import { REPORTER_CONSTANTS } from '../constants/REPORTER_CONSTANTS';
+import { rpApi } from '../specs/MochaHooks';
 
-export abstract class Logger {
+export 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)}`);
+		const message: string = this.getFullMessage(callerInfo, text);
+		this.logText(indentLevel, logLevelSymbol, message);
+		if (this.sendLogMessageIntoReportPortal()) {
+			rpApi.error(message);
+		}
 	}
 
 	/**
@@ -32,7 +38,11 @@ export abstract class Logger {
 		}
 		const callerInfo: string = this.getCallerInfo();
 		const logLevelSymbol: string = '[WARN] ';
-		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+		const message: string = this.getFullMessage(callerInfo, text);
+		this.logText(indentLevel, logLevelSymbol, message);
+		if (this.sendLogMessageIntoReportPortal()) {
+			rpApi.warn(message);
+		}
 	}
 
 	/**
@@ -46,7 +56,11 @@ export abstract class Logger {
 		}
 		const callerInfo: string = this.getCallerInfo();
 		const logLevelSymbol: string = '• ';
-		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+		const message: string = this.getFullMessage(callerInfo, text);
+		this.logText(indentLevel, logLevelSymbol, message);
+		if (this.sendLogMessageIntoReportPortal()) {
+			rpApi.info(message);
+		}
 	}
 
 	/**
@@ -64,7 +78,11 @@ export abstract class Logger {
 		}
 		const callerInfo: string = this.getCallerInfo();
 		const logLevelSymbol: string = '▼ ';
-		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+		const message: string = this.getFullMessage(callerInfo, text);
+		this.logText(indentLevel, logLevelSymbol, message);
+		if (this.sendLogMessageIntoReportPortal()) {
+			rpApi.debug(message);
+		}
 	}
 
 	/**
@@ -84,13 +102,21 @@ export abstract class Logger {
 		}
 		const callerInfo: string = this.getCallerInfo();
 		const logLevelSymbol: string = '‣ ';
-		this.logText(indentLevel, logLevelSymbol, `${this.getFullMessage(callerInfo, text)}`);
+		const message: string = this.getFullMessage(callerInfo, text);
+		this.logText(indentLevel, logLevelSymbol, message);
+		if (this.sendLogMessageIntoReportPortal()) {
+			rpApi.trace(message);
+		}
 	}
 
 	private static getFullMessage(callerInfo: string, text: string): string {
 		return `${callerInfo}${this.separator(text, callerInfo)}${text}`;
 	}
 
+	private static separator(text: string, caller: string): string {
+		return text ? (caller ? ' - ' : '') : '';
+	}
+
 	private static logText(messageIndentationLevel: number, logLevelSymbol: string, text: string): void {
 		if (text) {
 			// start group for every level
@@ -107,14 +133,26 @@ export abstract class Logger {
 		}
 	}
 
-	private static getCallerInfo(): string {
-		const e: Error = new Error();
-		const stack: string[] = e.stack ? e.stack.split('\n') : [];
+	private static getCallerInfo(i: number = 4): string {
+		const stack: string[] = this.getCallStackArray();
 		// " at functionName ( ..." => "functionName"
-		return stack[3].includes('.<anonymous') ? '' : stack[3].replace(/^\s+at\s+(.+?)\s.+/g, '$1');
+		return stack[i].includes('.<anonymous') ? '' : stack[i].replace(/^\s+at\s+(.+?)\s.+/g, '$1');
 	}
 
-	private static separator(text: string, caller: string): string {
-		return text ? (caller ? ' - ' : '') : '';
+	private static getCallStackArray(): string[] {
+		const e: Error = new Error();
+		return e.stack ? e.stack.split('\n') : [];
+	}
+
+	private static sendLogMessageIntoReportPortal(): boolean {
+		return REPORTER_CONSTANTS.SAVE_RP_REPORT_DATA && !this.isRootCaller();
+	}
+
+	private static isRootCaller(traceLevel: number = 6): boolean {
+		return this.getCallStackArray()
+			.slice(traceLevel, traceLevel + 4)
+			.reduce((acc, e): boolean => {
+				return acc || /MochaHooks|CheReporter/.test(e);
+			}, false);
 	}
 }

package/utils/workspace/ITestWorkspaceUtil.ts

@@ -11,33 +11,33 @@
 import { WorkspaceStatus } from './WorkspaceStatus';
 
 export interface ITestWorkspaceUtil {
-	waitWorkspaceStatus(namespace: string, workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus): void;
+	waitWorkspaceStatus(workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus): Promise<void>;
 
-	stopWorkspaceByName(workspaceName: string): void;
+	stopWorkspaceByName(workspaceName: string): Promise<void>;
 
 	/**
 	 * delete a workspace without stopping phase (similar with force deleting)
 	 */
-	deleteWorkspaceByName(workspaceName: string): void;
+	deleteWorkspaceByName(workspaceName: string): Promise<void>;
 
 	/**
 	 * stop workspace before deleting with checking stopping phase
 	 */
-	stopAndDeleteWorkspaceByName(workspaceName: string): void;
+	stopAndDeleteWorkspaceByName(workspaceName: string): Promise<void>;
 
 	/**
 	 * stop all run workspaces in the namespace
 	 */
-	stopAllRunningWorkspaces(namespace: string): void;
+	stopAllRunningWorkspaces(): Promise<void>;
 
 	/**
 	 * stop all run workspaces, check statused and remove the workspaces
 	 */
-	stopAndDeleteAllRunningWorkspaces(namespace: string): void;
+	stopAndDeleteAllRunningWorkspaces(): Promise<void>;
 
 	/**
 	 * stop all run workspaces without stopping and waiting for of 'Stopped' phase
 	 * Similar with 'force' deleting
 	 */
-	deleteAllWorkspaces(namespace: string): void;
+	deleteAllWorkspaces(): Promise<void>;
 }

package/configs/reporters-config.json

@@ -1,6 +0,0 @@
-{
-	"reporterEnabled": "allure-mocha,dist/utils/CheReporter.js",
-	"allureMochaReporterOptions": {
-		"resultsDir": ".allure-results"
-	}
-}