Merge pull request #1 from react-native-windows/refactor

Refactor

Author: licanhua

package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-appium",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A brdige to make selenium-webdriver to drive appium to do native app testing",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,14 +11,24 @@
   "scripts": {
     "prepublishOnly": "tsc -p ./ --outDir dist/"
   },
-  "keywords": ["selenium-webdriver", "appium", "jest", "e2e test"],
+  "keywords": [
+    "selenium-webdriver",
+    "appium",
+    "jest",
+    "e2e test"
+  ],
   "author": "Canhua Li",
   "license": "MIT",
   "devDependencies": {
     "@types/selenium-webdriver": "^4.0.1",
-    "typescript": "^3.5.3"   
+    "typescript": "^3.5.3"
   },
   "peerDependencies": {
     "selenium-webdriver": "^4.0.0-alpha.4"
-  }
+  },
+  "bugs": {
+    "url": "https://github.com/react-native-windows/selenium-appium/issues"
+  },
+  "homepage": "https://github.com/react-native-windows/selenium-appium#readme",
+  "dependencies": {}
 }

src/appiumdriver.ts

@@ -4,60 +4,118 @@
  */
 
 'use strict';
+import { WebDriver, Builder, until, Capabilities, WebElementPromise } from 'selenium-webdriver'
+import { By2 } from './by2';
+import { By } from 'selenium-webdriver'
 
-import { WebDriver, Builder, until } from 'selenium-webdriver'
-import { By } from './by';
+interface IAppiumWaitUntilFound {
+  get(by: By, timeout?: number, message?: string): WebElementPromise;
+  getByAccessibilityId(id: string, timeout?: number, message?: string): WebElementPromise;
+  getByName(name: string, timeout?: number, message?: string): WebElementPromise;
+  getById(id: string, timeout?: number, message?: string): WebElementPromise;
+  getByclassName(className: string, timeout?: number, message?: string): WebElementPromise;
+}
 
-export class AppiumDriver {
-  private static windowsCapabilities(appName: string) {
-    return {
-      browserName: '',
-      platformName: 'windows',
-      deviceName: 'WindowsPC',
-      app: appName
-    };
+export interface IAppiumDriver extends IAppiumWaitUntilFound 
+{
+  start(): Promise<void>;
+  stop(): Promise<void>;
+  restart(): Promise<void>;
+  isActive(): Promise<boolean>;
+  seleniumDriver(): WebDriver;
+  lastError(): any;
+  sleep(ms: number): Promise<void>;
+}
+
+class AppiumDriver implements IAppiumDriver {
+  get(by: By, timeout?: number, message?: string | undefined): WebElementPromise {
+    if (this.webDriver)
+      return this.webDriver.wait(until.elementLocated(by), timeout, message);
+    throw new Error("no valid connection");
   }
 
-  driver_: WebDriver;
+  getByAccessibilityId(id: string, timeout?: number | undefined, message?: string | undefined): WebElementPromise {
+    return this.get(By2.accessibilityId(id), timeout, message);
+  }
 
-  static createWinAppDriver(appName: string, url = "http://localhost:4723/wd/hub"): Promise<AppiumDriver> {
-    return new Promise<AppiumDriver>(resolve => {
-      new Builder()
-        .usingServer(url)
-        .withCapabilities(AppiumDriver.windowsCapabilities(appName))
-        .build().
-        then((driver) => { resolve(new AppiumDriver(driver)); });
-    });
+  getByName(name: string, timeout?: number | undefined, message?: string | undefined): WebElementPromise {
+    return this.get(By2.name(name), timeout, message);
   }
 
-  webDriver(): WebDriver {
-    return this.driver_;
+  getById(id: string, timeout?: number | undefined, message?: string | undefined): WebElementPromise {
+    return this.get(By2.id(id), timeout, message);
   }
 
-  constructor(driver: WebDriver) {
-    this.driver_ = driver;
+  getByclassName(className: string, timeout?: number | undefined, message?: string | undefined): WebElementPromise {
+    return this.get(By2.className(className), timeout, message);
   }
 
-  getByAccessibilityId(id: string, timeout = 0, message = undefined) {
-    return this.driver_.wait(until.elementLocated(By.accessibilityId(id)), timeout, message);
+  sleep(ms: number): Promise<void> {
+    if (this.webDriver)
+      return this.webDriver.sleep(ms);
+    throw new Error("no valid connection");
   }
 
-  getByName(name: string, timeout = 0, message = undefined) {
-    return this.driver_.wait(until.elementLocated(By.name(name)), timeout, message);
+  seleniumDriver(): WebDriver {
+    if (this.webDriver)
+      return this.webDriver;
+    throw new Error("no valid connection");
   }
 
-  getById(id: string, timeout = 0, message = undefined) {
-    return this.driver_.wait(until.elementLocated(By.id(id)), timeout, message);
+  lastError() {
+    return this.error_;
   }
 
-  getByclassName(className: string, timeout = 0, message = undefined) {
-    return this.driver_.wait(until.elementLocated(By.className(className)), timeout, message);
+  start(): Promise<void> {
+    return new Promise<void>(resolve => {
+      new Builder()
+        .usingServer(this.url_)
+        .withCapabilities(this.capabilities_)
+        .build()
+        .then(driver => { this.webDriver = driver; resolve(); })
+        .catch(e => { this.error_ = e; throw e; });
+    });
   }
 
-  sleep(ms: number) {
-    return this.driver_.sleep(ms);
+  stop(): Promise<void> {
+    return new Promise<void>(resolve => {
+      this.webDriver && this.webDriver
+        .quit()
+        .then(() => resolve())
+        .catch(e => { this.error_ = e; throw e });
+      resolve();
+    });
   }
-  quit() {
-    return this.driver_.quit();
+
+  restart(): Promise<void> {
+    return this._restart();
   }
+
+  private async _restart() {
+    await this.stop().catch(); //ignore stop error
+    await this.start();
+  }
+
+  private capabilities_: Capabilities | {};
+  private error_?: any;
+  private url_: string
+  private webDriver?: WebDriver;
+
+  constructor(capabilities: Capabilities | {}, url: string = "http://localhost:4723/wd/hub") {
+    this.capabilities_ = capabilities;
+    this.url_ = url;
+  }
+
+  isActive(): Promise<boolean> {
+    return new Promise<boolean>(resolve => {
+      this.webDriver && this.webDriver
+        .getSession()
+        .then(() => resolve(true), reason => resolve(false))
+      resolve(false);
+    });
+  }
+}
+
+export function createAppiumWebDriver(capabilities: Capabilities | {}, url?: string): IAppiumDriver {
+  return new AppiumDriver(capabilities, url);
 }

src/appiumdriver.windows.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+'use strict';
+
+export function windowsNativeAppCapabilities(appName: string) {
+  return {
+    browserName: '',
+    platformName: 'windows',
+    deviceName: 'WindowsPC',
+    app: appName
+  }
+};

src/by.ts src/by2.tssrc/by.ts renamed to src/by2.ts

@@ -4,23 +4,23 @@
  */
 
 'use strict';
-import { By as SeleniumBy } from 'selenium-webdriver'
+import { By } from 'selenium-webdriver'
 
-export class By {
+export class By2 {
   static id(id: string) {
-    return new SeleniumBy('id', id);
+    return new By('id', id);
   }
 
   static accessibilityId(id: string) {
-    return new SeleniumBy('accessibility id', id);
+    return new By('accessibility id', id);
   }
 
   // @ts-ignore: error TS2699: Static property 'name' conflicts with built-in property 'Function.name'
   static name(name: string) {
-    return new SeleniumBy('name', name);
+    return new By('name', name);
   }
 
   static className(name: string) {
-    return new SeleniumBy('class name', name);
+    return new By('class name', name);
   }
 }

src/index.ts

@@ -3,5 +3,6 @@
  * Licensed under the MIT License.
  */
 
-export { By } from './by';
-export { AppiumDriver } from './appiumdriver'
+export { By2 } from './by2';
+export { IAppiumDriver, createAppiumWebDriver } from './appiumdriver'
+export { windowsNativeAppCapabilities } from './appiumdriver.windows'