[ TS-SELENIUM ] Investigating new typescript related test framework

.gitignore

@@ -83,9 +83,12 @@ docs/assets/imgs
 plugins/plugin-terminal-ui/node_modules/
 plugins/plugin-terminal-ui/build/
 requirements.lock
+typescript-selenium/dist/
+typescript-selenium/node_modules/
+typescript-selenium/report/
 
 # Cypress modules #
-##################
+###################
 */cypress/screenshots
 */cypress/videos
 */node_modules

cypress-tests/cypress/pageobjects/ide/ProjectTree.ts

@@ -32,6 +32,14 @@ export class ProjectTree {
         return `${this.getExpandIconLocator(itemPath)}:not(.theia-mod-collapsed)`;
     }
 
+    private getExpandIconLocator(itemPath: string) {
+        return `div[data-node-id='/projects:/projects${itemPath}']`;
+    }
+
+    private getTreeItemLocator(itemPath: string) {
+        return `.theia-TreeNode[title='/projects${itemPath}']`
+    }
+
     openProjectTreeContainer() {
         cy.get(Ide.EXPLORER_BUTTON)
             .should('be.visible')
@@ -92,14 +100,6 @@ export class ProjectTree {
         cy.get(selectedItemLocator).should('be.visible');
     }
 
-    private getExpandIconLocator(itemPath: string) {
-        return `div[data-node-id='/projects:/projects${itemPath}']`;
-    }
-
-    private getTreeItemLocator(itemPath: string) {
-        return `.theia-TreeNode[title='/projects${itemPath}']`
-    }
-
     expandItem(itemPath: string) {
         let expandIconLocator: string = this.getExpandIconLocator(itemPath);
         let treeItemLocator: string = this.getTreeItemLocator(itemPath);

typescript-selenium/README.md

@@ -0,0 +1,24 @@
+## Requirements
+- node 8.x
+- "Chrome" browser 69.x or later
+
+## Default launch
+- npm install && npm test
+
+## Custom launch
+**Use environment variables (check default values in 'TestConstants.ts' file):**
+### application url  
+- TS_SELENIUM_BASE_URL *( string )*
+
+### headless launch
+- TS_SELENIUM_HEADLESS *( boolean )*
+
+### timeouts
+- TS_SELENIUM_DEFAULT_ATTEMPTS *( number )*
+- TS_SELENIUM_DEFAULT_POLLING *( number )*
+- TS_SELENIUM_DEFAULT_TIMEOUT *( number )*
+- TS_SELENIUM_LANGUAGE_SERVER_START_TIMEOUT *( number )*
+- TS_SELENIUM_LOAD_PAGE_TIMEOUT *( number )*
+- TS_SELENIUM_START_WORKSPACE_TIMEOUT *( number )*
+- TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS *( number )*
+- TS_SELENIUM_WORKSPACE_STATUS_POLLING *( number )*

typescript-selenium/TestConstants.ts

@@ -0,0 +1,38 @@
+/*********************************************************************
+ * 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
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+function readEnvAndSetValue(envProperty: any, defaultValue: string | number | boolean): any {
+    const propertyValue = envProperty
+    if (!propertyValue) {
+        return defaultValue;
+    }
+
+    return propertyValue
+}
+
+export const TestConstants = {
+    TS_SELENIUM_HEADLESS: readEnvAndSetValue(process.env.TS_SELENIUM_HEADLESS, false),
+
+    TS_SELENIUM_START_WORKSPACE_TIMEOUT: readEnvAndSetValue(process.env.TS_SELENIUM_START_WORKSPACE_TIMEOUT, 240000),
+    TS_SELENIUM_LOAD_PAGE_TIMEOUT: readEnvAndSetValue(process.env.TS_SELENIUM_LOAD_PAGE_TIMEOUT, 120000),
+    TS_SELENIUM_LANGUAGE_SERVER_START_TIMEOUT: readEnvAndSetValue(process.env.TS_SELENIUM_LANGUAGE_SERVER_START_TIMEOUT, 180000),
+
+    TS_SELENIUM_DEFAULT_TIMEOUT: readEnvAndSetValue(process.env.TS_SELENIUM_DEFAULT_TIMEOUT, 20000),
+    TS_SELENIUM_DEFAULT_ATTEMPTS: readEnvAndSetValue(process.env.TS_SELENIUM_DEFAULT_ATTEMPTS, 5),
+    TS_SELENIUM_DEFAULT_POLLING: readEnvAndSetValue(process.env.TS_SELENIUM_DEFAULT_POLLING, 1000),
+
+    TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS: readEnvAndSetValue(process.env.TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS, 90),
+    TS_SELENIUM_WORKSPACE_STATUS_POLLING: readEnvAndSetValue(process.env.TS_SELENIUM_WORKSPACE_STATUS_POLLING, 10000),
+
+    TS_SELENIUM_BASE_URL: readEnvAndSetValue(process.env.TS_SELENIUM_BASE_URL, "http://che-che.192.168.99.100.nip.io"),
+
+    TS_SELENIUM_RESOLUTION_WIDTH: readEnvAndSetValue(process.env.TS_SELENIUM_BASE_URL, 1920),
+    TS_SELENIUM_RESOLUTION_HEIGHT: readEnvAndSetValue(process.env.TS_SELENIUM_BASE_URL, 1080)
+}

typescript-selenium/driver/CheReporter.ts

@@ -0,0 +1,104 @@
+/*********************************************************************
+ * 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
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+import * as mocha from 'mocha';
+import { Driver } from './Driver';
+import { e2eContainer } from '../inversify.config';
+import { TYPES } from '../inversify.types';
+import * as fs from 'fs';
+import { TestConstants } from '../TestConstants';
+
+const driver: Driver = e2eContainer.get(TYPES.Driver);
+
+class CheReporter extends mocha.reporters.Spec {
+
+  constructor(runner: mocha.Runner, options: mocha.MochaOptions) {
+    super(runner, options);
+
+    runner.on('start', async (test: mocha.Test) => {
+      const launchInformation: string =
+        `################## Launch Information ##################
+
+      TS_SELENIUM_BASE_URL: ${TestConstants.TS_SELENIUM_BASE_URL}
+      TS_SELENIUM_HEADLESS: ${TestConstants.TS_SELENIUM_HEADLESS}
+
+      TS_SELENIUM_DEFAULT_ATTEMPTS: ${TestConstants.TS_SELENIUM_DEFAULT_ATTEMPTS}
+      TS_SELENIUM_DEFAULT_POLLING: ${TestConstants.TS_SELENIUM_DEFAULT_POLLING}
+      TS_SELENIUM_DEFAULT_TIMEOUT: ${TestConstants.TS_SELENIUM_DEFAULT_TIMEOUT}
+
+      TS_SELENIUM_LANGUAGE_SERVER_START_TIMEOUT: ${TestConstants.TS_SELENIUM_LANGUAGE_SERVER_START_TIMEOUT}
+      TS_SELENIUM_LOAD_PAGE_TIMEOUT: ${TestConstants.TS_SELENIUM_LOAD_PAGE_TIMEOUT}
+      TS_SELENIUM_START_WORKSPACE_TIMEOUT: ${TestConstants.TS_SELENIUM_START_WORKSPACE_TIMEOUT}
+      TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS: ${TestConstants.TS_SELENIUM_WORKSPACE_STATUS_ATTEMPTS}
+      TS_SELENIUM_WORKSPACE_STATUS_POLLING: ${TestConstants.TS_SELENIUM_WORKSPACE_STATUS_POLLING}
+
+########################################################
+      `
+
+      console.log(launchInformation)
+    })
+
+    runner.on('end', async function (test: mocha.Test) {
+      // ensure that fired events done
+      await driver.get().sleep(5000).catch(err => {throw err})
+
+      // close driver
+      await driver.get().quit().catch(err => { throw err })
+    })
+
+
+    runner.on('fail', async function (test: mocha.Test) {
+
+      const reportDirPath: string = './report'
+      const testFullTitle: string = test.fullTitle().replace(/\s/g, '_')
+      const testTitle: string = test.title.replace(/\s/g, '_')
+
+      const testReportDirPath: string = `${reportDirPath}/${testFullTitle}`
+      const screenshotFileName: string = `${testReportDirPath}/screenshot-${testTitle}.png`
+      const pageSourceFileName: string = `${testReportDirPath}/pagesource-${testTitle}.html`
+
+      // create reporter dir if not exist
+      await fs.exists(reportDirPath, async isDirExist => {
+        if (!isDirExist) {
+          await fs.mkdir(reportDirPath, err => {
+            if (err) {
+              throw err
+            }
+          })
+        }
+      })
+
+      // create dir for collected data if not exist
+      await fs.exists(testReportDirPath, async isDirExist => {
+        if (!isDirExist) {
+          await fs.mkdir(testReportDirPath, err => {
+            if (err) {
+              throw err
+            }
+          })
+        }
+      })
+
+      // take screenshot and write to file
+      const screenshot: string = await driver.get().takeScreenshot().catch(err => { throw err });
+      const screenshotStream = fs.createWriteStream(screenshotFileName)
+      screenshotStream.write(new Buffer(screenshot, 'base64'))
+      screenshotStream.end()
+
+      // take pagesource and write to file
+      const pageSource: string = await driver.get().getPageSource().catch(err => { throw err })
+      const pageSourceStream = fs.createWriteStream(pageSourceFileName)
+      pageSourceStream.write(new Buffer(pageSource))
+      pageSourceStream.end()
+
+    })
+  }
+}
+
+module.exports = CheReporter;

typescript-selenium/driver/ChromeDriver.ts

@@ -0,0 +1,45 @@
+/*********************************************************************
+ * 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
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+import 'chromedriver';
+import 'reflect-metadata';
+import { injectable, inject } from "inversify";
+import { ThenableWebDriver, Builder } from "selenium-webdriver";
+import { Driver } from './Driver';
+import { Options } from 'selenium-webdriver/chrome';
+import { TestConstants } from '../TestConstants';
+
+@injectable()
+export class ChromeDriver implements Driver {
+    private readonly driver: ThenableWebDriver;
+
+    constructor() {
+        const isHeadless: boolean = TestConstants.TS_SELENIUM_HEADLESS;
+        let options: Options = new Options().addArguments('--no-sandbox')
+
+        if (isHeadless) {
+            options = options.addArguments('headless')
+        }
+
+        this.driver = new Builder()
+            .forBrowser('chrome')
+            .setChromeOptions(options)
+            .build();
+
+        this.driver
+            .manage()
+            .window()
+            .setSize(TestConstants.TS_SELENIUM_RESOLUTION_WIDTH, TestConstants.TS_SELENIUM_RESOLUTION_HEIGHT)
+    }
+
+    get(): ThenableWebDriver {
+        return this.driver
+    }
+
+}

typescript-selenium/driver/Driver.ts

@@ -0,0 +1,14 @@
+/*********************************************************************
+ * 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
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+import { ThenableWebDriver } from "selenium-webdriver";
+
+export interface Driver {
+    get(): ThenableWebDriver
+}

typescript-selenium/inversify.config.ts

@@ -0,0 +1,45 @@
+/*********************************************************************
+ * 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
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+import { Container } from "inversify";
+import { Driver } from "./driver/Driver";
+import { TYPES, CLASSES } from "./inversify.types";
+import { ChromeDriver } from "./driver/ChromeDriver";
+import { DriverHelper } from "./utils/DriverHelper";
+import { LoginPage } from "./pageobjects/login/LoginPage";
+import { SingleUserLoginPage } from "./pageobjects/login/SingleUserLoginPage";
+import { Dashboard } from "./pageobjects/dashboard/Dashboard";
+import { Workspaces } from "./pageobjects/dashboard/Workspaces";
+import { NewWorkspace } from "./pageobjects/dashboard/NewWorkspace";
+import { WorkspaceDetails } from "./pageobjects/dashboard/workspace-details/WorkspaceDetails";
+import { WorkspaceDetailsPlugins } from "./pageobjects/dashboard/workspace-details/WorkspaceDetailsPlugins";
+import { Ide } from "./pageobjects/ide/Ide";
+import { TestWorkspaceUtil } from "./utils/workspace/TestWorkspaceUtil";
+import { ProjectTree } from "./pageobjects/ide/ProjectTree";
+import { Editor } from "./pageobjects/ide/Editor";
+
+const e2eContainer = new Container();
+
+e2eContainer.bind<Driver>(TYPES.Driver).to(ChromeDriver).inSingletonScope();
+e2eContainer.bind<LoginPage>(TYPES.LoginPage).to(SingleUserLoginPage).inSingletonScope();
+
+e2eContainer.bind<DriverHelper>(CLASSES.DriverHelper).to(DriverHelper).inSingletonScope();
+e2eContainer.bind<Dashboard>(CLASSES.Dashboard).to(Dashboard).inSingletonScope();
+e2eContainer.bind<Workspaces>(CLASSES.Workspaces).to(Workspaces).inSingletonScope();
+e2eContainer.bind<NewWorkspace>(CLASSES.NewWorkspace).to(NewWorkspace).inSingletonScope();
+e2eContainer.bind<WorkspaceDetails>(CLASSES.WorkspaceDetails).to(WorkspaceDetails).inSingletonScope();
+e2eContainer.bind<WorkspaceDetailsPlugins>(CLASSES.WorkspaceDetailsPlugins).to(WorkspaceDetailsPlugins).inSingletonScope();
+e2eContainer.bind<Ide>(CLASSES.Ide).to(Ide).inSingletonScope();
+e2eContainer.bind<TestWorkspaceUtil>(CLASSES.TestWorkspaceUtil).to(TestWorkspaceUtil).inSingletonScope();
+e2eContainer.bind<ProjectTree>(CLASSES.ProjectTree).to(ProjectTree).inSingletonScope();
+e2eContainer.bind<Editor>(CLASSES.Editor).to(Editor).inSingletonScope();
+
+
+
+export { e2eContainer }

typescript-selenium/inversify.types.ts

@@ -0,0 +1,29 @@
+/*********************************************************************
+ * 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
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+const TYPES = {
+    Driver: Symbol.for("Driver"),
+    LoginPage: Symbol.for("LoginPage")
+}
+
+const CLASSES = {
+    DriverHelper: "DriverHelper",
+    Dashboard: "Dashboard",
+    Workspaces: "Workspaces",
+    NewWorkspace: "NewWorkspace",
+    WorkspaceDetails: "WorkspaceDetails",
+    WorkspaceDetailsPlugins: "WorkspaceDetailsPlugins",
+    Ide: "Ide",
+    TestWorkspaceUtil: "TestWorkspaceUtil",
+    ProjectTree: "ProjectTree",
+    Editor: "Editor",
+}
+
+export { TYPES, CLASSES };

typescript-selenium/mocha.opts

@@ -0,0 +1,5 @@
+--require ts-node/register
+--timeout 1200000
+--reporter 'driver/CheReporter.ts'
+-u tdd 
+--spec tests/*.spec.ts