driver-specs.js

import sinon from 'sinon';
import * as iosDriver from 'appium-ios-driver';
import { JWProxy } from 'appium-base-driver';
import XCUITestDriver from '../..';
import xcode from 'appium-xcode';
import _ from 'lodash';
import chai from 'chai';
import * as utils from '../../lib/utils';
import { MOCHA_LONG_TIMEOUT } from './helpers';


chai.should();
const expect = chai.expect;

const caps = {
  platformName: 'iOS',
  deviceName: 'iPhone 6',
  app: '/foo.app',
  platformVersion: '10.0',
};


describe('driver commands', function () {
  describe('status', function () {
    let driver;
    let jwproxyCommandSpy;

    beforeEach(function () {
      driver = new XCUITestDriver();

      // fake the proxy to WDA
      const jwproxy = new JWProxy();
      jwproxyCommandSpy = sinon.stub(jwproxy, 'command').callsFake(async function () { // eslint-disable-line require-await
        return {some: 'thing'};
      });
      driver.wda = {
        jwproxy,
      };
    });

    afterEach(function () {
      jwproxyCommandSpy.reset();
    });

    it('should not have wda status by default', async function () {
      const status = await driver.getStatus();
      jwproxyCommandSpy.calledOnce.should.be.false;
      expect(status.wda).to.be.undefined;
    });

    it('should return wda status if cached', async function () {
      driver.cachedWdaStatus = {};
      const status = await driver.getStatus();
      jwproxyCommandSpy.called.should.be.false;
      status.wda.should.exist;
    });
  });

  describe('createSession', function () {
    let driver;
    let sandbox;

    beforeEach(function () {
      driver = new XCUITestDriver();
      sandbox = sinon.createSandbox();
      sandbox.stub(driver, 'determineDevice').callsFake(async function () { // eslint-disable-line require-await
        return {
          device: {
            shutdown: _.noop,
            isRunning () {
              return true;
            },
            stat () {
              return {state: 'Booted'};
            },
            clearCaches: _.noop,
            getWebInspectorSocket () {
              return '/path/to/uds.socket';
            },
          },
          udid: null,
          realDevice: null
        };
      });
      sandbox.stub(driver, 'configureApp').callsFake(_.noop);
      sandbox.stub(driver, 'startLogCapture').callsFake(_.noop);
      sandbox.stub(driver, 'startSim').callsFake(_.noop);
      sandbox.stub(driver, 'startWdaSession').callsFake(_.noop);
      sandbox.stub(driver, 'startWda').callsFake(_.noop);
      sandbox.stub(driver, 'setReduceMotion').callsFake(_.noop);
      sandbox.stub(driver, 'installAUT').callsFake(_.noop);
      sandbox.stub(driver, 'connectToRemoteDebugger').callsFake(_.noop);
      sandbox.stub(iosDriver.settings, 'setLocale').callsFake(_.noop);
      sandbox.stub(iosDriver.settings, 'setPreferences').callsFake(_.noop);
      sandbox.stub(xcode, 'getMaxIOSSDK').callsFake(async () => '10.0'); // eslint-disable-line require-await
      sandbox.stub(utils, 'checkAppPresent').callsFake(_.noop);
      sandbox.stub(iosDriver.appUtils, 'extractBundleId').callsFake(_.noop);
    });

    afterEach(function () {
      sandbox.restore();
    });

    it('should include server capabilities', async function () {
      this.timeout(MOCHA_LONG_TIMEOUT);
      const resCaps = await driver.createSession(caps);
      resCaps[1].javascriptEnabled.should.be.true;
    });

    it('should call startLogCapture', async function () {
      const c = { ... caps };
      Object.assign(c, {skipLogCapture: false});
      this.timeout(MOCHA_LONG_TIMEOUT);
      const resCaps = await driver.createSession(c);
      resCaps[1].javascriptEnabled.should.be.true;
      driver.startLogCapture.called.should.be.true;
    });
    it('should not call startLogCapture', async function () {
      const c = { ... caps };
      Object.assign(c, {skipLogCapture: true});
      this.timeout(MOCHA_LONG_TIMEOUT);
      const resCaps = await driver.createSession(c);
      resCaps[1].javascriptEnabled.should.be.true;
      driver.startLogCapture.called.should.be.false;
    });
  });
});

describe('installOtherApps', function () {
  let driver = new XCUITestDriver();
  let sandbox;

  beforeEach(function () {
    sandbox = sinon.createSandbox();
  });

  afterEach(function () {
    sandbox.restore();
  });

  it('should skip install other apps on real devices', async function () {
    sandbox.stub(driver, 'isRealDevice');
    sandbox.stub(driver.helpers, 'parseCapsArray');
    driver.isRealDevice.returns(true);
    await driver.installOtherApps('/path/to/iosApp.app');
    driver.isRealDevice.calledOnce.should.be.true;
    driver.helpers.parseCapsArray.notCalled.should.be.true;
  });

  it('should install multiple apps from otherApps as string on simulators', async function () {
    const SimulatorManagementModule = require('../../lib/simulator-management');
    sandbox.stub(SimulatorManagementModule, 'installToSimulator');
    sandbox.stub(driver, 'isRealDevice');
    driver.isRealDevice.returns(false);
    driver.opts.noReset = false;
    driver.opts.device = 'some-device';
    driver.lifecycleData = {createSim: false};
    await driver.installOtherApps('/path/to/iosApp.app');
    driver.isRealDevice.calledOnce.should.be.true;
    SimulatorManagementModule.installToSimulator.calledOnce.should.be.true;
    SimulatorManagementModule.installToSimulator.calledWith(
      'some-device',
      '/path/to/iosApp.app',
      undefined, {noReset: false, newSimulator: false}
    ).should.be.true;
  });

  it('should install multiple apps from otherApps as JSON array on simulators', async function () {
    const SimulatorManagementModule = require('../../lib/simulator-management');
    sandbox.stub(SimulatorManagementModule, 'installToSimulator');
    sandbox.stub(driver, 'isRealDevice');
    driver.isRealDevice.returns(false);
    driver.opts.noReset = false;
    driver.opts.device = 'some-device';
    driver.lifecycleData = {createSim: false};
    await driver.installOtherApps('["/path/to/iosApp1.app","/path/to/iosApp2.app"]');
    driver.isRealDevice.calledOnce.should.be.true;
    SimulatorManagementModule.installToSimulator.calledWith(
      'some-device',
      '/path/to/iosApp1.app',
      undefined, {noReset: false, newSimulator: false}
    ).should.be.true;
    SimulatorManagementModule.installToSimulator.calledWith(
      'some-device',
      '/path/to/iosApp2.app',
      undefined, {noReset: false, newSimulator: false}
    ).should.be.true;
  });
});