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  * @suppress {reportUnknownTypes}
  41  */
  42 chromeMocks.Event.prototype.mock$fire = function(var_args) {
  43   var params = Array.prototype.slice.call(arguments);
  44   this.listeners_.forEach(
  45       /** @param {Function} listener */
  46       function(listener){
  47         listener.apply(null, params);
  48       });
  49 };
  50
  51 /** @type {Object} */
  52 chromeMocks.runtime = {};
  53
  54 /** @constructor */
  55 chromeMocks.runtime.Port = function() {
  56   /** @const */
  57   this.onMessage = new chromeMocks.Event();
  58
  59   /** @const */
  60   this.onDisconnect = new chromeMocks.Event();
  61
  62   /** @type {string} */
  63   this.name = '';
  64
  65   /** @type {MessageSender} */
  66   this.sender = null;
  67 };
  68
  69 chromeMocks.runtime.Port.prototype.disconnect = function() {};
  70
  71 /**
  72  * @param {Object} message
  73  */
  74 chromeMocks.runtime.Port.prototype.postMessage = function(message) {};
  75
  76 /** @type {chromeMocks.Event} */
  77 chromeMocks.runtime.onMessage = new chromeMocks.Event();
  78
  79
  80 /** @type {chromeMocks.Event} */
  81 chromeMocks.runtime.onSuspend = new chromeMocks.Event();
  82
  83 /**
  84  * @param {string?} extensionId
  85  * @param {*} message
  86  * @param {function(*)=} responseCallback
  87  */
  88 chromeMocks.runtime.sendMessage = function(extensionId, message,
  89                                            responseCallback) {
  90   console.assert(
  91       extensionId === null,
  92       'The mock only supports sending messages to the same extension.');
  93   extensionId = chrome.runtime.id;
  94   Promise.resolve().then(function() {
  95     var message_copy = base.deepCopy(message);
  96     chromeMocks.runtime.onMessage.mock$fire(
  97         message_copy, {id: extensionId}, responseCallback);
  98   });
  99 };
 100
 101 /**
 102  * Always returns the same mock port for given application name.
 103  * @param {string} application
 104  * @return {chromeMocks.runtime.Port}
 105  */
 106 chromeMocks.runtime.connectNative = function(application) {
 107   var port = nativePorts[application];
 108   if (port === undefined) {
 109     port = new chromeMocks.runtime.Port();
 110     port.name = application;
 111     nativePorts[application] = port;
 112   }
 113   return port;
 114 };
 115
 116 /** @const {Object<!chromeMocks.runtime.Port>} */
 117 var nativePorts = null;
 118
 119 /** @type {string} */
 120 chromeMocks.runtime.id = 'extensionId';
 121
 122 /** @type {Object} */
 123 chromeMocks.runtime.lastError = {
 124   /** @type {string|undefined} */
 125   message: undefined
 126 };
 127
 128 chromeMocks.runtime.getManifest = function() {
 129   return {
 130     version: 10,
 131     app: {
 132       background: true
 133     }
 134   };
 135 };
 136
 137 // Sample implementation of chrome.StorageArea according to
 138 // https://developer.chrome.com/apps/storage#type-StorageArea
 139 /**
 140  * @constructor
 141  * @extends {StorageArea}
 142  */
 143 chromeMocks.StorageArea = function() {
 144   /** @type {!Object} */
 145   this.storage_ = {};
 146 };
 147
 148 /**
 149  * @param {Object|string} keys
 150  * @return {Array<string>}
 151  */
 152 function getKeys(keys) {
 153   if (typeof keys === 'string') {
 154     return [keys];
 155   } else if (typeof keys === 'object') {
 156     var objectKeys = /** @type {!Object} */ (keys);
 157     return Object.keys(objectKeys);
 158   }
 159   return [];
 160 }
 161
 162 chromeMocks.StorageArea.prototype.get = function(keys, onDone) {
 163   if (!keys) {
 164     // No keys are specified, returns the entire storage.
 165     var storageCopy = base.deepCopy(this.storage_);
 166     onDone(/** @type {Object} */ (storageCopy));
 167     return;
 168   }
 169
 170   var result = (typeof keys === 'object') ? keys : {};
 171   getKeys(keys).forEach(
 172       /** @param {string} key */
 173       function(key) {
 174         if (key in this.storage_) {
 175           result[key] = base.deepCopy(this.storage_[key]);
 176         }
 177       }, this);
 178   onDone(result);
 179 };
 180
 181 chromeMocks.StorageArea.prototype.set = function(value, opt_onDone) {
 182   for (var key in value) {
 183     this.storage_[key] = base.deepCopy(value[key]);
 184   }
 185   if (opt_onDone) {
 186     opt_onDone();
 187   }
 188 };
 189
 190 chromeMocks.StorageArea.prototype.remove = function(keys, opt_onDone) {
 191   getKeys(keys).forEach(
 192       /** @param {string} key */
 193       function(key) {
 194         delete this.storage_[key];
 195       }, this);
 196   if (opt_onDone) {
 197     opt_onDone();
 198   }
 199 };
 200
 201 /** @return {!Object} */
 202 chromeMocks.StorageArea.prototype.mock$getStorage = function() {
 203   return this.storage_;
 204 };
 205
 206 chromeMocks.StorageArea.prototype.clear = function() {
 207   this.storage_ = {};
 208 };
 209
 210 /** @type {Object} */
 211 chromeMocks.storage = {};
 212
 213 /** @type {chromeMocks.StorageArea} */
 214 chromeMocks.storage.local = new chromeMocks.StorageArea();
 215
 216
 217 /** @constructor */
 218 chromeMocks.Identity = function() {
 219   /** @private {string|undefined} */
 220   this.token_ = undefined;
 221 };
 222
 223 /**
 224  * @param {Object} options
 225  * @param {function(string=):void} callback
 226  */
 227 chromeMocks.Identity.prototype.getAuthToken = function(options, callback) {
 228   // Append the 'scopes' array, if present, to the dummy token.
 229   var token = this.token_;
 230   if (token !== undefined && options['scopes'] !== undefined) {
 231     token += JSON.stringify(options['scopes']);
 232   }
 233   // Don't use setTimeout because sinon mocks it.
 234   Promise.resolve().then(callback.bind(null, token));
 235 };
 236
 237 /** @param {string} token */
 238 chromeMocks.Identity.prototype.mock$setToken = function(token) {
 239   this.token_ = token;
 240 };
 241
 242 chromeMocks.Identity.prototype.mock$clearToken = function() {
 243   this.token_ = undefined;
 244 };
 245
 246 /** @type {chromeMocks.Identity} */
 247 chromeMocks.identity;
 248
 249 /** @constructor */
 250 chromeMocks.MetricsPrivate = function() {};
 251
 252 chromeMocks.MetricsPrivate.prototype.recordValue = function() {};
 253
 254 /** @type {chromeMocks.MetricsPrivate} */
 255 chromeMocks.metricsPrivate;
 256
 257 /** @constructor */
 258 chromeMocks.I18n = function() {};
 259
 260 /**
 261  * @param {string} messageName
 262  * @param {(string|Array<string>)=} opt_args
 263  * @return {string}
 264  */
 265 chromeMocks.I18n.prototype.getMessage = function(messageName, opt_args) {};
 266
 267 /**
 268  * @return {string}
 269  */
 270 chromeMocks.I18n.prototype.getUILanguage = function() {};
 271
 272 /** @constructor */
 273 chromeMocks.WindowManager = function() {
 274   this.current_ = new chromeMocks.AppWindow();
 275 };
 276
 277 chromeMocks.WindowManager.prototype.current = function() {
 278   return this.current_;
 279 };
 280
 281 /** @constructor */
 282 chromeMocks.AppWindow = function() {};
 283
 284 var originals_ = null;
 285
 286 /**
 287  * Activates a list of Chrome components to mock
 288  */
 289 chromeMocks.activate = function() {
 290   if (originals_) {
 291     throw new Error('chromeMocks.activate() can only be called once.');
 292   }
 293   originals_ = {};
 294   nativePorts = {};
 295
 296   chromeMocks.i18n = new chromeMocks.I18n();
 297   chromeMocks.identity = new chromeMocks.Identity();
 298   chromeMocks.metricsPrivate = new chromeMocks.MetricsPrivate();
 299
 300   ['identity', 'i18n', 'runtime', 'storage', 'metricsPrivate'].forEach(
 301     function(/** string */ component) {
 302       if (!chromeMocks[component]) {
 303         throw new Error('No mocks defined for chrome.' + component);
 304       }
 305       originals_[component] = chrome[component];
 306       chrome[component] = chromeMocks[component];
 307     });
 308
 309   chrome.app['window'] = new chromeMocks.WindowManager();
 310 };
 311
 312 chromeMocks.restore = function() {
 313   if (!originals_) {
 314     throw new Error('You must call activate() before restore().');
 315   }
 316   for (var components in originals_) {
 317     chrome[components] = originals_[components];
 318   }
 319   originals_ = null;
 320   nativePorts = null;
 321 };
 322
 323 })();