Bug 617152. Part 6: Improve diagnostic messages for reftest failures. r=dbaron

This commit is contained in:
Robert O'Callahan 2010-12-20 14:37:43 +13:00
Родитель e7ada2cb2c
Коммит cd07e8ea6a
1 изменённых файлов: 166 добавлений и 40 удалений

Просмотреть файл

@ -108,6 +108,7 @@ var gExplicitPendingPaintsCompleteHook;
var gCurrentURL;
var gFailureTimeout = null;
var gFailureReason;
var gTestLog = [];
var gServer;
var gCount = 0;
var gAssertionCount = 0;
@ -150,6 +151,26 @@ var gRecycledCanvases = new Array();
// By default we just log to stdout
var gDumpLog = dump;
function LogWarning(str)
{
gDumpLog("REFTEST INFO | " + str + "\n");
gTestLog.push(str);
}
function LogInfo(str)
{
// gDumpLog("REFTEST INFO | " + str + "\n");
gTestLog.push(str);
}
function FlushTestLog()
{
for (var i = 0; i < gTestLog.length; ++i) {
gDumpLog("REFTEST INFO | Saved log: " + gTestLog[i] + "\n");
}
gTestLog = [];
}
function AllocateCanvas()
{
var windowElem = document.documentElement;
@ -172,14 +193,29 @@ function ReleaseCanvas(canvas)
gRecycledCanvases.push(canvas);
}
function IDForEventTarget(event)
{
try {
return "'" + event.target.getAttribute('id') + "'";
} catch (ex) {
return "<unknown>";
}
}
function PaintWaitListener(event)
{
LogInfo("MozPaintWait received for ID " + IDForEventTarget(event));
gExplicitPendingPaintCount++;
}
function PaintWaitFinishedListener(event)
{
LogInfo("MozPaintWaitFinished received for ID " + IDForEventTarget(event));
gExplicitPendingPaintCount--;
if (gExplicitPendingPaintCount < 0) {
LogWarning("Underrun in gExplicitPendingPaintCount\n");
gExplicitPendingPaintCount = 0;
}
if (gExplicitPendingPaintCount == 0 &&
gExplicitPendingPaintsCompleteHook) {
gExplicitPendingPaintsCompleteHook();
@ -459,8 +495,8 @@ function BuildConditionSandbox(aURL) {
return testPluginIsOOP;
};
dump("REFTEST INFO | Dumping JSON representation of sandbox \n");
dump("REFTEST INFO | " + JSON.stringify(sandbox) + " \n");
gDumpLog("REFTEST INFO | Dumping JSON representation of sandbox \n");
gDumpLog("REFTEST INFO | " + JSON.stringify(sandbox) + " \n");
return sandbox;
}
@ -756,6 +792,8 @@ function ServeFiles(manifestURL, depth, aURL, files)
function StartCurrentTest()
{
gTestLog = [];
// make sure we don't run tests that are expected to kill the browser
while (gURLs.length > 0) {
var test = gURLs[0];
@ -796,6 +834,13 @@ function StartCurrentURI(aState)
gState = aState;
gCurrentURL = gURLs[0]["url" + aState].spec;
// Reset gExplicitPendingPaintCount in case there was a timeout or
// the count is out of sync for some other reason
if (gExplicitPendingPaintCount != 0) {
LogWarning("Resetting gExplicitPendingPaintCount to zero (currently " +
gExplicitPendingPaintCount + "\n");
gExplicitPendingPaintCount = 0;
}
if (gURICanvases[gCurrentURL] &&
(gURLs[0].type == TYPE_REFTEST_EQUAL ||
@ -806,6 +851,7 @@ function StartCurrentURI(aState)
setTimeout(RecordResult, 0);
} else {
gDumpLog("REFTEST TEST-START | " + gCurrentURL + "\n");
LogInfo("START " + gCurrentURL);
gBrowser.loadURI(gCurrentURL);
}
}
@ -833,7 +879,7 @@ function DoneTests()
gTestResults.Exception + " exception)\n");
count = gTestResults.KnownFail + gTestResults.AssertionKnown +
gTestResults.Random + gTestResults.Skip + gTestResults.Slow;
dump("REFTEST INFO | Known problems: " + count + " (" +
gDumpLog("REFTEST INFO | Known problems: " + count + " (" +
gTestResults.KnownFail + " known fail, " +
gTestResults.AssertionKnown + " known asserts, " +
gTestResults.Random + " random, " +
@ -927,28 +973,48 @@ function WaitForTestEnd() {
var stopAfterPaintReceived = false;
var currentDoc = gBrowser.contentDocument;
var utils = gBrowser.contentWindow.QueryInterface(CI.nsIInterfaceRequestor)
.getInterface(CI.nsIDOMWindowUtils);
var state = STATE_WAITING_TO_FIRE_INVALIDATE_EVENT;
gFailureReason = "timed out waiting for pending paint count to reach zero";
function FlushRendering() {
var anyPendingPaintsGeneratedInDescendants = false;
function flushWindow(win) {
var utils = win.QueryInterface(CI.nsIInterfaceRequestor)
.getInterface(CI.nsIDOMWindowUtils);
var afterPaintWasPending = utils.isMozAfterPaintPending;
try {
// Flush pending restyles and reflows for this window
win.document.documentElement.getBoundingClientRect();
} catch (e) {}
} catch (e) {
LogWarning("flushWindow failed: " + e + "\n");
}
if (!afterPaintWasPending && utils.isMozAfterPaintPending) {
LogInfo("FlushRendering generated paint for window " + win.location.href);
anyPendingPaintsGeneratedInDescendants = true;
}
for (var i = 0; i < win.frames.length; ++i) {
flushWindow(win.frames[i]);
}
}
// Flush pending restyles and reflows
flushWindow(contentRootElement.ownerDocument.defaultView);
// Flush out invalidation
flushWindow(gBrowser.contentWindow);
if (anyPendingPaintsGeneratedInDescendants &&
!gWindowUtils.isMozAfterPaintPending) {
LogWarning("Internal error: descendant frame generated a MozAfterPaint event, but the root document doesn't have one!");
}
// XXX this should not be necessary!
var utils = gBrowser.contentWindow.QueryInterface(CI.nsIInterfaceRequestor)
.getInterface(CI.nsIDOMWindowUtils);
utils.processUpdates();
}
function AfterPaintListener(event) {
LogInfo("AfterPaintListener in " + event.target.document.location.href);
if (event.target.document != document) {
// ignore paint events for subframes or old documents in the window.
// Invalidation in subframes will cause invalidation in the toplevel document anyway.
@ -962,6 +1028,7 @@ function WaitForTestEnd() {
}
function AttrModifiedListener() {
LogInfo("AttrModifiedListener fired");
// Wait for the next return-to-event-loop before continuing --- for
// example, the attribute may have been modified in an subdocument's
// load event handler, in which case we need load event processing
@ -970,6 +1037,7 @@ function WaitForTestEnd() {
}
function ExplicitPaintsCompleteListener() {
LogInfo("ExplicitPaintsCompleteListener fired");
// Since this can fire while painting, don't confuse ourselves by
// firing synchronously. It's fine to do this asynchronously.
setTimeout(MakeProgress, 0);
@ -990,32 +1058,58 @@ function WaitForTestEnd() {
// change from returning true to returning false is monitored via some kind
// of event listener which eventually calls this function.
function MakeProgress() {
if (state >= STATE_COMPLETED)
if (state >= STATE_COMPLETED) {
LogInfo("MakeProgress: STATE_COMPLETED");
return;
}
FlushRendering();
switch (state) {
case STATE_WAITING_TO_FIRE_INVALIDATE_EVENT:
if (shouldWaitForExplicitPaintWaiters() || shouldWaitForPendingPaints())
case STATE_WAITING_TO_FIRE_INVALIDATE_EVENT: {
LogInfo("MakeProgress: STATE_WAITING_TO_FIRE_INVALIDATE_EVENT");
if (shouldWaitForExplicitPaintWaiters() || shouldWaitForPendingPaints()) {
gFailureReason = "timed out waiting for pending paint count to reach zero";
if (shouldWaitForExplicitPaintWaiters()) {
gFailureReason += " (waiting for MozPaintWaitFinished)";
LogInfo("MakeProgress: waiting for MozPaintWaitFinished");
}
if (shouldWaitForPendingPaints()) {
gFailureReason += " (waiting for MozAfterPaint)";
LogInfo("MakeProgress: waiting for MozAfterPaint");
}
return;
}
state = STATE_WAITING_FOR_REFTEST_WAIT_REMOVAL;
gFailureReason = "timed out waiting for reftest-wait to be removed";
var hasReftestWait = shouldWaitForReftestWaitRemoval();
// Notify the test document that now is a good time to test some invalidation
var notification = document.createEvent("Events");
notification.initEvent("MozReftestInvalidate", true, false);
contentRootElement.dispatchEvent(notification);
if (hasReftestWait && !shouldWaitForReftestWaitRemoval()) {
// MozReftestInvalidate handler removed reftest-wait.
// We expect something to have been invalidated...
FlushRendering();
if (!shouldWaitForPendingPaints() && !shouldWaitForExplicitPaintWaiters()) {
LogWarning("MozInvalidateEvent didn't invalidate");
}
}
// Try next state
MakeProgress();
return;
}
case STATE_WAITING_FOR_REFTEST_WAIT_REMOVAL:
if (shouldWaitForReftestWaitRemoval())
LogInfo("MakeProgress: STATE_WAITING_FOR_REFTEST_WAIT_REMOVAL");
if (shouldWaitForReftestWaitRemoval()) {
gFailureReason = "timed out waiting for reftest-wait to be removed";
LogInfo("MakeProgress: waiting for reftest-wait to be removed");
return;
}
state = STATE_WAITING_TO_FINISH;
gFailureReason = "timed out waiting for pending paint count to " +
"reach zero (after reftest-wait removed and switch to print mode)";
if (doPrintMode(contentRootElement)) {
LogInfo("MakeProgress: setting up print mode");
setupPrintMode();
didPrintMode = true;
}
@ -1024,8 +1118,21 @@ function WaitForTestEnd() {
return;
case STATE_WAITING_TO_FINISH:
if (shouldWaitForExplicitPaintWaiters() || shouldWaitForPendingPaints())
LogInfo("MakeProgress: STATE_WAITING_TO_FINISH");
if (shouldWaitForExplicitPaintWaiters() || shouldWaitForPendingPaints()) {
gFailureReason = "timed out waiting for pending paint count to " +
"reach zero (after reftest-wait removed and switch to print mode)";
if (shouldWaitForExplicitPaintWaiters()) {
gFailureReason += " (waiting for MozPaintWaitFinished)";
LogInfo("MakeProgress: waiting for MozPaintWaitFinished");
}
if (shouldWaitForPendingPaints()) {
gFailureReason += " (waiting for MozAfterPaint)";
LogInfo("MakeProgress: waiting for MozAfterPaint");
}
return;
}
LogInfo("MakeProgress: Completed");
state = STATE_COMPLETED;
gFailureReason = "timed out while taking snapshot (bug in harness?)";
RemoveListeners();
@ -1054,17 +1161,21 @@ function OnDocumentLoad(event)
return;
}
if (gBrowser.contentDocument.location.href != gCurrentURL)
if (gBrowser.contentDocument.location.href != gCurrentURL) {
LogInfo("OnDocumentLoad fired for previous document");
// Ignore load events for previous documents.
return;
}
var contentRootElement = gBrowser.contentDocument.documentElement;
setupZoom(contentRootElement);
function AfterOnLoadScripts() {
if (doPrintMode(contentRootElement))
if (doPrintMode(contentRootElement)) {
LogInfo("AfterOnLoadScripts setting up print mode");
setupPrintMode();
}
// Take a snapshot now. We need to do this before we check whether
// we should wait, since this might trigger dispatching of
@ -1073,6 +1184,7 @@ function OnDocumentLoad(event)
InitCurrentCanvasWithSnapshot();
if (shouldWaitForExplicitPaintWaiters()) {
LogInfo("AfterOnLoadScripts belatedly entering WaitForTestEnd");
// Go into reftest-wait mode belatedly.
WaitForTestEnd();
} else {
@ -1084,6 +1196,7 @@ function OnDocumentLoad(event)
// Go into reftest-wait mode immediately after painting has been
// unsuppressed, after the onload event has finished dispatching.
gFailureReason = "timed out waiting for test to complete (trying to get into WaitForTestEnd)";
LogInfo("OnDocumentLoad triggering WaitForTestEnd");
setTimeout(function() {
InitCurrentCanvasWithSnapshot();
WaitForTestEnd();
@ -1094,6 +1207,7 @@ function OnDocumentLoad(event)
// first to get us after the onload has fired in the content, and
// the second to get us after any setTimeout(foo, 0) in the content.
gFailureReason = "timed out waiting for test to complete (waiting for onload scripts to complete)";
LogInfo("OnDocumentLoad triggering AfterOnLoadScripts");
setTimeout(setTimeout, 0, AfterOnLoadScripts, 0);
}
}
@ -1142,14 +1256,15 @@ function DoDrawWindow(ctx, x, y, w, h)
} else {
// Output a special warning because we need to be able to detect
// this whenever it happens.
dump("REFTEST INFO | WARNING: USE_WIDGET_LAYERS disabled\n");
gDumpLog("REFTEST INFO | WARNING: USE_WIDGET_LAYERS disabled\n");
}
dump("REFTEST INFO | drawWindow flags = " + flagsStr +
gDumpLog("REFTEST INFO | drawWindow flags = " + flagsStr +
"; window size = " + window.innerWidth + "," + window.innerHeight +
"; test browser size = " + testRect.width + "," + testRect.height +
"\n");
}
LogInfo("DoDrawWindow " + x + "," + y + "," + w + "," + h);
ctx.drawWindow(window, x, y, w, h, "rgb(255,255,255)",
gDrawWindowFlags);
}
@ -1196,6 +1311,8 @@ function UpdateCurrentCanvasForEvent(event)
function RecordResult()
{
LogInfo("RecordResult fired");
// Keep track of which test was slowest, and how long it took.
var currentTestRunTime = Date.now() - gCurrentTestStartTime;
if (currentTestRunTime > gSlowestTestTime) {
@ -1258,7 +1375,7 @@ function RecordResult()
if (!gURLs[0].allowSilentFail)
missing_msg = "No test results reported. (SCRIPT)\n";
else
dump("REFTEST INFO | An expected silent failure occurred \n");
gDumpLog("REFTEST INFO | An expected silent failure occurred \n");
}
if (missing_msg) {
@ -1299,6 +1416,10 @@ function RecordResult()
gDumpLog(result);
});
if (anyFailed && expected == EXPECTED_PASS) {
FlushTestLog();
}
FinishTestItem();
return;
}
@ -1373,6 +1494,10 @@ function RecordResult()
}
}
if (!test_passed && expected == EXPECTED_PASS) {
FlushTestLog();
}
UpdateCanvasCache(gURLs[0].url1, gCanvas1);
UpdateCanvasCache(gURLs[0].url2, gCanvas2);
@ -1392,6 +1517,7 @@ function LoadFailed()
++gTestResults.FailedLoad;
gDumpLog("REFTEST TEST-UNEXPECTED-FAIL | " +
gURLs[0]["url" + gState].spec + " | " + gFailureReason + "\n");
FlushTestLog();
FinishTestItem();
}