xctest-e2e-specs.js

import path from 'path';
import {MOCHA_TIMEOUT, initSession, deleteSession, hasDefaultPrebuiltWDA} from '../helpers/session';
import {GENERIC_CAPS, amendCapabilities} from '../desired';
import xcode from 'appium-xcode';

const APP_UNDER_TEST_PATH = path.resolve(__dirname, '..', '..', 'assets', 'XCTesterApp.app');
const TEST_BUNDLE_PATH = path.resolve(
  __dirname,
  '..',
  '..',
  'assets',
  'XCTesterAppUITests-Runner.app',
);
const XCTEST_BUNDLE_PATH = path.join(TEST_BUNDLE_PATH, 'PlugIns', 'XCTesterAppUITests.xctest');


if (process.env.LAUNCH_WITH_IDB) {
  describe('XCTest', function () {
    this.timeout(MOCHA_TIMEOUT);

    let driver;
    let chai;

    before(async function () {
      chai = await import('chai');
      const chaiAsPromised = await import('chai-as-promised');

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

      // idb_companion doesn't work with xcode 13 or lower due to concurrency lib issue.
      if (
        /** @type {import('appium-xcode').XcodeVersion} */ (await xcode.getVersion(true)).major < 14
      ) {
        this.skip();
      }
      const caps = amendCapabilities(GENERIC_CAPS, {
        'appium:app': APP_UNDER_TEST_PATH,
        'appium:launchWithIDB': true,
        'appium:usePrebuiltWDA': hasDefaultPrebuiltWDA(),
      });
      driver = await initSession(caps);
    });

    after(async function () {
      await deleteSession();
    });
    it('should install an XC test bundle and then run it', async function () {
      // Install the test runner app
      await driver.installApp(TEST_BUNDLE_PATH);

      // Install the xctest bundle
      await driver.execute('mobile: installXCTestBundle', {xctestApp: XCTEST_BUNDLE_PATH});

      // Get list of xctest bundles
      const xcTestBundleList = await driver.execute('mobile: listXCTestBundles');
      const bundleTest = 'io.appium.XCTesterAppUITests';
      xcTestBundleList.should.includes(bundleTest);

      // Get list of xctests within bundle
      const xcTestsInBundle = await driver.execute('mobile: listXCTestsInTestBundle', {
        bundle: bundleTest,
      });
      xcTestsInBundle.should.eql([
        'XCTesterAppUITests.XCTesterAppUITests/testExample',
        'XCTesterAppUITests.XCTesterAppUITests/testLaunchPerformance',
      ]);

      // Now run the tests
      const bundleApp = 'io.appium.XCTesterApp';
      const res = await driver.execute('mobile: runXCTest', {
        testRunnerBundleId: 'io.appium.XCTesterAppUITests.xctrunner',
        appUnderTestBundleId: bundleApp,
        xctestBundleId: bundleTest,
        testType: 'ui',
      });
      res.code.should.equal(0);
      res.passed.should.be.true;
      res.results[0].testName.should.eql(
        'XCTesterAppUITests - XCTesterAppUITests.XCTesterAppUITests/testExample',
      );
      res.results[0].passed.should.be.true;
      res.results[1].testName.should.eql(
        'XCTesterAppUITests - XCTesterAppUITests.XCTesterAppUITests/testLaunchPerformance',
      );
      res.results[1].passed.should.be.true;
    });
    it('should fail gracefully if bad params passed in runXCTest', async function () {
      try {
        await driver.execute('mobile: runXCTest', {
          testRunnerBundleId: 'bad',
          appUnderTestBundleId: 'bad',
          xctestBundleId: 'bad',
          testType: 'ui',
        });
      } catch (e) {
        e.message.should.match(/Couldn't find test with id: bad/);
        return;
      }

      throw new Error(`An exception should have been thrown`);
    });
    it('should fail if timeout', async function () {
      try {
        await driver.execute('mobile: runXCTest', {
          testRunnerBundleId: 'bad',
          appUnderTestBundleId: 'bad',
          xctestBundleId: 'bad',
          testType: 'ui',
          timeout: 1,
        });
      } catch (e) {
        e.message.should.match(/Timed out after '1ms' waiting for XCTest to complete/);
        return;
      }

      throw new Error(`An exception should have been thrown`);
    });
  });
}