feat: Add mobile endpoints to run XCTest #1205
Conversation
dpgraham
changed the title
There was a problem hiding this comment.
It would be good to add commands in https://github.com/appium/appium/blob/master/commands-yml/commands/mobile-command.yml after this merge :)
|
Changes pushed. |
|
More changes pushed. |
lib/commands/xctest.js
Outdated
| * @property {string} testName Name of the test (e.g.: 'XCTesterAppUITests - XCTesterAppUITests.XCTesterAppUITests/testExample') | ||
| * @property {boolean} passed Did the tests pass? | ||
| * @property {boolean} crashed Did the tests crash? | ||
| * @property {number} duration How long did the tests take (in seconds) |
There was a problem hiding this comment.
are these float seconds?
There was a problem hiding this comment.
I don't know, but a JS number can be an integer or a float.
There was a problem hiding this comment.
it's more about the downstream API. Usually Apple stuff uses NSTimeInterval type to describe duration and this is represented in float seconds, which means that the precision is fine for milliseconds as well and digits after the decimal point are not ignored.
lib/commands/xctest.js
Outdated
| * @property {boolean} crashed Did the tests crash? | ||
| * @property {number} duration How long did the tests take (in seconds) | ||
| * @property {string} failureMessage Failure message (if applicable) | ||
| * @property {number} location |
There was a problem hiding this comment.
There was no documentation on it, so not sure.
lib/commands/xctest.js
Outdated
| /** | ||
| * @typedef {Object} RunXCUITestOptions | ||
| * | ||
| * @property {string!} testRunnerBundleId Test app bundle (e.g.: 'io.appium.XCTesterAppUITests.xctrunner') |
There was a problem hiding this comment.
the exclamation mark should be the prefix: {!string}
lib/commands/xctest.js
Outdated
| /** | ||
| * List XCTests in a test bundle | ||
| * | ||
| * @param {string!} bundle Bundle ID |
There was a problem hiding this comment.
The method should also accept opts
| /** | ||
| * @typedef {Object} InstallXCTestBundleOpts | ||
| * | ||
| * @property {xctestApp} xctestBundle Path of the XCTest app (URL or .app) |
There was a problem hiding this comment.
@property {!string} xctestApp ...
|
Another push. The IDB failure is unrelated to this PR, I'll need to make a separate PR to fix it. |
lib/commands/xctest.js
Outdated
|
|
||
| /** | ||
| * Run an XCTest. Launches a subprocess that runs the XC Test and blocks | ||
| * until it is complete. Throws an exception if the subprocess fails. |
There was a problem hiding this comment.
I would rather move these descriptions into @throws and @returns tags
Add a feature that allows users to run XCTests (requires IDB installed an
launchWithIdbcapability to be set).Justification
This is useful primarily for cloud users of Appium, as it will allow iOS testers to run their XCTests against a grid of iOS devices (simulators/real). The only requirement for the cloud provider will be that they need to have IDB installed on their machines.