feat: Added support for macOS

Author: Feroz Khan

README.md

@@ -96,6 +96,11 @@ Get the latest version from `https://pub.dev/packages/appium_flutter_server/inst
       flutter build ipa --release integration_test/appium_test.dart
     ```
 
+7. Build the MacOS app:
+    ```bash
+    flutter build macos --release integration_test/appium_test.dart
+    ```
+
 Bingo! You are ready to run your tests using Appium Flutter Integration Driver.
 
 Check if your Flutter app is running on the device or emulator.

package.json

@@ -5,7 +5,7 @@
       "appium",
       "flutter"
    ],
-   "version": "1.4.1",
+   "version": "1.5.0",
    "author": "",
    "license": "MIT License",
    "repository": {
@@ -29,7 +29,8 @@
       "automationName": "FlutterIntegration",
       "platformNames": [
          "Android",
-         "iOS"
+         "iOS",
+         "Mac"
       ],
       "mainClass": "AppiumFlutterDriver",
       "flutterServerVersion": ">=0.0.18 <1.0.0"
@@ -98,6 +99,7 @@
       "appium-ios-device": "^2.7.20",
       "appium-uiautomator2-driver": "^4.1.5",
       "appium-xcuitest-driver": "9.1.2",
+      "appium-mac2-driver": "^2.2.2",
       "async-retry": "^1.3.3",
       "asyncbox": "^3.0.0",
       "bluebird": "^3.7.2",

src/commands/element.ts

@@ -2,6 +2,8 @@ import _ from 'lodash';
 import { getProxyDriver } from '../utils';
 import { JWProxy } from 'appium/driver';
 import { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
+// @ts-ignore
+import { XCUITestDriver } from 'appium-xcuitest-driver';
 import { W3C_ELEMENT_KEY } from 'appium/driver';
 import type { AppiumFlutterDriver } from '../driver';
 
@@ -16,13 +18,13 @@ export async function findElOrEls(
    const driver = await getProxyDriver.bind(this)(strategy);
    let elementBody;
    if (
-      !(driver instanceof JWProxy) &&
-      !(this.proxydriver instanceof AndroidUiautomator2Driver)
+      this.proxydriver instanceof AndroidUiautomator2Driver ||
+      this.proxydriver instanceof XCUITestDriver
    ) {
       elementBody = {
-         using: strategy,
-         value: selector,
-         context, //this needs be validated
+         strategy,
+         selector,
+         context,
       };
    } else {
       elementBody = {

src/desiredCaps.ts

@@ -7,7 +7,7 @@ export const desiredCapConstraints = {
       presence: true,
    },
    platformName: {
-      inclusionCaseInsensitive: ['iOS', 'Android'],
+      inclusionCaseInsensitive: ['iOS', 'Android', 'Mac'],
       isString: true,
       presence: true,
    },

src/driver.ts

@@ -10,6 +10,8 @@ type FlutterDriverConstraints = typeof desiredCapConstraints;
 // @ts-ignore
 import { XCUITestDriver } from 'appium-xcuitest-driver';
 import { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
+// @ts-ignore
+import { Mac2Driver } from 'appium-mac2-driver';
 import { createSession as createSessionMixin } from './session';
 import {
    findElOrEls,
@@ -55,7 +57,7 @@ const WEBVIEW_NO_PROXY = [
 
 export class AppiumFlutterDriver extends BaseDriver<FlutterDriverConstraints> {
    // @ts-ignore
-   public proxydriver: XCUITestDriver | AndroidUiautomator2Driver;
+   public proxydriver: XCUITestDriver | AndroidUiautomator2Driver | Mac2Driver;
    public flutterPort: number | null | undefined;
    private internalCaps: DriverCaps<FlutterDriverConstraints> | undefined;
    public proxy: JWProxy | undefined;
@@ -220,6 +222,9 @@ export class AppiumFlutterDriver extends BaseDriver<FlutterDriverConstraints> {
          this.currentContext === this.NATIVE_CONTEXT_NAME &&
          isFlutterDriverCommand(command)
       ) {
+         this.log.debug(
+            `executeCommand: command ${command} is flutter command using flutter driver`,
+         );
          return await super.executeCommand(command, ...args);
       } else {
          this.log.info(

src/macOS.ts

@@ -0,0 +1,30 @@
+import type { AppiumFlutterDriver } from './driver';
+// @ts-ignore
+import { Mac2Driver } from 'appium-mac2-driver';
+import type { InitialOpts } from '@appium/types';
+import { DEVICE_CONNECTIONS_FACTORY } from './iProxy';
+
+export async function startMacOsSession(
+   this: AppiumFlutterDriver,
+   ...args: any[]
+): Promise<Mac2Driver> {
+   this.log.info(`Starting an MacOs proxy session`);
+   const macOsDriver = new Mac2Driver({} as InitialOpts);
+   await macOsDriver.createSession(...args);
+   return macOsDriver;
+}
+
+export async function macOsPortForward(
+   udid: string,
+   systemPort: number,
+   devicePort: number,
+) {
+   await DEVICE_CONNECTIONS_FACTORY.requestConnection(udid, systemPort, {
+      usePortForwarding: true,
+      devicePort: devicePort,
+   });
+}
+
+export function macOsRemovePortForward(udid: string, systemPort: number) {
+   DEVICE_CONNECTIONS_FACTORY.releaseConnection(udid, systemPort);
+}

src/platform.ts

@@ -1,4 +1,5 @@
 export const PLATFORM = {
    IOS: 'ios',
    ANDROID: 'android',
+   MAC: 'mac',
 } as const;

src/session.ts

@@ -3,6 +3,7 @@ import _ from 'lodash';
 import { PLATFORM } from './platform';
 import { startAndroidSession } from './android';
 import { startIOSSession } from './iOS';
+import { startMacOsSession } from './macOS';
 import type { DefaultCreateSessionResult } from '@appium/types';
 
 export async function createSession(
@@ -28,6 +29,13 @@ export async function createSession(
             this.proxydriver.denyInsecure = this.denyInsecure;
             this.proxydriver.allowInsecure = this.allowInsecure;
             break;
+         case PLATFORM.MAC:
+            this.proxydriver = await startMacOsSession.bind(this)(...args);
+            this.proxydriver.relaxedSecurityEnabled =
+               this.relaxedSecurityEnabled;
+            this.proxydriver.denyInsecure = this.denyInsecure;
+            this.proxydriver.allowInsecure = this.allowInsecure;
+            break;
          default:
             this.log.errorWithException(
                `Unsupported platformName: ${caps.platformName}. ` +

src/utils.ts

@@ -1,4 +1,8 @@
 import { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
+// @ts-ignore
+import { XCUITestDriver } from 'appium-xcuitest-driver';
+// @ts-ignore
+import { Mac2Driver } from 'appium-mac2-driver';
 import { findAPortNotInUse } from 'portscanner';
 import { waitForCondition } from 'asyncbox';
 import { JWProxy } from '@appium/base-driver';
@@ -29,13 +33,28 @@ export async function getProxyDriver(
    strategy: string,
 ): Promise<JWProxy | undefined> {
    if (strategy.startsWith('-flutter') || FLUTTER_LOCATORS.includes(strategy)) {
+      this.log.debug(
+         `getProxyDriver: using flutter driver, strategy: ${strategy}`,
+      );
       return this.proxy;
    } else if (this.proxydriver instanceof AndroidUiautomator2Driver) {
+      this.log.debug(
+         'getProxyDriver: using AndroidUiautomator2Driver driver for Android',
+      );
       // @ts-ignore Proxy instance is OK
       return this.proxydriver.uiautomator2.jwproxy;
-   } else {
+   } else if (this.proxydriver instanceof XCUITestDriver) {
+      this.log.debug('getProxyDriver: using XCUITestDriver driver for iOS');
       // @ts-ignore Proxy instance is OK
       return this.proxydriver.wda.jwproxy;
+   } else if (this.proxydriver instanceof Mac2Driver) {
+      this.log.debug('getProxyDriver: using Mac2Driver driver for mac');
+      // @ts-ignore Proxy instance is OK
+      return this.proxydriver.wda.proxy;
+   } else {
+      throw new Error(
+         `proxydriver is unknown type (${typeof this.proxydriver})`,
+      );
    }
 }
 

test/unit/element.specs.ts

@@ -2,6 +2,10 @@
 import sinon from 'sinon';
 import * as utils from '../../src/utils';
 import { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
+// @ts-ignore
+import { XCUITestDriver } from 'appium-xcuitest-driver';
+// @ts-ignore
+import { Mac2Driver } from 'appium-mac2-driver';
 import { W3C_ELEMENT_KEY } from 'appium/driver';
 import {
    ELEMENT_CACHE,
@@ -137,6 +141,45 @@ describe('Element Interaction Functions', () => {
             }),
          ).to.be.true;
       });
+
+      it('should use different element body for XCUITestDriver', async () => {
+         mockAppiumFlutterDriver.proxydriver = new XCUITestDriver();
+
+         await findElOrEls.call(
+            mockAppiumFlutterDriver,
+            'strategy',
+            'selector',
+            false,
+            'context',
+         );
+
+         expect(
+            mockDriver.command.calledWith('/element', 'POST', {
+               strategy: 'strategy',
+               selector: 'selector',
+               context: 'context',
+            }),
+         ).to.be.true;
+      });
+
+      it('should use different element body for Mac2Driver', async () => {
+         mockAppiumFlutterDriver.proxydriver = new Mac2Driver();
+
+         await findElOrEls.call(
+            mockAppiumFlutterDriver,
+            'strategy',
+            'selector',
+            false,
+            'context',
+         );
+         expect(
+            mockDriver.command.calledWith('/element', 'POST', {
+               using: 'strategy',
+               value: 'selector',
+               context: 'context',
+            }),
+         ).to.be.true;
+      });
    });
 
    describe('click', () => {