@appium/fake-driver 5.1.3 → 5.1.4

package/lib/commands/general.js

@@ -2,118 +2,146 @@ import {errors} from 'appium/driver';
 
 const ORIENTATIONS = new Set(['LANDSCAPE', 'PORTRAIT']);
 
-/**
- * @template {Class<import('../types').IContextsCommands & import('../types').IElementCommands>} T
- * @param {T} Base
- */
-export function GeneralMixin(Base) {
+export default {
   /**
-   * @implements {IGeneralCommands}
+   * @this {FakeDriver}
    */
-  class GeneralCommands extends Base {
-    async title() {
-      this.assertWebviewContext();
-      return this.appModel.title;
-    }
-
-    async keys(value) {
-      if (!this.focusedElId) {
-        throw new errors.InvalidElementStateError();
-      }
-      await this.setValue(value, this.focusedElId);
-    }
-
-    async setGeoLocation(location) {
-      // TODO test this adequately once WD bug is fixed
-      this.appModel.lat = location.latitude;
-      this.appModel.long = location.longitude;
-    }
+  async title() {
+    this.assertWebviewContext();
+    return this.appModel.title;
+  },
 
-    async getGeoLocation() {
-      return this.appModel.currentGeoLocation;
-    }
-
-    async getPageSource() {
-      return this.appModel.rawXml;
+  /**
+   * @this {FakeDriver}
+   */
+  async keys(value) {
+    if (!this.focusedElId) {
+      throw new errors.InvalidElementStateError();
     }
+    await this.setValue(value, this.focusedElId);
+  },
 
-    async getOrientation() {
-      return this.appModel.orientation;
-    }
+  /**
+   * @this {FakeDriver}
+   */
+  async setGeoLocation(location) {
+    // TODO test this adequately once WD bug is fixed
+    this.appModel.lat = location.latitude;
+    this.appModel.long = location.longitude;
+  },
 
-    /**
-     *
-     * @param {import('../types').FakeDriverCaps['orientation']} o
-     */
-    async setOrientation(o) {
-      if (!ORIENTATIONS.has(o)) {
-        throw new errors.UnknownError('Orientation must be LANDSCAPE or PORTRAIT');
-      }
-      this.appModel.orientation = o;
-    }
+  /**
+   * @this {FakeDriver}
+   */
+  async getGeoLocation() {
+    return this.appModel.currentGeoLocation;
+  },
 
-    async getScreenshot() {
-      return this.appModel.getScreenshot();
-    }
+  /**
+   * @this {FakeDriver}
+   */
+  async getPageSource() {
+    return this.appModel.rawXml;
+  },
 
-    async getWindowSize() {
-      return {width: this.appModel.width, height: this.appModel.height};
-    }
+  /**
+   * @this {FakeDriver}
+   */
+  async getOrientation() {
+    return this.appModel.orientation;
+  },
 
-    async getWindowRect() {
-      return {width: this.appModel.width, height: this.appModel.height, x: 0, y: 0};
+  /**
+   *
+   * @param {import('../types').FakeDriverCaps['orientation']} o
+   * @this {FakeDriver}
+   */
+  async setOrientation(o) {
+    if (!ORIENTATIONS.has(o)) {
+      throw new errors.UnknownError('Orientation must be LANDSCAPE or PORTRAIT');
     }
+    this.appModel.orientation = o;
+  },
 
-    async performActions(actions) {
-      this.appModel.actionLog.push(actions);
-    }
+  /**
+   * @this {FakeDriver}
+   */
+  async getScreenshot() {
+    return this.appModel.getScreenshot();
+  },
 
-    async releaseActions() {}
+  /**
+   * @this {FakeDriver}
+   */
+  async getWindowSize() {
+    return {width: this.appModel.width, height: this.appModel.height};
+  },
 
-    async getLog(type) {
-      switch (type) {
-        case 'actions':
-          return this.appModel.actionLog;
-        default:
-          throw new Error(`Don't understand log type '${type}'`);
-      }
-    }
+  /**
+   * @this {FakeDriver}
+   */
+  async getWindowRect() {
+    return {width: this.appModel.width, height: this.appModel.height, x: 0, y: 0};
+  },
 
-    async mobileShake() {
-      this.shook = true;
-    }
+  /**
+   *
+   * @this {FakeDriver}
+   */
+  async performActions(actions) {
+    this.appModel.actionLog.push(actions);
+  },
 
-    async doubleClick() {}
+  /**
+   * @this {FakeDriver}
+   */
+  async releaseActions() {},
 
-    async execute(script, args) {
-      return await this.executeMethod(script, args);
+  /**
+   * @this {FakeDriver}
+   */
+  async getLog(type) {
+    switch (type) {
+      case 'actions':
+        return this.appModel.actionLog;
+      default:
+        throw new Error(`Don't understand log type '${type}'`);
     }
+  },
 
-    /**
-     * Add two or maybe even three numbers
-     *
-     * @param {number} num1
-     * @param {number} num2
-     * @param {number} [num3]
-     * @returns {Promise<number>}
-     */
-    async fakeAddition(num1, num2, num3 = 0) {
-      return num1 + num2 + (num3 ?? 0);
-    }
-  }
+  /**
+   * @this {FakeDriver}
+   */
+  async mobileShake() {
+    this.shook = true;
+  },
 
-  return GeneralCommands;
-}
+  /**
+   * @this {FakeDriver}
+   */
+  async doubleClick() {},
 
-/**
- * @typedef {import('../driver').FakeDriverCore} FakeDriverCore
- */
+  /**
+   * @this {FakeDriver}
+   */
+  async execute(script, args) {
+    return await this.executeMethod(script, args);
+  },
 
-/**
- * @template T,[U={}],[V=Array<any>]
- * @typedef {import('@appium/types').Class<T,U,V>} Class
- */
+  /**
+   * Add two or maybe even three numbers
+   *
+   * @param {number} num1
+   * @param {number} num2
+   * @param {number} [num3]
+   * @returns {Promise<number>}
+   * @this {FakeDriver}
+   */
+  async fakeAddition(num1, num2, num3 = 0) {
+    return num1 + num2 + (num3 ?? 0);
+  },
+};
 
 /**
- * @typedef {import('../types').IGeneralCommands} IGeneralCommands
+ * @typedef {import('../driver').FakeDriver} FakeDriver
  */

package/lib/commands/index.js

@@ -1,16 +1,8 @@
-import {AlertMixin} from './alert';
-import {ContextsMixin} from './contexts';
-import {ElementMixin} from './element';
-import {FindMixin} from './find';
-import {GeneralMixin} from './general';
-
-/**
- *
- * @param {import('@appium/types').Class<import('../driver').FakeDriverCore>} Base
- */
-export function FakeDriverMixin(Base) {
-  return GeneralMixin(FindMixin(ElementMixin(AlertMixin(ContextsMixin(Base)))));
-}
+export {default as alert} from './alert';
+export {default as contexts} from './contexts';
+export {default as element} from './element';
+export {default as find} from './find';
+export {default as general} from './general';
 
 /* // TODO:
   //rest.post('/wd/hub/session/:sessionId?/touch/click', controller.doClick);

package/lib/driver.js

@@ -2,7 +2,7 @@ import B from 'bluebird';
 import {BaseDriver, errors} from 'appium/driver';
 import {deprecatedCommandsLogged} from '@appium/base-driver/build/lib/protocol/protocol';
 import {FakeApp} from './fake-app';
-import {FakeDriverMixin} from './commands';
+import {alert, contexts, element, find, general} from './commands';
 
 const FAKE_DRIVER_CONSTRAINTS = /** @type {const} */ ({
   app: {
@@ -22,7 +22,7 @@ const FAKE_DRIVER_CONSTRAINTS = /** @type {const} */ ({
  * @extends {BaseDriver<FakeDriverConstraints>}
  * @implements {ExternalDriver<FakeDriverConstraints>}
  */
-export class FakeDriverCore extends BaseDriver {
+export class FakeDriver extends BaseDriver {
   desiredCapConstraints = FAKE_DRIVER_CONSTRAINTS;
 
   /** @type {string} */
@@ -190,36 +190,92 @@ export class FakeDriverCore extends BaseDriver {
     },
   });
 
-  /**
-   * Add two or maybe even three numbers
-   *
-   * @param {number} num1
-   * @param {number} num2
-   * @param {number} [num3]
-   * @returns {Promise<number>}
-   */
-  // eslint-disable-next-line no-unused-vars
-  async fakeAddition(num1, num2, num3 = 0) {
-    throw new errors.NotImplementedError();
-  }
-
   static fakeRoute(req, res) {
     res.send(JSON.stringify({fakedriver: 'fakeResponse'}));
   }
 
   static async updateServer(expressApp, httpServer, cliArgs) {
     // eslint-disable-line require-await
-    expressApp.all('/fakedriver', FakeDriverCore.fakeRoute);
+    expressApp.all('/fakedriver', FakeDriver.fakeRoute);
     expressApp.all('/fakedriverCliArgs', (req, res) => {
       res.send(JSON.stringify(cliArgs));
     });
   }
+
+  /*********
+   * ALERT *
+   *********/
+  assertNoAlert = alert.assertNoAlert;
+  assertAlert = alert.assertAlert;
+  getAlertText = alert.getAlertText;
+  setAlertText = alert.setAlertText;
+  postAcceptAlert = alert.postAcceptAlert;
+  postDismissAlert = alert.postDismissAlert;
+
+  /************
+   * CONTEXTS *
+   ************/
+  getRawContexts = contexts.getRawContexts;
+  assertWebviewContext = contexts.assertWebviewContext;
+  getCurrentContext = contexts.getCurrentContext;
+  getContexts = contexts.getContexts;
+  setContext = contexts.setContext;
+  setFrame = contexts.setFrame;
+
+  /************
+   * ELEMENTS *
+   ************/
+  getElements = element.getElements;
+  getElement = element.getElement;
+  getName = element.getName;
+  elementDisplayed = element.elementDisplayed;
+  elementEnabled = element.elementEnabled;
+  elementSelected = element.elementSelected;
+  setValue = element.setValue;
+  getText = element.getText;
+  clear = element.clear;
+  click = element.click;
+  getAttribute = element.getAttribute;
+  getElementRect = element.getElementRect;
+  getSize = element.getSize;
+  equalsElement = element.equalsElement;
+  getCssProperty = element.getCssProperty;
+  getLocation = element.getLocation;
+  getLocationInView = element.getLocationInView;
+
+  /********
+   * FIND *
+   ********/
+  getExistingElementForNode = find.getExistingElementForNode;
+  wrapNewEl = find.wrapNewEl;
+  findElOrEls = find.findElOrEls;
+  findElement = find.findElement;
+  findElements = find.findElements;
+  findElementFromElement = find.findElementFromElement;
+  findElementsFromElement = find.findElementsFromElement;
+
+  /***********
+   * GENERAL *
+   ***********/
+  title = general.title;
+  keys = general.keys;
+  setGeoLocation = general.setGeoLocation;
+  getGeoLocation = general.getGeoLocation;
+  getPageSource = general.getPageSource;
+  getOrientation = general.getOrientation;
+  setOrientation = general.setOrientation;
+  getScreenshot = general.getScreenshot;
+  getWindowSize = general.getWindowSize;
+  getWindowRect = general.getWindowRect;
+  performActions = general.performActions;
+  getLog = general.getLog;
+  mobileShake = general.mobileShake;
+  doubleClick = general.doubleClick;
+  execute = general.execute;
+  fakeAddition = general.fakeAddition;
+  releaseActions = general.releaseActions;
 }
 
-/**
- * @extends FakeDriverCore
- */
-export class FakeDriver extends FakeDriverMixin(FakeDriverCore) {}
 export default FakeDriver;
 
 /**

package/lib/types.ts

@@ -1,7 +1,5 @@
-import type {DriverCaps, ExternalDriver, W3CDriverCaps} from '@appium/types';
+import type {DriverCaps, W3CDriverCaps} from '@appium/types';
 import type {FakeDriverConstraints} from './driver';
-import {FakeApp} from './fake-app';
-import {FakeElement} from './fake-element';
 
 /**
  * W3C-style caps for {@link FakeDriver}
@@ -14,29 +12,3 @@ export type W3CFakeDriverCaps = W3CDriverCaps<FakeDriverConstraints>;
  * @public
  */
 export type FakeDriverCaps = DriverCaps<FakeDriverConstraints>;
-
-export interface IFakeDriver extends ExternalDriver<FakeDriverConstraints> {
-  elMap: Record<string, FakeElement>;
-  maxElId: number;
-  appModel: FakeApp;
-  focusedElId: string;
-  curContext: string;
-}
-
-export interface IGeneralCommands extends IFakeDriver {
-  fakeAddition(num1: number, num2: number, num3?: number): Promise<number>;
-}
-
-export interface IContextsCommands extends IFakeDriver {
-  assertWebviewContext(): void;
-}
-
-export interface IElementCommands extends IFakeDriver {
-  getElement(id: string): FakeElement;
-  getElements(ids: string[]): FakeElement[];
-  setValue(text: string, id: string): Promise<void>;
-}
-
-export interface IAlertCommands extends IFakeDriver {
-  assertNoAlert(): void;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/fake-driver",
-  "version": "5.1.3",
+  "version": "5.1.4",
   "description": "Mock driver used internally by Appium for testing. Ignore",
   "keywords": [
     "automation",
@@ -81,5 +81,5 @@
     "entryPoint": "./lib/index.js"
   },
   "types": "./build/lib/index.d.ts",
-  "gitHead": "67c9bdfbceeb049aa134bf1d9b107543ff0a80b0"
+  "gitHead": "f1e0a46712b76564cd44c37657882308a7bac706"
 }