Support WebDriverAgentRunner-Runner.app

[ilendemli]

Hey!
First of all, thank you for this project. We are in the process of replacing appium-device-farm with GADS.
I saw you are providing a fork of WebDriverAgent. I usually like to build the runner from source by passing our code-signing information to xcodebuild. This results in a .app package as you know.
I can install this directly using ideviceinstaller but GADS requires an ipa file. If I package the app package into an ipa, then the installation fails because of missing signature (even though the app package itself is signed properly).
We use this with appium-device-farm already but we would appreciate it, if you could also support .app packages from a path or something instead of uploading an ipa. Installing the app package using ideviceinstaller works fine.
Best regards

[shamanec]

Hey @ilendemli ! GADS has been working for a while with ipa file for WebDriverAgent without issues. Since the .app is essentially a folder it will be tough storing it in MongoDB the way the ipa is being stored. How are you packaging it into an ipa, maybe the issue lies there? :)

[ilendemli]

Maybe storing the path in the database in this case if the selection has the .app extension, or a separate field in the interface to use a path instead could be a solution. I packaged the .app the same way you do in your workflow file, removed the frameworks, created Payload folder, copied the app over, then compressed to WebDriverAgent.ipa, all from terminal.

➜  Desktop ideviceinstaller install WebDriverAgent.ipa
WARNING: could not locate iTunesMetadata.plist in archive!
WARNING: could not locate Payload/WebDriverAgentRunner-Runner.app/SC_Info/WebDriverAgentRunner-Runner.sinf in archive!
Copying 'WebDriverAgent.ipa' to device... DONE.
Installing '<redacted>.xctrunner'
Install: CreatingStagingDirectory (5%)
Install: ExtractingPackage (15%)
Install: InspectingPackage (20%)
Install: PreflightingApplication (30%)
Install: VerifyingApplication (40%)ERROR: Install failed. Got error "ApplicationVerificationFailed" with code 0xe8008017: Failed to verify code signature of /var/installd/Library/Caches/com.apple.mobile.installd.staging/temp.CfJzN8/extracted/Payload/WebDriverAgent.app : 0xe8008017 (A signed resource has been added, modified, or deleted.)

➜  Desktop ideviceinstaller install WebDriverAgentRunner-Runner-10.40.2.app 
Uploading WebDriverAgentRunner-Runner-10.40.2.app package contents... DONE.
Installing '<redacted>.xctrunner'
Install: CreatingStagingDirectory (5%)
Install: ExtractingPackage (15%)
Install: InspectingPackage (20%)
Install: PreflightingApplication (30%)
Install: VerifyingApplication (40%)
Install: CreatingContainer (50%)
Install: InstallingApplication (60%)
Install: PostflightingApplication (70%)
Install: SandboxingApplication (80%)
Install: GeneratingApplicationMap (90%)
Install: InstallComplete (100%)
Install: Complete

EDIT: I think removing the XC*Frameworks breaks the signature if packaged as .ipa but works fine as .app

[shamanec]

Exactly, when you build from Xcode it creates the app package with the proper signing, but when you remove the XC*Frameworks it changes the signature which means you have to resign the ipa after that. You can just package it without removing the frameworks or resign it using a tool like zsign :)

[ilendemli]

However it is suggested to remove the Frameworks from the package: https://github.com/appium/appium-xcuitest-driver/blob/master/docs/guides/run-preinstalled-wda.md#additional-requirement-for-iostvos-17

Would appreciate this change, and could help you test it out on my end.

[shamanec]

This is suggested when Appium is the one starting WebDriverAgent, in GADS case WDA is started by GADS itself through go-ios using testmanagerd and it doesn't really matter if the Frameworks are not removed. I can still probably add support for app but it will require the package to be uploaded as a zip through the Admin panel so it is a single file, then provider will download and extract the zip and install it as app. For the moment you should not worry about creating the ipa with the Frameworks included 👌
Edit: Also it seems this will break iOS < 17 devices because they do not have the frameworks included with the Developer Disk Image ( if you have such devices at all )

[ilendemli]

Zipped app sounds good! 👌 We support iOS 16+ in our App but our grid has only iOS 18+ devices.