How to use driver.setGeoLocation method in Appium Xcuitest Driver

1import sinon from 'sinon';
2import XCUITestDriver from '../../..';
3import { fs } from 'appium-support';
4import * as teenProcess from 'teen_process';
5
6describe('location commands', function () {
7  const udid = '1234';
8  const toolName = 'idevicelocation';
9
10  const driver = new XCUITestDriver();
11  const proxySpy = sinon.stub(driver, 'proxyCommand');
12
13  afterEach(function () {
14    proxySpy.reset();
15  });
16
17  describe('setLocation', function () {
18    let execStub;
19    let fsWhichStub;
20
21    beforeEach(function () {
22      execStub = sinon.stub(teenProcess, 'exec');
23      fsWhichStub = sinon.stub(fs, 'which');
24    });
25
26    afterEach(function () {
27      execStub.restore();
28      fsWhichStub.restore();
29    });
30
31    it('should fail when location object is wrong', async function () {
32      await driver.setGeoLocation({}).should.be.rejectedWith('Both latitude and longitude should be set');
33    });
34
35    describe('on real device', function () {
36      beforeEach(function () {
37        driver.opts.udid = udid;
38        driver.opts.realDevice = true;
39      });
40
41      it('should use idevicelocation to set a location', async function () {
42        fsWhichStub.returns(toolName);
43        await driver.setGeoLocation({latitude: '1.234', longitude: '2.789'});
44
45        execStub.calledOnce.should.be.true;
46        execStub.firstCall.args[0].should.eql(toolName);
47        execStub.firstCall.args[1].should.eql(['-u', udid, '1.234', '2.789']);
48      });
49
50      it('should use idevicelocation to set a location with negative values', async function () {
51        fsWhichStub.returns(toolName);
52        await driver.setGeoLocation({latitude: 1.234, longitude: -2});
53
54        execStub.calledOnce.should.be.true;
55        execStub.firstCall.args[0].should.eql(toolName);
56        execStub.firstCall.args[1].should.eql(['-u', udid, '1.234', '--', '-2']);
57      });
58
59      it('should fail when idevicelocation doesnt exist on the host', async function () {
60        fsWhichStub.throws();
61        await driver.setGeoLocation({
62          latitude: '1.234',
63          longitude: '2.789'}
64        ).should.be.rejectedWith(`idevicelocation doesn't exist on the host`);
65      });
66    });
67
68    describe('on simulator', function () {
69      let deviceSetLocationSpy;
70      beforeEach(function () {
71        driver.opts.realDevice = false;
72
73        deviceSetLocationSpy = sinon.spy();
74        driver.opts.device = {
75          setGeolocation: deviceSetLocationSpy,
76        };
77      });
78      afterEach(function () {
79        deviceSetLocationSpy.resetHistory();
80      });
81      it('should set string coordinates', async function () {
82        await driver.setGeoLocation({latitude: '1.234', longitude: '2.789'});
83        deviceSetLocationSpy.firstCall.args[0].should.eql('1.234');
84        deviceSetLocationSpy.firstCall.args[1].should.eql('2.789');
85      });
86      it('should set number coordinates', async function () {
87        await driver.setGeoLocation({latitude: 1, longitude: -2});
88        deviceSetLocationSpy.firstCall.args[0].should.eql('1');
89        deviceSetLocationSpy.firstCall.args[1].should.eql('-2');
90      });
91    });
92  });
93});
94

Source: location-specs.js

import sinon from 'sinon';
import XCUITestDriver from '../../..';
import { fs } from 'appium-support';
import * as teenProcess from 'teen_process';

describe('location commands', function () {
  const udid = '1234';
  const toolName = 'idevicelocation';

  const driver = new XCUITestDriver();
  const proxySpy = sinon.stub(driver, 'proxyCommand');

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

  describe('setLocation', function () {
    let execStub;
    let fsWhichStub;

    beforeEach(function () {
      execStub = sinon.stub(teenProcess, 'exec');
      fsWhichStub = sinon.stub(fs, 'which');
    });

    afterEach(function () {
      execStub.restore();
      fsWhichStub.restore();
    });

    it('should fail when location object is wrong', async function () {
      await driver.setGeoLocation({}).should.be.rejectedWith('Both latitude and longitude should be set');
    });

    describe('on real device', function () {
      beforeEach(function () {
        driver.opts.udid = udid;
        driver.opts.realDevice = true;
      });

      it('should use idevicelocation to set a location', async function () {
        fsWhichStub.returns(toolName);
        await driver.setGeoLocation({latitude: '1.234', longitude: '2.789'});

        execStub.calledOnce.should.be.true;
        execStub.firstCall.args[0].should.eql(toolName);
        execStub.firstCall.args[1].should.eql(['-u', udid, '1.234', '2.789']);
      });

      it('should use idevicelocation to set a location with negative values', async function () {
        fsWhichStub.returns(toolName);
        await driver.setGeoLocation({latitude: 1.234, longitude: -2});

        execStub.calledOnce.should.be.true;
        execStub.firstCall.args[0].should.eql(toolName);
        execStub.firstCall.args[1].should.eql(['-u', udid, '1.234', '--', '-2']);
      });

      it('should fail when idevicelocation doesnt exist on the host', async function () {
        fsWhichStub.throws();
        await driver.setGeoLocation({
          latitude: '1.234',
          longitude: '2.789'}
        ).should.be.rejectedWith(`idevicelocation doesn't exist on the host`);
      });
    });

    describe('on simulator', function () {
      let deviceSetLocationSpy;
      beforeEach(function () {
        driver.opts.realDevice = false;

        deviceSetLocationSpy = sinon.spy();
        driver.opts.device = {
          setGeolocation: deviceSetLocationSpy,
        };
      });
      afterEach(function () {
        deviceSetLocationSpy.resetHistory();
      });
      it('should set string coordinates', async function () {
        await driver.setGeoLocation({latitude: '1.234', longitude: '2.789'});
        deviceSetLocationSpy.firstCall.args[0].should.eql('1.234');
        deviceSetLocationSpy.firstCall.args[1].should.eql('2.789');
      });
      it('should set number coordinates', async function () {
        await driver.setGeoLocation({latitude: 1, longitude: -2});
        deviceSetLocationSpy.firstCall.args[0].should.eql('1');
        deviceSetLocationSpy.firstCall.args[1].should.eql('-2');
      });
    });
  });
});