gecko/toolkit/components/places/tests/expiration/test_pref_maxpages.js

179 lines
5.7 KiB
JavaScript

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
* ***** 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 Places Unit Tests.
*
* The Initial Developer of the Original Code is
* Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2009
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Marco Bonardo <mak77@bonardo.net> (Original Author)
*
* 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 ***** */
/**
* What this is aimed to test:
*
* Expiration will obey to hardware spec, but user can set a custom maximum
* number of pages to retain, to restrict history, through
* "places.history.expiration.max_pages".
* This limit is used at next expiration run.
* If the pref is set to a number < 0 we will use the default value.
*/
let os = Cc["@mozilla.org/observer-service;1"].
getService(Ci.nsIObserverService);
let hs = Cc["@mozilla.org/browser/nav-history-service;1"].
getService(Ci.nsINavHistoryService);
let gTests = [
{ desc: "Set max_pages to a negative value, with 1 page.",
maxPages: -1,
addPages: 1,
expectedNotifications: 0, // Will ignore and won't expire anything.
},
{ desc: "Set max_pages to 0.",
maxPages: 0,
addPages: 1,
expectedNotifications: 1,
},
{ desc: "Set max_pages to 0, with 2 pages.",
maxPages: 0,
addPages: 2,
expectedNotifications: 2, // Will expire everything.
},
// Notice if we are over limit we do a full step of expiration. So we ensure
// that we will expire if we are over the limit, but we don't ensure that we
// will expire exactly up to the limit. Thus in this case we expire
// everything.
{ desc: "Set max_pages to 1 with 2 pages.",
maxPages: 1,
addPages: 2,
expectedNotifications: 2, // Will expire everything (in this case).
},
{ desc: "Set max_pages to 10, with 9 pages.",
maxPages: 10,
addPages: 9,
expectedNotifications: 0, // We are at the limit, won't expire anything.
},
{ desc: "Set max_pages to 10 with 10 pages.",
maxPages: 10,
addPages: 10,
expectedNotifications: 0, // We are below the limit, won't expire anything.
},
];
let gCurrentTest;
let gTestIndex = 0;
function run_test() {
// The pref should not exist by default.
try {
getMaxPages();
do_throw("interval pref should not exist by default");
}
catch (ex) {}
// Set interval to a large value so we don't expire on it.
setInterval(3600); // 1h
do_test_pending();
run_next_test();
}
function run_next_test() {
if (gTests.length) {
gCurrentTest = gTests.shift();
gTestIndex++;
print("\nTEST " + gTestIndex + ": " + gCurrentTest.desc);
gCurrentTest.receivedNotifications = 0;
// Setup visits.
let now = Date.now() * 1000;
for (let i = 0; i < gCurrentTest.addPages; i++) {
hs.addVisit(uri("http://" + gTestIndex + "." + i + ".mozilla.org/"), now++, null,
hs.TRANSITION_TYPED, false, 0);
}
// Observe history.
historyObserver = {
onBeginUpdateBatch: function PEX_onBeginUpdateBatch() {},
onEndUpdateBatch: function PEX_onEndUpdateBatch() {},
onClearHistory: function() {},
onVisit: function() {},
onTitleChanged: function() {},
onBeforeDeleteURI: function() {},
onDeleteURI: function(aURI) {
print("onDeleteURI " + aURI.spec);
gCurrentTest.receivedNotifications++;
},
onPageChanged: function() {},
onDeleteVisits: function(aURI, aTime) {
print("onDeleteVisits " + aURI.spec + " " + aTime);
},
};
hs.addObserver(historyObserver, false);
// Observe expirations.
observer = {
observe: function(aSubject, aTopic, aData) {
os.removeObserver(observer, PlacesUtils.TOPIC_EXPIRATION_FINISHED);
hs.removeObserver(historyObserver, false);
// This test finished.
check_result();
}
};
os.addObserver(observer, PlacesUtils.TOPIC_EXPIRATION_FINISHED, false);
setMaxPages(gCurrentTest.maxPages);
// Expire now, observers will check results.
force_expiration_step();
}
else {
clearMaxPages();
waitForClearHistory(do_test_finished);
}
}
function check_result() {
do_check_eq(gCurrentTest.receivedNotifications,
gCurrentTest.expectedNotifications);
// Clean up.
waitForClearHistory(run_next_test);
}