appium-android-driver 6.0.0 → 7.0.0

package/lib/bootstrap.js

@@ -1,227 +0,0 @@
-import UiAutomator from './uiautomator';
-import net from 'net';
-import path from 'path';
-import _ from 'lodash';
-import { errorFromCode } from 'appium/driver';
-import B from 'bluebird';
-import { logger, fs } from '@appium/support';
-
-
-const log = logger.getLogger('AndroidBootstrap');
-const COMMAND_TYPES = {
-  ACTION: 'action',
-  SHUTDOWN: 'shutdown'
-};
-const SEND_COMMAND_TIMEOUT = 1 * 60 * 1000;
-
-/**
- * Calculates the path to the current module's root folder
- *
- * @returns {string} The full path to module root
- * @throws {Error} If the current module root folder cannot be determined
- */
-const getModuleRoot = _.memoize(async function getModuleRoot () {
-  let currentDir = path.dirname(path.resolve(__filename));
-  let isAtFsRoot = false;
-  while (!isAtFsRoot) {
-    const manifestPath = path.join(currentDir, 'package.json');
-    try {
-      if (await fs.exists(manifestPath) &&
-          JSON.parse(await fs.readFile(manifestPath, 'utf8')).name === 'appium-android-driver') {
-        return currentDir;
-      }
-    } catch (ign) {}
-    currentDir = path.dirname(currentDir);
-    isAtFsRoot = currentDir.length <= path.dirname(currentDir).length;
-  }
-  throw new Error('Cannot find the root folder of the appium-android-driver Node.js module');
-});
-
-class AndroidBootstrap {
-  constructor (adb, systemPort = 4724, webSocket = undefined) {
-    this.adb = adb;
-    this.systemPort = systemPort;
-    this.webSocket = webSocket;
-    this.ignoreUnexpectedShutdown = false;
-  }
-
-  get onUnexpectedShutdown () {
-    if (!this._onUnexpectedShutdownPromise) {
-      let reject;
-      this._onUnexpectedShutdownPromise = new B(function _onUnexpectedShutdownPromise (_resolve, _reject) {
-        reject = _reject;
-      });
-      this._onUnexpectedShutdownPromise.cancel = reject;
-    }
-    return this._onUnexpectedShutdownPromise;
-  }
-
-  async start (appPackage, disableAndroidWatchers = false, acceptSslCerts = false) {
-    try {
-      const startDetector = (s) => /Appium Socket Server Ready/.test(s);
-      const bootstrapJar = path.resolve(await getModuleRoot(), 'bootstrap', 'bin', 'AppiumBootstrap.jar');
-
-      await this.init();
-      await this.adb.forwardPort(this.systemPort, 4724);
-      this.process = await this.uiAutomator.start(
-        bootstrapJar, 'io.appium.android.bootstrap.Bootstrap',
-        startDetector,
-        '-e', 'pkg', appPackage,
-        '-e', 'disableAndroidWatchers', disableAndroidWatchers,
-        '-e', 'acceptSslCerts', acceptSslCerts
-      );
-
-      // process the output
-      this.process.on('output', (stdout, stderr) => {
-        const alertRe = /Emitting system alert message/;
-        if (alertRe.test(stdout)) {
-          log.debug('Emitting alert message...');
-          if (this.webSocket) {
-            this.webSocket.sockets.emit('alert', {message: stdout});
-          }
-        }
-
-        // the bootstrap logger wraps its own log lines with
-        // [APPIUM-UIAUTO] ... [APPIUM-UIAUTO]
-        // and leaves actual UiAutomator logs as they are
-        let stdoutLines = (stdout || '').split('\n');
-        const uiautoLog = /\[APPIUM-UIAUTO\](.+)\[\/APPIUM-UIAUTO\]/;
-        for (let line of stdoutLines) {
-          if (line.trim()) {
-            if (uiautoLog.test(line)) {
-              let innerLine = uiautoLog.exec(line)[1].trim();
-              let logMethod = log.info.bind(log);
-              // if the bootstrap log considers something debug, log that as
-              // debug and not info
-              if (/\[debug\]/.test(innerLine)) {
-                logMethod = log.debug.bind(log);
-              }
-              logMethod(`[BOOTSTRAP LOG] ${innerLine}`);
-            } else {
-              log.debug(`[UIAUTO STDOUT] ${line}`);
-            }
-          }
-        }
-
-        let stderrLines = (stderr || '').split('\n');
-        for (let line of stderrLines) {
-          if (line.trim()) {
-            log.debug(`[UIAUTO STDERR] ${line}`);
-          }
-        }
-      });
-
-      // only return when the socket client has connected
-      return await new B((resolve, reject) => {
-        try {
-          this.socketClient = net.connect(this.systemPort, '127.0.0.1');
-          // Windows: the socket errors out when ADB restarts. Let's catch it to avoid crashing.
-          this.socketClient.on('error', (err) => {
-            if (!this.ignoreUnexpectedShutdown) {
-              throw new Error(`Android bootstrap socket crashed: ${err}`);
-            }
-          });
-          this.socketClient.once('connect', () => {
-            log.info('Android bootstrap socket is now connected');
-            resolve();
-          });
-        } catch (err) {
-          reject(err);
-        }
-      });
-    } catch (err) {
-      log.errorAndThrow(`Error occured while starting AndroidBootstrap. Original error: ${err}`);
-    }
-  }
-
-  async sendCommand (type, extra = {}) {
-    if (!this.socketClient) {
-      throw new Error('Socket connection closed unexpectedly');
-    }
-
-    return await new B((resolve, reject) => {
-      let cmd = Object.assign({cmd: type}, extra);
-      let cmdJson = `${JSON.stringify(cmd)} \n`;
-      log.debug(`Sending command to android: ${_.truncate(cmdJson, {length: 1000}).trim()}`);
-      this.socketClient.write(cmdJson);
-      this.socketClient.setEncoding('utf8');
-      let streamData = '';
-      let sendCommandTimeoutHandler = null;
-      this.socketClient.on('data', (data) => {
-        if (sendCommandTimeoutHandler) {
-          clearTimeout(sendCommandTimeoutHandler);
-        }
-        log.debug('Received command result from bootstrap');
-        try {
-          streamData = JSON.parse(streamData + data);
-          // we successfully parsed JSON so we've got all the data,
-          // remove the socket listener and evaluate
-          this.socketClient.removeAllListeners('data');
-          if (streamData.status === 0) {
-            return resolve(streamData.value);
-          }
-          reject(errorFromCode(streamData.status, streamData.value));
-        } catch (err) {
-          if (!_.isString(streamData)) {
-            log.error('Got an unexpected error inside socket listener');
-            log.error(err.stack);
-            return reject(errorFromCode(13, err.message));
-          }
-          log.debug(`Stream still not complete, waiting up to ${SEND_COMMAND_TIMEOUT}ms for the data to arrive`);
-          streamData += data;
-          sendCommandTimeoutHandler = setTimeout(() => {
-            const errMsg = `Server socket stopped responding. The recent response was '${streamData}'`;
-            log.error(errMsg);
-            this.socketClient.removeAllListeners('data');
-            reject(errorFromCode(13, errMsg));
-          }, SEND_COMMAND_TIMEOUT);
-        }
-      });
-    });
-  }
-
-  async sendAction (action, params = {}) {
-    let extra = {action, params};
-    return await this.sendCommand(COMMAND_TYPES.ACTION, extra);
-  }
-
-  async shutdown () {
-    if (!this.uiAutomator) {
-      log.warn('Cannot shut down Android bootstrap; it has already shut down');
-      return;
-    }
-
-    // remove listners so we don't trigger unexpected shutdown
-    this.uiAutomator.removeAllListeners(UiAutomator.EVENT_CHANGED);
-    if (this.socketClient) {
-      await this.sendCommand(COMMAND_TYPES.SHUTDOWN);
-    }
-    await this.uiAutomator.shutdown();
-    this.uiAutomator = null;
-  }
-
-  // this helper function makes unit testing easier.
-  async init () { // eslint-disable-line require-await
-    this.uiAutomator = new UiAutomator(this.adb);
-
-    // Handle unexpected UiAutomator shutdown
-    this.uiAutomator.on(UiAutomator.EVENT_CHANGED, (msg) => {
-      if (msg.state === UiAutomator.STATE_STOPPED) {
-        this.uiAutomator = null;
-        this.onUnexpectedShutdown.cancel(new Error('UiAUtomator shut down unexpectedly'));
-      }
-    });
-  }
-
-  set ignoreUnexpectedShutdown (ignore) {
-    log.debug(`${ignore ? 'Ignoring' : 'Watching for'} bootstrap disconnect`);
-    this._ignoreUnexpectedShutdown = ignore;
-  }
-
-  get ignoreUnexpectedShutdown () {
-    return this._ignoreUnexpectedShutdown;
-  }
-}
-
-export { AndroidBootstrap, COMMAND_TYPES };
-export default AndroidBootstrap;

package/lib/uiautomator.js

@@ -1,109 +0,0 @@
-import events from 'events';
-import { logger } from '@appium/support';
-
-
-const log = logger.getLogger('UiAutomator');
-
-class UiAutomator extends events.EventEmitter {
-  constructor (adb) {
-    if (!adb) {
-      log.errorAndThrow('adb is required to instantiate UiAutomator');
-    }
-    super();
-    this.adb = adb;
-    this.tempPath = '/data/local/tmp/';
-  }
-
-  async start (uiAutomatorBinaryPath, className, startDetector, ...extraParams) {
-    let processIsAlive;
-    try {
-      log.debug('Starting UiAutomator');
-      this.changeState(UiAutomator.STATE_STARTING);
-
-      log.debug('Parsing uiautomator jar');
-      // expecting a path like /ads/ads/foo.jar or \asd\asd\foo.jar
-      let jarName = this.parseJarNameFromPath(uiAutomatorBinaryPath);
-      await this.adb.push(uiAutomatorBinaryPath, this.tempPath);
-
-      // killing any uiautomator existing processes
-      await this.killUiAutomatorOnDevice();
-
-      log.debug('Starting UIAutomator');
-      let args = ['shell', 'uiautomator', 'runtest', jarName, '-c', className, ...extraParams];
-      this.proc = this.adb.createSubProcess(args);
-
-      // handle out-of-bound exit by simply emitting a stopped state
-      this.proc.on('exit', (code, signal) => {
-        processIsAlive = false;
-        // cleanup
-        if (this.state !== UiAutomator.STATE_STOPPED &&
-            this.state !== UiAutomator.STATE_STOPPING) {
-          let msg = `UiAutomator exited unexpectedly with code ${code}, ` +
-                    `signal ${signal}`;
-          log.error(msg);
-        } else if (this.state === UiAutomator.STATE_STOPPING) {
-          log.debug('UiAutomator shut down normally');
-        }
-        this.changeState(UiAutomator.STATE_STOPPED);
-      });
-
-      await this.proc.start(startDetector);
-      processIsAlive = true;
-      this.changeState(UiAutomator.STATE_ONLINE);
-      return this.proc;
-    } catch (e) {
-      this.emit(UiAutomator.EVENT_ERROR, e);
-      if (processIsAlive) {
-        await this.killUiAutomatorOnDevice();
-        await this.proc.stop();
-      }
-      log.errorAndThrow(e);
-    }
-  }
-
-  async shutdown () {
-    log.debug('Shutting down UiAutomator');
-    if (this.state !== UiAutomator.STATE_STOPPED) {
-      this.changeState(UiAutomator.STATE_STOPPING);
-      await this.proc.stop();
-    }
-    await this.killUiAutomatorOnDevice();
-    this.changeState(UiAutomator.STATE_STOPPED);
-  }
-
-  parseJarNameFromPath (binaryPath) {
-    let reTest = /.*(\/|\\)(.*\.jar)/.exec(binaryPath);
-    if (!reTest) {
-      throw new Error(`Unable to parse jar name from ${binaryPath}`);
-    }
-    let jarName = reTest[2];
-    log.debug(`Found jar name: '${jarName}'`);
-    return jarName;
-  }
-
-  changeState (state) {
-    log.debug(`Moving to state '${state}'`);
-    this.state = state;
-    this.emit(UiAutomator.EVENT_CHANGED, {state});
-  }
-
-  async killUiAutomatorOnDevice () {
-    try {
-      await this.adb.killProcessesByName('uiautomator');
-    } catch (e) {
-      log.warn(`Error while killing uiAutomator: ${e}`);
-    }
-  }
-
-}
-
-UiAutomator.EVENT_ERROR = 'uiautomator_error';
-UiAutomator.EVENT_CHANGED = 'stateChanged';
-UiAutomator.STATE_STOPPING = 'stopping';
-UiAutomator.STATE_STOPPED = 'stopped';
-UiAutomator.STATE_STARTING = 'starting';
-UiAutomator.STATE_ONLINE = 'online';
-
-
-export { UiAutomator };
-export default UiAutomator;