appium-test-support

A collection of test utility lib used across Appium packages.

Install

npm install appium-test-support --save-dev

Api

stubEnv

1import { stubEnv } from 'appium-test-support';
2
3describe('myTest', () => {
4  stubEnv();
5  it('setting env variable', () => {
6    // Changes to process.env will stay local
7    process.env.ABC = 'abc';
8  });
9});

stubLog

1import { stubLog } from 'appium-test-support';
2
3describe('myTest', () => {
4  let sandbox;
5  // configure sandbox here...
6
7  it('stubbing log', () => {
8    let logStub = stubLog(sandbox, log);
9    log.info('Hello World!');
10    log.warn(`The ${'sun'.yellow} is shining!`);
11    logStub.output.should.equals([
12      'info: Hello World!',
13      `warn: The ${'sun'.yellow} is shining!`
14    ].join('\n'));
15  });
16  it('stubbing log stripping colors', () => {
17    let logStub = stubLog(sandbox, log, {stripColors: true});
18    log.info('Hello World!');
19    log.warn(`The ${'sun'.yellow} is shining!`);
20    logStub.output.should.equals([
21      'info: Hello World!',
22      'warn: The sun is shining!'
23    ].join('\n'));
24  });
25});

withSandbox

Use when mixing up sinon apis (mocks, spies stubs).

1import { withSandbox } from 'appium-test-support';
2
3let api = {
4  abc: () => { return 'abc'; }
5};
6
7describe('MyTest', withSandbox({mocks: {api}}, (S) => {
8  it('stubbing api, stubbing dog', () => {
9    S.mocks.api.expects('abc').once().returns('efg');
10    let dog = { bark: () => { return 'ouaf!'; } };
11    S.sandbox.stub(dog, 'bark').returns('miaou');
12    api.abc().should.equal('efg');
13    dog.bark().should.equal('miaou');
14    S.verify();
15  });
16}));

withMocks

When using mainly stubs.

1import { withMocks } from 'appium-test-support';
2
3let api = {
4  abc: () => { return 'abc'; }
5};
6
7describe('withMocks', withMocks({api}, (mocks) => {
8  it('should mock api', () => {
9    mocks.api.expects('abc').once().returns('efg');
10    api.abc().should.equal('efg');
11    mocks.verify();
12  });
13}));

fakeTime

1import { fakeTime } from 'appium-test-support';
2
3function doSomething() {
4  return new B.Promise((resolve) => {
5    let ret = '';
6    function appendOneByOne () {
7      if(ret.length >= 10) {
8        return resolve(ret);
9      }
10      setTimeout(() => {
11        ret = ret + ret.length;
12        appendOneByOne();
13      }, 1000);
14    }
15    appendOneByOne();
16  });
17}
18
19describe('fakeTime', () => {
20  let sandbox;
21  // create sandbox ...
22
23  it('should fake time', async () => {
24    let timeLord = fakeTime(sandbox);
25    let p = doSomething();
26    timeLord.speedup(200, 60); // interval=200, times=60
27    (await p).should.equals('0123456789');
28  });
29});

Travis Android Emu Setup

On Travis, setting up an emulator takes a lot of boilerplate. While the configuration needs to be done on a case-by-case basis, the actual startup can be scripted. Toward that, there are two scripts:

• android-emu-travis-pre - creates a device (configured with the environment variables ANDROID_EMU_NAME, ANDROID_EMU_TARGET, and ANDROID_EMU_ABI) and starts it in the background
• android-emu-travis-post - waits for the device to be booted, and then goes to its home screen

Watch

npm run watch

Test

npm test