Bug 923345 - Fix intermittent failure in test/browser_thumbnails_background_crash.js by splitting it up. r=markh

This commit is contained in:
Drew Willcoxon 2013-12-09 19:52:51 -08:00
parent 8fedde7ead
commit b2eb58c06e
5 changed files with 132 additions and 164 deletions

View File

@ -9,7 +9,8 @@ support-files =
thumbnails_crash_content_helper.js
thumbnails_update.sjs
[browser_thumbnails_background_crash.js]
[browser_thumbnails_bg_crash_during_capture.js]
[browser_thumbnails_bg_crash_while_idle.js]
[browser_thumbnails_bg_basic.js]
[browser_thumbnails_bg_queueing.js]
[browser_thumbnails_bg_timeout.js]

View File

@ -1,162 +0,0 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
const TEST_PAGE_URL = "http://mochi.test:8888/browser/toolkit/components/thumbnails/test/thumbnails_background.sjs";
const TEST_CONTENT_HELPER = "chrome://mochitests/content/browser/toolkit/components/thumbnails/test/thumbnails_crash_content_helper.js";
const imports = {};
Cu.import("resource://gre/modules/BackgroundPageThumbs.jsm", imports);
Cu.import("resource://gre/modules/PageThumbs.jsm", imports);
Cu.import("resource://gre/modules/Task.jsm", imports);
Cu.import("resource://gre/modules/commonjs/sdk/core/promise.js", imports);
function test() {
waitForExplicitFinish();
Services.obs.addObserver(crashObserver, 'ipc:content-shutdown', false);
spawnNextTest();
}
function spawnNextTest() {
if (!tests.length) {
Services.obs.removeObserver(crashObserver, 'ipc:content-shutdown');
is(numCrashes, 2, "saw 2 crashes from this test");
finish();
return;
}
let test = tests.shift();
info("Running sub-test " + test.name);
imports.Task.spawn(test).then(spawnNextTest, function onError(err) {
ok(false, err);
spawnNextTest();
});
}
let tests = [
function crashDuringCapture() {
// make a good capture first - this ensures we have the <browser>
let goodUrl = testPageURL();
yield capture(goodUrl);
let goodFile = fileForURL(goodUrl);
ok(goodFile.exists(), "Thumbnail should be cached after capture: " + goodFile.path);
goodFile.remove(false);
// inject our content script.
let mm = injectContentScript();
// queue up 2 captures - the first has a wait, so this is the one that
// will die. The second one should immediately capture after the crash.
let waitUrl = testPageURL({ wait: 30000 });
let deferred1 = capture(waitUrl);
let deferred2 = capture(goodUrl);
info("Crashing the thumbnail content process.");
mm.sendAsyncMessage("thumbnails-test:crash");
yield deferred1;
let waitFile = fileForURL(waitUrl);
ok(!waitFile.exists(), "Thumbnail should not have been saved due to the crash: " + waitFile.path);
yield deferred2;
ok(goodFile.exists(), "We should have recovered and completed the 2nd capture after the crash: " + goodFile.path);
goodFile.remove(false);
},
function crashWhileIdle() {
// make a good capture first - this ensures we have the <browser>
let goodUrl = testPageURL();
yield capture(goodUrl);
let goodFile = fileForURL(goodUrl);
ok(goodFile.exists(), "Thumbnail should be cached after capture: " + goodFile.path);
goodFile.remove(false);
// inject our content script.
let mm = injectContentScript();
// the observer for the crashing process is basically async, so it's hard
// to know when the <browser> has actually seen it. Easist is to just add
// our own observer.
let deferred = imports.Promise.defer();
Services.obs.addObserver(function crashObserver() {
Services.obs.removeObserver(crashObserver, "oop-frameloader-crashed");
// spin the event loop to ensure the BPT observer was called.
executeSoon(function() {
// Now queue another capture and ensure it recovers.
capture(goodUrl).then(() => {
ok(goodFile.exists(), "We should have recovered and handled new capture requests: " + goodFile.path);
goodFile.remove(false);
deferred.resolve();
});
});
} , "oop-frameloader-crashed", false);
// Nothing is pending - crash the process.
info("Crashing the thumbnail content process.");
mm.sendAsyncMessage("thumbnails-test:crash");
yield deferred.promise;
},
];
function injectContentScript() {
let thumbnailBrowser = imports.BackgroundPageThumbs._thumbBrowser;
let mm = thumbnailBrowser.messageManager;
mm.loadFrameScript(TEST_CONTENT_HELPER, false);
return mm;
}
function capture(url, options) {
let deferred = imports.Promise.defer();
options = options || {};
options.onDone = function onDone(capturedURL) {
deferred.resolve(capturedURL);
};
imports.BackgroundPageThumbs.capture(url, options);
return deferred.promise;
}
function fileForURL(url) {
let path = imports.PageThumbsStorage.getFilePathForURL(url);
let file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
file.initWithPath(path);
return file;
}
function testPageURL(opts) {
return TEST_PAGE_URL + "?" + encodeURIComponent(JSON.stringify(opts || {}));
}
// This observer is needed so we can clean up all evidence of the crash so
// the testrunner thinks things are peachy.
let numCrashes = 0;
function crashObserver(subject, topic, data) {
is(topic, 'ipc:content-shutdown', 'Received correct observer topic.');
ok(subject instanceof Components.interfaces.nsIPropertyBag2,
'Subject implements nsIPropertyBag2.');
// we might see this called as the process terminates due to previous tests.
// We are only looking for "abnormal" exits...
if (!subject.hasKey("abnormal")) {
info("This is a normal termination and isn't the one we are looking for...");
return;
}
numCrashes++;
var dumpID;
if ('nsICrashReporter' in Components.interfaces) {
dumpID = subject.getPropertyAsAString('dumpID');
ok(dumpID, "dumpID is present and not an empty string");
}
if (dumpID) {
var minidumpDirectory = getMinidumpDirectory();
removeFile(minidumpDirectory, dumpID + '.dmp');
removeFile(minidumpDirectory, dumpID + '.extra');
}
}
function getMinidumpDirectory() {
var dir = Services.dirsvc.get('ProfD', Components.interfaces.nsIFile);
dir.append("minidumps");
return dir;
}
function removeFile(directory, filename) {
var file = directory.clone();
file.append(filename);
if (file.exists()) {
file.remove(false);
}
}

View File

@ -0,0 +1,36 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
function runTests() {
let crashObserver = bgAddCrashObserver();
// make a good capture first - this ensures we have the <browser>
let goodUrl = bgTestPageURL();
yield bgCapture(goodUrl);
ok(thumbnailExists(goodUrl), "Thumbnail should be cached after capture");
removeThumbnail(goodUrl);
// inject our content script.
let mm = bgInjectCrashContentScript();
// queue up 2 captures - the first has a wait, so this is the one that
// will die. The second one should immediately capture after the crash.
let waitUrl = bgTestPageURL({ wait: 30000 });
let sawWaitUrlCapture = false;
bgCapture(waitUrl, { onDone: () => {
sawWaitUrlCapture = true;
ok(!thumbnailExists(waitUrl), "Thumbnail should not have been saved due to the crash");
}});
bgCapture(goodUrl, { onDone: () => {
ok(sawWaitUrlCapture, "waitUrl capture should have finished first");
ok(thumbnailExists(goodUrl), "We should have recovered and completed the 2nd capture after the crash");
removeThumbnail(goodUrl);
// Test done.
ok(crashObserver.crashed, "Saw a crash from this test");
next();
}});
info("Crashing the thumbnail content process.");
mm.sendAsyncMessage("thumbnails-test:crash");
yield true;
}

View File

@ -0,0 +1,38 @@
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
function runTests() {
let crashObserver = bgAddCrashObserver();
// make a good capture first - this ensures we have the <browser>
let goodUrl = bgTestPageURL();
yield bgCapture(goodUrl);
ok(thumbnailExists(goodUrl), "Thumbnail should be cached after capture");
removeThumbnail(goodUrl);
// inject our content script.
let mm = bgInjectCrashContentScript();
// the observer for the crashing process is basically async, so it's hard
// to know when the <browser> has actually seen it. Easist is to just add
// our own observer.
Services.obs.addObserver(function onCrash() {
Services.obs.removeObserver(onCrash, "oop-frameloader-crashed");
// spin the event loop to ensure the BPT observer was called.
executeSoon(function() {
// Now queue another capture and ensure it recovers.
bgCapture(goodUrl, { onDone: () => {
ok(thumbnailExists(goodUrl), "We should have recovered and handled new capture requests");
removeThumbnail(goodUrl);
// Test done.
ok(crashObserver.crashed, "Saw a crash from this test");
next();
}});
});
} , "oop-frameloader-crashed", false);
// Nothing is pending - crash the process.
info("Crashing the thumbnail content process.");
mm.sendAsyncMessage("thumbnails-test:crash");
yield true;
}

View File

@ -312,7 +312,8 @@ function bgCaptureIfMissing(aURL, aOptions) {
}
function bgCaptureWithMethod(aMethodName, aURL, aOptions = {}) {
aOptions.onDone = next;
if (!aOptions.onDone)
aOptions.onDone = next;
BackgroundPageThumbs[aMethodName](aURL, aOptions);
}
@ -320,3 +321,57 @@ function bgTestPageURL(aOpts = {}) {
let TEST_PAGE_URL = "http://mochi.test:8888/browser/toolkit/components/thumbnails/test/thumbnails_background.sjs";
return TEST_PAGE_URL + "?" + encodeURIComponent(JSON.stringify(aOpts));
}
function bgAddCrashObserver() {
let crashed = false;
Services.obs.addObserver(function crashObserver(subject, topic, data) {
is(topic, 'ipc:content-shutdown', 'Received correct observer topic.');
ok(subject instanceof Components.interfaces.nsIPropertyBag2,
'Subject implements nsIPropertyBag2.');
// we might see this called as the process terminates due to previous tests.
// We are only looking for "abnormal" exits...
if (!subject.hasKey("abnormal")) {
info("This is a normal termination and isn't the one we are looking for...");
return;
}
Services.obs.removeObserver(crashObserver, 'ipc:content-shutdown');
crashed = true;
var dumpID;
if ('nsICrashReporter' in Components.interfaces) {
dumpID = subject.getPropertyAsAString('dumpID');
ok(dumpID, "dumpID is present and not an empty string");
}
if (dumpID) {
var minidumpDirectory = getMinidumpDirectory();
removeFile(minidumpDirectory, dumpID + '.dmp');
removeFile(minidumpDirectory, dumpID + '.extra');
}
}, 'ipc:content-shutdown', false);
return {
get crashed() crashed
};
}
function bgInjectCrashContentScript() {
const TEST_CONTENT_HELPER = "chrome://mochitests/content/browser/toolkit/components/thumbnails/test/thumbnails_crash_content_helper.js";
let thumbnailBrowser = BackgroundPageThumbs._thumbBrowser;
let mm = thumbnailBrowser.messageManager;
mm.loadFrameScript(TEST_CONTENT_HELPER, false);
return mm;
}
function getMinidumpDirectory() {
var dir = Services.dirsvc.get('ProfD', Components.interfaces.nsIFile);
dir.append("minidumps");
return dir;
}
function removeFile(directory, filename) {
var file = directory.clone();
file.append(filename);
if (file.exists()) {
file.remove(false);
}
}