Add enforceFreshSimulatorCreation capability
#859
Conversation
There was a problem hiding this comment.
to me 'use' is a bit ambiguous, and could potentially mean "if there's a new simulator that already exists, then use it". where what this is really doing is always creating a new sim. maybe something like createSimForSession, createNewSim, makeFreshSim, or similar?
how about |
| if (!this.opts.platformVersion && this.iosSdkVersion) { | ||
| log.info(`No platformVersion specified. Using latest version Xcode supports: '${this.iosSdkVersion}' ` + | ||
| `This may cause problems if a simulator does not exist for this platform version.`); | ||
| this.opts.platformVersion = this.iosSdkVersion; | ||
| } | ||
|
|
||
| if (this.opts.noReset) { |
There was a problem hiding this comment.
don't we need to consider noReset?
There was a problem hiding this comment.
I honestly could not figure out how this block ever got run. The original code was:
let device = await getExistingSim(this.opts);
// check for an existing simulator
if (device) {
return {device, realDevice: false, udid: device.udid};
}
// no device of this type exists, so create one
log.info('Simulator udid not provided, using desired caps to create a new simulator');
if (!this.opts.platformVersion && this.iosSdkVersion) {
log.info(`No platformVersion specified. Using latest version Xcode supports: '${this.iosSdkVersion}' ` +
`This may cause problems if a simulator does not exist for this platform version.`);
this.opts.platformVersion = this.iosSdkVersion;
}
if (this.opts.noReset) {
// Check for existing simulator just with correct capabilities
let device = await getExistingSim(this.opts);
if (device) {
return {device, realDevice: false, udid: device.udid};
}
}Which means the noReset section is only different in that the platformVersion, if empty, has been set to the Xcode default.
There was a problem hiding this comment.
I assume the idea behind this is that we never wanted to create a new simulator if noReset it set. Although, I don't mind the current approach
There was a problem hiding this comment.
I'll put it back in, since it actually seems to have a use (#520). Needs to be documented in the code, though, since it is unclear.
There was a problem hiding this comment.
Though I actually think moving the platformVersion check up a little is a better solution.
| @@ -17,7 +19,7 @@ const INSTALL_DAEMON_CACHE = 'com.apple.mobile.installd.staging'; | |||
| * @returns {object} Simulator object associated with the udid passed in. | |||
| */ | |||
| async function createSim (caps) { | |||
| const appiumTestDeviceName = `appiumTest-${caps.deviceName}`; | |||
| const appiumTestDeviceName = `appiumTest-${UUID.create().toString().toUpperCase()}-${caps.deviceName}`; | |||
imurchie
changed the title
enforceFreshSimulatorCreation capability
| @@ -734,6 +734,12 @@ class XCUITestDriver extends BaseDriver { | |||
| return {device, realDevice: true, udid: this.opts.udid}; | |||
| } | |||
|
|
|||
| if (!this.opts.platformVersion && this.iosSdkVersion) { | |||
| log.info(`No platformVersion specified. Using latest version Xcode supports: '${this.iosSdkVersion}' ` + | |||
* Add useNewSimulator capability * Change cap name to 'enforceFreshSimulatorCreation' * Move platformVersion check in determinDevice
If the system on which Appium is being run has no simulator with the required platform version and name, Appium will create one, and then delete it at the end of the session. If there is a simulator, though, it will just use it, which can cause problems (see appium/appium#12025).
This PR introduces a capability,
useNewSimulator, which will force the use of a new sim if no UDID is specified in the caps.