chore: Migrate tests to typescript (#1083)

mykola-mokhnach · web-flow · commit 6ac993e29ab0 · 2025-12-13T12:49:18.000+01:00
diff --git a/.github/workflows/functional-test.yml b/.github/workflows/functional-test.yml
@@ -13,8 +13,8 @@ jobs:
       matrix:
         test_targets:
           - HOST_OS: 'macos-15'
-            XCODE_VERSION: '26.0'
-            IOS_VERSION: '26.0'
+            XCODE_VERSION: '26.1'
+            IOS_VERSION: '26.1'
             IOS_MODEL: iPhone 17
           - HOST_OS: 'macos-15'
             XCODE_VERSION: '16.4'
diff --git a/lib/types.ts b/lib/types.ts
@@ -99,6 +99,16 @@ export interface AppleDevice {
   [key: string]: any;
 }
 
+/**
+ * Information of the device under test
+ */
+export interface DeviceInfo {
+  isRealDevice: boolean;
+  udid: string;
+  platformVersion: string;
+  platformName: string;
+}
+
 export interface XcodeBuildArgs {
   realDevice: boolean; // Required
   agentPath: string; // Required
diff --git a/lib/utils.js b/lib/utils.js
@@ -160,12 +160,8 @@ async function setRealDeviceSecurity (keychainPath, keychainPassword) {
 
 /**
  * Information of the device under test
- * @typedef {Object} DeviceInfo
- * @property {boolean} isRealDevice - Equals to true if the current device is a real device
- * @property {string} udid - The device UDID.
- * @property {string} platformVersion - The platform version of OS.
- * @property {string} platformName - The platform name of iOS, tvOS
-*/
+ * @typedef {import('./types').DeviceInfo} DeviceInfo
+ */
 
 /**
  * Arguments for setting xctestrun file
diff --git a/lib/xcodebuild.js b/lib/xcodebuild.js
@@ -110,7 +110,7 @@ export class XcodeBuild {
     this.noSessionProxy = noSessionProxy;
 
     if (this.useXctestrunFile) {
-      /** @type {import('./utils').DeviceInfo} */
+      /** @type {import('./types').DeviceInfo} */
       const deviceInfo = {
         isRealDevice: !!this.realDevice,
         udid: this.device.udid,
diff --git a/package.json b/package.json
@@ -13,8 +13,8 @@
     "lint:fix": "npm run lint -- --fix",
     "prepare": "npm run build",
     "version": "npm run sync-wda-version",
-    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\"",
-    "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.js\"",
+    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\"",
+    "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.ts\"",
     "bundle": "npm run bundle:ios && npm run bundle:tv",
     "bundle:ios": "TARGET=runner SDK=sim node ./Scripts/build-webdriveragent.js",
     "bundle:tv": "TARGET=tv_runner SDK=tv_sim node ./Scripts/build-webdriveragent.js",
diff --git a/test/functional/desired.js b/test/functional/desired.js
diff --git a/test/functional/desired.ts b/test/functional/desired.ts
@@ -0,0 +1,7 @@
+import { util } from '@appium/support';
+
+export const PLATFORM_VERSION: string = process.env.PLATFORM_VERSION
+  ? process.env.PLATFORM_VERSION : '11.3';
+export const DEVICE_NAME: string = process.env.DEVICE_NAME
+  || (util.compareVersions(PLATFORM_VERSION, '>=', '13.0') ? 'iPhone X' : 'iPhone 6');
+
diff --git a/test/functional/helpers/simulator.ts b/test/functional/helpers/simulator.ts
@@ -3,9 +3,9 @@ import { Simctl } from 'node-simctl';
 import { retryInterval } from 'asyncbox';
 import { killAllSimulators as simKill } from 'appium-ios-simulator';
 import { resetTestProcesses } from '../../../lib/utils';
+import type { AppleDevice } from '../../../lib/types';
 
-
-async function killAllSimulators () {
+export async function killAllSimulators (): Promise<void> {
   if (process.env.CLOUD) {
     return;
   }
@@ -24,18 +24,15 @@ async function killAllSimulators () {
   await simKill();
 }
 
-async function shutdownSimulator (device) {
+export async function shutdownSimulator (device: AppleDevice): Promise<void> {
   // stop XCTest processes if running to avoid unexpected side effects
   await resetTestProcesses(device.udid, true);
   await device.shutdown();
 }
 
-async function deleteDeviceWithRetry (udid) {
+export async function deleteDeviceWithRetry (udid: string): Promise<void> {
   const simctl = new Simctl({udid});
   try {
     await retryInterval(10, 1000, simctl.deleteDevice.bind(simctl));
   } catch {}
 }
-
-
-export { killAllSimulators, shutdownSimulator, deleteDeviceWithRetry };
diff --git a/test/functional/webdriveragent-e2e-specs.ts b/test/functional/webdriveragent-e2e-specs.ts
@@ -1,21 +1,27 @@
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 import { Simctl } from 'node-simctl';
 import { getVersion } from 'appium-xcode';
+import type { XcodeVersion } from 'appium-xcode';
 import { getSimulator } from 'appium-ios-simulator';
 import { killAllSimulators, shutdownSimulator } from './helpers/simulator';
 import { SubProcess } from 'teen_process';
 import { PLATFORM_VERSION, DEVICE_NAME } from './desired';
 import { retryInterval } from 'asyncbox';
 import { WebDriverAgent } from '../../lib/webdriveragent';
 import axios from 'axios';
+import type { AppleDevice } from '../../lib/types';
+
+chai.use(chaiAsPromised);
 
 const MOCHA_TIMEOUT_MS = 60 * 1000 * 5;
 
 const SIM_DEVICE_NAME = 'webDriverAgentTest';
 const SIM_STARTUP_TIMEOUT_MS = MOCHA_TIMEOUT_MS;
 
-let testUrl = 'http://localhost:8100/tree';
+const testUrl = 'http://localhost:8100/tree';
 
-function getStartOpts (device) {
+function getStartOpts (device: AppleDevice) {
   return {
     device,
     platformVersion: PLATFORM_VERSION,
@@ -30,16 +36,9 @@ function getStartOpts (device) {
 
 describe('WebDriverAgent', function () {
   this.timeout(MOCHA_TIMEOUT_MS);
-  let chai;
-  let xcodeVersion;
+  let xcodeVersion: XcodeVersion | undefined;
 
   before(async function () {
-    chai = await import('chai');
-    const chaiAsPromised = await import('chai-as-promised');
-
-    chai.should();
-    chai.use(chaiAsPromised.default);
-
     // Don't do these tests on Sauce Labs
     if (process.env.CLOUD) {
       this.skip();
@@ -48,8 +47,8 @@ describe('WebDriverAgent', function () {
     xcodeVersion = await getVersion(true);
   });
   describe('with fresh sim', function () {
-    let device;
-    let simctl;
+    let device: AppleDevice;
+    let simctl: Simctl;
 
     before(async function () {
       simctl = new Simctl();
@@ -67,7 +66,9 @@ describe('WebDriverAgent', function () {
         showXcodeLog: true,
         device,
       });
-      await wda.xcodebuild.start(true);
+      if (wda.xcodebuild) {
+        await wda.xcodebuild.start(true);
+      }
     });
 
     after(async function () {
@@ -96,7 +97,7 @@ describe('WebDriverAgent', function () {
         const agent = new WebDriverAgent(xcodeVersion, getStartOpts(device));
 
         await agent.launch('sessionId');
-        await axios({url: testUrl}).should.be.eventually.rejected;
+        await expect(axios({url: testUrl})).to.be.rejected;
         await agent.quit();
       });
 
@@ -106,8 +107,11 @@ describe('WebDriverAgent', function () {
 
         const agent = new WebDriverAgent(xcodeVersion, getStartOpts(device));
 
+        if (!agent.xcodebuild) {
+          throw new Error('xcodebuild is null');
+        }
         agent.xcodebuild.createSubProcess = async function () {
-          let args = [
+          const args = [
             '-workspace',
             `${this.agentPath}dfgs`,
             // '-scheme',
@@ -119,11 +123,12 @@ describe('WebDriverAgent', function () {
           return new SubProcess('xcodebuild', args, {detached: true});
         };
 
-        await agent.launch('sessionId')
-          .should.eventually.be.rejectedWith('xcodebuild failed');
+        await expect(agent.launch('sessionId'))
+          .to.be.rejectedWith('xcodebuild failed');
 
         await agent.quit();
       });
     });
   });
 });
+
diff --git a/test/unit/utils-specs.ts b/test/unit/utils-specs.ts
@@ -1,33 +1,29 @@
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 import { getXctestrunFilePath, getAdditionalRunContent, getXctestrunFileName } from '../../lib/utils';
 import { PLATFORM_NAME_IOS, PLATFORM_NAME_TVOS } from '../../lib/constants';
 import { fs } from '@appium/support';
 import path from 'path';
 import { fail } from 'assert';
 import { arch } from 'os';
 import sinon from 'sinon';
+import type { DeviceInfo } from '../../lib/types';
 
-function get_arch() {
+chai.use(chaiAsPromised);
+
+function get_arch(): string {
   return arch() === 'arm64' ? 'arm64' : 'x86_64';
 }
 
 describe('utils', function () {
-  let chai;
-
-  before(async function() {
-    chai = await import('chai');
-    const chaiAsPromised = await import('chai-as-promised');
-
-    chai.should();
-    chai.use(chaiAsPromised.default);
-  });
 
   describe('#getXctestrunFilePath', function () {
     const platformVersion = '12.0';
     const sdkVersion = '12.2';
     const udid = 'xxxxxyyyyyyzzzzzz';
     const bootstrapPath = 'path/to/data';
     const platformName = PLATFORM_NAME_IOS;
-    let sandbox;
+    let sandbox: sinon.SinonSandbox;
 
     beforeEach(function () {
       sandbox = sinon.createSandbox();
@@ -42,9 +38,9 @@ describe('utils', function () {
         .withArgs(path.resolve(`${bootstrapPath}/${udid}_${sdkVersion}.xctestrun`))
         .resolves(true);
       sandbox.stub(fs, 'copyFile');
-      const deviceInfo = {isRealDevice: true, udid, platformVersion, platformName};
-      await getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath)
-        .should.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${sdkVersion}.xctestrun`));
+      const deviceInfo: DeviceInfo = {isRealDevice: true, udid, platformVersion, platformName};
+      await expect(getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath))
+        .to.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${sdkVersion}.xctestrun`));
       sandbox.assert.notCalled(fs.copyFile);
     });
 
@@ -58,9 +54,9 @@ describe('utils', function () {
           path.resolve(`${bootstrapPath}/${udid}_${sdkVersion}.xctestrun`)
         )
         .resolves();
-      const deviceInfo = {isRealDevice: true, udid, platformVersion};
-      await getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath)
-        .should.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${sdkVersion}.xctestrun`));
+      const deviceInfo: DeviceInfo = {isRealDevice: true, udid, platformVersion, platformName: PLATFORM_NAME_IOS};
+      await expect(getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath))
+        .to.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${sdkVersion}.xctestrun`));
     });
 
     it('should return platform based path', async function () {
@@ -69,9 +65,9 @@ describe('utils', function () {
       existsStub.withArgs(path.resolve(`${bootstrapPath}/WebDriverAgentRunner_iphonesimulator${sdkVersion}-${get_arch()}.xctestrun`)).resolves(false);
       existsStub.withArgs(path.resolve(`${bootstrapPath}/${udid}_${platformVersion}.xctestrun`)).resolves(true);
       sandbox.stub(fs, 'copyFile');
-      const deviceInfo = {isRealDevice: false, udid, platformVersion};
-      await getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath)
-        .should.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${platformVersion}.xctestrun`));
+      const deviceInfo: DeviceInfo = {isRealDevice: false, udid, platformVersion, platformName: PLATFORM_NAME_IOS};
+      await expect(getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath))
+        .to.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${platformVersion}.xctestrun`));
       sandbox.assert.notCalled(fs.copyFile);
     });
 
@@ -88,38 +84,36 @@ describe('utils', function () {
         )
         .resolves();
 
-      const deviceInfo = {isRealDevice: false, udid, platformVersion};
-      await getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath)
-        .should.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${platformVersion}.xctestrun`));
+      const deviceInfo: DeviceInfo = {isRealDevice: false, udid, platformVersion, platformName: PLATFORM_NAME_IOS};
+      await expect(getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath))
+        .to.eventually.equal(path.resolve(`${bootstrapPath}/${udid}_${platformVersion}.xctestrun`));
     });
 
     it('should raise an exception because of no files', async function () {
       const expected = path.resolve(`${bootstrapPath}/WebDriverAgentRunner_iphonesimulator${sdkVersion}-${get_arch()}.xctestrun`);
       sandbox.stub(fs, 'exists').resolves(false);
 
-      const deviceInfo = {isRealDevice: false, udid, platformVersion};
+      const deviceInfo: DeviceInfo = {isRealDevice: false, udid, platformVersion, platformName: PLATFORM_NAME_IOS};
       try {
         await getXctestrunFilePath(deviceInfo, sdkVersion, bootstrapPath);
         fail();
-      } catch (err) {
-        err.message.should.equal(`If you are using 'useXctestrunFile' capability then you need to have a xctestrun file (expected: '${expected}')`);
+      } catch (err: any) {
+        expect(err.message).to.equal(`If you are using 'useXctestrunFile' capability then you need to have a xctestrun file (expected: '${expected}')`);
       }
     });
   });
 
   describe('#getAdditionalRunContent', function () {
     it('should return ios format', function () {
       const wdaPort = getAdditionalRunContent(PLATFORM_NAME_IOS, 8000);
-      wdaPort.WebDriverAgentRunner
-        .EnvironmentVariables.USE_PORT
-        .should.equal('8000');
+      expect(wdaPort.WebDriverAgentRunner
+        .EnvironmentVariables.USE_PORT).to.equal('8000');
     });
 
     it('should return tvos format', function () {
       const wdaPort = getAdditionalRunContent(PLATFORM_NAME_TVOS, '9000');
-      wdaPort.WebDriverAgentRunner_tvOS
-        .EnvironmentVariables.USE_PORT
-        .should.equal('9000');
+      expect(wdaPort.WebDriverAgentRunner_tvOS
+        .EnvironmentVariables.USE_PORT).to.equal('9000');
     });
   });
 
@@ -129,34 +123,35 @@ describe('utils', function () {
 
     it('should return ios format, real device', function () {
       const platformName = 'iOs';
-      const deviceInfo = {isRealDevice: true, udid, platformVersion, platformName};
+      const deviceInfo: DeviceInfo = {isRealDevice: true, udid, platformVersion, platformName};
 
-      getXctestrunFileName(deviceInfo, '10.2.0').should.equal(
+      expect(getXctestrunFileName(deviceInfo, '10.2.0')).to.equal(
         'WebDriverAgentRunner_iphoneos10.2.0-arm64.xctestrun');
     });
 
     it('should return ios format, simulator', function () {
       const platformName = 'ios';
-      const deviceInfo = {isRealDevice: false, udid, platformVersion, platformName};
+      const deviceInfo: DeviceInfo = {isRealDevice: false, udid, platformVersion, platformName};
 
-      getXctestrunFileName(deviceInfo, '10.2.0').should.equal(
+      expect(getXctestrunFileName(deviceInfo, '10.2.0')).to.equal(
         `WebDriverAgentRunner_iphonesimulator10.2.0-${get_arch()}.xctestrun`);
     });
 
     it('should return tvos format, real device', function () {
       const platformName = 'tVos';
-      const deviceInfo = {isRealDevice: true, udid, platformVersion, platformName};
+      const deviceInfo: DeviceInfo = {isRealDevice: true, udid, platformVersion, platformName};
 
-      getXctestrunFileName(deviceInfo, '10.2.0').should.equal(
+      expect(getXctestrunFileName(deviceInfo, '10.2.0')).to.equal(
         'WebDriverAgentRunner_tvOS_appletvos10.2.0-arm64.xctestrun');
     });
 
     it('should return tvos format, simulator', function () {
       const platformName = 'tvOS';
-      const deviceInfo = {isRealDevice: false, udid, platformVersion, platformName};
+      const deviceInfo: DeviceInfo = {isRealDevice: false, udid, platformVersion, platformName};
 
-      getXctestrunFileName(deviceInfo, '10.2.0').should.equal(
+      expect(getXctestrunFileName(deviceInfo, '10.2.0')).to.equal(
         `WebDriverAgentRunner_tvOS_appletvsimulator10.2.0-${get_arch()}.xctestrun`);
     });
   });
 });
+
diff --git a/test/unit/webdriveragent-specs.ts b/test/unit/webdriveragent-specs.ts
diff --git a/tsconfig.json b/tsconfig.json
