Add a possibility to shutdown other running Simulators on session sta…

…rtup (appium#600)

* Add a possibility to shutdown other running Simulators on session startup

* Tune logging

README.md

@@ -155,6 +155,7 @@ Differences noted here
 |`absoluteWebLocations`|This capability will direct the `Get Element Location` command, when used within webviews, to return coordinates which are relative to the origin of the page, rather than relative to the current scroll offset. This capability has no effect outside of webviews. Default `false`.|e.g., `true`|
 |`simulatorWindowCenter`|Allows to explicitly set the coordinates of Simulator window center for Xcode9+ SDK. This capability only has an effect if Simulator window has not been opened yet for the current session before it started.|e.g. `{-100.0,100.0}` or `{500,500}`, spaces are not allowed|
 |`useJSONSource`|Get JSON source from WDA and parse into XML on Appium server. This can be much faster, especially on large devices. Defaults to `false`.|e.g., `true`|
+|`shutdownOtherSimulators`|If this capability set to `true` and the current device under test is an iOS Simulator then Appium will try to shutdown all the other running Simulators before to start a new session. This might be useful while executing webview tests on different devices, since only one device can be debugged remotely at once due to an Apple bug. The capability only has an effect if `--relaxed-security` command line argument is provided to the server. Defaults to `false`.|e.g. `true`|
 
 ## Development<a id="development"></a>
 

lib/desired-caps.js

@@ -125,7 +125,10 @@ let desiredCapConstraints = _.defaults({
   },
   useJSONSource: {
     isBoolean: true
-  }
+  },
+  shutdownOtherSimulators: {
+    isBoolean: true
+  },
 }, iosDesiredCapConstraints);
 
 export { desiredCapConstraints };

lib/driver.js

@@ -4,7 +4,8 @@ import _ from 'lodash';
 import { launch } from 'node-simctl';
 import WebDriverAgent from './wda/webdriveragent';
 import log from './logger';
-import { createSim, getExistingSim, runSimulatorReset, installToSimulator } from './simulator-management';
+import { createSim, getExistingSim, runSimulatorReset, installToSimulator,
+         shutdownOtherSimulators } from './simulator-management';
 import { simExists, getSimulator, installSSLCert, uninstallSSLCert } from 'appium-ios-simulator';
 import { retryInterval } from 'asyncbox';
 import { settings as iosSettings, defaultServerCaps, appUtils, IWDP } from 'appium-ios-driver';
@@ -296,6 +297,14 @@ class XCUITestDriver extends BaseDriver {
     log.info(`Setting up ${this.isRealDevice() ? 'real device' : 'simulator'}`);
 
     if (this.isSimulator()) {
+      if (this.opts.shutdownOtherSimulators) {
+        if (!this.relaxedSecurityEnabled) {
+          log.errorAndThrow(`Appium server must have relaxed security flag set in order ` +
+                            `for 'shutdownOtherSimulators' capability to work`);
+        }
+        await shutdownOtherSimulators(this.opts.device);
+      }
+
       this.localeConfig = await iosSettings.setLocale(this.opts.device, this.opts, {}, this.isSafari());
       await iosSettings.setPreferences(this.opts.device, this.opts, this.isSafari());
       // Cleanup of installd cache helps to save disk space while running multiple tests

lib/simulator-management.js

@@ -1,9 +1,10 @@
 import path from 'path';
 import { getSimulator } from 'appium-ios-simulator';
-import { createDevice, getDevices, terminate } from 'node-simctl';
+import { createDevice, getDevices, terminate, shutdown } from 'node-simctl';
 import { resetXCTestProcesses } from './utils';
 import _ from 'lodash';
 import log from './logger';
+import B from 'bluebird';
 
 // returns sim for desired caps
 async function createSim (caps, sessionId) {
@@ -94,5 +95,16 @@ async function installToSimulator (device, app, bundleId, noReset = true) {
   log.debug('The app has been installed successfully.');
 }
 
+async function shutdownOtherSimulators (currentDevice) {
+  const allDevices = await getDevices();
+  const otherBootedDevices = allDevices.filter((device) => device.udid !== currentDevice.udid && device.state === 'Booted');
+  if (!otherBootedDevices.length) {
+    log.info('No other running simulators have been detected');
+    return;
+  }
+  log.info(`Detected ${otherBootedDevices.length} other running Simulator${otherBootedDevices.length === 1 ? '' : 's'}.` +
+           `Shutting ${otherBootedDevices.length === 1 ? 'it' : 'them'} down...`);
+  await B.each(otherBootedDevices, async (device) => await shutdown(device.udid));
+}
 
-export { createSim, getExistingSim, runSimulatorReset, installToSimulator };
+export { createSim, getExistingSim, runSimulatorReset, installToSimulator, shutdownOtherSimulators };