@appium/base-driver 8.3.0 → 8.4.1

package/test/basedriver/capability-specs.js

@@ -1,383 +0,0 @@
-// @ts-check
-
-import B from 'bluebird';
-import { default as BaseDriver, errors } from '../../lib';
-import logger from '../../lib/basedriver/logger';
-import { createSandbox } from 'sinon';
-
-describe('Desired Capabilities', function () {
-  let d;
-  let sandbox;
-
-  beforeEach(function () {
-    d = new BaseDriver();
-    sandbox = createSandbox();
-    sandbox.spy(d.log, 'warn');
-    sandbox.spy(logger, 'warn');
-  });
-
-  afterEach(function () {
-    sandbox.restore();
-  });
-
-  it('should require platformName and deviceName', async function () {
-    await d.createSession({
-      firstMatch: [{}]
-    }).should.eventually.be.rejectedWith(errors.SessionNotCreatedError, /platformName/);
-  });
-
-
-  it('should require platformName', async function () {
-    await d.createSession({
-      alwaysMatch: {
-        'appium:deviceName': 'Delorean'
-      }
-    }).should.eventually.be.rejectedWith(errors.SessionNotCreatedError, /platformName/);
-  });
-
-  it('should not care about cap order', async function () {
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'appium:deviceName': 'Delorean',
-        platformName: 'iOS'
-      }
-    }).should.eventually.be.fulfilled;
-  });
-
-  it('should check required caps which are added to driver', async function () {
-    d.desiredCapConstraints = {
-      necessary: {
-        presence: true
-      },
-      proper: {
-        presence: true,
-        isString: true,
-        inclusion: ['Delorean', 'Reventon']
-      }
-    };
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformName': 'iOS',
-        'appium:deviceName': 'Delorean'
-      }
-    }).should.eventually.be.rejectedWith(errors.SessionNotCreatedError, /necessary.*proper/);
-  });
-
-  it('should check added required caps in addition to base', async function () {
-    d.desiredCapConstraints = {
-      necessary: {
-        presence: true
-      },
-      proper: {
-        presence: true,
-        isString: true,
-        inclusion: ['Delorean', 'Reventon']
-      }
-    };
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'appium:necessary': 'yup'
-      }
-    }).should.eventually.be.rejectedWith(errors.SessionNotCreatedError, /platformName/);
-  });
-
-  it('should accept extra capabilities', async function () {
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformName': 'iOS',
-        'appium:deviceName': 'Delorean',
-        'appium:extra': 'cheese',
-        'appium:hold the': 'sauce'
-      }
-    }).should.eventually.be.fulfilled;
-  });
-
-  it('should log the use of extra caps', async function () {
-    this.timeout(500);
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformName': 'iOS',
-        'appium:deviceName': 'Delorean',
-        'appium:extra': 'cheese',
-        'appium:hold the': 'sauce'
-      }
-    });
-
-    d.log.warn.should.have.been.called;
-  });
-
-  it('should be sensitive to the case of caps', async function () {
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformname': 'iOS',
-        'appium:deviceName': 'Delorean'
-      }
-    }).should.eventually.be.rejectedWith(errors.SessionNotCreatedError, /platformName/);
-  });
-
-  describe('boolean capabilities', function () {
-    it('should allow a string "false"', async function () {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          'platformName': 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:noReset': 'false'
-        }
-      });
-      d.log.warn.should.have.been.called;
-
-      let sessions = await d.getSessions();
-      sessions[0].capabilities.noReset.should.eql(false);
-    });
-
-    it('should allow a string "true"', async function () {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          'platformName': 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:noReset': 'true'
-        }
-      });
-      d.log.warn.should.have.been.called;
-
-      let sessions = await d.getSessions();
-      sessions[0].capabilities.noReset.should.eql(true);
-    });
-
-    it('should allow a string "true" in string capabilities', async function () {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          'platformName': 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:language': 'true'
-        }
-      });
-      d.log.warn.should.not.have.been.called;
-
-      let sessions = await d.getSessions();
-      sessions[0].capabilities.language.should.eql('true');
-    });
-  });
-
-  describe('number capabilities', function () {
-    it('should allow a string "1"', async function () {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          'platformName': 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:newCommandTimeout': '1'
-        }
-      });
-      d.log.warn.should.have.been.called;
-
-      let sessions = await d.getSessions();
-      sessions[0].capabilities.newCommandTimeout.should.eql(1);
-    });
-
-    it('should allow a string "1.1"', async function () {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          'platformName': 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:newCommandTimeout': '1.1'
-        }
-      });
-      d.log.warn.should.have.been.called;
-
-      let sessions = await d.getSessions();
-      sessions[0].capabilities.newCommandTimeout.should.eql(1.1);
-    });
-
-    it('should allow a string "1" in string capabilities', async function () {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          'platformName': 'iOS',
-          'appium:deviceName': 'Delorean',
-          'appium:language': '1'
-        }
-      });
-      d.log.warn.should.not.have.been.called;
-
-      let sessions = await d.getSessions();
-      sessions[0].capabilities.language.should.eql('1');
-    });
-  });
-
-  it ('should error if objects in caps', async function () {
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformName': {a: 'iOS'},
-        'appium:deviceName': 'Delorean'
-      }
-    }).should.eventually.be.rejectedWith(errors.SessionNotCreatedError, /platformName/i);
-  });
-
-  it('should check for deprecated caps', async function () {
-    this.timeout(500);
-
-    d.desiredCapConstraints = {
-      'lynx-version': {
-        deprecated: true
-      }
-    };
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformName': 'iOS',
-        'appium:deviceName': 'Delorean',
-        'appium:lynx-version': 5
-      }
-    });
-
-    logger.warn.should.have.been.called;
-  });
-
-  it('should not warn if deprecated=false', async function () {
-    this.timeout(500);
-
-    d.desiredCapConstraints = {
-      'lynx-version': {
-        deprecated: false
-      }
-    };
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        'platformName': 'iOS',
-        'appium:deviceName': 'Delorean',
-        'appium:lynx-version': 5
-      }
-    });
-
-    d.log.warn.should.not.have.been.called;
-  });
-
-  it('should not validate against null/undefined caps', async function () {
-    d.desiredCapConstraints = {
-      'foo': {
-        isString: true
-      }
-    };
-
-    try {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
-          'appium:foo': null
-        }
-      });
-    } finally {
-      await d.deleteSession();
-    }
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        platformName: 'iOS',
-        'appium:deviceName': 'Dumb',
-        'appium:foo': 1
-      }
-    }).should.eventually.be.rejectedWith(/'foo' must be of type string/);
-
-    try {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
-          'appium:foo': undefined
-        }
-      });
-    } finally {
-      await d.deleteSession();
-    }
-
-    try {
-      await d.createSession(null, null, {
-        alwaysMatch: {
-          platformName: 'iOS',
-          'appium:deviceName': 'Dumb',
-          'appium:foo': ''
-        }
-      });
-    } finally {
-      await d.deleteSession();
-    }
-  });
-
-  it('should still validate null/undefined/empty caps whose presence is required', async function () {
-    d.desiredCapConstraints = {
-      foo: {
-        presence: true
-      },
-    };
-
-    await d.createSession(null, null, {
-      alwaysMatch: {
-        platformName: 'iOS',
-        'appium:deviceName': 'Dumb',
-        'appium:foo': null
-      }
-    }).should.eventually.be.rejectedWith(/blank/);
-
-    await d.createSession(null, {
-      alwaysMatch: {
-        platformName: 'iOS',
-        'appium:deviceName': 'Dumb',
-        'appium:foo': ''
-      }
-    }).should.eventually.be.rejectedWith(/blank/);
-
-    await d.createSession({
-      firstMatch: [{
-        platformName: 'iOS',
-        'appium:deviceName': 'Dumb',
-        'appium:foo': {}
-      }]
-    }).should.eventually.be.rejectedWith(/blank/);
-
-    await d.createSession({
-      alwaysMatch: {
-        platformName: 'iOS',
-        'appium:deviceName': 'Dumb',
-        'appium:foo': []
-      }
-    }).should.eventually.be.rejectedWith(/blank/);
-
-    await d.createSession({
-      alwaysMatch: {
-        platformName: 'iOS',
-        'appium:deviceName': 'Dumb',
-        'appium:foo': '  '
-      }
-    }).should.eventually.be.rejectedWith(/blank/);
-  });
-
-  describe('w3c', function () {
-    it('should accept w3c capabilities', async function () {
-      const [sessionId, caps] = await d.createSession(null, null, {
-        alwaysMatch: {
-          platformName: 'iOS',
-          'appium:deviceName': 'Delorean'
-        }, firstMatch: [{}],
-      });
-      try {
-        sessionId.should.exist;
-        caps.should.eql({
-          platformName: 'iOS',
-          deviceName: 'Delorean',
-        });
-      } finally {
-        await d.deleteSession();
-      }
-    });
-
-    it('should raise an error if w3c capabilities is not a plain JSON object', async function () {
-      const testValues = [true, 'string', [], 100];
-      // this loop runs in parallel, and does not guarantee all assertions will be made
-      await B.map(testValues, (val) => d.createSession(null, null, val).should.eventually.be.rejectedWith(errors.SessionNotCreatedError));
-    });
-  });
-});

package/test/basedriver/commands/event-specs.js

@@ -1,74 +0,0 @@
-import _ from 'lodash';
-import { BaseDriver } from '../../../lib';
-
-
-
-describe('logging custom events', function () {
-  it('should allow logging of events', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    await d.logCustomEvent('myorg', 'myevent');
-    _.keys(d._eventHistory).should.eql(['commands', 'myorg:myevent']);
-  });
-  it('should get all events including custom ones', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d.logEvent('appiumEvent');
-    await d.logCustomEvent('myorg', 'myevent');
-    const events = await d.getLogEvents();
-    _.keys(events).should.eql(['commands', 'appiumEvent', 'myorg:myevent']);
-  });
-});
-
-describe('#getLogEvents', function () {
-  it('should allow to get all events', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d._eventHistory.testCommand = ['1', '2', '3'];
-    await d.getLogEvents().should.eql({
-      commands: [], testCommand: ['1', '2', '3']
-    });
-  });
-
-  it('should filter with testCommand', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d._eventHistory.testCommand = ['1', '2', '3'];
-    await d.getLogEvents('testCommand').should.eql({
-      testCommand: ['1', '2', '3']
-    });
-  });
-
-  it('should not filter with wrong but can be a part of the event name', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d._eventHistory.testCommand = ['1', '2', '3'];
-    await d.getLogEvents('testCommandDummy').should.eql({});
-  });
-
-  it('should filter with multiple event keys', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d._eventHistory.testCommand = ['1', '2', '3'];
-    d._eventHistory.testCommand2 = ['4', '5'];
-    await d.getLogEvents(['testCommand', 'testCommand2']).should.eql({
-      testCommand: ['1', '2', '3'], testCommand2: ['4', '5']
-    });
-  });
-
-  it('should filter with custom events', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d._eventHistory['custom:appiumEvent'] = ['1', '2', '3'];
-    await d.getLogEvents(['custom:appiumEvent']).should.eql({
-      'custom:appiumEvent': ['1', '2', '3']
-    });
-  });
-
-  it('should not filter with no existed event name', async function () {
-    const d = new BaseDriver();
-    d._eventHistory.should.eql({commands: []});
-    d._eventHistory.testCommand = ['1', '2', '3'];
-    await d.getLogEvents(['noEventName']).should.eql({});
-  });
-});

package/test/basedriver/commands/log-specs.js

@@ -1,79 +0,0 @@
-import logCommands from '../../../lib/basedriver/commands/log';
-import { createSandbox } from 'sinon';
-import _ from 'lodash';
-
-
-const expect = chai.expect;
-
-const FIRST_LOGS = ['first', 'logs'];
-const SECOND_LOGS = ['second', 'logs'];
-const SUPPORTED_LOG_TYPES = {
-  one: {
-    description: 'First logs',
-    getter: () => _.clone(FIRST_LOGS),
-  },
-  two: {
-    description: 'Seconds logs',
-    getter: () => _.clone(SECOND_LOGS),
-  },
-};
-
-describe('log commands -', function () {
-  let sandbox;
-
-  beforeEach(function () {
-    sandbox = createSandbox();
-    // reset the supported log types
-    logCommands.supportedLogTypes = {};
-    logCommands.log = {debug: _.noop};
-  });
-
-  afterEach(function () {
-    sandbox.restore();
-  });
-
-  describe('getLogTypes', function () {
-    it('should return empty array when no supported log types', async function () {
-      (await logCommands.getLogTypes()).should.eql([]);
-    });
-    it('should return keys to log type object', async function () {
-      logCommands.supportedLogTypes = SUPPORTED_LOG_TYPES;
-      (await logCommands.getLogTypes()).should.eql(['one', 'two']);
-    });
-  });
-  describe('getLog', function () {
-    beforeEach(function () {
-      sandbox.spy(SUPPORTED_LOG_TYPES.one, 'getter');
-      sandbox.spy(SUPPORTED_LOG_TYPES.two, 'getter');
-    });
-    afterEach(function () {
-      SUPPORTED_LOG_TYPES.one.getter.restore();
-      SUPPORTED_LOG_TYPES.two.getter.restore();
-    });
-    it('should throw error if log type not supported', async function () {
-      await logCommands.getLog('one').should.eventually.be.rejected;
-      SUPPORTED_LOG_TYPES.one.getter.called.should.be.false;
-      SUPPORTED_LOG_TYPES.two.getter.called.should.be.false;
-    });
-    it('should throw an error with available log types if log type not supported', async function () {
-      logCommands.supportedLogTypes = SUPPORTED_LOG_TYPES;
-      let err;
-      try {
-        await logCommands.getLog('three');
-      } catch (_err) {
-        err = _err;
-      }
-      expect(err).to.exist;
-      err.message.should.eql(`Unsupported log type 'three'. Supported types: {"one":"First logs","two":"Seconds logs"}`);
-      SUPPORTED_LOG_TYPES.one.getter.called.should.be.false;
-      SUPPORTED_LOG_TYPES.two.getter.called.should.be.false;
-    });
-    it('should call getter on appropriate log when found', async function () {
-      logCommands.supportedLogTypes = SUPPORTED_LOG_TYPES;
-      let logs = await logCommands.getLog('one');
-      logs.should.eql(FIRST_LOGS);
-      SUPPORTED_LOG_TYPES.one.getter.called.should.be.true;
-      SUPPORTED_LOG_TYPES.two.getter.called.should.be.false;
-    });
-  });
-});

package/test/basedriver/driver-e2e-specs.js

@@ -1,8 +0,0 @@
-// transpile:mocha
-
-import BaseDriver from '../../lib';
-import baseDriverE2ETests from './driver-e2e-tests';
-baseDriverE2ETests(BaseDriver, {
-  platformName: 'iOS',
-  'appium:deviceName': 'Delorean'
-});

package/test/basedriver/driver-specs.js

@@ -1,8 +0,0 @@
-// transpile:mocha
-
-import BaseDriver from '../../lib';
-import baseDriverUnitTests from './driver-tests';
-baseDriverUnitTests(BaseDriver, {
-  platformName: 'iOS',
-  'appium:deviceName': 'Delorean'
-});

package/test/basedriver/fixtures/BadZippedApp.zip

@@ -1 +0,0 @@
-zip zip zip

package/test/basedriver/fixtures/FakeAndroidApp.apk

@@ -1 +0,0 @@
-this is not really an apk

package/test/basedriver/fixtures/FakeIOSApp.app

@@ -1 +0,0 @@
-this is not really an app

package/test/basedriver/fixtures/custom-element-finder-bad.js

@@ -1,5 +0,0 @@
-module.exports = {
-  notFind: function () { // eslint-disable-line object-shorthand
-    return [];
-  }
-};

package/test/basedriver/fixtures/custom-element-finder.js

@@ -1,29 +0,0 @@
-module.exports = {
-  find: function (driver, logger, selector, multiple) { // eslint-disable-line object-shorthand
-    if (!driver || !driver.opts) {
-      throw new Error('Expected driver object');
-    }
-
-    if (!logger || !logger.info) {
-      throw new Error('Expected logger object');
-    }
-
-    if (selector === 'foo') {
-      return ['bar'];
-    }
-
-    if (selector === 'foos') {
-      if (multiple) {
-        return ['baz1', 'baz2'];
-      }
-
-      return ['bar1', 'bar2'];
-    }
-
-    if (selector === 'error') {
-      throw new Error('This is a plugin error');
-    }
-
-    return [];
-  }
-};