Improve Appium support in Nightwatch

lib/runner/cli/cli.js

@@ -469,8 +469,11 @@ class CliRunner {
         let promise = Promise.resolve();
 
         if (this.test_settings.selenium && this.test_settings.selenium.start_process) {
-          const SeleniumServer = require('../../transport/selenium-webdriver/selenium.js');
-          this.seleniumService = SeleniumServer.startServer(this.test_settings);
+          const Server = this.test_settings.selenium.use_appium
+            ? require('../../transport/selenium-webdriver/appium.js')
+            : require('../../transport/selenium-webdriver/selenium.js');
+
+          this.seleniumService = Server.startServer(this.test_settings);
           promise = this.seleniumService.init();
           this.test_settings.selenium['[_started]'] = true;
         }

lib/settings/defaults.js

@@ -146,7 +146,7 @@ module.exports = {
     start_process: false,
     cli_args: {},
     server_path: null,
-    log_path: '',
+    log_path: './logs',
     port: undefined,
     check_process_delay: 500,
     max_status_poll_tries: 15,

lib/transport/factory.js

@@ -49,7 +49,21 @@ module.exports = class TransportFactory {
     let {browserName} = settings.desiredCapabilities;
 
     // Better support for Appium, if the browserName has explicitly been set to null we can skip all further checks
+    if (settings.selenium && settings.selenium.use_appium && !browserName) {
+      return browserName;
+    }
+
+    // for backward compatibility
     if (browserName === null) {
+      // TODO:
+      // Deprecation warning: Setting browserName to null for running Appium tests has
+      // now been deprecated and will be removed from future versions. Set `use_appium`
+      // property to true in `selenium` config to run Appium tests.
+      // 
+      // put a warning here that if trying to connect to an Appium server,
+      // just setting browserName=null will not work in the future.
+      settings.selenium.use_appium = true;
+
       return browserName;
     }
 
@@ -92,15 +106,14 @@ module.exports = class TransportFactory {
     }
 
     if (usingSeleniumServer) {
-      const Selenium = require('./selenium-webdriver/selenium.js');
-
-      // support for mobile native apps
-      if (browserName === null) {
-        const Mobile = require('./selenium-webdriver/mobile-webdriver.js');
+      if (nightwatchInstance.settings.selenium.use_appium) {
+        const Appium = require('./selenium-webdriver/appium.js');
 
-        return new Mobile(nightwatchInstance);
+        return new Appium(nightwatchInstance, browserName);
       }
 
+      const Selenium = require('./selenium-webdriver/selenium.js');
+
       return new Selenium(nightwatchInstance, browserName);
     }
 

lib/transport/selenium-webdriver/appium.js

@@ -0,0 +1,102 @@
+const path = require('path');
+const {WebDriver} = require('selenium-webdriver');
+const {Executor} = require('selenium-webdriver/http');
+const TransportFactory = require('../factory');
+const SeleniumServer = require('./selenium');
+const AppiumServiceBuilder = require('./service-builders/appium');
+const http = require('selenium-webdriver/http');
+const {isObject} = require('../../utils');
+
+
+module.exports = class AppiumServer extends SeleniumServer {
+  static startServer(settings) {
+    const Options = require('./options.js');
+    const opts = new Options({settings});
+    opts.updateWebdriverPath();
+
+    const appiumService = new AppiumServiceBuilder(settings);
+
+    const outputFile = settings.webdriver.log_file_name || '';
+    appiumService.setOutputFile(outputFile);
+
+    return appiumService;
+  }
+
+  get defaultBrowser() {
+    return null;
+  }
+
+  get ServiceBuilder() {
+    return AppiumServiceBuilder;
+  }
+
+  get defaultServerUrl() {
+    return 'http://127.0.0.1:4723';
+  }
+
+  get defaultPort() {
+    return 4723;
+  }
+
+  get defaultPathPrefix() {
+    return '/wd/hub';
+  }
+
+  createSessionOptions(argv) {
+    // TODO: Re-think the below temp solution
+    if (TransportFactory.usingBrowserstack(this.settings)) {
+      return super.createSessionOptions(argv);
+    }
+
+    const options = this.desiredCapabilities;
+
+    // break 'appium:options' to individual configs
+    if (isObject(options['appium:options'])) {
+      const appiumOptions = options['appium:options'];
+      for (let key of Object.keys(appiumOptions)) {
+        const value = appiumOptions[key];
+
+        if (!key.startsWith('appium:')) {
+          key = `appium:${key}`;
+        }
+        options[key] = value;
+      }
+
+      delete options['appium:options'];
+    }
+
+    const isRelativePath = (value) => {
+      if (typeof value !== 'string') {
+        return false;
+      }
+
+      return value.startsWith('./') || value.startsWith('../');
+    };
+
+    // convert relative paths to absolute paths
+    for (const key of Object.keys(options)) {
+      if (key.startsWith('appium:') && isRelativePath(options[key])) {
+        options[key] = path.resolve(options[key]);
+      }
+    }
+
+    // if `appium:chromedriverExecutable` is present and left blank,
+    // assign the path of binary from `chromedriver` NPM package to it.
+    if (options['appium:chromedriverExecutable'] === '') {
+      const chromedriver = this.seleniumCapabilities.getChromedriverPath();
+      if (chromedriver) {
+        options['appium:chromedriverExecutable'] = chromedriver;
+      }
+    }
+
+    return options;
+  }
+
+  createDriver({options = this.desiredCapabilities} = {}) {
+    const httpClient = new http.HttpClient(this.getServerUrl());
+
+    const session = WebDriver.createSession(new Executor(httpClient), options);
+
+    return session;
+  }
+};

lib/transport/selenium-webdriver/browserstack.js

@@ -1,6 +1,6 @@
 const stripAnsi = require('strip-ansi');
 const {Logger} = require('../../utils');
-const BaseDriver = require('./mobile-webdriver.js');
+const BaseDriver = require('./appium.js');
 const defaultsDeep = require('lodash.defaultsdeep');
 
 class Browserstack extends BaseDriver {

lib/transport/selenium-webdriver/index.js

@@ -193,17 +193,14 @@ class Transport extends BaseTransport {
 
   async createDriverService({options, moduleKey, reuseBrowser = false}) {
     try {
+      moduleKey = this.settings.webdriver.log_file_name || moduleKey || '';
 
       if (!this.shouldReuseDriverService(reuseBrowser)) {
         Transport.driverService = new this.ServiceBuilder(this.settings);
         await Transport.driverService.setOutputFile(reuseBrowser ? 'test' : moduleKey).init(options);
       }
 
       this.driverService = Transport.driverService;
-
-      moduleKey = this.settings.webdriver.log_file_name || moduleKey || '';
-
-      Transport.driverService = this.driverService;
     } catch (err) {
       this.showConnectSpinner(colors.red(`Failed to start ${this.serviceName}.`), 'warn');
 

lib/transport/selenium-webdriver/options.js

@@ -243,10 +243,20 @@ module.exports = class SeleniumCapabilities {
     }
   }
 
+  getAppiumPath() {
+    return require.resolve('appium');
+  }
+
   updateWebdriverPath() {
     if (this.shouldSetupWebdriver()) {
       try {
         if (this.usingSeleniumServer()) {
+          if (this.settings.selenium.use_appium) {
+            this.settings.selenium.server_path = this.settings.webdriver.server_path = this.getAppiumPath();
+
+            return this;
+          }
+
           this.settings.selenium.server_path = this.settings.webdriver.server_path = require('@nightwatch/selenium-server').path;
           this.settings.selenium.cli_args = this.settings.selenium.cli_args || {};
 

lib/transport/selenium-webdriver/selenium.js

@@ -1,5 +1,5 @@
 const DefaultSeleniumDriver = require('./');
-const SeleniumServerBuilder = require('./service-builders/selenium.js');
+const SeleniumServiceBuilder = require('./service-builders/selenium.js');
 
 module.exports = class SeleniumServer extends DefaultSeleniumDriver {
   /**
@@ -10,21 +10,20 @@ module.exports = class SeleniumServer extends DefaultSeleniumDriver {
     const opts = new Options({settings});
     opts.updateWebdriverPath();
 
-    const seleniumService = new SeleniumServerBuilder(settings);
-    const moduleKey = settings.webdriver.log_file_name || '';
+    const seleniumService = new SeleniumServiceBuilder(settings);
 
-    seleniumService.setOutputFile(moduleKey);
+    const outputFile = settings.webdriver.log_file_name || '';
+    seleniumService.setOutputFile(outputFile);
 
     return seleniumService;
-
   }
 
   get defaultBrowser() {
     return 'firefox';
   }
 
   get ServiceBuilder() {
-    return SeleniumServerBuilder;
+    return SeleniumServiceBuilder;
   }
 
   get defaultServerUrl() {

lib/transport/selenium-webdriver/service-builders/appium.js

@@ -0,0 +1,98 @@
+const {SeleniumServer, DriverService} = require('selenium-webdriver/remote');
+const {getFreePort} = require('../../../utils');
+const BaseService = require('./base-service.js');
+
+class AppiumService extends DriverService {
+  constructor(server_path, opt_options) {
+    const options = opt_options || {};
+    const {args, default_path_prefix} = options;
+
+    const port = options.port;
+    if (port !== AppiumServiceBuilder.defaultPort && !args.includes('--port')) {
+      args.unshift('--port', port);
+    }
+
+    let cmd = 'node';
+    if (server_path.startsWith('appium')) {
+      cmd = server_path;
+    } else {
+      args.unshift(server_path);
+    }
+
+    super(cmd, {
+      loopback: options.loopback,
+      port,
+      args,
+      path: default_path_prefix,
+      env: options.env,
+      stdio: options.stdio
+    });
+  }
+}
+
+class AppiumServiceBuilder extends BaseService {
+  static get serviceName() {
+    return 'Appium Server';
+  }
+
+  static get defaultPort() {
+    return 4723;
+  }
+
+  get npmPackageName() {
+    return 'appium';
+  }
+
+  get outputFile() {
+    return this._outputFile + '_appium-server.log';
+  }
+
+  get defaultPort() {
+    return AppiumServiceBuilder.defaultPort;
+  }
+
+  get serviceName() {
+    return 'Appium Server';
+  }
+
+  get downloadMessage() {
+    return 'install Appium globally with "npm i -g appium" command, \n and set ' +
+      '"selenium.server_path" config option to "appium".';
+  }
+
+  /**
+   * @param {Capabilities} opts
+   * @returns {Promise<void>}
+   */
+  async createService(opts = {}) {
+    const {port} = this;
+    const options = new SeleniumServer.Options();
+    options.port = port || await getFreePort();
+    const {server_path, default_path_prefix = '/wd/hub'} = this.settings.webdriver;
+
+    const introMsg = `Starting Appium Server on port ${options.port}...`;
+
+    if (opts.showSpinner) {
+      opts.showSpinner(`${introMsg}\n\n`);
+    } else {
+      // eslint-disable-next-line
+      console.info(introMsg);
+    }
+
+    // TODO: read the log_path and add it to cliArgs
+    // above TODO is copied from ./selenium.js
+    options.args = this.cliArgs;
+    options.default_path_prefix = default_path_prefix;
+
+    if (this.hasSinkSupport() && this.needsSinkProcess()) {
+      this.createSinkProcess();
+      options.stdio = ['pipe', this.process.stdin, this.process.stdin];
+    }
+
+    this.service = new AppiumService(server_path, options);
+
+    return this.service.start();
+  }
+}
+
+module.exports = AppiumServiceBuilder;

lib/transport/selenium-webdriver/service-builders/base-service.js

@@ -359,7 +359,7 @@ class BaseService {
           return resolve();
         }
 
-        Logger.info(`Wrote log file to: ${filePath}.`);
+        Logger.info(`Wrote log file to: ${filePath}`);
         this.stopped = true;
         resolve();
       });

test/lib/mocks/mocks-w3c.yaml

@@ -103,7 +103,6 @@ mocks:
       firstMatch: [{}]
       alwaysMatch:
         appium:automationName: "XCUITest"
-        appium:app: "../samples/Wikipedia.app"
         appium:appPackage: "org.wikimedia.wikipedia"
         platformName: "iOS"
         appium:deviceName: "iPhone 13"
@@ -113,7 +112,6 @@ mocks:
       sessionId: '13521-10219-202'
       capabilities:
         appium:automationName: "XCUITest"
-        appium:app: "../samples/Wikipedia.app"
         appium:appPackage: "org.wikimedia.wikipedia"
         platformName: "iOS"
         appium:deviceName: "iPhone 13"