How to use driver.toggleTouchIdEnrollment method in Appium Xcuitest Driver

1// transpile:mocha
2
3import chai from 'chai';
4import chaiAsPromised from 'chai-as-promised';
5import { TOUCHIDAPP_CAPS } from '../desired';
6import { initSession, deleteSession, MOCHA_TIMEOUT } from '../helpers/session';
7import B from 'bluebird';
8import { killAllSimulators } from 'appium-ios-simulator';
9
10chai.should();
11chai.use(chaiAsPromised);
12
13describe('touchID() ', function () {
14  this.timeout(MOCHA_TIMEOUT);
15  let caps, driver;
16
17  beforeEach(async () => {
18    await killAllSimulators();
19  });
20
21  afterEach(async () => {
22    await deleteSession();
23    await B.delay(500);
24  });
25
26  after(async () => {
27    await killAllSimulators();
28  });
29
30  it('should throw an error if allowTouchIdEnroll desired capability is not set', async () => {
31    await killAllSimulators();
32    caps = Object.assign(TOUCHIDAPP_CAPS);
33    caps.allowTouchIdEnroll = false;
34    driver = await initSession(caps);
35
36    await driver.toggleTouchIdEnrollment().should.be.rejectedWith(/enroll touchId/);
37  });
38
39  describe('touchID enrollment functional tests applied to TouchId sample app', function () {
40    beforeEach(async () => {
41      caps = Object.assign(TOUCHIDAPP_CAPS);
42      caps.allowTouchIdEnroll = true;
43      driver = await initSession(caps);
44      await B.delay(2000); // Give the app a couple seconds to open
45    });
46
47    it('should not support touchID if not enrolled', async () => {
48      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
49      await authenticateButton.click();
50      await driver.elementByName('TouchID not supported').should.eventually.exist;
51    });
52
53    it('should accept matching fingerprint if touchID is enrolled or it should not be supported if phone doesn\'t support touchID', async () => {
54      await driver.toggleTouchIdEnrollment();
55      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
56      await authenticateButton.click();
57      await driver.touchId(true);
58      try {
59        await driver.elementByName('Authenticated Successfully').should.eventually.exist;
60      } catch (ign) {
61        await driver.elementByName('TouchID not supported').should.eventually.exist;
62      }
63      await driver.toggleTouchIdEnrollment();
64    });
65
66    it('should reject not matching fingerprint if touchID is enrolled or it should not be supported if phone doesn\'t support touchID', async () => {
67      await driver.toggleTouchIdEnrollment();
68      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
69      await authenticateButton.click();
70      await driver.touchId(false);
71      try {
72        await driver.elementByName('Try Again').should.eventually.exist;
73      } catch (ign) {
74        await driver.elementByName('TouchID not supported').should.eventually.exist;
75      }
76      await driver.toggleTouchIdEnrollment();
77    });
78
79    it('should enroll touchID and accept matching fingerprints then unenroll touchID and not be supported', async () => {
80      // Don't enroll
81      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
82      await authenticateButton.click();
83      await driver.elementByName('TouchID not supported').should.eventually.exist;
84      let okButton = await driver.elementByName('OK');
85      await okButton.click();
86      await B.delay(1000);
87
88      // Enroll
89      await driver.toggleTouchIdEnrollment();
90      await authenticateButton.click();
91      await driver.touchId(true);
92      try {
93        await driver.elementByName('Authenticated Successfully').should.eventually.exist;
94      } catch (ign) {
95        return await driver.elementByName('TouchID not supported').should.eventually.exist;
96      }
97      okButton = await driver.elementByName('OK');
98      await okButton.click();
99      await B.delay(1000);
100
101      // Unenroll
102      await driver.toggleTouchIdEnrollment();
103      authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
104      await authenticateButton.click();
105      await driver.elementByName('TouchID not supported').should.eventually.exist;
106    });
107  });
108
109});
110

Source: touch-id-e2e-specs.js

// transpile:mocha

import chai from 'chai';
import chaiAsPromised from 'chai-as-promised';
import { TOUCHIDAPP_CAPS } from '../desired';
import { initSession, deleteSession, MOCHA_TIMEOUT } from '../helpers/session';
import B from 'bluebird';
import { killAllSimulators } from 'appium-ios-simulator';

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

describe('touchID() ', function () {
  this.timeout(MOCHA_TIMEOUT);
  let caps, driver;

  beforeEach(async () => {
    await killAllSimulators();
  });

  afterEach(async () => {
    await deleteSession();
    await B.delay(500);
  });

  after(async () => {
    await killAllSimulators();
  });

  it('should throw an error if allowTouchIdEnroll desired capability is not set', async () => {
    await killAllSimulators();
    caps = Object.assign(TOUCHIDAPP_CAPS);
    caps.allowTouchIdEnroll = false;
    driver = await initSession(caps);

    await driver.toggleTouchIdEnrollment().should.be.rejectedWith(/enroll touchId/);
  });

  describe('touchID enrollment functional tests applied to TouchId sample app', function () {
    beforeEach(async () => {
      caps = Object.assign(TOUCHIDAPP_CAPS);
      caps.allowTouchIdEnroll = true;
      driver = await initSession(caps);
      await B.delay(2000); // Give the app a couple seconds to open
    });

    it('should not support touchID if not enrolled', async () => {
      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
      await authenticateButton.click();
      await driver.elementByName('TouchID not supported').should.eventually.exist;
    });

    it('should accept matching fingerprint if touchID is enrolled or it should not be supported if phone doesn\'t support touchID', async () => {
      await driver.toggleTouchIdEnrollment();
      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
      await authenticateButton.click();
      await driver.touchId(true);
      try {
        await driver.elementByName('Authenticated Successfully').should.eventually.exist;
      } catch (ign) {
        await driver.elementByName('TouchID not supported').should.eventually.exist;
      }
      await driver.toggleTouchIdEnrollment();
    });

    it('should reject not matching fingerprint if touchID is enrolled or it should not be supported if phone doesn\'t support touchID', async () => {
      await driver.toggleTouchIdEnrollment();
      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
      await authenticateButton.click();
      await driver.touchId(false);
      try {
        await driver.elementByName('Try Again').should.eventually.exist;
      } catch (ign) {
        await driver.elementByName('TouchID not supported').should.eventually.exist;
      }
      await driver.toggleTouchIdEnrollment();
    });

    it('should enroll touchID and accept matching fingerprints then unenroll touchID and not be supported', async () => {
      // Don't enroll
      let authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
      await authenticateButton.click();
      await driver.elementByName('TouchID not supported').should.eventually.exist;
      let okButton = await driver.elementByName('OK');
      await okButton.click();
      await B.delay(1000);

      // Enroll
      await driver.toggleTouchIdEnrollment();
      await authenticateButton.click();
      await driver.touchId(true);
      try {
        await driver.elementByName('Authenticated Successfully').should.eventually.exist;
      } catch (ign) {
        return await driver.elementByName('TouchID not supported').should.eventually.exist;
      }
      okButton = await driver.elementByName('OK');
      await okButton.click();
      await B.delay(1000);

      // Unenroll
      await driver.toggleTouchIdEnrollment();
      authenticateButton = await driver.elementByName(' Authenticate with Touch ID');
      await authenticateButton.click();
      await driver.elementByName('TouchID not supported').should.eventually.exist;
    });
  });

});