How to use driver.adb.isScreenLocked method in Appium Android Driver

1import chai from 'chai';2import chaiAsPromised from 'chai-as-promised';3import sinon from 'sinon';4import Bootstrap from '../../../lib/bootstrap';5import path from 'path';6import AndroidDriver from '../../..';7import * as support from 'appium-support';8import ADB from 'appium-adb';9import jimp from 'jimp';10import helpers from '../../../lib/commands/actions';11import * as teen_process from 'teen_process';12let driver;13let sandbox = sinon.createSandbox();14chai.should();15chai.use(chaiAsPromised);16describe('Actions', function () {17  beforeEach(function () {18    driver = new AndroidDriver();19    driver.adb = new ADB();20    driver.bootstrap = new Bootstrap();21    sandbox.stub(driver.bootstrap, 'sendAction');22  });23  afterEach(function () {24    sandbox.restore();25  });26  describe('keyevent', function () {27    it('shoudle be able to execute keyevent via pressKeyCode', async function () {28      sandbox.stub(driver, 'pressKeyCode');29      await driver.keyevent('66', 'meta');30      driver.pressKeyCode.calledWithExactly('66', 'meta').should.be.true;31    });32    it('should set metastate to null by default', async function () {33      sandbox.stub(driver, 'pressKeyCode');34      await driver.keyevent('66');35      driver.pressKeyCode.calledWithExactly('66', null).should.be.true;36    });37  });38  describe('pressKeyCode', function () {39    it('shoudle be able to press key code', async function () {40      await driver.pressKeyCode('66', 'meta');41      driver.bootstrap.sendAction42        .calledWithExactly('pressKeyCode', {keycode: '66', metastate: 'meta'})43        .should.be.true;44    });45    it('should set metastate to null by default', async function () {46      await driver.pressKeyCode('66');47      driver.bootstrap.sendAction48        .calledWithExactly('pressKeyCode', {keycode: '66', metastate: null})49        .should.be.true;50    });51  });52  describe('longPressKeyCode', function () {53    it('shoudle be able to press key code', async function () {54      await driver.longPressKeyCode('66', 'meta');55      driver.bootstrap.sendAction56        .calledWithExactly('longPressKeyCode', {keycode: '66', metastate: 'meta'})57        .should.be.true;58    });59    it('should set metastate to null by default', async function () {60      await driver.longPressKeyCode('66');61      driver.bootstrap.sendAction62        .calledWithExactly('longPressKeyCode', {keycode: '66', metastate: null})63        .should.be.true;64    });65  });66  describe('getOrientation', function () {67    it('shoudle be able to get orientation', async function () {68      driver.bootstrap.sendAction.withArgs('orientation', {naturalOrientation: false})69        .returns('landscape');70      await driver.getOrientation().should.become('LANDSCAPE');71      driver.bootstrap.sendAction72        .calledWithExactly('orientation', {naturalOrientation: false})73        .should.be.true;74    });75  });76  describe('setOrientation', function () {77    it('shoudle be able to set orientation', async function () {78      let opts = {orientation: 'SOMESCAPE', naturalOrientation: false};79      await driver.setOrientation('somescape');80      driver.bootstrap.sendAction.calledWithExactly('orientation', opts)81        .should.be.true;82    });83  });84  describe('fakeFlick', function () {85    it('shoudle be able to do fake flick', async function () {86      await driver.fakeFlick(12, 34);87      driver.bootstrap.sendAction88        .calledWithExactly('flick', {xSpeed: 12, ySpeed: 34}).should.be.true;89    });90  });91  describe('fakeFlickElement', function () {92    it('shoudle be able to do fake flick on element', async function () {93      await driver.fakeFlickElement(5000, 56, 78, 1.32);94      driver.bootstrap.sendAction95        .calledWithExactly('element:flick',96          {xoffset: 56, yoffset: 78, speed: 1.32, elementId: 5000})97        .should.be.true;98    });99  });100  describe('swipe', function () {101    it('should swipe an element', function () {102      let swipeOpts = {startX: 10, startY: 11, endX: 20, endY: 22,103                       steps: 3, elementId: 'someElementId'};104      driver.swipe(10, 11, 20, 22, 0.1, null, 'someElementId');105      driver.bootstrap.sendAction.calledWithExactly('element:swipe', swipeOpts)106        .should.be.true;107    });108    it('should swipe without an element', function () {109      driver.swipe(0, 0, 1, 1, 0, 1);110      driver.bootstrap.sendAction.calledWith('swipe').should.be.true;111    });112    it('should set start point to (0.5;0.5) if startX and startY are "null"', function () {113      let swipeOpts = {startX: 0.5, startY: 0.5, endX: 0, endY: 0, steps: 0};114      sandbox.stub(driver, 'doSwipe');115      driver.swipe('null', 'null', 0, 0, 0);116      driver.doSwipe.calledWithExactly(swipeOpts).should.be.true;117    });118  });119  describe('pinchClose', function () {120    it('should be able to pinch in element', async function () {121      let pinchOpts = {direction: 'in', elementId: 'el01', percent: 0.5, steps: 5};122      await driver.pinchClose(null, null, null, null, null, 0.5, 5, 'el01');123      driver.bootstrap.sendAction.calledWithExactly('element:pinch', pinchOpts)124        .should.be.true;125    });126  });127  describe('pinchOpen', function () {128    it('should be able to pinch out element', async function () {129      let pinchOpts = {direction: 'out', elementId: 'el01', percent: 0.5, steps: 5};130      await driver.pinchOpen(null, null, null, null, null, 0.5, 5, 'el01');131      driver.bootstrap.sendAction.calledWithExactly('element:pinch', pinchOpts)132        .should.be.true;133    });134  });135  describe('flick', function () {136    it('should call fakeFlickElement if element is passed', async function () {137      sandbox.stub(driver, 'fakeFlickElement');138      await driver.flick('elem', null, null, 1, 2, 3);139      driver.fakeFlickElement.calledWith('elem', 1, 2, 3).should.be.true;140    });141    it('should call fakeFlick if element is not passed', async function () {142      sandbox.stub(driver, 'fakeFlick');143      await driver.flick(null, 1, 2);144      driver.fakeFlick.calledWith(1, 2).should.be.true;145    });146  });147  describe('drag', function () {148    let dragOpts = {149      elementId: 'elem1', destElId: 'elem2',150      startX: 1, startY: 2, endX: 3, endY: 4, steps: 1151    };152    it('should drag an element', function () {153      driver.drag(1, 2, 3, 4, 0.02, null, 'elem1', 'elem2');154      driver.bootstrap.sendAction.calledWithExactly('element:drag', dragOpts)155        .should.be.true;156    });157    it('should drag without an element', function () {158      dragOpts.elementId = null;159      driver.drag(1, 2, 3, 4, 0.02, null, null, 'elem2');160      driver.bootstrap.sendAction.calledWithExactly('drag', dragOpts)161        .should.be.true;162    });163  });164  describe('lock', function () {165    it('should call adb.lock()', async function () {166      sandbox.stub(driver.adb, 'lock');167      await driver.lock();168      driver.adb.lock.calledOnce.should.be.true;169    });170  });171  describe('isLocked', function () {172    it('should call adb.isScreenLocked()', async function () {173      sandbox.stub(driver.adb, 'isScreenLocked').returns('lock_status');174      await driver.isLocked().should.become('lock_status');175      driver.adb.isScreenLocked.calledOnce.should.be.true;176    });177  });178  describe('openNotifications', function () {179    it('should be able to open notifications', async function () {180      await driver.openNotifications();181      driver.bootstrap.sendAction.calledWithExactly('openNotification')182        .should.be.true;183    });184  });185  describe('setLocation', function () {186    it('should be able to set location', async function () {187      sandbox.stub(driver.adb, 'sendTelnetCommand');188      await driver.setLocation('lat', 'long');189      driver.adb.sendTelnetCommand.calledWithExactly('geo fix long lat')190        .should.be.true;191    });192  });193  describe('fingerprint', function () {194    it('should call fingerprint adb command for emulator', async function () {195      sandbox.stub(driver.adb, 'fingerprint');196      sandbox.stub(driver, 'isEmulator').returns(true);197      await driver.fingerprint(1111);198      driver.adb.fingerprint.calledWithExactly(1111).should.be.true;199    });200    it('should throw exception for real device', async function () {201      sandbox.stub(driver.adb, 'fingerprint');202      sandbox.stub(driver, 'isEmulator').returns(false);203      await driver.fingerprint(1111).should.be204        .rejectedWith('fingerprint method is only available for emulators');205      driver.adb.fingerprint.notCalled.should.be.true;206    });207  });208  describe('sendSMS', function () {209    it('should call sendSMS adb command for emulator', async function () {210      sandbox.stub(driver.adb, 'sendSMS');211      sandbox.stub(driver, 'isEmulator').returns(true);212      await driver.sendSMS(4509, 'Hello Appium');213      driver.adb.sendSMS.calledWithExactly(4509, 'Hello Appium')214        .should.be.true;215    });216    it('should throw exception for real device', async function () {217      sandbox.stub(driver.adb, 'sendSMS');218      sandbox.stub(driver, 'isEmulator').returns(false);219      await driver.sendSMS(4509, 'Hello Appium')220        .should.be.rejectedWith('sendSMS method is only available for emulators');221      driver.adb.sendSMS.notCalled.should.be.true;222    });223  });224  describe('sensorSet', function () {225    it('should call sensor adb command for emulator', async function () {226      sandbox.stub(driver.adb, 'sensorSet');227      sandbox.stub(driver, 'isEmulator').returns(true);228      await driver.sensorSet({sensorType: 'light', value: 0});229      driver.adb.sensorSet.calledWithExactly('light', 0)230        .should.be.true;231    });232    it('should throw exception for real device', async function () {233      sandbox.stub(driver.adb, 'sensorSet');234      sandbox.stub(driver, 'isEmulator').returns(false);235      await driver.sensorSet({sensorType: 'light', value: 0})236        .should.be.rejectedWith('sensorSet method is only available for emulators');237      driver.adb.sensorSet.notCalled.should.be.true;238    });239  });240  describe('gsmCall', function () {241    it('should call gsmCall adb command for emulator', async function () {242      sandbox.stub(driver.adb, 'gsmCall');243      sandbox.stub(driver, 'isEmulator').returns(true);244      await driver.gsmCall(4509, 'call');245      driver.adb.gsmCall.calledWithExactly(4509, 'call').should.be.true;246    });247    it('should throw exception for real device', async function () {248      sandbox.stub(driver.adb, 'gsmCall');249      sandbox.stub(driver, 'isEmulator').returns(false);250      await driver.gsmCall(4509, 'call')251        .should.be.rejectedWith('gsmCall method is only available for emulators');252      driver.adb.gsmCall.notCalled.should.be.true;253    });254  });255  describe('gsmSignal', function () {256    it('should call gsmSignal adb command for emulator', async function () {257      sandbox.stub(driver.adb, 'gsmSignal');258      sandbox.stub(driver, 'isEmulator').returns(true);259      await driver.gsmSignal(3);260      driver.adb.gsmSignal.calledWithExactly(3)261        .should.be.true;262    });263    it('should throw exception for real device', async function () {264      sandbox.stub(driver.adb, 'gsmSignal');265      sandbox.stub(driver, 'isEmulator').returns(false);266      await driver.gsmSignal(3)267        .should.be.rejectedWith('gsmSignal method is only available for emulators');268      driver.adb.gsmSignal.notCalled.should.be.true;269    });270  });271  describe('gsmVoice', function () {272    it('should call gsmVoice adb command for emulator', async function () {273      sandbox.stub(driver.adb, 'gsmVoice');274      sandbox.stub(driver, 'isEmulator').returns(true);275      await driver.gsmVoice('roaming');276      driver.adb.gsmVoice.calledWithExactly('roaming')277        .should.be.true;278    });279    it('should throw exception for real device', async function () {280      sandbox.stub(driver.adb, 'gsmVoice');281      sandbox.stub(driver, 'isEmulator').returns(false);282      await driver.gsmVoice('roaming')283        .should.be.rejectedWith('gsmVoice method is only available for emulators');284      driver.adb.gsmVoice.notCalled.should.be.true;285    });286  });287  describe('powerAC', function () {288    it('should call powerAC adb command for emulator', async function () {289      sandbox.stub(driver.adb, 'powerAC');290      sandbox.stub(driver, 'isEmulator').returns(true);291      await driver.powerAC('off');292      driver.adb.powerAC.calledWithExactly('off')293        .should.be.true;294    });295    it('should throw exception for real device', async function () {296      sandbox.stub(driver.adb, 'powerAC');297      sandbox.stub(driver, 'isEmulator').returns(false);298      await driver.powerAC('roaming')299        .should.be.rejectedWith('powerAC method is only available for emulators');300      driver.adb.powerAC.notCalled.should.be.true;301    });302  });303  describe('powerCapacity', function () {304    it('should call powerCapacity adb command for emulator', async function () {305      sandbox.stub(driver.adb, 'powerCapacity');306      sandbox.stub(driver, 'isEmulator').returns(true);307      await driver.powerCapacity(5);308      driver.adb.powerCapacity.calledWithExactly(5)309        .should.be.true;310    });311    it('should throw exception for real device', async function () {312      sandbox.stub(driver.adb, 'powerCapacity');313      sandbox.stub(driver, 'isEmulator').returns(false);314      await driver.powerCapacity(5)315        .should.be.rejectedWith('powerCapacity method is only available for emulators');316      driver.adb.powerCapacity.notCalled.should.be.true;317    });318  });319  describe('networkSpeed', function () {320    it('should call networkSpeed adb command for emulator', async function () {321      sandbox.stub(driver.adb, 'networkSpeed');322      sandbox.stub(driver, 'isEmulator').returns(true);323      await driver.networkSpeed('gsm');324      driver.adb.networkSpeed.calledWithExactly('gsm')325        .should.be.true;326    });327    it('should throw exception for real device', async function () {328      sandbox.stub(driver.adb, 'networkSpeed');329      sandbox.stub(driver, 'isEmulator').returns(false);330      await driver.networkSpeed('gsm')331        .should.be.rejectedWith('networkSpeed method is only available for emulators');332      driver.adb.networkSpeed.notCalled.should.be.true;333    });334  });335  describe('getScreenshotDataWithAdbShell', function () {336    const defaultDir = '/data/local/tmp/';337    const png = '/path/sc.png';338    const localFile = 'local_file';339    beforeEach(function () {340      sandbox.stub(support.tempDir, 'path');341      sandbox.stub(support.fs, 'exists');342      sandbox.stub(support.fs, 'unlink');343      sandbox.stub(driver.adb, 'shell');344      sandbox.stub(driver.adb, 'pull');345      sandbox.stub(path.posix, 'resolve');346      sandbox.stub(jimp, 'read');347      sandbox.stub(driver.adb, 'fileSize');348      support.tempDir.path.returns(localFile);349      support.fs.exists.withArgs(localFile).returns(true);350      support.fs.unlink.withArgs(localFile).returns(true);351      path.posix.resolve.withArgs(defaultDir, 'screenshot.png').returns(png);352      driver.adb.fileSize.withArgs(png).returns(1);353      jimp.read.withArgs(localFile).returns('screenshoot_context');354    });355    it('should be able to get screenshot via adb shell', async function () {356      await helpers.getScreenshotDataWithAdbShell(driver.adb, {})357        .should.become('screenshoot_context');358      driver.adb.shell.calledWithExactly(['/system/bin/rm', `${png};`359        , '/system/bin/screencap', '-p', png]).should.be.true;360      driver.adb.pull.calledWithExactly(png, localFile).should.be.true;361      jimp.read.calledWithExactly(localFile).should.be.true;362      support.fs.exists.calledTwice.should.be.true;363      support.fs.unlink.calledTwice.should.be.true;364    });365    it('should be possible to change default png dir', async function () {366      path.posix.resolve.withArgs('/custom/path/tmp/', 'screenshot.png').returns(png);367      await helpers.getScreenshotDataWithAdbShell(driver.adb368        , {androidScreenshotPath: '/custom/path/tmp/'})369        .should.become('screenshoot_context');370    });371    it('should throw error if size of the screenshot is zero', async function () {372      driver.adb.fileSize.withArgs(png).returns(0);373      await helpers.getScreenshotDataWithAdbShell(driver.adb, {})374        .should.be.rejectedWith('equals to zero');375    });376  });377  describe('getScreenshotDataWithAdbExecOut', function () {378    it('should be able to take screenshot via exec-out', async function () {379      sandbox.stub(teen_process, 'exec');380      sandbox.stub(jimp, 'read');381      teen_process.exec.returns({stdout: 'stdout', stderr: ''});382      driver.adb.executable.path = 'path/to/adb';383      await helpers.getScreenshotDataWithAdbExecOut(driver.adb);384      teen_process.exec.calledWithExactly(driver.adb.executable.path,385        driver.adb.executable.defaultArgs386          .concat(['exec-out', '/system/bin/screencap', '-p']),387        {encoding: 'binary', isBuffer: true}).should.be.true;388      jimp.read.calledWithExactly('stdout').should.be.true;389    });390    it('should throw error if size of the screenshot is zero', async function () {391      sandbox.stub(teen_process, 'exec');392      teen_process.exec.returns({stdout: '', stderr: ''});393      await helpers.getScreenshotDataWithAdbExecOut(driver.adb)394        .should.be.rejectedWith('Screenshot returned no data');395    });396    it('should throw error if code is not 0', async function () {397      sandbox.stub(teen_process, 'exec');398      teen_process.exec.returns({code: 1, stdout: '', stderr: ''});399      await helpers.getScreenshotDataWithAdbExecOut(driver.adb)400        .should.be.rejectedWith(`Screenshot returned error, code: '1', stderr: ''`);401    });402    it('should throw error if stderr is not empty', async function () {403      sandbox.stub(teen_process, 'exec');404      teen_process.exec.returns({code: 0, stdout: '', stderr: 'Oops'});405      await helpers.getScreenshotDataWithAdbExecOut(driver.adb)406        .should.be.rejectedWith(`Screenshot returned error, code: '0', stderr: 'Oops'`);407    });408  });409  describe('getScreenshot', function () {410    let image;411    beforeEach(function () {412      image = new jimp(1, 1);413      sandbox.stub(driver.adb, 'getApiLevel');414      sandbox.stub(driver.adb, 'getScreenOrientation');415      sandbox.stub(driver, 'getScreenshotDataWithAdbExecOut');416      sandbox.stub(driver, 'getScreenshotDataWithAdbShell');417      sandbox.stub(image, 'getBuffer').callsFake(function (mime, cb) { // eslint-disable-line promise/prefer-await-to-callbacks418        return cb.call(this, null, Buffer.from('appium'));419      });420      sandbox.stub(image, 'rotate');421      driver.adb.getScreenOrientation.returns(2);422      image.rotate.withArgs(-180).returns(image);423    });424    it('should be able to take screenshot via exec-out (API level > 20)', async function () {425      driver.adb.getApiLevel.returns(24);426      driver.getScreenshotDataWithAdbExecOut.withArgs(driver.adb).returns(image);427      await driver.getScreenshot().should.become('YXBwaXVt');428      driver.getScreenshotDataWithAdbExecOut.calledOnce.should.be.true;429      driver.getScreenshotDataWithAdbShell.notCalled.should.be.true;430      image.getBuffer.calledWith(jimp.MIME_PNG).should.be.true;431    });432    it('should be able to take screenshot via adb shell (API level <= 20)', async function () {433      driver.adb.getApiLevel.returns(20);434      driver.getScreenshotDataWithAdbShell.withArgs(driver.adb, driver.opts).returns(image);435      await driver.getScreenshot().should.become('YXBwaXVt');436      driver.getScreenshotDataWithAdbShell.calledOnce.should.be.true;437      driver.getScreenshotDataWithAdbExecOut.notCalled.should.be.true;438      image.getBuffer.calledWith(jimp.MIME_PNG).should.be.true;439    });440    it('should tries to take screenshot via adb shell if exec-out failed (API level > 20)', async function () {441      driver.adb.getApiLevel.returns(24);442      driver.getScreenshotDataWithAdbExecOut.throws();443      driver.getScreenshotDataWithAdbShell.withArgs(driver.adb, driver.opts).returns(image);444      await driver.getScreenshot().should.become('YXBwaXVt');445      driver.getScreenshotDataWithAdbShell.calledOnce.should.be.true;446      driver.getScreenshotDataWithAdbShell.calledOnce.should.be.true;447    });448    it('should throw error if adb shell failed', async function () {449      driver.adb.getApiLevel.returns(20);450      driver.getScreenshotDataWithAdbShell.throws();451      await driver.getScreenshot().should.be.rejectedWith('Cannot get screenshot');452    });453    it('should rotate image if API level < 23', async function () {454      driver.adb.getApiLevel.returns(22);455      driver.getScreenshotDataWithAdbExecOut.withArgs(driver.adb).returns(image);456      await driver.getScreenshot();457      driver.adb.getScreenOrientation.calledOnce.should.be.true;458      image.rotate.calledOnce.should.be.true;459    });460    it('should not rotate image if API level >= 23', async function () {461      driver.adb.getApiLevel.returns(23);462      driver.getScreenshotDataWithAdbExecOut.withArgs(driver.adb).returns(image);463      await driver.getScreenshot();464      driver.adb.getScreenOrientation.notCalled.should.be.true;465      image.rotate.notCalled.should.be.true;466    });467    it('should not throws error if rotate image failed', async function () {468      image.rotate.resetBehavior();469      image.rotate.throws();470      driver.adb.getApiLevel.returns(22);471      driver.getScreenshotDataWithAdbExecOut.withArgs(driver.adb).returns(image);472      await driver.getScreenshot().should.be.fulfilled;473      image.rotate.threw().should.be.true;474    });475  });...

...26    });27    it('should unlock an Android 19 device using a PIN', async function () {28      let caps = _.extend(defaultCaps, {unlockType: 'pin', unlockKey: '1111', avd: AVD_ANDROID_19_PIN_UNLOCK});29      await driver.createSession(caps);30      let isLock = await driver.adb.isScreenLocked();31      isLock.should.equal(false);32    });33    it('should unlock an Android 23 device using a PIN', async function () {34      let caps = _.extend(defaultCaps, {unlockType: 'pin', unlockKey: '1111', avd: AVD_ANDROID_23_PIN_UNLOCK});35      await driver.createSession(caps);36      let isLock = await driver.adb.isScreenLocked();37      isLock.should.equal(false);38    });39    it('should unlock an Android 19 device using a PASSWORD', async function () {40      let caps = _.extend(defaultCaps, {unlockType: 'password', unlockKey: 'appium', avd: AVD_ANDROID_19_PASSWORD_UNLOCK});41      await driver.createSession(caps);42      let isLock = await driver.adb.isScreenLocked();43      isLock.should.equal(false);44    });45    it('should unlock an Android 23 device using a PASSWORD', async function () {46      let caps = _.extend(defaultCaps, {unlockType: 'password', unlockKey: 'appium', avd: AVD_ANDROID_23_PASSWORD_UNLOCK});47      await driver.createSession(caps);48      let isLock = await driver.adb.isScreenLocked();49      isLock.should.equal(false);50    });51    it('should unlock an Android 19 device using a PATTERN', async function () {52      let caps = _.extend(defaultCaps, {unlockType: 'pattern', unlockKey: '729856143', avd: AVD_ANDROID_19_PATTERN_UNLOCK});53      await driver.createSession(caps);54      let isLock = await driver.adb.isScreenLocked();55      isLock.should.equal(false);56    });57    it('should unlock an Android 23 device using a PATTERN', async function () {58      let caps = _.extend(defaultCaps, {unlockType: 'pattern', unlockKey: '729856143', avd: AVD_ANDROID_23_PATTERN_UNLOCK});59      await driver.createSession(caps);60      let isLock = await driver.adb.isScreenLocked();61      isLock.should.equal(false);62    });63    it('should unlock an Android 23 device using FINGERPRINT', async function () {64      let caps = _.extend(defaultCaps, {unlockType: 'pattern', unlockKey: '729856143', avd: AVD_ANDROID_23_FINGERPRINT_UNLOCK});65      await driver.createSession(caps);66      let isLock = await driver.adb.isScreenLocked();67      isLock.should.equal(false);68    });69  });...