gecko/toolkit/components/places/tests/unit/test_utils_getURLsForContainerNode.js

214 lines
7.9 KiB
JavaScript

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 Places unit test code.
*
* The Initial Developer of the Original Code is
* Mozilla Corporation.
* 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 ***** */
/**
* Check for correct functionality of PlacesUtils.getURLsForContainerNode and
* PlacesUtils.hasChildURIs (those helpers share almost all of their code)
*/
Components.utils.import("resource://gre/modules/utils.js");
var PU = PlacesUtils;
var hs = PU.history;
var bs = PU.bookmarks;
var tests = [
function() {
dump("\n\n*** TEST: folder\n");
// This is the folder we will check for children.
var folderId = bs.createFolder(bs.toolbarFolder, "folder", bs.DEFAULT_INDEX);
// Create a folder and a query node inside it, these should not be considered
// uri nodes.
bs.createFolder(folderId, "inside folder", bs.DEFAULT_INDEX);
bs.insertBookmark(folderId, uri("place:sort=1"),
bs.DEFAULT_INDEX, "inside query");
var query = hs.getNewQuery();
query.setFolders([bs.toolbarFolder], 1);
var options = hs.getNewQueryOptions();
dump("Check folder without uri nodes\n");
check_uri_nodes(query, options, 0);
dump("Check folder with uri nodes\n");
// Add an uri node, this should be considered.
bs.insertBookmark(folderId, uri("http://www.mozilla.org/"),
bs.DEFAULT_INDEX, "bookmark");
check_uri_nodes(query, options, 1);
},
function() {
dump("\n\n*** TEST: folder in an excludeItems root\n");
// This is the folder we will check for children.
var folderId = bs.createFolder(bs.toolbarFolder, "folder", bs.DEFAULT_INDEX);
// Create a folder and a query node inside it, these should not be considered
// uri nodes.
bs.createFolder(folderId, "inside folder", bs.DEFAULT_INDEX);
bs.insertBookmark(folderId, uri("place:sort=1"), bs.DEFAULT_INDEX, "inside query");
var query = hs.getNewQuery();
query.setFolders([bs.toolbarFolder], 1);
var options = hs.getNewQueryOptions();
options.excludeItems = true;
dump("Check folder without uri nodes\n");
check_uri_nodes(query, options, 0);
dump("Check folder with uri nodes\n");
// Add an uri node, this should be considered.
bs.insertBookmark(folderId, uri("http://www.mozilla.org/"),
bs.DEFAULT_INDEX, "bookmark");
check_uri_nodes(query, options, 1);
},
function() {
dump("\n\n*** TEST: query\n");
// This is the query we will check for children.
bs.insertBookmark(bs.toolbarFolder, uri("place:folder=BOOKMARKS_MENU&sort=1"),
bs.DEFAULT_INDEX, "inside query");
// Create a folder and a query node inside it, these should not be considered
// uri nodes.
bs.createFolder(bs.bookmarksMenuFolder, "inside folder", bs.DEFAULT_INDEX);
bs.insertBookmark(bs.bookmarksMenuFolder, uri("place:sort=1"),
bs.DEFAULT_INDEX, "inside query");
var query = hs.getNewQuery();
query.setFolders([bs.toolbarFolder], 1);
var options = hs.getNewQueryOptions();
dump("Check query without uri nodes\n");
check_uri_nodes(query, options, 0);
dump("Check query with uri nodes\n");
// Add an uri node, this should be considered.
bs.insertBookmark(bs.bookmarksMenuFolder, uri("http://www.mozilla.org/"),
bs.DEFAULT_INDEX, "bookmark");
check_uri_nodes(query, options, 1);
},
function() {
dump("\n\n*** TEST: excludeItems Query\n");
// This is the query we will check for children.
bs.insertBookmark(bs.toolbarFolder, uri("place:folder=BOOKMARKS_MENU&sort=8"),
bs.DEFAULT_INDEX, "inside query");
// Create a folder and a query node inside it, these should not be considered
// uri nodes.
bs.createFolder(bs.bookmarksMenuFolder, "inside folder", bs.DEFAULT_INDEX);
bs.insertBookmark(bs.bookmarksMenuFolder, uri("place:sort=1"),
bs.DEFAULT_INDEX, "inside query");
var query = hs.getNewQuery();
query.setFolders([bs.toolbarFolder], 1);
var options = hs.getNewQueryOptions();
options.excludeItems = true;
dump("Check folder without uri nodes\n");
check_uri_nodes(query, options, 0);
dump("Check folder with uri nodes\n");
// Add an uri node, this should be considered.
bs.insertBookmark(bs.bookmarksMenuFolder, uri("http://www.mozilla.org/"),
bs.DEFAULT_INDEX, "bookmark");
check_uri_nodes(query, options, 1);
},
function() {
dump("\n\n*** TEST: !expandQueries Query\n");
// This is the query we will check for children.
bs.insertBookmark(bs.toolbarFolder, uri("place:folder=BOOKMARKS_MENU&sort=8"),
bs.DEFAULT_INDEX, "inside query");
// Create a folder and a query node inside it, these should not be considered
// uri nodes.
bs.createFolder(bs.bookmarksMenuFolder, "inside folder", bs.DEFAULT_INDEX);
bs.insertBookmark(bs.bookmarksMenuFolder, uri("place:sort=1"),
bs.DEFAULT_INDEX, "inside query");
var query = hs.getNewQuery();
query.setFolders([bs.toolbarFolder], 1);
var options = hs.getNewQueryOptions();
options.expandQueries = false;
dump("Check folder without uri nodes\n");
check_uri_nodes(query, options, 0);
dump("Check folder with uri nodes\n");
// Add an uri node, this should be considered.
bs.insertBookmark(bs.bookmarksMenuFolder, uri("http://www.mozilla.org/"),
bs.DEFAULT_INDEX, "bookmark");
check_uri_nodes(query, options, 1);
}
];
/**
* Executes a query and checks number of uri nodes in the first container in
* query's results. To correctly test a container ensure that the query will
* return only your container in the first level.
*
* @param aQuery
* nsINavHistoryQuery object defining the query
* @param aOptions
* nsINavHistoryQueryOptions object defining the query's options
* @param aExpectedURINodes
* number of expected uri nodes
*/
function check_uri_nodes(aQuery, aOptions, aExpectedURINodes) {
var result = hs.executeQuery(aQuery, aOptions);
var root = result.root;
root.containerOpen = true;
var node = root.getChild(0);
do_check_eq(PU.hasChildURIs(node), aExpectedURINodes > 0);
do_check_eq(PU.getURLsForContainerNode(node).length, aExpectedURINodes);
root.containerOpen = false;
}
function run_test() {
tests.forEach(function(aTest) {
remove_all_bookmarks();
aTest();
});
// Cleanup.
remove_all_bookmarks();
}