remoting/webapp/js_proto/chrome_mocks.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // This file contains various mock objects for the chrome platform to make
   6 // unit testing easier.
   7
   8 var chromeMocks = {};
   9
  10 (function(){
  11
  12 'use strict'
  13
  14 /**
  15  * @constructor
  16  * @extends {ChromeEvent}
  17  */
  18 chromeMocks.Event = function() {
  19   this.listeners_ = [];
  20 };
  21
  22 /** @param {Function} callback */
  23 chromeMocks.Event.prototype.addListener = function(callback) {
  24   this.listeners_.push(callback);
  25 };
  26
  27 /** @param {Function} callback */
  28 chromeMocks.Event.prototype.removeListener = function(callback) {
  29   for (var i = 0; i < this.listeners_.length; i++) {
  30     if (this.listeners_[i] === callback) {
  31       this.listeners_.splice(i, 1);
  32       break;
  33     }
  34   }
  35 };
  36
  37 /**
  38  * @param {...*} var_args
  39  * @return {void}
  40  */
  41 chromeMocks.Event.prototype.mock$fire = function(var_args) {
  42   var params = Array.prototype.slice.call(arguments);
  43   this.listeners_.forEach(
  44       /** @param {Function} listener */
  45       function(listener){
  46         listener.apply(null, params);
  47       });
  48 };
  49
  50 /** @type {Object} */
  51 chromeMocks.runtime = {};
  52
  53 /** @constructor */
  54 chromeMocks.runtime.Port = function() {
  55   /** @const */
  56   this.onMessage = new chromeMocks.Event();
  57
  58   /** @const */
  59   this.onDisconnect = new chromeMocks.Event();
  60
  61   /** @type {string} */
  62   this.name = '';
  63
  64   /** @type {MessageSender} */
  65   this.sender = null;
  66 };
  67
  68 chromeMocks.runtime.Port.prototype.disconnect = function() {};
  69
  70 /**
  71  * @param {Object} message
  72  */
  73 chromeMocks.runtime.Port.prototype.postMessage = function(message) {};
  74
  75 /** @type {chromeMocks.Event} */
  76 chromeMocks.runtime.onMessage = new chromeMocks.Event();
  77
  78 /**
  79  * @param {string?} extensionId
  80  * @param {*} message
  81  * @param {function(*)=} responseCallback
  82  */
  83 chromeMocks.runtime.sendMessage = function(extensionId, message,
  84                                            responseCallback) {
  85   base.debug.assert(
  86       extensionId === null,
  87       'The mock only supports sending messages to the same extension.');
  88   extensionId = chrome.runtime.id;
  89   window.requestAnimationFrame(function() {
  90     var message_copy = base.deepCopy(message);
  91     chromeMocks.runtime.onMessage.mock$fire(
  92         message_copy, {id: extensionId}, responseCallback);
  93   });
  94 };
  95
  96 /**
  97  * Always returns the same mock port for given application name.
  98  * @param {string} application
  99  * @return {chromeMocks.runtime.Port}
 100  */
 101 chromeMocks.runtime.connectNative = function(application) {
 102   var port = nativePorts[application];
 103   if (port === undefined) {
 104     port = new chromeMocks.runtime.Port();
 105     port.name = application;
 106     nativePorts[application] = port;
 107   }
 108   return port;
 109 };
 110
 111 /** @const {Object<string,!chromeMocks.runtime.Port>} */
 112 var nativePorts = null;
 113
 114 /** @type {string} */
 115 chromeMocks.runtime.id = 'extensionId';
 116
 117 /** @type {Object} */
 118 chromeMocks.runtime.lastError = {
 119   /** @type {string|undefined} */
 120   message: undefined
 121 };
 122
 123
 124 // Sample implementation of chrome.StorageArea according to
 125 // https://developer.chrome.com/apps/storage#type-StorageArea
 126 /** @constructor */
 127 chromeMocks.StorageArea = function() {
 128   /** @type {Object} */
 129   this.storage_ = {};
 130 };
 131
 132 /**
 133  * @param {!Object} keys
 134  * @return {Array<string>}
 135  */
 136 function getKeys(keys) {
 137   if (typeof keys === 'string') {
 138     return [keys];
 139   } else if (typeof keys === 'object') {
 140     return Object.keys(keys);
 141   }
 142   return [];
 143 }
 144
 145 /**
 146  * @param {!Object} keys
 147  * @param {Function} onDone
 148  */
 149 chromeMocks.StorageArea.prototype.get = function(keys, onDone) {
 150   if (!keys) {
 151     onDone(base.deepCopy(this.storage_));
 152     return;
 153   }
 154
 155   var result = (typeof keys === 'object') ? keys : {};
 156   getKeys(keys).forEach(
 157       /** @param {string} key */
 158       function(key) {
 159         if (key in this.storage_) {
 160           result[key] = base.deepCopy(this.storage_[key]);
 161         }
 162       }, this);
 163   onDone(result);
 164 };
 165
 166 /** @param {Object} value */
 167 chromeMocks.StorageArea.prototype.set = function(value) {
 168   for (var key in value) {
 169     this.storage_[key] = base.deepCopy(value[key]);
 170   }
 171 };
 172
 173 /**
 174  * @param {!Object} keys
 175  */
 176 chromeMocks.StorageArea.prototype.remove = function(keys) {
 177   getKeys(keys).forEach(
 178       /** @param {string} key */
 179       function(key) {
 180         delete this.storage_[key];
 181       }, this);
 182 };
 183
 184 chromeMocks.StorageArea.prototype.clear = function() {
 185   this.storage_ = null;
 186 };
 187
 188 /** @type {Object} */
 189 chromeMocks.storage = {};
 190
 191 /** @type {chromeMocks.StorageArea} */
 192 chromeMocks.storage.local = new chromeMocks.StorageArea();
 193
 194
 195 /** @constructor */
 196 chromeMocks.Identity = function() {
 197   /** @private {string|undefined} */
 198   this.token_ = undefined;
 199 };
 200
 201 /**
 202  * @param {Object} options
 203  * @param {function(string=):void} callback
 204  */
 205 chromeMocks.Identity.prototype.getAuthToken = function(options, callback) {
 206   // Append the 'scopes' array, if present, to the dummy token.
 207   var token = this.token_;
 208   if (token !== undefined && options['scopes'] !== undefined) {
 209     token += JSON.stringify(options['scopes']);
 210   }
 211   // Don't use setTimeout because sinon mocks it.
 212   window.requestAnimationFrame(callback.bind(null, token));
 213 };
 214
 215 /** @param {string} token */
 216 chromeMocks.Identity.prototype.mock$setToken = function(token) {
 217   this.token_ = token;
 218 };
 219
 220 chromeMocks.Identity.prototype.mock$clearToken = function() {
 221   this.token_ = undefined;
 222 };
 223
 224 /** @type {chromeMocks.Identity} */
 225 chromeMocks.identity;
 226
 227
 228 /** @constructor */
 229 chromeMocks.I18n = function() {};
 230
 231 /**
 232  * @param {string} messageName
 233  * @param {(string|Array<string>)=} opt_args
 234  * @return {string}
 235  */
 236 chromeMocks.I18n.prototype.getMessage = function(messageName, opt_args) {};
 237
 238 /**
 239  * @return {string}
 240  */
 241 chromeMocks.I18n.prototype.getUILanguage = function() {};
 242
 243 /** @constructor */
 244 chromeMocks.WindowManager = function() {};
 245
 246 chromeMocks.WindowManager.prototype.current = function() {
 247   return new chromeMocks.AppWindow();
 248 };
 249
 250 /** @constructor */
 251 chromeMocks.AppWindow = function() {};
 252
 253 var originals_ = null;
 254
 255 /**
 256  * Activates a list of Chrome components to mock
 257  */
 258 chromeMocks.activate = function() {
 259   if (originals_) {
 260     throw new Error('chromeMocks.activate() can only be called once.');
 261   }
 262   originals_ = {};
 263   nativePorts = {};
 264
 265   chromeMocks.i18n = new chromeMocks.I18n();
 266   chromeMocks.identity = new chromeMocks.Identity();
 267
 268   ['identity', 'i18n', 'runtime', 'storage'].forEach(
 269     function(/** string */ component) {
 270       if (!chromeMocks[component]) {
 271         throw new Error('No mocks defined for chrome.' + component);
 272       }
 273       originals_[component] = chrome[component];
 274       chrome[component] = chromeMocks[component];
 275     });
 276
 277   chrome.app['window'] = new chromeMocks.WindowManager();
 278 };
 279
 280 chromeMocks.restore = function() {
 281   if (!originals_) {
 282     throw new Error('You must call activate() before restore().');
 283   }
 284   for (var components in originals_) {
 285     chrome[components] = originals_[components];
 286   }
 287   originals_ = null;
 288   nativePorts = null;
 289 };
 290
 291 })();