gecko/testing/tests/l10n/extensions/coverage/chrome/content/coverage.js

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org l10n testing.
 *
 * The Initial Developer of the Original Code is
 * Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2066
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Axel Hecht <l10n@mozilla.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/**
 * Basic architecture for UI exposure tests
 *
 * Details on http://wiki.mozilla.org/SoftwareTesting:Tools:L10n:Coverage
 */

var Ci = Components.interfaces;
var Cc = Components.classes;
var Cr = Components.results;

var ios = Cc["@mozilla.org/network/io-service;1"].getService(Ci.nsIIOService);
var ds = Cc[NS_DIRECTORY_SERVICE_CONTRACTID].getService(Ci.nsIProperties);
const WM = Cc["@mozilla.org/appshell/window-mediator;1"].getService(Ci.nsIWindowMediator);

/**
 * Global Stack object
 *
 * This object keeps the tests running with some time for visual inspection.
 */
var Stack = {
  _stack: [],
  _time: 250,
  _timer: Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer),
  notify: function _notify(aTimer) {
    this.pop();
  },
  push: function _push(aItem) {
    this._stack.push(aItem);
    if (this._stack.length == 1) {
      this._timer.initWithCallback({notify:function (aTimer) {Stack.pop();}},
                                   this._time, 1);
    }
  },
  pop: function _pop() {
    var obj = this._stack.pop();
    try {
      obj.method.apply(obj, obj.args);
    } catch (e) {
      Components.utils.reportError(e);
    }
    if (!this._stack.length) {
      this._timer.cancel();
    }
  }
};
/**
 * Add your test set to toRun.
 * The onload handler will add them to the Stack and kick off the
 * testing.
 */
var toRun = [];

/**
 * Utility to get array of xpcom objects from a nsISimpleEnumerator
 * Requires JS1.7
 */
function SimpleGenerator(enumr, interface) {
  while (enumr.hasMoreElements()) {
    yield enumr.getNext().QueryInterface(interface);
  }
}

var wins = [w for (w in SimpleGenerator(WM.getEnumerator(null), Ci.nsIDOMWindow))];

/**
 * Helper items to log start and end of testing to the Error Console
 */
function MsgBase() {
}
MsgBase.prototype = {
  args: [],
  method: function() {
    Components.utils.reportError(this._msg);
  }
};
function TestStart(aCat) {
  this._msg = 'TESTING:START:COVERAGE:' + aCat;
}
TestStart.prototype = new MsgBase;
function TestDone(aCat) {
  this._msg = 'TESTING:DONE:COVERAGE:' + aCat;
}
TestDone.prototype = new MsgBase;

/**
 * onload handler for the entry page.
 * Copy the toRun items over to the stack and kick things off.
 */
function onLoad() {
  for each (var obj in toRun) {
    Stack.push(obj);
  }
}