appium-mac2-driver 1.7.3 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.8.0](https://github.com/appium/appium-mac2-driver/compare/v1.7.4...v1.8.0) (2023-09-08)
+
+
+### Features
+
+* add appPath to handleCreateSession ([#230](https://github.com/appium/appium-mac2-driver/issues/230)) ([7b7cc17](https://github.com/appium/appium-mac2-driver/commit/7b7cc17f267e909f38fd210dea6652281679d662))
+
+## [1.7.4](https://github.com/appium/appium-mac2-driver/compare/v1.7.3...v1.7.4) (2023-08-28)
+
+
+### Miscellaneous Chores
+
+* **deps-dev:** bump conventional-changelog-conventionalcommits ([#226](https://github.com/appium/appium-mac2-driver/issues/226)) ([6417dc6](https://github.com/appium/appium-mac2-driver/commit/6417dc6b24461a0f83e2e9ae156f323d999f767b))
+
 ## [1.7.3](https://github.com/appium/appium-mac2-driver/compare/v1.7.2...v1.7.3) (2023-08-25)
 
 

package/README.md

@@ -24,6 +24,7 @@ On top of standard Appium requirements Mac2 driver also expects the following pr
 - macOS 10.15 or later
     - macOS 11.3 or later and less than macOS 12, and Xcode 12 combination does not work as the build failure
 - Xcode 12 or later should be installed
+    - `xcode-select` should be pointing to `<full_path_to_xcode_app>/Contents/Developer` developer directory instead of `/Library/Developer/CommandLineTools` to run `xcodebuild` commands
 - Xcode Helper app should be enabled for Accessibility access. The app itself could be usually found at `/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/Library/Xcode/Agents/Xcode Helper.app`. In order to enable Accessibility access for it simply open the parent folder in Finder: `open /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/Library/Xcode/Agents/` and drag & drop the `Xcode Helper` app to `Security & Privacy -> Privacy -> Accessibility` list of your `System Preferences`. This action must only be done once.
 - `testmanagerd` proccess requires UIAutomation authentication since macOS 12. `automationmodetool enable-automationmode-without-authentication` command may help to disable it. This may be particularly useful in CI environments. [Apple forum thread](https://developer.apple.com/forums/thread/693850).
 
@@ -47,6 +48,7 @@ appium:skipAppKill | Whether to skip the termination of the application under te
 appium:prerun | An object containing either `script` or `command` key. The value of each key must be a valid AppleScript script or command to be executed prior to the Mac2Driver session startup. See [AppleScript commands execution](#applescript-commands-execution) for more details. Example: `{command: 'do shell script "echo hello"'}`
 appium:postrun | An object containing either `script` or `command` key. The value of each key must be a valid AppleScript script or command to be executed after Mac2Driver session is stopped. See [AppleScript commands execution](#applescript-commands-execution) for more details.
 appium:noReset | Whether to restart the app whose bundle identifier was passed to capabilities as `bundleId` value if it was already running on the session startup (`false`, the default value) or just pick it up without changing the app state (`true`). Note that neither of `arguments` or `environment` capabilities will take effect if the app did not restart.
+appium:appPath | The path to the application to automate, for example `/Applications/MyAppName.app`. This is an optional capability, but it requires `bundleId` to be present. If `bundleId` is empty, `appPath` will be ignored. If the path is invalid or application is damaged/incomplete then an error will be thrown on session startup. This capability could be usefull when you have multiple builds of the same application with the same bundleId on your machine (for example one production build in /Applications/ and several dev builds). If you provide bundleId only, the operating system could open any of these builds. By providing `appPath` you have a guarantee that the specified .app will be launched, rather than a random one.
 
 
 ## Element Attributes

package/WebDriverAgentMac/WebDriverAgentLib/Commands/FBSessionCommands.m

@@ -17,6 +17,7 @@
 #import "FBRouteRequest.h"
 #import "FBSession.h"
 #import "FBRuntimeUtils.h"
+#import "XCUIApplication.h"
 #import "XCUIApplication+AMHelpers.h"
 #import "XCUIApplication+AMUIInterruptions.h"
 
@@ -87,7 +88,10 @@ const static NSString *CAPABILITIES_KEY = @"capabilities";
   if (nil == bundleID) {
     session = [FBSession initWithApplication:nil];
   } else {
-    XCUIApplication *app = [[XCUIApplication alloc] initWithBundleIdentifier:bundleID];
+    NSString *appPath = requirements[AM_APP_PATH_CAPABILITY];
+    XCUIApplication *app = appPath == nil ?
+      [[XCUIApplication alloc] initWithBundleIdentifier:bundleID] :
+      [[XCUIApplication alloc] initPrivateWithPath:appPath bundleID:bundleID];
     session = [FBSession initWithApplication:app];
     if (noReset && app.state > XCUIApplicationStateNotRunning) {
       [app activate];

package/WebDriverAgentMac/WebDriverAgentLib/PrivateHeaders/XCTest/XCUIApplication.h

@@ -0,0 +1,12 @@
+
+#import <XCTest/XCTest.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIApplication (InitPrivateWithPath)
+
+- (id)initPrivateWithPath:(id)path bundleID:(id)bundleId;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/AMSessionCapabilities.h

@@ -23,5 +23,6 @@ extern NSString* const AM_APP_ARGUMENTS_CAPABILITY;
 extern NSString* const AM_APP_ENVIRONMENT_CAPABILITY;
 extern NSString* const AM_SKIP_APP_KILL_CAPABILITY;
 extern NSString* const AM_NO_RESET_CAPABILITY;
+extern NSString* const AM_APP_PATH_CAPABILITY;
 
 NS_ASSUME_NONNULL_END

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/AMSessionCapabilities.m

@@ -21,3 +21,4 @@ NSString* const AM_APP_ARGUMENTS_CAPABILITY = @"arguments";
 NSString* const AM_APP_ENVIRONMENT_CAPABILITY = @"environment";
 NSString* const AM_SKIP_APP_KILL_CAPABILITY = @"skipAppKill";
 NSString* const AM_NO_RESET_CAPABILITY = @"noReset";
+NSString* const AM_APP_PATH_CAPABILITY = @"appPath";

package/WebDriverAgentMac/WebDriverAgentMac.xcodeproj/project.pbxproj

@@ -190,6 +190,7 @@
 		71B8B68126726369009CE50C /* AMSwipeHelpers.h in Headers */ = {isa = PBXBuildFile; fileRef = 71B8B67F26726369009CE50C /* AMSwipeHelpers.h */; };
 		71B8B68226726369009CE50C /* AMSwipeHelpers.m in Sources */ = {isa = PBXBuildFile; fileRef = 71B8B68026726369009CE50C /* AMSwipeHelpers.m */; };
 		71B8B684267265D7009CE50C /* AMVariousElementTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 71B8B683267265D7009CE50C /* AMVariousElementTests.m */; };
+		C68B934B2AA892CF009F00F2 /* XCUIApplication.h in Headers */ = {isa = PBXBuildFile; fileRef = C68B934A2AA892CF009F00F2 /* XCUIApplication.h */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -424,6 +425,7 @@
 		71B8B67F26726369009CE50C /* AMSwipeHelpers.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AMSwipeHelpers.h; sourceTree = "<group>"; };
 		71B8B68026726369009CE50C /* AMSwipeHelpers.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AMSwipeHelpers.m; sourceTree = "<group>"; };
 		71B8B683267265D7009CE50C /* AMVariousElementTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = AMVariousElementTests.m; sourceTree = "<group>"; };
+		C68B934A2AA892CF009F00F2 /* XCUIApplication.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = XCUIApplication.h; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -766,6 +768,7 @@
 				7180C1E6257A94F3008FA870 /* XCPointerEventPath.h */,
 				7180C1EC257A95C2008FA870 /* XCSynthesizedEventRecord.h */,
 				7180C1F6257A9896008FA870 /* XCUIEventSynthesizing-Protocol.h */,
+				C68B934A2AA892CF009F00F2 /* XCUIApplication.h */,
 			);
 			path = XCTest;
 			sourceTree = "<group>";
@@ -875,6 +878,7 @@
 				7109C0532565B5EA006BFD13 /* HTTPErrorResponse.h in Headers */,
 				7180C1E9257A94F4008FA870 /* XCPointerEvent.h in Headers */,
 				712FA091288BD68100976DA8 /* AMWindowCommands.h in Headers */,
+				C68B934B2AA892CF009F00F2 /* XCUIApplication.h in Headers */,
 				7180C1ED257A95C2008FA870 /* XCSynthesizedEventRecord.h in Headers */,
 				718D2C322567FED3005F533B /* AMSessionCapabilities.h in Headers */,
 				7109BFE02565B536006BFD13 /* FBCommandHandler.h in Headers */,

package/build/lib/desired-caps.d.ts

@@ -46,5 +46,9 @@ export namespace desiredCapConstraints {
         let isString_3: boolean;
         export { isString_3 as isString };
     }
+    namespace appPath {
+        let isString_4: boolean;
+        export { isString_4 as isString };
+    }
 }
 //# sourceMappingURL=desired-caps.d.ts.map

package/build/lib/desired-caps.js

@@ -40,6 +40,9 @@ const desiredCapConstraints = {
     },
     webDriverAgentMacUrl: {
         isString: true
+    },
+    appPath: {
+        isString: true
     }
 };
 exports.desiredCapConstraints = desiredCapConstraints;

package/build/lib/desired-caps.js.map

@@ -1 +1 @@
-{"version":3,"file":"desired-caps.js","sourceRoot":"","sources":["../../lib/desired-caps.js"],"names":[],"mappings":";;;AAAA,MAAM,qBAAqB,GAAG;IAC5B,UAAU,EAAE;QACV,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,SAAS,EAAE,IAAI;KAChB;IACD,aAAa,EAAE;QACb,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,IAAI;KACf;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,OAAO,EAAE,IAAI;KACd;IACD,WAAW,EAAE;QACX,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,SAAS,EAAE,IAAI;KAChB;IACD,WAAW,EAAE;QACX,SAAS,EAAE,IAAI;KAChB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEO,sDAAqB"}
+{"version":3,"file":"desired-caps.js","sourceRoot":"","sources":["../../lib/desired-caps.js"],"names":[],"mappings":";;;AAAA,MAAM,qBAAqB,GAAG;IAC5B,UAAU,EAAE;QACV,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,SAAS,EAAE,IAAI;KAChB;IACD,aAAa,EAAE;QACb,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,IAAI;KACf;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,OAAO,EAAE,IAAI;KACd;IACD,WAAW,EAAE;QACX,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,SAAS,EAAE,IAAI;KAChB;IACD,WAAW,EAAE;QACX,SAAS,EAAE,IAAI;KAChB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,QAAQ,EAAE,IAAI;KACf;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEO,sDAAqB"}

package/build/lib/driver.d.ts

@@ -67,6 +67,9 @@ export class Mac2Driver extends BaseDriver<any, import("@appium/types").StringRe
         webDriverAgentMacUrl: {
             isString: boolean;
         };
+        appPath: {
+            isString: boolean;
+        };
     };
     settings: DeviceSettings<{}>;
     onSettingsUpdate(key: any, value: any): Promise<unknown>;

package/build/lib/driver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../lib/driver.js"],"names":[],"mappings":";;AAoBA;IAOE;;;;;;;;;;;;;;;;;MAAmC;IAEnC,uBAyBC;IAjCD,sBAAsB;IACtB,eADW,OAAO,CACJ;IAEd,8EAA8E;IAC9E,8BADmB;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAC,KAAK,QAAQ,MAAM,CAAC,CACrD;IAOnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAkD;IAiBlD,6BAAwE;IAO1E,yDAIC;IAED,mBAKC;IAJC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAAe;IACf,iBAAuB;IAEvB,qBAA2B;IAI7B,qCAEC;IAGD,0EAEC;IAED,oBAEC;IAED,mEAEC;IAGD,8BAEC;IAGD,6FAwBC;IAED,+BAwBC;CACF;;2BA/I0C,eAAe;+BAAf,eAAe"}
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../lib/driver.js"],"names":[],"mappings":";;AAoBA;IAOE;;;;;;;;;;;;;;;;;MAAmC;IAEnC,uBAyBC;IAjCD,sBAAsB;IACtB,eADW,OAAO,CACJ;IAEd,8EAA8E;IAC9E,8BADmB;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAC,KAAK,QAAQ,MAAM,CAAC,CACrD;IAOnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAkD;IAiBlD,6BAAwE;IAO1E,yDAIC;IAED,mBAKC;IAJC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAAe;IACf,iBAAuB;IAEvB,qBAA2B;IAI7B,qCAEC;IAGD,0EAEC;IAED,oBAEC;IAED,mEAEC;IAGD,8BAEC;IAGD,6FAwBC;IAED,+BAwBC;CACF;;2BA/I0C,eAAe;+BAAf,eAAe"}

package/lib/desired-caps.js

@@ -37,6 +37,9 @@ const desiredCapConstraints = {
   },
   webDriverAgentMacUrl: {
     isString: true
+  },
+  appPath: {
+    isString: true
   }
 };
 

package/package.json

@@ -6,7 +6,7 @@
     "mac",
     "XCTest"
   ],
-  "version": "1.7.3",
+  "version": "1.8.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -90,7 +90,7 @@
     "@typescript-eslint/parser": "^5.62.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
-    "conventional-changelog-conventionalcommits": "^6.0.0",
+    "conventional-changelog-conventionalcommits": "^7.0.1",
     "eslint": "^8.46.0",
     "eslint-config-prettier": "^8.9.0",
     "eslint-import-resolver-typescript": "^3.5.5",