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

package/driver/ChromeDriver.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
@@ -10,66 +10,60 @@
 import 'chromedriver';
 import 'reflect-metadata';
 import { injectable } from 'inversify';
-import { ThenableWebDriver, Builder } from 'selenium-webdriver';
+import { Builder, ThenableWebDriver } from 'selenium-webdriver';
 import { IDriver } from './IDriver';
 import { Options } from 'selenium-webdriver/chrome';
-import { ChromeDriverConstants } from '../constants/ChromeDriverConstants';
+import { CHROME_DRIVER_CONSTANTS } from '../constants/CHROME_DRIVER_CONSTANTS';
 
 @injectable()
 export class ChromeDriver implements IDriver {
-    private readonly driver: ThenableWebDriver | undefined;
+	private readonly driver: ThenableWebDriver | undefined;
 
-    constructor() {
-        const options: Options = this.getDriverOptions();
-        if (ChromeDriverConstants.TS_USE_WEB_DRIVER_FOR_TEST) {
-            this.driver = this.getDriverBuilder(options).build();
-        }
-    }
+	constructor() {
+		const options: Options = this.getDriverOptions();
+		if (CHROME_DRIVER_CONSTANTS.TS_USE_WEB_DRIVER_FOR_TEST) {
+			this.driver = this.getDriverBuilder(options).build();
+		}
+	}
 
-    get(): ThenableWebDriver {
-        return this.driver as ThenableWebDriver;
-    }
+	get(): ThenableWebDriver {
+		return this.driver as ThenableWebDriver;
+	}
 
-    async setWindowSize(): Promise<void> {
-        await (this.driver as ThenableWebDriver)
-            .manage()
-            .window()
-            .setSize(ChromeDriverConstants.TS_SELENIUM_RESOLUTION_WIDTH, ChromeDriverConstants.TS_SELENIUM_RESOLUTION_HEIGHT);
-    }
+	async setWindowSize(): Promise<void> {
+		await (this.driver as ThenableWebDriver)
+			.manage()
+			.window()
+			.setSize(CHROME_DRIVER_CONSTANTS.TS_SELENIUM_RESOLUTION_WIDTH, CHROME_DRIVER_CONSTANTS.TS_SELENIUM_RESOLUTION_HEIGHT);
+	}
 
-    private getDriverOptions(): Options {
-        let options: Options = new Options()
-            .addArguments('--no-sandbox')
-            .addArguments('--disable-web-security')
-            .addArguments('--allow-running-insecure-content')
-            .addArguments('--ignore-certificate-errors');
-        // if 'true' run in 'headless' mode
-        if (ChromeDriverConstants.TS_SELENIUM_HEADLESS) {
-            options = options.addArguments('headless');
-        }
-        return options;
-    }
+	private getDriverOptions(): Options {
+		let options: Options = new Options()
+			.addArguments('--no-sandbox')
+			.addArguments('--disable-web-security')
+			.addArguments('--allow-running-insecure-content')
+			.addArguments('--ignore-certificate-errors');
+		// if 'true' run in 'headless' mode
+		if (CHROME_DRIVER_CONSTANTS.TS_SELENIUM_HEADLESS) {
+			options = options.addArguments('headless');
+		}
+		return options;
+	}
 
-    private getDriverBuilder(options: Options): Builder {
-        const disableW3copts: object = { 'goog:chromeOptions' : { 'w3c' : false }};
-        let builder: Builder = new Builder()
-            .forBrowser('chrome')
-            .setChromeOptions(options);
+	private getDriverBuilder(options: Options): Builder {
+		const disableW3copts: object = { 'goog:chromeOptions': { w3c: false } };
+		let builder: Builder = new Builder().forBrowser('chrome').setChromeOptions(options);
 
-        // if 'false' w3c protocol is disabled
-        if (! ChromeDriverConstants.TS_SELENIUM_W3C_CHROME_OPTION) {
-            builder.withCapabilities(disableW3copts)
-            .forBrowser('chrome')
-            .setChromeOptions(options);
-        }
+		// if 'false' w3c protocol is disabled
+		if (!CHROME_DRIVER_CONSTANTS.TS_SELENIUM_W3C_CHROME_OPTION) {
+			builder.withCapabilities(disableW3copts).forBrowser('chrome').setChromeOptions(options);
+		}
 
-        // if 'true' run with remote driver
-        if (ChromeDriverConstants.TS_SELENIUM_REMOTE_DRIVER_URL) {
-            builder = builder.usingServer(ChromeDriverConstants.TS_SELENIUM_REMOTE_DRIVER_URL);
-        }
-
-        return builder;
-
-    }
+		// if 'true' run with remote driver
+		if (CHROME_DRIVER_CONSTANTS.TS_SELENIUM_REMOTE_DRIVER_URL) {
+			builder = builder.usingServer(CHROME_DRIVER_CONSTANTS.TS_SELENIUM_REMOTE_DRIVER_URL);
+		}
 
+		return builder;
+	}
 }

package/driver/IDriver.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
@@ -10,5 +10,5 @@
 import { ThenableWebDriver } from 'selenium-webdriver';
 
 export interface IDriver {
-    get(): ThenableWebDriver;
+	get(): ThenableWebDriver;
 }

package/index.ts

@@ -41,12 +41,12 @@ export * from './pageobjects/openshift/OcpMainPage';
 export * from './tests-library/LoginTests';
 export * from './tests-library/ProjectAndFileTests';
 export * from './tests-library/WorkspaceHandlingTests';
-export * from './constants/APITestConstants';
-export * from './constants/BaseTestConstants';
-export * from './constants/ChromeDriverConstants';
-export * from './constants/FactoryTestConstants';
-export * from './constants/MonacoConstants';
-export * from './constants/OAuthConstants';
-export * from './constants/PluginsTestConstants';
-export * from './constants/ReporterConstants';
-export * from './constants/TimeoutConstants';
+export * from './constants/API_TEST_CONSTANTS';
+export * from './constants/BASE_TEST_CONSTANTS';
+export * from './constants/CHROME_DRIVER_CONSTANTS';
+export * from './constants/FACTORY_TEST_CONSTANTS';
+export * from './constants/MONACO_CONSTANTS';
+export * from './constants/OAUTH_CONSTANTS';
+export * from './constants/PLUGIN_TEST_CONSTANTS';
+export * from './constants/REPORTER_CONSTANTS';
+export * from './constants/TIMEOUT_CONSTANTS';

package/package.json

@@ -1,51 +1,61 @@
 {
-  "name": "@eclipse-che/che-e2e",
-  "version": "7.73.0",
-  "description": "",
-  "main": "dist/index.js",
-  "scripts": {
-    "lint": "tslint --fix -p .",
-    "tsc": "rm -rf ./dist && ./configs/sh-scripts/generateIndex.sh && tsc -p .",
-    "test": "./configs/sh-scripts/initDefaultValues.sh npm run lint && npm run tsc && export USERSTORY=$USERSTORY && mocha --config dist/configs/mocharc.js",
-    "driver-less-test": "export TS_USE_WEB_DRIVER_FOR_TEST=false && npm run test",
-    "cleanup-docker": "if [ $(docker ps -a | grep -c selenium-e2e) -gt 0 ]; then docker rm -f $(docker ps --filter \"name=selenium-e2e\" -aq); fi;",
-    "test-docker": "npm run cleanup-docker && docker run -it --shm-size=2g -p 5920:5920 --name selenium-e2e -e TS_SELENIUM_BASE_URL=$TS_SELENIUM_BASE_URL eclipse/che-e2e:nightly",
-    "test-docker-mount-e2e": "npm run cleanup-docker && docker run -it --shm-size=2g -p 5920:5920 --name selenium-e2e -e TS_SELENIUM_BASE_URL=$TS_SELENIUM_BASE_URL -v $(pwd):/tmp/e2e:Z eclipse/che-e2e:nightly",
-    "test-all-devfiles": " ./configs/sh-scripts/initDefaultValues.sh && ./configs/sh-scripts/initDevfileTests.sh",
-    "devfile-acceptance-test-suite": "./configs/sh-scripts/initDefaultValues.sh npm run lint && npm run tsc && export TS_USE_WEB_DRIVER_FOR_TEST=false && mocha 'dist/specs/api/*.js' --config dist/configs/mocharc.js --delay --grep 'Devfile acceptance test suite'"
-  },
-  "author": "Ihor Okhrimenko (iokhrime@redhat.com)",
-  "license": "ISC",
-  "devDependencies": {
-    "@eclipse-che/che-devworkspace-generator": "next",
-    "@types/chai": "^4.3.4",
-    "@types/clone-deep": "^4.0.1",
-    "@types/mocha": "5.2.6",
-    "@types/node": "11.13.4",
-    "@types/rimraf": "2.0.2",
-    "@types/selenium-webdriver": "4.1.3",
-    "@types/shelljs": "^0.8.11",
-    "axios": "^0.25.0",
-    "chai": "^4.3.4",
-    "chromedriver": "^114.0.2",
-    "clone-deep": "^4.0.1",
-    "mocha": "^9.1.3",
-    "monaco-page-objects": "3.1.0",
-    "rimraf": "2.6.2",
-    "selenium-webdriver": "4.4.0",
-    "shelljs": "^0.8.5",
-    "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "typescript": "3.9.9",
-    "vscode-extension-tester-locators": "3.1.0",
-    "yaml": "^2.2.2"
-  },
-  "dependencies": {
-    "@eclipse-che/api": "latest",
-    "inversify": "5.0.1",
-    "reflect-metadata": "0.1.13"
-  },
-  "resolutions": {
-    "minimist": "^1.2.5"
-  }
+	"name": "@eclipse-che/che-e2e",
+	"version": "7.74.0-dev-41d1364",
+	"description": "",
+	"main": "dist/index.js",
+	"scripts": {
+		"lint": "eslint --fix .",
+		"prettier": "prettier --config .prettierrc.json . --write",
+		"tsc": "rm -rf ./dist && ./configs/sh-scripts/generateIndex.sh && tsc -p .",
+		"test": "./configs/sh-scripts/initDefaultValues.sh npm run lint && npm run tsc && export USERSTORY=$USERSTORY && mocha --config dist/configs/mocharc.js",
+		"driver-less-test": "export TS_USE_WEB_DRIVER_FOR_TEST=false && npm run test",
+		"cleanup-docker": "if [ $(docker ps -a | grep -c selenium-e2e) -gt 0 ]; then docker rm -f $(docker ps --filter \"name=selenium-e2e\" -aq); fi;",
+		"test-docker": "npm run cleanup-docker && docker run -it --shm-size=2g -p 5920:5920 --name selenium-e2e -e TS_SELENIUM_BASE_URL=$TS_SELENIUM_BASE_URL eclipse/che-e2e:nightly",
+		"test-docker-mount-e2e": "npm run cleanup-docker && docker run -it --shm-size=2g -p 5920:5920 --name selenium-e2e -e TS_SELENIUM_BASE_URL=$TS_SELENIUM_BASE_URL -v $(pwd):/tmp/e2e:Z eclipse/che-e2e:nightly",
+		"test-all-devfiles": " ./configs/sh-scripts/initDefaultValues.sh && ./configs/sh-scripts/initDevfileTests.sh",
+		"devfile-acceptance-test-suite": "./configs/sh-scripts/initDefaultValues.sh npm run lint && npm run tsc && export TS_USE_WEB_DRIVER_FOR_TEST=false && mocha 'dist/specs/api/*.js' --config dist/configs/mocharc.js --delay --grep 'Devfile acceptance test suite'"
+	},
+	"author": "Ihor Okhrimenko (iokhrime@redhat.com)",
+	"license": "ISC",
+	"devDependencies": {
+		"@eclipse-che/che-devworkspace-generator": "next",
+		"@types/chai": "^4.3.4",
+		"@types/clone-deep": "^4.0.1",
+		"@types/mocha": "5.2.6",
+		"@types/node": "11.13.4",
+		"@types/rimraf": "2.0.2",
+		"@types/selenium-webdriver": "4.1.3",
+		"@types/shelljs": "^0.8.11",
+		"@typescript-eslint/eslint-plugin": "^6.4.1",
+		"@typescript-eslint/eslint-plugin-tslint": "^6.1.0",
+		"@typescript-eslint/parser": "^6.1.0",
+		"axios": "^0.25.0",
+		"chai": "^4.3.4",
+		"chromedriver": "^114.0.2",
+		"clone-deep": "^4.0.1",
+		"eslint": "^8.45.0",
+		"eslint-config-prettier": "^8.10.0",
+		"eslint-plugin-header": "^3.1.1",
+		"eslint-plugin-jsdoc": "^46.5.0",
+		"eslint-plugin-prettier": "^5.0.0",
+		"husky": "^8.0.3",
+		"mocha": "^9.1.3",
+		"monaco-page-objects": "3.1.0",
+		"prettier": "^3.0.2",
+		"rimraf": "2.6.2",
+		"selenium-webdriver": "4.4.0",
+		"shelljs": "^0.8.5",
+		"ts-node": "^10.9.1",
+		"typescript": "3.9.9",
+		"vscode-extension-tester-locators": "3.1.0",
+		"yaml": "^2.2.2"
+	},
+	"dependencies": {
+		"@eclipse-che/api": "latest",
+		"inversify": "5.0.1",
+		"reflect-metadata": "0.1.13"
+	},
+	"resolutions": {
+		"minimist": "^1.2.5"
+	}
 }

package/pageobjects/dashboard/CreateWorkspace.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
@@ -8,90 +8,99 @@
  * SPDX-License-Identifier: EPL-2.0
  **********************************************************************/
 
-import { injectable, inject } from 'inversify';
+import { inject, injectable } from 'inversify';
 import { CLASSES } from '../../configs/inversify.types';
 import { DriverHelper } from '../../utils/DriverHelper';
 import { By, Key } from 'selenium-webdriver';
 import { Logger } from '../../utils/Logger';
-import { TimeoutConstants } from '../../constants/TimeoutConstants';
-import { BaseTestConstants } from '../../constants/BaseTestConstants';
+import { TIMEOUT_CONSTANTS } from '../../constants/TIMEOUT_CONSTANTS';
+import { BASE_TEST_CONSTANTS } from '../../constants/BASE_TEST_CONSTANTS';
 
 @injectable()
 export class CreateWorkspace {
-    static readonly FACTORY_URL_LOCATOR: By = By.xpath(`//input[@id="git-repo-url"]`);
+	static readonly FACTORY_URL_LOCATOR: By = By.xpath('//input[@id="git-repo-url"]');
 
-    constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper) { }
+	constructor(
+		@inject(CLASSES.DriverHelper)
+		private readonly driverHelper: DriverHelper
+	) {}
 
-    async waitTitleContains(expectedText: string, timeout: number = TimeoutConstants.TS_COMMON_DASHBOARD_WAIT_TIMEOUT): Promise<void> {
-        Logger.debug(`CreateWorkspace.waitTitleContains text: "${expectedText}"`);
+	async waitTitleContains(expectedText: string, timeout: number = TIMEOUT_CONSTANTS.TS_COMMON_DASHBOARD_WAIT_TIMEOUT): Promise<void> {
+		Logger.debug(`text: "${expectedText}"`);
 
-        const pageTitleLocator: By = By.xpath(`//h1[contains(text(), '${expectedText}')]`);
+		const pageTitleLocator: By = By.xpath(`//h1[contains(text(), '${expectedText}')]`);
 
-        await this.driverHelper.waitVisibility(pageTitleLocator, timeout);
-    }
+		await this.driverHelper.waitVisibility(pageTitleLocator, timeout);
+	}
 
-    async waitPage(timeout: number = TimeoutConstants.TS_SELENIUM_LOAD_PAGE_TIMEOUT): Promise<void> {
-        Logger.debug('CreateWorkspace.waitPage');
+	async waitPage(timeout: number = TIMEOUT_CONSTANTS.TS_SELENIUM_LOAD_PAGE_TIMEOUT): Promise<void> {
+		Logger.debug();
 
-        await this.waitTitleContains('Create Workspace', timeout);
-    }
+		await this.waitTitleContains('Create Workspace', timeout);
+	}
 
-    async clickOnSampleNoEditorSelection(sampleName: string, timeout: number = TimeoutConstants.TS_CLICK_DASHBOARD_ITEM_TIMEOUT): Promise<void> {
-        Logger.debug(`CreateWorkspace.clickOnSample sampleName: "${sampleName}"`);
+	async clickOnSampleNoEditorSelection(
+		sampleName: string,
+		timeout: number = TIMEOUT_CONSTANTS.TS_CLICK_DASHBOARD_ITEM_TIMEOUT
+	): Promise<void> {
+		Logger.debug(`sampleName: "${sampleName}"`);
 
-        const sampleLocator: By = this.getSampleLocator(sampleName);
+		const sampleLocator: By = this.getSampleLocator(sampleName);
 
-        await this.driverHelper.waitAndClick(sampleLocator, timeout);
-    }
+		await this.driverHelper.waitAndClick(sampleLocator, timeout);
+	}
 
-    async clickOnSampleForSpecificEditor(sampleName: string, timeout: number = TimeoutConstants.TS_CLICK_DASHBOARD_ITEM_TIMEOUT): Promise<void> {
-        await this.clickOnEditorsDropdownListButton(sampleName, timeout);
+	async clickOnSampleForSpecificEditor(
+		sampleName: string,
+		timeout: number = TIMEOUT_CONSTANTS.TS_CLICK_DASHBOARD_ITEM_TIMEOUT
+	): Promise<void> {
+		await this.clickOnEditorsDropdownListButton(sampleName, timeout);
 
-        Logger.debug(`CreateWorkspace.clickOnSampleForSpecificEditor sampleName: "${sampleName}"`);
+		Logger.debug(`sampleName: "${sampleName}"`);
 
-        const sampleLocator: By = this.getSampleLocatorWithSpecificEditor(sampleName);
-        await this.driverHelper.waitAndClick(sampleLocator, timeout);
-    }
+		const sampleLocator: By = this.getSampleLocatorWithSpecificEditor(sampleName);
+		await this.driverHelper.waitAndClick(sampleLocator, timeout);
+	}
 
-    async importFromGitUsingUI(factoryUrl: string, timeout: number = TimeoutConstants.TS_CLICK_DASHBOARD_ITEM_TIMEOUT): Promise<void> {
-        Logger.debug(`CreateWorkspace.importFromGitUsingUI factoryUrl: "${factoryUrl}"`);
-        await this.driverHelper.waitVisibility(CreateWorkspace.FACTORY_URL_LOCATOR, timeout);
-        await this.driverHelper.type(CreateWorkspace.FACTORY_URL_LOCATOR, Key.chord(factoryUrl, Key.ENTER), timeout);
-    }
+	async importFromGitUsingUI(factoryUrl: string, timeout: number = TIMEOUT_CONSTANTS.TS_CLICK_DASHBOARD_ITEM_TIMEOUT): Promise<void> {
+		Logger.debug(`factoryUrl: "${factoryUrl}"`);
+		await this.driverHelper.waitVisibility(CreateWorkspace.FACTORY_URL_LOCATOR, timeout);
+		await this.driverHelper.type(CreateWorkspace.FACTORY_URL_LOCATOR, Key.chord(factoryUrl, Key.ENTER), timeout);
+	}
 
-    private async clickOnEditorsDropdownListButton(sampleName: string, timeout: number): Promise<void> {
-        Logger.debug(`CreateWorkspace.clickOnSample sampleName: "${sampleName}, editor ${BaseTestConstants.TS_SELENIUM_EDITOR}"`);
+	private async clickOnEditorsDropdownListButton(sampleName: string, timeout: number): Promise<void> {
+		Logger.debug(`sampleName: "${sampleName}, editor ${BASE_TEST_CONSTANTS.TS_SELENIUM_EDITOR}"`);
 
-        const editorDropdownListLocator: By = this.getEditorsDropdownListLocator(sampleName);
-        await this.driverHelper.waitAndClick(editorDropdownListLocator, timeout);
-    }
+		const editorDropdownListLocator: By = this.getEditorsDropdownListLocator(sampleName);
+		await this.driverHelper.waitAndClick(editorDropdownListLocator, timeout);
+	}
 
-    private getEditorsDropdownListLocator(sampleName: string): By {
-        return By.xpath(`//div[text()=\'${sampleName}\']//parent::article//button`);
-    }
+	private getEditorsDropdownListLocator(sampleName: string): By {
+		return By.xpath(`//div[text()=\'${sampleName}\']//parent::article//button`);
+	}
 
-    private getSampleLocatorWithSpecificEditor(sampleName: string): By {
-        let editor: string = '';
-        switch (process.env.TS_SELENIUM_EDITOR) {
-            case 'che-code':
-                editor = 'code';
-                break;
-            default:
-                throw new Error(`Unsupported editor ${process.env.TS_SELENIUM_EDITOR}`);
-        }
+	private getSampleLocatorWithSpecificEditor(sampleName: string): By {
+		let editor: string = '';
+		switch (process.env.TS_SELENIUM_EDITOR) {
+			case 'che-code':
+				editor = 'code';
+				break;
+			default:
+				throw new Error(`Unsupported editor ${process.env.TS_SELENIUM_EDITOR}`);
+		}
 
-        Logger.trace(`CreateWorkspace.getSampleLocatorWithSpecificEditor sampleName: ${sampleName}, editor "${editor}"`);
+		Logger.trace(`sampleName: ${sampleName}, editor "${editor}"`);
 
-        return By.xpath(`//div[text()='${sampleName}']//parent::article//span[text()[
+		return By.xpath(`//div[text()='${sampleName}']//parent::article//span[text()[
                 contains(
                 translate(., 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz'),
                 '${editor}')]
             ]//parent::a`);
-    }
+	}
 
-    private getSampleLocator(sampleName: string): By {
-        Logger.trace(`CreateWorkspace.getSampleLocator sampleName: ${sampleName}, used default editor`);
+	private getSampleLocator(sampleName: string): By {
+		Logger.trace(`sampleName: ${sampleName}, used default editor`);
 
-        return By.xpath(`//article[contains(@class, 'sample-card')]//div[text()='${sampleName}']`);
-    }
+		return By.xpath(`//article[contains(@class, 'sample-card')]//div[text()='${sampleName}']`);
+	}
 }