appium/test/protocol/protocol-specs.js

// transpile:mocha

import '../..'; // NOTE: For some reason this file needs to be imported to prevent a babel error
import chai from 'chai';
import sinon from 'sinon';
import chaiAsPromised from 'chai-as-promised';
import { MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY, parseProtocol, driverShouldDoJwpProxy, IMAGE_ELEMENT_PREFIX } from '../../lib/protocol/protocol';
import BaseDriver from '../../lib/basedriver/driver';

chai.should();
chai.use(chaiAsPromised);

describe('Protocol', async function () {

  describe('#parseProtocol', function () {
    it('should parse {protocol: "MJSONWP"} as MJSONWP', function () {
      parseProtocol({protocol: 'MJSONWP', value: undefined}).should.eql({isW3C: false, isMJSONWP: true, value: undefined});
    });
    it('should parse {protocol: "W3C"} as W3C', function () {
      parseProtocol({protocol: 'W3C', value: undefined}).should.eql({isW3C: true, isMJSONWP: false, value: undefined});
    });
    it('should parse {protocol: "MJSONWP", value: false} as MJSONWP with value: false', function () {
      parseProtocol({protocol: 'MJSONWP', value: false}).should.eql({isW3C: false, isMJSONWP: true, value: false});
    });
    it('should parse {protocol: "W3C", value: 0} as W3C with value: 0', function () {
      parseProtocol({protocol: 'W3C', value: 0}).should.eql({isW3C: true, isMJSONWP: false, value: 0});
    });
    it('should parse {protocol: "MJSONWP", value: "string"}', function () {
      parseProtocol({protocol: 'MJSONWP', value: "string"}).should.eql({isW3C: false, isMJSONWP: true, value: "string"});
    });
    it('should parse {protocol: "W3C", value: {obj}}', function () {
      const value = {hello: 'world', goodbye: 'whirl'};
      parseProtocol({protocol: 'MJSONWP', value}).should.eql({isW3C: false, isMJSONWP: true, value});
    });
    it('should throw if {protocol: "MJSONWP", error}', function () {
      const error = new Error('some error');
      parseProtocol({protocol: 'W3C', error}).error.should.equal(error);
    });
  });

  describe('#driverShouldDoJwpProxy', function () {
    it('should not proxy if an image element is found in request url', function () {
      const d = new BaseDriver();
      sinon.stub(d, 'proxyActive').returns(true);
      sinon.stub(d, 'proxyRouteIsAvoided').returns(false);
      const hasImageElements = [
        `/wd/hub/session/:sessionId/element/${IMAGE_ELEMENT_PREFIX}bar`,
        `/wd/hub/session/:sessionId/element/${IMAGE_ELEMENT_PREFIX}bar/click`,
        `/wd/hub/session/:sessionId/element/${IMAGE_ELEMENT_PREFIX}bar/submit`,
        `/wd/hub/session/:sessionId/screenshot/${IMAGE_ELEMENT_PREFIX}bar`,
      ];
      const noImageElements = [
        `/wd/hub/session/:sessionId/element/${IMAGE_ELEMENT_PREFIX}`,
        `/wd/hub/session/:sessionId/screenshot/${IMAGE_ELEMENT_PREFIX}`,
        `/wd/hub/session/:sessionId/element/bar${IMAGE_ELEMENT_PREFIX}`,
        '/wd/hub/session/:sessionId/element/element123',
        '/wd/hub/session/:sessionId/title',
        `/wd/hub/session/:sessionId/notelement/${IMAGE_ELEMENT_PREFIX}bar`,
      ];
      for (let testCase of hasImageElements) {
        const req = {body: {}, params: {}, originalUrl: testCase};
        driverShouldDoJwpProxy(d, req, null).should.be.false;
      }
      for (let testCase of noImageElements) {
        const req = {body: {}, params: {}, originalUrl: testCase};
        driverShouldDoJwpProxy(d, req, null).should.be.true;
      }
    });
    it('should not proxy if an image element is found in request body', function () {
      const d = new BaseDriver();
      sinon.stub(d, 'proxyActive').returns(true);
      sinon.stub(d, 'proxyRouteIsAvoided').returns(false);
      const hasImageElements = [{
        [W3C_ELEMENT_KEY]: `${IMAGE_ELEMENT_PREFIX}bar`,
      }, {
        [W3C_ELEMENT_KEY]: `${IMAGE_ELEMENT_PREFIX}foo`,
      }, {
        [MJSONWP_ELEMENT_KEY]: `${IMAGE_ELEMENT_PREFIX}bar`,
      }];
      const noImageElements = [{
        [IMAGE_ELEMENT_PREFIX]: 'foo',
      }, {
        [W3C_ELEMENT_KEY]: `${IMAGE_ELEMENT_PREFIX}`,
      }, {
        [MJSONWP_ELEMENT_KEY]: `${IMAGE_ELEMENT_PREFIX}`,
      }, {
        foo: 'bar',
      }, {
        [W3C_ELEMENT_KEY]: 'bar',
      }, {
        [MJSONWP_ELEMENT_KEY]: 'bar',
      }, {
        foo: `${IMAGE_ELEMENT_PREFIX}bar`,
      }, {
        foo: `bar${IMAGE_ELEMENT_PREFIX}`
      }, {
        [W3C_ELEMENT_KEY]: `bar${IMAGE_ELEMENT_PREFIX}`
      }, {
        [MJSONWP_ELEMENT_KEY]: `bar${IMAGE_ELEMENT_PREFIX}`
      }];
      for (let testCase of hasImageElements) {
        const req = {body: testCase, params: {}};
        driverShouldDoJwpProxy(d, req, null).should.be.false;
      }
      for (let testCase of noImageElements) {
        const req = {body: testCase, params: {}};
        driverShouldDoJwpProxy(d, req, null).should.be.true;
      }

    });
  });
});