Publish Vulpes Preview 15 sources for desktop, Android and Tundra

Share Gaia assets and adapters, keep private profiles and development documents local, and update both public READMEs.

gaia/tests/jsmarionette/runner/marionette-js-runner/lib/runtime/hostmanager.js

@@ -0,0 +1,172 @@
+'use strict';
+var Logger = require('marionette-js-logger');
+var Marionette = require('marionette-client');
+var Promise = require('promise');
+var debug = require('debug')('marionette-js-runner:hostmanager');
+var prettyjson = require('prettyjson');
+
+/**
+ * @constructor
+ */
+function HostManager() {
+  this.plugins = [];
+}
+
+
+HostManager.prototype = {
+  /**
+   * Adds a plugin to the stack of plugins.
+   *
+   * @param {String} name of plugin.
+   * @param {Function} plugin function to invoke.
+   * @param {Object} options for plugin.
+   */
+  addPlugin: function(name, plugin, options) {
+    var plugins = this.plugins;
+    suiteSetup(function() {
+      plugins.push({ plugin: plugin, name: name, options: options });
+    });
+
+    suiteTeardown(function() {
+      plugins.pop();
+    });
+  },
+
+  /**
+   * Setup a host inside of the current execution context.
+   * @param {Object} options an options object that contains:
+   *                         {Object} profile settings for host.
+   *                         {Object} driver for marionette.
+   *                         {Object} desired capabilities for mariontte
+   * @return {Marionette.Client} instance of a client.
+   */
+  createHost: function(options) {
+    options = options || {};
+    var profile = options.profile || {};
+    var driver = options.driver || Marionette.Drivers.TcpSync;
+    var desiredCapabilities = options.desiredCapabilities ||
+      this.desiredCapabilities;
+
+    debug('create host', profile);
+
+    // rpc interfaces created...
+    var host, session, profileBuilder;
+
+    var client = new Marionette.Client(null, { lazy: true });
+    var plugins = this.plugins;
+    var verbose = this.verbose;
+    if (verbose) {
+      this.addPlugin('logger', Logger);
+    }
+
+    suiteSetup(function() {
+      var ctx = this;
+      return this.runner.createHost().then(function(_host) {
+        host = _host;
+        // client is tacked on mostly for error handling.
+        host.client = client;
+        ctx.hosts.push(host);
+      });
+    });
+
+    setup(function() {
+      var driverInstance;
+      var pluginReferences = {};
+      var createdProfileConfig;
+
+      return this.runner.createProfile(profile)
+        .then(function(_profileBuilder) {
+          profileBuilder = _profileBuilder;
+          return profileBuilder.getConfig();
+        })
+        .then(function(_createdProfileConfig) {
+          host.profileConfig = createdProfileConfig = _createdProfileConfig;
+          return host.createSession(
+            createdProfileConfig, profile.hostOptions
+          );
+        })
+        .then(function(_session) {
+          session = _session;
+          host.session = session;
+
+          // build object with all plugins
+          plugins.forEach(function(plugin) {
+            pluginReferences[plugin.name] = {
+              plugin: plugin.plugin,
+              options: plugin.options
+            };
+          });
+
+          driverInstance = new driver({
+            port: createdProfileConfig.port,
+            // XXX: make configurable
+            connectionTimeout: (60 * 1000) * 5 // 5 minutes
+          });
+
+          return Promise.denodeify(
+            driverInstance.connect.bind(driverInstance)
+          )();
+        })
+        .then(function() {
+          client.resetWithDriver(driverInstance);
+
+          for (var name in pluginReferences) {
+            debug('add plugin', name);
+            // remove old plugin reference
+            delete client[name];
+
+            // setup new plugin
+            client.plugin(
+              name,
+              pluginReferences[name].plugin,
+              pluginReferences[name].options
+            );
+          }
+
+          if (verbose) {
+            client.logger.pollMessages();
+            client.logger.on('message', function(msg) {
+              console.log(prettyjson.render(msg) + '\n');
+            });
+          }
+
+          return new Promise(function(accept) {
+            client.startSession(accept, desiredCapabilities);
+          });
+        });
+    });
+
+    // turn off the client
+    teardown(function() {
+      if (verbose) {
+        // Ensure all messages are drained before shutting down.
+        client.logger.grabLogMessages();
+      }
+
+      var deleteSession = Promise.denodeify(client.deleteSession.bind(client));
+      return deleteSession()
+      .then(function() {
+        return session.destroy();
+      })
+      .catch(function() {
+        // If something goes wrong during teardown we probably don't care
+        // since we've already run the test? We're swallowing this to ignore
+        // cases where we do a bad job of closing a marionette connection
+        // and then fail a test as in
+        // https://bugzilla.mozilla.org/show_bug.cgi?id=1104285
+      });
+    });
+
+    suiteTeardown(function() {
+      if (typeof host.destroy === 'function') {
+        return host.destroy();
+      }
+    });
+
+    return client;
+  }
+
+};
+
+// expose host manager.
+module.exports.HostManager = HostManager;