How to use driver.doFindElementOrEls 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 AndroidDriver from '../../..';
6import { errors } from 'appium-base-driver';
7
8
9let driver;
10let sandbox = sinon.createSandbox();
11chai.should();
12chai.use(chaiAsPromised);
13
14describe('Find', function () {
15  beforeEach(function () {
16    driver = new AndroidDriver();
17    driver.bootstrap = new Bootstrap();
18    driver.implicitWaitMs = 0;
19    sandbox.stub(driver, 'validateLocatorStrategy');
20    sandbox.stub(driver.bootstrap, 'sendAction');
21    sandbox.stub(driver, 'doFindElementOrEls');
22  });
23  afterEach(function () {
24    sandbox.restore();
25  });
26  describe('doFindElementOrEls', function () {
27    it('should send find action to bootstrap', async function () {
28      driver.doFindElementOrEls.restore();
29      await driver.doFindElementOrEls('params');
30      driver.bootstrap.sendAction.calledWithExactly('find', 'params').should.be.true;
31    });
32  });
33  describe('findElorEls', function () {
34    it('should throw an error if there is no selector', async function () {
35      await driver.findElOrEls('xpath', null, false, 'some context')
36        .should.be.rejectedWith(/provide a selector/);
37    });
38    it('should be able to find element', async function () {
39      let params = {strategy: 'xpath', selector: '//*[1]', context: 'context', multiple: false};
40      driver.doFindElementOrEls.returns('el1');
41      await driver.findElOrEls('xpath', '//*[1]', false, 'context').should.become('el1');
42      driver.doFindElementOrEls.calledWithExactly(params).should.be.true;
43    });
44    it('should be able to find elements', async function () {
45      let params = {strategy: 'xpath', selector: '//*[1]', context: 'context', multiple: true};
46      driver.doFindElementOrEls.returns(['el1', 'el2']);
47      await driver.findElOrEls('xpath', '//*[1]', true, 'context')
48        .should.eventually.be.deep.equal(['el1', 'el2']);
49      driver.doFindElementOrEls.calledWithExactly(params).should.be.true;
50    });
51    it('should not throws NoSuchElementError when searching multiple if element does not exist', async function () {
52      driver.doFindElementOrEls.returns(null);
53      await driver.findElOrEls('xpaht', '//*[1]', true)
54        .should.eventually.be.deep.equal([]);
55    });
56    it('should throw NoSuchElementError if element does not exist', async function () {
57      driver.doFindElementOrEls.throws(new errors.NoSuchElementError());
58      await driver.findElOrEls('xpath', '//*[1]', false)
59        .should.be.rejectedWith(errors.NoSuchElementError);
60    });
61    it('should fails if locator strategy is not valid', async function () {
62      driver.validateLocatorStrategy.throws();
63      await driver.findElOrEls().should.be.rejected;
64    });
65    it('should fails if gets unexpected error', async function () {
66      driver.doFindElementOrEls.throws(new Error('unexpected_error'));
67      await driver.findElOrEls('x', 'loc').should.be.rejectedWith('unexpected_error');
68    });
69  });
70});
71

Source: find-specs.js

import chai from 'chai';
import chaiAsPromised from 'chai-as-promised';
import sinon from 'sinon';
import Bootstrap from '../../../lib/bootstrap';
import AndroidDriver from '../../..';
import { errors } from 'appium-base-driver';


let driver;
let sandbox = sinon.createSandbox();
chai.should();
chai.use(chaiAsPromised);

describe('Find', function () {
  beforeEach(function () {
    driver = new AndroidDriver();
    driver.bootstrap = new Bootstrap();
    driver.implicitWaitMs = 0;
    sandbox.stub(driver, 'validateLocatorStrategy');
    sandbox.stub(driver.bootstrap, 'sendAction');
    sandbox.stub(driver, 'doFindElementOrEls');
  });
  afterEach(function () {
    sandbox.restore();
  });
  describe('doFindElementOrEls', function () {
    it('should send find action to bootstrap', async function () {
      driver.doFindElementOrEls.restore();
      await driver.doFindElementOrEls('params');
      driver.bootstrap.sendAction.calledWithExactly('find', 'params').should.be.true;
    });
  });
  describe('findElorEls', function () {
    it('should throw an error if there is no selector', async function () {
      await driver.findElOrEls('xpath', null, false, 'some context')
        .should.be.rejectedWith(/provide a selector/);
    });
    it('should be able to find element', async function () {
      let params = {strategy: 'xpath', selector: '//*[1]', context: 'context', multiple: false};
      driver.doFindElementOrEls.returns('el1');
      await driver.findElOrEls('xpath', '//*[1]', false, 'context').should.become('el1');
      driver.doFindElementOrEls.calledWithExactly(params).should.be.true;
    });
    it('should be able to find elements', async function () {
      let params = {strategy: 'xpath', selector: '//*[1]', context: 'context', multiple: true};
      driver.doFindElementOrEls.returns(['el1', 'el2']);
      await driver.findElOrEls('xpath', '//*[1]', true, 'context')
        .should.eventually.be.deep.equal(['el1', 'el2']);
      driver.doFindElementOrEls.calledWithExactly(params).should.be.true;
    });
    it('should not throws NoSuchElementError when searching multiple if element does not exist', async function () {
      driver.doFindElementOrEls.returns(null);
      await driver.findElOrEls('xpaht', '//*[1]', true)
        .should.eventually.be.deep.equal([]);
    });
    it('should throw NoSuchElementError if element does not exist', async function () {
      driver.doFindElementOrEls.throws(new errors.NoSuchElementError());
      await driver.findElOrEls('xpath', '//*[1]', false)
        .should.be.rejectedWith(errors.NoSuchElementError);
    });
    it('should fails if locator strategy is not valid', async function () {
      driver.validateLocatorStrategy.throws();
      await driver.findElOrEls().should.be.rejected;
    });
    it('should fails if gets unexpected error', async function () {
      driver.doFindElementOrEls.throws(new Error('unexpected_error'));
      await driver.findElOrEls('x', 'loc').should.be.rejectedWith('unexpected_error');
    });
  });
});