appium/test/helpers/session.js

"use strict";
var env = require('./env')
  , wd = require("wd")
  , Q = require("q")
  , _ = require("underscore")
  , androidUninstall = require('./reset').androidUninstall;

require('colors');

wd.configureHttp(env.HTTP_CONFIG);

var trimToLength = function (str, length) {
  return (str && str.length > length) ?
    str.substring(0, length) + '...' : str;
};

module.exports.initSession = function (desired, opts) {
  desired = desired || {};
  opts = opts || {};

  var deferred = Q.defer(),
      browser,
      initialized;

  wd.addPromiseChainMethod('clickBack', function () {
    var backEl;
    return this.elementByNameOrNull('Back')
    .then(function (el) {
      if (el) {
        backEl = el;
        return el.isDisplayed();
      } else return false;
    })
    .then(function (isDisplayed) {
      if (isDisplayed) {
        return backEl.click();
      }
    });
  });

  wd.addPromiseChainMethod('clickButton', function (name) {
    var buttonEl;
    return this.elementByXPathOrNull("//UIAButton[@name = '" + name + "']")
    .then(function (el) {
      if (el) {
        buttonEl = el;
        return el.isDisplayed();
      } else return false;
    })
    .then(function (isDisplayed) {
      if (isDisplayed) {
        return buttonEl.click();
      }
    });
  });

  wd.addPromiseChainMethod('printSource', function () {
    return this.source().then(function (s) { console.log(s); });
  });

  return {
    setUp: function (name) {
      if (env.VERBOSE) {
        console.log("env.APPIUM_HOST -->", env.APPIUM_HOST);
        console.log("env.APPIUM_PORT -->", env.APPIUM_PORT);
      }
      browser = wd.promiseChainRemote(env.APPIUM_HOST, env.APPIUM_PORT, env.APPIUM_USERNAME, env.APPIUM_PASSWORD);
      if (env.SAUCE_REST_ROOT) browser.sauceRestRoot = env.SAUCE_REST_ROOT;
      if (env.VERBOSE) {
        var MAX_DATA_LENGTH = 500;
        browser.on('status', function (info) {
          console.log(info.cyan);
        });
        browser.on('command', function (eventType, command, response) {
          console.log(' > ' + eventType.cyan, command, (trimToLength(response, MAX_DATA_LENGTH) || '').grey);
        });
        browser.on('http', function (meth, path, data) {
          console.log(' > ' + meth.magenta, path, (trimToLength(data, MAX_DATA_LENGTH) || '').grey);
        });
      }
      if (env.DEBUG_CONNECTION) {
        browser.on('connection', function (message) {
          console.log('connection > ' + message );
        });
      }
      deferred.resolve(browser);
      var caps = _.clone(desired);
      _.defaults(caps, env.CAPS);

      if (env.SAUCE) {
        if (env.APPIUM_JOB_NUMBER) name = '[' + env.APPIUM_JOB_NUMBER + '] ' + name;
        if (name) caps.name = name.replace(/@[^\s]*/,'');
        if (env.APPIUM_BUILD_NUMBER) caps.build = env.APPIUM_BUILD_NUMBER;
        if (opts['expect-error']){
          caps.tags.push('expect-error');
        }
        caps['max-duration'] = 600;
        if (caps['appium-version']){
          // locking cap list
          caps['appium-version']['filter-caps'] = _(caps).keys();
        }
      }

      if (env.VERBOSE) console.log("caps -->", caps);
      if (env.VERBOSE) console.log("opts -->", opts);

      function init(remainingAttempts) {
        if (env.VERBOSE) console.log("remainingAttempts -->", remainingAttempts);
        return browser
          .init(caps)
          .catch(function (err) {
            if (env.VERBOSE) console.log("Init failed with error -->", err);
            remainingAttempts --;
            if (remainingAttempts === 0) {
              throw err;
            } else {
              return browser.sleep(10000).then(function () {
                return init(remainingAttempts);
              });
            }
          });
      }
      var attempts = opts['no-retry'] ? 1 : 3;
      if (env.MAX_RETRY) attempts = Math.min(env.MAX_RETRY, attempts);
      return browser.chain()
        .then(function () {
          // if android uninstall package first
          if (!env.SAUCE && desired.platformName === 'Android' && desired.appPackage) {
            // TODO this should not be necessary
            return androidUninstall(desired.appPackage);
          }
        }).then(function () { return init(attempts); })
        .then(function () {
          initialized = true;
          browser._origCaps = caps;
        })
        .setImplicitWaitTimeout(env.IMPLICIT_WAIT_TIMEOUT);
    },
    tearDown: function (passed) {
      return browser.chain()
        .then(function () {
          if (initialized && !opts['no-quit']) {
            return browser
              .quit()
              .catch(function () {
                if (env.VERBOSE) console.warn("didn't quit cleanly.");
              });
          }
        }).then(function () {
          if (env.SAUCE) return browser.sauceJobStatus(passed);
        })
        .catch(function (err) { console.warn("didn't manange to set sauce status. error:", err); })
        .sleep(3000);
    },
    promisedBrowser: deferred.promise
  };
};

module.exports.attachToSession = function (sessionId) {
  var browser = wd.promiseChainRemote(env.APPIUM_HOST, env.APPIUM_PORT, env.APPIUM_USERNAME, env.APPIUM_PASSWORD);
  browser.attach(sessionId);
  return browser;
};