gecko/dom/tests/browser/browser_ConsoleAPITests.js

399 lines
14 KiB
JavaScript

/* vim:set ts=2 sw=2 sts=2 et: */
/* ***** 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 DevTools test code.
*
* The Initial Developer of the Original Code is Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* David Dahl <ddahl@mozilla.com>
* Rob Campbell <rcampbell@mozilla.com>
* Mihai Sucan <mihai.sucan@gmail.com>
* Panos Astithas <past@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 ***** */
const TEST_URI = "http://example.com/browser/dom/tests/browser/test-console-api.html";
var gWindow, gLevel, gArgs;
function test() {
waitForExplicitFinish();
var tab = gBrowser.addTab(TEST_URI);
gBrowser.selectedTab = tab;
var browser = gBrowser.selectedBrowser;
registerCleanupFunction(function () {
gBrowser.removeTab(tab);
});
ConsoleObserver.init();
browser.addEventListener("DOMContentLoaded", function onLoad(event) {
browser.removeEventListener("DOMContentLoaded", onLoad, false);
executeSoon(function test_executeSoon() {
gWindow = browser.contentWindow;
consoleAPISanityTest();
observeConsoleTest();
});
}, false);
}
function testConsoleData(aMessageObject) {
let messageWindow = getWindowByWindowId(aMessageObject.ID);
is(messageWindow, gWindow, "found correct window by window ID");
is(aMessageObject.level, gLevel, "expected level received");
ok(aMessageObject.arguments, "we have arguments");
is(aMessageObject.arguments.length, gArgs.length, "arguments.length matches");
if (gLevel == "trace") {
is(aMessageObject.arguments.toSource(), gArgs.toSource(),
"stack trace is correct");
// Now test the location information in console.log()
startLocationTest();
}
else {
gArgs.forEach(function (a, i) {
is(aMessageObject.arguments[i], a, "correct arg " + i);
});
}
if (aMessageObject.level == "error") {
// Now test console.trace()
startTraceTest();
}
}
function testLocationData(aMessageObject) {
let messageWindow = getWindowByWindowId(aMessageObject.ID);
is(messageWindow, gWindow, "found correct window by window ID");
is(aMessageObject.level, gLevel, "expected level received");
ok(aMessageObject.arguments, "we have arguments");
is(aMessageObject.filename, gArgs[0].filename, "filename matches");
is(aMessageObject.lineNumber, gArgs[0].lineNumber, "lineNumber matches");
is(aMessageObject.functionName, gArgs[0].functionName, "functionName matches");
is(aMessageObject.arguments.length, gArgs[0].arguments.length, "arguments.length matches");
gArgs[0].arguments.forEach(function (a, i) {
is(aMessageObject.arguments[i], a, "correct arg " + i);
});
startGroupTest();
}
function startGroupTest() {
// Reset the observer function to cope with the fabricated test data.
ConsoleObserver.observe = function CO_observe(aSubject, aTopic, aData) {
try {
testConsoleGroup(aSubject.wrappedJSObject);
} catch (ex) {
// XXX Exceptions in this function currently aren't reported, because of
// some XPConnect weirdness, so report them manually
ok(false, "Exception thrown in CO_observe: " + ex);
}
};
let button = gWindow.document.getElementById("test-groups");
ok(button, "found #test-groups button");
EventUtils.synthesizeMouseAtCenter(button, {}, gWindow);
}
function testConsoleGroup(aMessageObject) {
let messageWindow = getWindowByWindowId(aMessageObject.ID);
is(messageWindow, gWindow, "found correct window by window ID");
ok(aMessageObject.level == "group" ||
aMessageObject.level == "groupCollapsed" ||
aMessageObject.level == "groupEnd",
"expected level received");
is(aMessageObject.functionName, "testGroups", "functionName matches");
ok(aMessageObject.lineNumber >= 45 && aMessageObject.lineNumber <= 47,
"lineNumber matches");
if (aMessageObject.level == "groupCollapsed") {
ok(aMessageObject.arguments == "a group", "groupCollapsed arguments matches");
}
else if (aMessageObject.level == "group") {
ok(aMessageObject.arguments == "b group", "group arguments matches");
}
else if (aMessageObject.level == "groupEnd") {
ok(Array.prototype.join.call(aMessageObject.arguments, " ") == "b group", "groupEnd arguments matches");
}
if (aMessageObject.level == "groupEnd") {
startTimeTest();
}
}
function startTraceTest() {
gLevel = "trace";
gArgs = [
{filename: TEST_URI, lineNumber: 6, functionName: null, language: 2},
{filename: TEST_URI, lineNumber: 11, functionName: "foobar585956b", language: 2},
{filename: TEST_URI, lineNumber: 15, functionName: "foobar585956a", language: 2},
{filename: TEST_URI, lineNumber: 1, functionName: "onclick", language: 2}
];
let button = gWindow.document.getElementById("test-trace");
ok(button, "found #test-trace button");
EventUtils.synthesizeMouseAtCenter(button, {}, gWindow);
}
function startLocationTest() {
// Reset the observer function to cope with the fabricated test data.
ConsoleObserver.observe = function CO_observe(aSubject, aTopic, aData) {
try {
testLocationData(aSubject.wrappedJSObject);
} catch (ex) {
// XXX Exceptions in this function currently aren't reported, because of
// some XPConnect weirdness, so report them manually
ok(false, "Exception thrown in CO_observe: " + ex);
}
};
gLevel = "log";
gArgs = [
{filename: TEST_URI, lineNumber: 19, functionName: "foobar646025", arguments: ["omg", "o", "d"]}
];
let button = gWindow.document.getElementById("test-location");
ok(button, "found #test-location button");
EventUtils.synthesizeMouseAtCenter(button, {}, gWindow);
}
function expect(level) {
gLevel = level;
gArgs = Array.slice(arguments, 1);
}
function observeConsoleTest() {
let win = XPCNativeWrapper.unwrap(gWindow);
expect("log", "arg");
win.console.log("arg");
expect("info", "arg", "extra arg");
win.console.info("arg", "extra arg");
// We don't currently support width and precision qualifiers, but we don't
// choke on them either.
expect("warn", "Lesson 1: PI is approximately equal to 3.14159");
win.console.warn("Lesson %d: %s is approximately equal to %1.2f",
1,
"PI",
3.14159);
expect("log", "%d, %s, %l");
win.console.log("%d, %s, %l");
expect("log", "%a %b %c");
win.console.log("%a %b %c");
expect("log", "%a %b %c", "a", "b");
win.console.log("%a %b %c", "a", "b");
expect("log", "2, a, %l", 3);
win.console.log("%d, %s, %l", 2, "a", 3);
// Bug #692550 handle null and undefined.
expect("log", "null, undefined");
win.console.log("%s, %s", null, undefined);
// Bug #696288 handle object as first argument.
let obj = { a: 1 };
expect("log", obj, "a");
win.console.log(obj, "a");
expect("dir", win.toString());
win.console.dir(win);
expect("error", "arg");
win.console.error("arg");
}
function consoleAPISanityTest() {
let win = XPCNativeWrapper.unwrap(gWindow);
ok(win.console, "we have a console attached");
ok(win.console, "we have a console attached, 2nd attempt");
ok(win.console.log, "console.log is here");
ok(win.console.info, "console.info is here");
ok(win.console.warn, "console.warn is here");
ok(win.console.error, "console.error is here");
ok(win.console.trace, "console.trace is here");
ok(win.console.dir, "console.dir is here");
ok(win.console.group, "console.group is here");
ok(win.console.groupCollapsed, "console.groupCollapsed is here");
ok(win.console.groupEnd, "console.groupEnd is here");
ok(win.console.time, "console.time is here");
ok(win.console.timeEnd, "console.timeEnd is here");
}
function startTimeTest() {
// Reset the observer function to cope with the fabricated test data.
ConsoleObserver.observe = function CO_observe(aSubject, aTopic, aData) {
try {
testConsoleTime(aSubject.wrappedJSObject);
} catch (ex) {
// XXX Exceptions in this function currently aren't reported, because of
// some XPConnect weirdness, so report them manually
ok(false, "Exception thrown in CO_observe: " + ex);
}
};
gLevel = "time";
gArgs = [
{filename: TEST_URI, lineNumber: 23, functionName: "startTimer"},
];
let button = gWindow.document.getElementById("test-time");
ok(button, "found #test-time button");
EventUtils.synthesizeMouseAtCenter(button, {}, gWindow);
}
function testConsoleTime(aMessageObject) {
let messageWindow = getWindowByWindowId(aMessageObject.ID);
is(messageWindow, gWindow, "found correct window by window ID");
is(aMessageObject.level, gLevel, "expected level received");
is(aMessageObject.filename, gArgs[0].filename, "filename matches");
is(aMessageObject.lineNumber, gArgs[0].lineNumber, "lineNumber matches");
is(aMessageObject.functionName, gArgs[0].functionName, "functionName matches");
startTimeEndTest();
}
function startTimeEndTest() {
// Reset the observer function to cope with the fabricated test data.
ConsoleObserver.observe = function CO_observe(aSubject, aTopic, aData) {
try {
testConsoleTimeEnd(aSubject.wrappedJSObject);
} catch (ex) {
// XXX Exceptions in this function currently aren't reported, because of
// some XPConnect weirdness, so report them manually
ok(false, "Exception thrown in CO_observe: " + ex);
}
};
gLevel = "timeEnd";
gArgs = [
{filename: TEST_URI, lineNumber: 27, functionName: "stopTimer", arguments: { name: "foo" }},
];
let button = gWindow.document.getElementById("test-timeEnd");
ok(button, "found #test-timeEnd button");
EventUtils.synthesizeMouseAtCenter(button, {}, gWindow);
}
function testConsoleTimeEnd(aMessageObject) {
let messageWindow = getWindowByWindowId(aMessageObject.ID);
is(messageWindow, gWindow, "found correct window by window ID");
is(aMessageObject.level, gLevel, "expected level received");
ok(aMessageObject.arguments, "we have arguments");
is(aMessageObject.filename, gArgs[0].filename, "filename matches");
is(aMessageObject.lineNumber, gArgs[0].lineNumber, "lineNumber matches");
is(aMessageObject.functionName, gArgs[0].functionName, "functionName matches");
is(aMessageObject.arguments.length, gArgs[0].arguments.length, "arguments.length matches");
is(aMessageObject.arguments.name, gArgs[0].arguments.name, "timer name matches");
ok(typeof aMessageObject.arguments.duration == "number", "timer duration is a number");
ok(aMessageObject.arguments.duration > 0, "timer duration is positive");
startEmptyTimerTest();
}
function startEmptyTimerTest() {
// Reset the observer function to cope with the fabricated test data.
ConsoleObserver.observe = function CO_observe(aSubject, aTopic, aData) {
try {
testEmptyTimer(aSubject.wrappedJSObject);
} catch (ex) {
// XXX Exceptions in this function currently aren't reported, because of
// some XPConnect weirdness, so report them manually
ok(false, "Exception thrown in CO_observe: " + ex);
}
};
let button = gWindow.document.getElementById("test-namelessTimer");
ok(button, "found #test-namelessTimer button");
EventUtils.synthesizeMouseAtCenter(button, {}, gWindow);
}
function testEmptyTimer(aMessageObject) {
let messageWindow = getWindowByWindowId(aMessageObject.ID);
is(messageWindow, gWindow, "found correct window by window ID");
ok(aMessageObject.level == "time" || aMessageObject.level == "timeEnd",
"expected level received");
ok(!aMessageObject.arguments, "we don't have arguments");
is(aMessageObject.functionName, "namelessTimer", "functionName matches");
ok(aMessageObject.lineNumber == 31 || aMessageObject.lineNumber == 32,
"lineNumber matches");
// Test finished
ConsoleObserver.destroy();
finish();
}
var ConsoleObserver = {
QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver]),
init: function CO_init() {
Services.obs.addObserver(this, "console-api-log-event", false);
},
destroy: function CO_destroy() {
Services.obs.removeObserver(this, "console-api-log-event");
},
observe: function CO_observe(aSubject, aTopic, aData) {
try {
testConsoleData(aSubject.wrappedJSObject);
} catch (ex) {
// XXX Exceptions in this function currently aren't reported, because of
// some XPConnect weirdness, so report them manually
ok(false, "Exception thrown in CO_observe: " + ex);
}
}
};
function getWindowId(aWindow)
{
return aWindow.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIDOMWindowUtils)
.outerWindowID;
}
function getWindowByWindowId(aId) {
let someWindow = Services.wm.getMostRecentWindow("navigator:browser");
if (someWindow) {
let windowUtils = someWindow.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIDOMWindowUtils);
return windowUtils.getOuterWindowWithId(aId);
}
return null;
}