@eclipse-che/che-e2e 7.74.0-dev-41d1364 → 7.74.0-dev-aace77a

package/utils/CheReporter.ts

@@ -17,21 +17,27 @@ import { DriverHelper } from './DriverHelper';
 import { ScreenCatcher } from './ScreenCatcher';
 import { TIMEOUT_CONSTANTS } from '../constants/TIMEOUT_CONSTANTS';
 import { Logger } from './Logger';
-import { e2eContainer } from '../configs/inversify.config';
 import { StringUtil } from './StringUtil';
 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';
+import { inject, injectable } from 'inversify';
 
-const driverHelper: DriverHelper = e2eContainer.get(CLASSES.DriverHelper);
-const screenCatcher: ScreenCatcher = e2eContainer.get(CLASSES.ScreenCatcher);
-let methodIndex: number = 0;
-let deleteScreencast: boolean = true;
-
+@injectable()
 class CheReporter extends mocha.reporters.Spec {
-	constructor(runner: mocha.Runner, options: mocha.MochaOptions) {
+	private static methodIndex: number = 0;
+	private static deleteScreencast: boolean = true;
+
+	constructor(
+		runner: mocha.Runner,
+		options: mocha.MochaOptions,
+		@inject(CLASSES.DriverHelper)
+		private readonly driverHelper: DriverHelper,
+		@inject(CLASSES.ScreenCatcher)
+		private readonly screenCatcher: ScreenCatcher
+	) {
 		super(runner, options);
 
 		runner.on('start', (): void => {
@@ -76,20 +82,20 @@ class CheReporter extends mocha.reporters.Spec {
 			rm.sync(REPORTER_CONSTANTS.TS_SELENIUM_REPORT_FOLDER);
 		});
 
-		runner.on('test', async function (test: mocha.Test): Promise<void> {
+		runner.on('test', async (test: mocha.Test): Promise<void> => {
 			if (!REPORTER_CONSTANTS.TS_SELENIUM_EXECUTION_SCREENCAST) {
 				return;
 			}
 
-			methodIndex = methodIndex + 1;
-			const currentMethodIndex: number = methodIndex;
+			CheReporter.methodIndex = CheReporter.methodIndex + 1;
+			const currentMethodIndex: number = CheReporter.methodIndex;
 			let iterationIndex: number = 1;
 
 			while (!(test.state === 'passed' || test.state === 'failed')) {
-				await screenCatcher.catchMethodScreen(test.title, currentMethodIndex, iterationIndex);
+				await this.screenCatcher.catchMethodScreen(test.title, currentMethodIndex, iterationIndex);
 				iterationIndex = iterationIndex + 1;
 
-				await driverHelper.wait(REPORTER_CONSTANTS.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS);
+				await this.driverHelper.wait(REPORTER_CONSTANTS.TS_SELENIUM_DELAY_BETWEEN_SCREENSHOTS);
 			}
 		});
 
@@ -107,21 +113,21 @@ class CheReporter extends mocha.reporters.Spec {
 
 		runner.on('end', async (): Promise<void> => {
 			// ensure that fired events done
-			await driverHelper.wait(5000);
+			await this.driverHelper.wait(5000);
 
 			// close driver
-			await driverHelper.getDriver().quit();
+			await this.driverHelper.getDriver().quit();
 
 			// delete screencast folder if conditions matched
-			if (deleteScreencast && REPORTER_CONSTANTS.DELETE_SCREENCAST_IF_TEST_PASS) {
+			if (CheReporter.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> {
+		runner.on('fail', async (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;
+			CheReporter.deleteScreencast = false;
 
 			Logger.trace(`FullTitle:${test.fullTitle()}`);
 			const testFullTitle: string = StringUtil.sanitizeTitle(test.fullTitle());
@@ -150,19 +156,19 @@ class CheReporter extends mocha.reporters.Spec {
 			}
 
 			// take screenshot and write to file
-			const screenshot: string = await driverHelper.getDriver().takeScreenshot();
+			const screenshot: string = await this.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 pageSource: string = await this.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');
+			const browserLogsEntries: logging.Entry[] = await this.driverHelper.getDriver().manage().logs().get('browser');
 			let browserLogs: string = '';
 
 			browserLogsEntries.forEach((log): void => {

package/utils/DevWorkspaceConfigurationHelper.ts

@@ -15,31 +15,16 @@ import * as axios from 'axios';
 import { Logger } from './Logger';
 import { ShellExecutor } from './ShellExecutor';
 import { API_TEST_CONSTANTS } from '../constants/API_TEST_CONSTANTS';
+import { injectable } from 'inversify';
+import { IContextParams } from './IContextParams';
+import { e2eContainer } from '../configs/inversify.config';
+import { CLASSES, EXTERNAL_CLASSES } from '../configs/inversify.types';
 
-/**
- * to see more about IContextParams and generateDevfileContext(params) check README.md in "@eclipse-che/che-devworkspace-generator;
- * tests/e2e/node_modules/@eclipse-che/che-devworkspace-generator/README.md
- */
-
-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;
-}
-
+@injectable()
 export class DevWorkspaceConfigurationHelper {
-	private generator: Generator = new Generator();
+	private generator: Generator = e2eContainer.get(EXTERNAL_CLASSES.Generator);
+	private shellExecutor: ShellExecutor = e2eContainer.get(CLASSES.ShellExecutor);
+
 	private readonly params: IContextParams;
 
 	constructor(params: IContextParams) {
@@ -60,7 +45,7 @@ export class DevWorkspaceConfigurationHelper {
 			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;
+			params.editorContent = this.shellExecutor.curl(API_TEST_CONSTANTS.TS_API_TEST_CHE_CODE_EDITOR_DEVFILE_URI).stdout;
 		}
 		this.params = params;
 	}

package/utils/DevfilesRegistryHelper.ts

@@ -11,20 +11,25 @@ import axios, { AxiosResponse } from 'axios';
 import { Logger } from './Logger';
 import YAML from 'yaml';
 import { API_TEST_CONSTANTS, SUPPORTED_DEVFILE_REGISTRIES } from '../constants/API_TEST_CONSTANTS';
+import { injectable } from 'inversify';
 
+@injectable()
 export class DevfilesRegistryHelper {
 	async getInbuiltDevfilesRegistryContent(): Promise<AxiosResponse> {
-		Logger.debug();
+		Logger.trace();
+
 		return await this.getContent(SUPPORTED_DEVFILE_REGISTRIES.INBUILT_APPLICATION_DEVFILE_REGISTRY_URL());
 	}
 
 	async getGitHubCheDevfileRegistryContent(): Promise<AxiosResponse> {
-		Logger.debug();
+		Logger.trace();
+
 		return await this.getContent(SUPPORTED_DEVFILE_REGISTRIES.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()) {
@@ -72,7 +77,7 @@ export class DevfilesRegistryHelper {
 	}
 
 	private async getContent(url: string, headers?: object): Promise<AxiosResponse> {
-		Logger.debug(`${url}`);
+		Logger.trace(`${url}`);
 
 		let response: AxiosResponse | undefined;
 		try {

package/utils/DriverHelper.ts

@@ -95,7 +95,6 @@ export class DriverHelper {
 	async waitVisibility(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<WebElement> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -158,7 +157,6 @@ export class DriverHelper {
 	async waitPresence(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<WebElement> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -191,7 +189,6 @@ export class DriverHelper {
 	): Promise<Array<WebElement>> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -246,6 +243,7 @@ export class DriverHelper {
 		pollingPerLocator: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING
 	): Promise<void> {
 		Logger.trace(`${locators}`);
+
 		try {
 			for (const elementLocator of locators) {
 				await this.waitDisappearance(elementLocator, attemptsPerLocator, pollingPerLocator);
@@ -258,7 +256,6 @@ export class DriverHelper {
 	async waitAndClick(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<void> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -284,7 +281,7 @@ export class DriverHelper {
 				await element.click();
 				return;
 			} catch (err) {
-				function isElementClickInterceptedOnLastAttempt(err: Error, i: number): boolean {
+				function isElementClickInterceptedOnLastAttempt(err: any, i: number): boolean {
 					return err instanceof error.ElementClickInterceptedError && i === attempts - 1;
 				}
 
@@ -320,7 +317,6 @@ export class DriverHelper {
 	): Promise<string> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator} attribute: '${attribute}'`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -367,7 +363,6 @@ export class DriverHelper {
 	): Promise<string> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator} cssAttribute: ${cssAttribute}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -474,7 +469,6 @@ export class DriverHelper {
 	): Promise<void> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator} text: ${text}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -516,7 +510,6 @@ export class DriverHelper {
 	async clear(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<void> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -558,7 +551,6 @@ export class DriverHelper {
 	async clearInvisible(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<void> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -624,7 +616,6 @@ export class DriverHelper {
 	async waitAndGetText(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<string> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -677,7 +668,6 @@ export class DriverHelper {
 	async scrollTo(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<void> {
 		const polling: number = TIMEOUT_CONSTANTS.TS_SELENIUM_DEFAULT_POLLING;
 		const attempts: number = Math.ceil(timeout / polling);
-
 		Logger.trace(`${elementLocator}`);
 
 		for (let i: number = 0; i < attempts; i++) {
@@ -717,6 +707,8 @@ export class DriverHelper {
 	}
 
 	async scrollToAndClick(elementLocator: By, timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM): Promise<void> {
+		Logger.trace();
+
 		await this.scrollTo(elementLocator, timeout);
 		await this.waitAndClick(elementLocator, timeout);
 	}
@@ -726,12 +718,16 @@ export class DriverHelper {
 		value: string,
 		timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_CLICK_ON_VISIBLE_ITEM
 	): Promise<void> {
+		Logger.trace();
+
 		await this.scrollTo(elementLocator, timeout);
 		await this.enterValue(elementLocator, value, timeout);
 	}
 
 	// method is useful to debug page object elements
 	async highLightElement(element: WebElement): Promise<void> {
+		Logger.trace();
+
 		await this.getDriver().executeScript('arguments[0].style.border="2px solid red"', element);
 	}
 
@@ -740,4 +736,10 @@ export class DriverHelper {
 
 		return this.driver;
 	}
+
+	async navigateToUrl(url: string): Promise<void> {
+		Logger.trace();
+
+		await this.getDriver().navigate().to(url);
+	}
 }

package/utils/IContextParams.ts

@@ -0,0 +1,26 @@
+/** *******************************************************************
+ * 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
+ **********************************************************************/
+
+export 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;
+}

package/utils/IKubernetesCommandLineToolsExecutor.ts

@@ -0,0 +1,42 @@
+/** *******************************************************************
+ * 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 { ShellString } from 'shelljs';
+
+export interface IKubernetesCommandLineToolsExecutor {
+	loginToOcp(): void;
+
+	getContainerName(): string;
+
+	getWorkspacePodName(): string;
+
+	deleteDevWorkspace(): void;
+
+	applyAndWaitDevWorkspace(yamlConfiguration: string): ShellString;
+
+	executeCommand(commandToExecute: string, container: string): ShellString;
+
+	applyYamlConfigurationAsStringOutput(yamlConfiguration: string): ShellString;
+
+	applyYamlConfigurationAsFile(pathToFile: string): void;
+
+	getDevWorkspaceYamlConfiguration(): ShellString;
+
+	waitDevWorkspace(timeout: number): ShellString;
+
+	createProject(projectName: string): void;
+
+	deleteProject(projectName: string): void;
+
+	getPodAndContainerNames(): void;
+
+	isUserLoggedIn(user: string): boolean;
+
+	getServerUrl(): string;
+}