How to use adb.keyevent method in Appium Android Driver

...259        let code = parseInt(keycode, 10);260        mocks.adb.expects("shell")261          .once().withExactArgs(['input', 'keyevent', code])262          .returns("");263        await adb.keyevent(keycode);264        mocks.adb.verify();265      });266    }));267    describe('inputText', withMocks({adb}, (mocks) => {268      it('should call shell with correct args', async () => {269        let text = 'some text with spaces';270        let expectedText = 'some%stext%swith%sspaces';271        mocks.adb.expects("shell")272          .once().withExactArgs(['input', 'text', expectedText])273          .returns("");274        await adb.inputText(text);275        mocks.adb.verify();276      });277    }));...

...91};92androidCommon.background = function (secs, cb) {93  this.adb.getFocusedPackageAndActivity(function (err, pack, activity) {94    if (err) return cb(err);95    this.adb.keyevent("3", function (err) {96      if (err) return cb(err);97      setTimeout(function () {98        var onStart = function (err) {99          if (err) return cb(err);100          cb(null,{101            status: status.codes.Success.code,102            value: null103          });104        };105        this.adb.startApp({106          pkg: this.args.appPackage,107          activity: this.args.appActivity,108          action: this.args.intentAction,109          category: this.args.intentCategory,110          flags: this.args.intentFlags,111          waitPkg: pack,112          waitActivity: activity,113          optionalIntentArguments: this.args.optionalIntentArguments,114          retry: true,115          stopApp: this.args.stopAppOnReset116        }, onStart);117      }.bind(this), secs * 1000);118    }.bind(this));119  }.bind(this));120};121androidCommon.openSettingsActivity = function (setting, cb) {122  this.adb.getFocusedPackageAndActivity(function (err, foundPackage,123                                                 foundActivity) {124    var cmd = 'am start -a android.settings.' + setting;125    this.adb.shell(cmd, function (err) {126      if (err) {127        cb(err);128      } else {129        this.adb.waitForNotActivity(foundPackage, foundActivity, 5000, cb);130      }131    }.bind(this));132  }.bind(this));133};134androidCommon.toggleSetting = function (setting, preKeySeq, ocb) {135  var doKey = function (key) {136    return function (cb) {137      setTimeout(function () {138        this.adb.keyevent(key, cb);139      }.bind(this), 2000);140    }.bind(this);141  }.bind(this);142  var settPkg, settAct;143  var back = function (cb) {144    this.adb.back(function (err) {145      if (err) {146        cb(err);147      } else {148        this.adb.waitForNotActivity(settPkg, settAct, 5000, cb);149      }150    }.bind(this));151  }.bind(this);152  /*153   * preKeySeq is the keyevent sequence to send over ADB in order154   * to position the cursor on the right option.155   * By default it's [up, up, down] because we usually target the 1st item in156   * the screen, and sometimes when opening settings activities the cursor is157   * already positionned on the 1st item, but we can't know for sure158   */159  if (preKeySeq === null) preKeySeq = [19, 19, 20]; // up, up, down160  var sequence = [161    function (cb) {162      this.openSettingsActivity(setting, cb);163    }.bind(this)164  ];165  var len = preKeySeq.length;166  for (var i = 0; i < len; i++) {167    sequence.push(doKey(preKeySeq[i]));168  }169  sequence.push(170    function (cb) {171      this.adb.getFocusedPackageAndActivity(function (err, foundPackage,172                                                     foundActivity) {173        settPkg = foundPackage;174        settAct = foundActivity;175        cb(err);176      }.bind(this));177    }.bind(this)178    , function (cb) {179      /*180       * Click and handle potential ADB disconnect that occurs on official181       * emulator when the network connection is disabled182       */183      this.wrapActionAndHandleADBDisconnect(doKey(23), cb);184    }.bind(this)185    , function (cb) {186      /*187       * In one particular case (enable Location Services), a pop-up is188       * displayed on some platforms so the user accepts or refuses that Google189       * collects location data. So we wait for that pop-up to open, if it190       * doesn't then proceed191       */192      this.adb.waitForNotActivity(settPkg, settAct, 5000, function (err) {193        if (err) {194          cb(null);195        } else {196          // Click on right button, "Accept"197          async.series([198            doKey(22)     // right199            , doKey(23)   // click200            , function (cb) {201              // Wait for pop-up to close202              this.adb.waitForActivity(settPkg, settAct, 5000, cb);203            }.bind(this)204          ], function (err) {205            cb(err);206          }.bind(this));207        }208      }.bind(this));209    }.bind(this)210    , back211  );212  async.series(sequence, function (err) {213    if (err) return ocb(err);214    ocb(null, { status: status.codes.Success.code });215  }.bind(this));216};217androidCommon.toggleData = function (cb) {218  this.adb.isDataOn(function (err, dataOn) {219    if (err) return cb(err);220    this.wrapActionAndHandleADBDisconnect(function (ncb) {221      this.adb.setData(dataOn ? 0 : 1, ncb);222    }.bind(this), function (err) {223      if (err) return cb(err);224      cb(null, {225        status: status.codes.Success.code226      });227    });228  }.bind(this));229};230androidCommon.toggleFlightMode = function (ocb) {231  this.adb.isAirplaneModeOn(function (err, airplaneModeOn) {232    if (err) return ocb(err);233    async.series([234      function (cb) {235        this.wrapActionAndHandleADBDisconnect(function (ncb) {236          this.adb.setAirplaneMode(airplaneModeOn ? 0 : 1, ncb);237        }.bind(this), cb);238      }.bind(this),239      function (cb) {240        this.wrapActionAndHandleADBDisconnect(function (ncb) {241          this.adb.broadcastAirplaneMode(airplaneModeOn ? 0 : 1, ncb);242        }.bind(this), cb);243      }.bind(this)244    ], function (err) {245      if (err) return ocb(err);246      ocb(null, {247        status: status.codes.Success.code248      });249    }.bind(this));250  }.bind(this));251};252androidCommon.toggleWiFi = function (cb) {253  this.adb.isWifiOn(function (err, dataOn) {254    if (err) return cb(err);255    this.wrapActionAndHandleADBDisconnect(function (ncb) {256      this.adb.setWifi(dataOn ? 0 : 1, ncb);257    }.bind(this), function (err) {258      if (err) return cb(err);259      cb(null, {260        status: status.codes.Success.code261      });262    });263  }.bind(this));264};265androidCommon.toggleLocationServices = function (ocb) {266  this.adb.getApiLevel(function (err, api) {267    if (api > 15) {268      var seq = [19, 19];   // up, up269      if (api === 16) {270        // This version of Android has a "parent" button in its action bar271        seq.push(20);       // down272      } else if (api >= 19) {273        // Newer versions of Android have the toggle in the Action bar274        seq = [22, 22, 19];     // right, right, up275        /*276         * Once the Location services switch is OFF, it won't receive focus277         * when going back to the Location Services settings screen unless we278         * send a dummy keyevent (UP) *before* opening the settings screen279         */280        this.adb.keyevent(19, function (/*err*/) {281          this.toggleSetting('LOCATION_SOURCE_SETTINGS', seq, ocb);282        }.bind(this));283        return;284      }285      this.toggleSetting('LOCATION_SOURCE_SETTINGS', seq, ocb);286    } else {287      // There's no global location services toggle on older Android versions288      ocb(new NotYetImplementedError(), null);289    }290  }.bind(this));291};292androidCommon.prepareDevice = function (onReady) {293  logger.debug("Using fast reset? " + this.args.fastReset);294  logger.debug("Preparing device for session");...

...262    }263  }.bind(this));264};265Selendroid.prototype.keyevent = function (keycode, metastate, cb) {266  this.adb.keyevent(keycode, function () {267    cb(null, {268      status: status.codes.Success.code269    , value: null270    });271  });272};273/*274 * Execute an arbitrary function and handle potential ADB disconnection before275 * proceeding276 */277Selendroid.prototype.wrapActionAndHandleADBDisconnect = function (action, ocb) {278  async.series([279    function (cb) {280      action(cb);...

1import chai from 'chai';2import chaiAsPromised from 'chai-as-promised';3import sinon from 'sinon';4import ADB from 'appium-adb';5import AndroidDriver from '../../..';6import B from 'bluebird';7let driver;8let adb;9let sandbox = sinon.sandbox.create();10chai.should();11chai.use(chaiAsPromised);12describe('Network', () => {13  beforeEach(async () => {14    driver = new AndroidDriver();15    adb = new ADB();16    driver.adb = adb;17    sandbox.stub(adb);18    sandbox.stub(driver, 'isEmulator');19    sandbox.stub(driver, 'wrapBootstrapDisconnect', async (fn) => {20      await fn();21    });22    sandbox.stub(B, 'delay');23  });24  afterEach(() => {25    sandbox.restore();26  });27  describe('getNetworkConnection', () => {28    beforeEach(() => {29      adb.isAirplaneModeOn.returns(false);30      adb.isDataOn.returns(false);31      sandbox.stub(driver, 'isWifiOn').returns(false);32    });33    it('should determine nothing enabled', async () => {34      await driver.getNetworkConnection().should.eventually.equal(0);35    });36    it('should determine airplane mode is on', async () => {37      adb.isAirplaneModeOn.returns(true);38      await driver.getNetworkConnection().should.eventually.equal(1);39    });40    it('should determine wifi is on', async () => {41      driver.isWifiOn.returns(true);42      await driver.getNetworkConnection().should.eventually.equal(2);43    });44    it('should determine data is on', async () => {45      adb.isDataOn.returns(true);46      await driver.getNetworkConnection().should.eventually.equal(4);47    });48    it('should determine wifi and data are on', async () => {49      driver.isWifiOn.returns(true);50      adb.isDataOn.returns(true);51      await driver.getNetworkConnection().should.eventually.equal(6);52    });53  });54  describe('isWifiOn', () => {55    it('should return wifi state', async () => {56      adb.isWifiOn.returns('wifi_state');57      await driver.isWifiOn().should.become('wifi_state');58    });59  });60  describe('setNetworkConnection', () => {61    beforeEach(async () => {62      sandbox.stub(driver, 'getNetworkConnection').returns('res');63      sandbox.stub(driver, 'setWifiState');64      driver.isEmulator.returns(false);65    });66    it('should turn off wifi and data', async () => {67      await driver.setNetworkConnection(0).should.become('res');68      adb.setAirplaneMode.calledWithExactly(0).should.be.true;69      adb.broadcastAirplaneMode.calledWithExactly(0).should.be.true;70      driver.setWifiState.calledWithExactly(0).should.be.true;71      adb.setDataState.calledWithExactly(0, false).should.be.true;72    });73    it('should turn on and broadcast airplane mode', async () => {74      await driver.setNetworkConnection(1);75      adb.setAirplaneMode.calledWithExactly(1).should.be.true;76      adb.broadcastAirplaneMode.calledWithExactly(1).should.be.true;77      driver.setWifiState.called.should.be.false;78      adb.setDataState.called.should.be.false;79    });80    it('should turn on wifi', async () => {81      await driver.setNetworkConnection(2);82      adb.setAirplaneMode.calledWithExactly(0).should.be.true;83      adb.broadcastAirplaneMode.calledWithExactly(0).should.be.true;84      driver.setWifiState.calledWithExactly(1).should.be.true;85      adb.setDataState.calledWithExactly(0, false).should.be.true;86    });87    it('should turn on data', async () => {88      await driver.setNetworkConnection(4);89      adb.setAirplaneMode.calledWithExactly(0).should.be.true;90      adb.broadcastAirplaneMode.calledWithExactly(0).should.be.true;91      driver.setWifiState.calledWithExactly(0).should.be.true;92      adb.setDataState.calledWithExactly(1, false).should.be.true;93    });94    it('should turn on data and wifi', async () => {95      await driver.setNetworkConnection(6);96      adb.setAirplaneMode.calledWithExactly(0).should.be.true;97      adb.broadcastAirplaneMode.calledWithExactly(0).should.be.true;98      driver.setWifiState.calledWithExactly(1).should.be.true;99      adb.setDataState.calledWithExactly(1, false).should.be.true;100    });101  });102  describe('setWifiState', () => {103    it('should set wifi state', async () => {104      driver.isEmulator.returns('is_emu');105      await driver.setWifiState('wifi_state');106      adb.setWifiState.calledWithExactly('wifi_state', 'is_emu').should.be.true;107    });108  });109  describe('toggleData', () => {110    it('should toggle data', async () => {111      adb.isDataOn.returns(false);112      driver.isEmulator.returns('is_emu');113      adb.setWifiAndData.returns('');114      await driver.toggleData();115      adb.setWifiAndData.calledWithExactly({data: true}, 'is_emu')116        .should.be.true;117    });118  });119  describe('toggleWiFi', () => {120    it('should toggle wifi', async () => {121      adb.isWifiOn.returns(false);122      driver.isEmulator.returns('is_emu');123      adb.setWifiAndData.returns('');124      await driver.toggleWiFi();125      adb.setWifiAndData.calledWithExactly({wifi: true}, 'is_emu')126        .should.be.true;127    });128  });129  describe('toggleFlightMode', () => {130    it('should toggle flight mode', async () => {131      adb.isAirplaneModeOn.returns(false);132      adb.setAirplaneMode.returns('');133      adb.broadcastAirplaneMode.returns('');134      await driver.toggleFlightMode();135      adb.setAirplaneMode.calledWithExactly(true).should.be.true;136      adb.broadcastAirplaneMode.calledWithExactly(true).should.be.true;137    });138  });139  describe('setGeoLocation', () => {140    it('should set location', async () => {141      adb.setGeoLocation.withArgs('location', 'is_emu').returns('res');142      driver.isEmulator.returns('is_emu');143      await driver.setGeoLocation('location').should.become('res');144    });145  });146  describe('toggleLocationSettings', () => {147    beforeEach(async () => {148      sandbox.stub(driver, 'toggleSetting');149    });150    it('should throw an error for API<16', async () => {151      adb.getApiLevel.returns(15);152      driver.isEmulator.returns(false);153      await driver.toggleLocationServices().should.eventually.be.rejectedWith(/implemented/);154    });155    it('should generate the correct sequence of keys for API 16', async () => {156      let sequence = [19, 19, 20];157      adb.getApiLevel.returns(16);158      driver.isEmulator.returns(false);159      await driver.toggleLocationServices();160      driver.toggleSetting.calledWith('LOCATION_SOURCE_SETTINGS', sequence).should.be.true;161    });162    it('should generate the correct sequence of keys for API >= 19', async () => {163      let sequence = [22, 22, 19];164      adb.getApiLevel.returns(19);165      driver.isEmulator.returns(false);166      await driver.toggleLocationServices();167      adb.keyevent.calledWithExactly(19).should.be.true;168      driver.toggleSetting.calledWith('LOCATION_SOURCE_SETTINGS', sequence)169        .should.be.true;170    });171    it('should set gps for emulators', async () => {172      adb.getApiLevel.returns(19);173      driver.isEmulator.returns(true);174      adb.getLocationProviders.returns(['wifi']);175      await driver.toggleLocationServices();176      adb.toggleGPSLocationProvider.calledWithExactly(true).should.be.true;177    });178  });179  describe('toggleSetting', () => {180    beforeEach(() => {181      sandbox.stub(driver, 'doKey').returns('');182      sandbox.stub(driver, 'openSettingsActivity').returns('');183      adb.getFocusedPackageAndActivity184        .returns({appPackage: 'fpkg', appActivity:'fact'});185    });186    it('should toggle setting', async () => {187      await driver.toggleSetting('set', [61, 72]);188      driver.doKey.getCall(0).args[0].should.be.equal(61);189      driver.doKey.getCall(1).args[0].should.be.equal(72);190      driver.doKey.getCall(2).args[0].should.be.equal(23);191      driver.doKey.getCall(3).args[0].should.be.equal(22);192      driver.doKey.getCall(4).args[0].should.be.equal(23);193      driver.openSettingsActivity.calledWithExactly('set').should.be.true;194      adb.waitForNotActivity.calledTwice.should.be.true;195      adb.waitForNotActivity.alwaysCalledWith('fpkg', 'fact').should.be.true;196      adb.back.calledOnce.should.be.true;197    });198    it('should use default key sequence', async () => {199      await driver.toggleSetting('set', null);200      driver.doKey.getCall(0).args[0].should.be.equal(19);201      driver.doKey.getCall(1).args[0].should.be.equal(19);202      driver.doKey.getCall(2).args[0].should.be.equal(20);203    });204    it('should skip errors from adb.waitForNotActivity', async () => {205      adb.waitForNotActivity.throws();206      await driver.toggleSetting('set', null).should.be.fulfilled;207    });208  });209  describe('doKey', () => {210    it('should send key event', async () => {211      await driver.doKey(55);212      adb.keyevent.calledWithExactly(55).should.be.true;213    });214  });215  describe('wrapBootstrapDisconnect', () => {216    it('should restart adb and start bootstrap', async () => {217      driver.wrapBootstrapDisconnect.restore();218      let fn = sandbox.stub();219      driver.bootstrap = sandbox.stub();220      driver.bootstrap.start = sandbox.stub();221      driver.opts = {appPackage: 'pkg', disableAndroidWatchers: 'daw', acceptSslCerts: 'acert'};222      await driver.wrapBootstrapDisconnect(fn);223      sinon.assert.callOrder(fn, adb.restart, driver.bootstrap.start);224      driver.bootstrap.calledWithExactly('pkg', 'daw', 'acert');225      driver.bootstrap.ignoreUnexpectedShutdown.should.be.false;226    });227  });...

...102       * Once the Location services switch is OFF, it won't receive focus103       * when going back to the Location Services settings screen unless we104       * send a dummy keyevent (UP) *before* opening the settings screen105       */106      await this.adb.keyevent(19);107    }108    await this.toggleSetting('LOCATION_SOURCE_SETTINGS', seq);109  } else {110    // There's no global location services toggle on older Android versions111    throw new errors.NotYetImplementedError();112  }113};114helpers.toggleSetting = async function (setting, preKeySeq) {115  /*116   * preKeySeq is the keyevent sequence to send over ADB in order117   * to position the cursor on the right option.118   * By default it's [up, up, down] because we usually target the 1st item in119   * the screen, and sometimes when opening settings activities the cursor is120   * already positionned on the 1st item, but we can't know for sure121   */122  if (_.isNull(preKeySeq)) {123    preKeySeq = [19, 19, 20]; // up, up, down124  }125  await this.openSettingsActivity(setting);126  for (let key of preKeySeq) {127    await this.doKey(key);128  }129  let {appPackage, appActivity} = await this.adb.getFocusedPackageAndActivity();130  /*131   * Click and handle potential ADB disconnect that occurs on official132   * emulator when the network connection is disabled133   */134  await this.wrapBootstrapDisconnect(async () => {135    await this.doKey(23);136  });137  /*138   * In one particular case (enable Location Services), a pop-up is139   * displayed on some platforms so the user accepts or refuses that Google140   * collects location data. So we wait for that pop-up to open, if it141   * doesn't then proceed142   */143  try {144    await this.adb.waitForNotActivity(appPackage, appActivity, 5000);145    await this.doKey(22); // right146    await this.doKey(23); // click147    await this.adb.waitForNotActivity(appPackage, appActivity, 5000);148  } catch (ign) {}149  await this.adb.back();150};151helpers.doKey = async function (key) {152  // TODO: Confirm we need this delay. Seems to work without it.153  await B.delay(2000);154  await this.adb.keyevent(key);155};156helpers.wrapBootstrapDisconnect = async function (wrapped) {157  this.bootstrap.ignoreUnexpectedShutdown = true;158  try {159    await wrapped();160    await this.adb.restart();161    await this.bootstrap.start(this.opts.appPackage, this.opts.disableAndroidWatchers, this.opts.acceptSslCerts);162  } finally {163    this.bootstrap.ignoreUnexpectedShutdown = false;164  }165};166Object.assign(extensions, commands, helpers);167export { commands, helpers };168export default extensions;

...72};73// Selendroid doesn't support metastate for keyevents74commands.keyevent = async function keyevent (keycode, metastate) {75  log.debug(`Ignoring metastate ${metastate}`);76  await this.adb.keyevent(keycode);77};78// Use ADB since we don't have UiAutomator79commands.back = async function back () {80  await this.adb.keyevent(4);81};82commands.getContexts = async function getContexts () {83  let chromiumViews = [];84  let webviews = await webviewHelpers.getWebviews(this.adb,85      this.opts.androidDeviceSocket);86  if (_.includes(webviews, CHROMIUM_WIN)) {87    chromiumViews = [CHROMIUM_WIN];88  } else {89    chromiumViews = [];90  }91  log.info('Getting window handles from Selendroid');92  let selendroidViews = await this.selendroid.jwproxy.command('/window_handles', 'GET', {});93  this.contexts = _.union(selendroidViews, chromiumViews);94  log.info(`Available contexts: ${JSON.stringify(this.contexts)}`);...

...14};15// uiautomator2 doesn't support metastate for keyevents16commands.keyevent = async function (keycode, metastate) {17  log.debug(`Ignoring metastate ${metastate}`);18  await this.adb.keyevent(keycode);19};20// Use ADB since we don't have UiAutomator21commands.back = async function () {22  await this.adb.keyevent(4);23};24commands.getStrings = async function (language) {25  if (!language) {26    language = await this.adb.getDeviceLanguage();27    log.info(`No language specified, returning strings for: ${language}`);28  }29  if (this.apkStrings[language]) {30    // Return cached strings31    return this.apkStrings[language];32  }33  // TODO: This is mutating the current language, but it's how appium currently works34  this.apkStrings[language] = await androidHelpers.pushStrings(language, this.adb, this.opts);35  await this.uiautomator2.jwproxy.command(`/appium/app/strings`, 'POST', {});36  return this.apkStrings[language];...