Bug 708693 - Intermittent TEST-UNEXPECTED-FAIL | xpcshell/tests/toolkit/components/places/tests/bookmarks/test_keywords.js.

r=dietrich a=tests-only

toolkit/components/places/tests/bookmarks/test_keywords.js

@@ -1,81 +1,45 @@
-/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* Any copyright is dedicated to the Public Domain.
-/* vim:set ts=2 sw=2 sts=2 et: */
+   http://creativecommons.org/publicdomain/zero/1.0/ */
-/* ***** 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 Test Code.
- *
- * The Initial Developer of the Original Code is the Mozilla Foundation.
- * Portions created by the Initial Developer are Copyright (C) 2010
- * 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 ***** */
 
-let bs = PlacesUtils.bookmarks;
+function check_bookmark_keyword(aItemId, aKeyword)
-let db = DBConn();
+{
+  let keyword = aKeyword ? aKeyword.toLowerCase() : null;
+  do_check_eq(PlacesUtils.bookmarks.getKeywordForBookmark(aItemId),
+              keyword);
+}
 
-function check_keyword(aItemId, aExpectedBookmarkKeyword, aExpectedURIKeyword) {
+function check_uri_keyword(aURI, aKeyword)
-  // All keywords are handled lowercased internally.
+{
-  if (aExpectedURIKeyword)
+  let keyword = aKeyword ? aKeyword.toLowerCase() : null;
-    aExpectedURIKeyword = aExpectedURIKeyword.toLowerCase();
+  do_check_eq(PlacesUtils.bookmarks.getKeywordForURI(aURI),
-  if (aExpectedBookmarkKeyword)
+              keyword);
-    aExpectedBookmarkKeyword = aExpectedBookmarkKeyword.toLowerCase();
 
-  if (aItemId) {
+  if (aKeyword) {
-    print("Check keyword for bookmark");
-    do_check_eq(bs.getKeywordForBookmark(aItemId), aExpectedBookmarkKeyword);
-
-    print("Check keyword for uri");
-    let uri = bs.getBookmarkURI(aItemId);
-    do_check_eq(bs.getKeywordForURI(uri), aExpectedURIKeyword);
-
-    print("Check uri for keyword");
     // This API can't tell which uri the user wants, so it returns a random one.
-    if (aExpectedURIKeyword) {
+    let re = /http:\/\/test[0-9]\.mozilla\.org/;
-      do_check_true(/http:\/\/test[0-9]\.mozilla\.org/.test(bs.getURIForKeyword(aExpectedURIKeyword).spec));
+    let url = PlacesUtils.bookmarks.getURIForKeyword(aKeyword).spec;
-      // Check case insensitivity.
+    do_check_true(re.test(url));
-      do_check_true(/http:\/\/test[0-9]\.mozilla\.org/.test(bs.getURIForKeyword(aExpectedURIKeyword.toUpperCase()).spec));
+    // Check case insensitivity.
-    }
+    url = PlacesUtils.bookmarks.getURIForKeyword(aKeyword.toUpperCase()).spec
+    do_check_true(re.test(url));
   }
-  else {
+}
-    stmt = db.createStatement(
+
-      "SELECT id FROM moz_keywords WHERE keyword = :keyword"
+function check_orphans()
-    );
+{
-    stmt.params.keyword = aExpectedBookmarkKeyword;
+  stmt = DBConn().createStatement(
-    try {
+    "SELECT id FROM moz_keywords k WHERE NOT EXISTS ("
-      do_check_false(stmt.executeStep());
+  +    "SELECT id FROM moz_bookmarks WHERE keyword_id = k.id "
-    } finally {
+  + ")"
-      stmt.finalize();
+  );
-    }
+  try {
+    do_check_false(stmt.executeStep());
+  } finally {
+    stmt.finalize();
   }
 
   print("Check there are no orphan database entries");
-  let stmt = db.createStatement(
+  let stmt = DBConn().createStatement(
     "SELECT b.id FROM moz_bookmarks b "
   + "LEFT JOIN moz_keywords k ON b.keyword_id = k.id "
   + "WHERE keyword_id NOTNULL AND k.id ISNULL"
@@ -87,54 +51,111 @@ function check_keyword(aItemId, aExpectedBookmarkKeyword, aExpectedURIKeyword) {
   }
 }
 
-function run_test() {
+const URIS = [
-  print("Check that leyword does not exist");
+  uri("http://test1.mozilla.org/"),
-  do_check_eq(bs.getURIForKeyword("keyword"), null);
+  uri("http://test2.mozilla.org/"),
+];
 
-  let folderId = bs.createFolder(PlacesUtils.unfiledBookmarksFolderId,
+add_test(function test_addBookmarkWithKeyword()
-                                 "folder", bs.DEFAULT_INDEX);
+{
+  check_uri_keyword(URIS[0], null);
+
+  let itemId =
+    PlacesUtils.bookmarks.insertBookmark(PlacesUtils.unfiledBookmarksFolderId,
+                                         URIS[0],
+                                         PlacesUtils.bookmarks.DEFAULT_INDEX,
+                                         "test");
+  PlacesUtils.bookmarks.setKeywordForBookmark(itemId, "keyword");
+  check_bookmark_keyword(itemId, "keyword");
+  check_uri_keyword(URIS[0], "keyword");
+
+  waitForAsyncUpdates(function() {
+    check_orphans();
+    run_next_test();
+  });
+});
+
+add_test(function test_addBookmarkToURIHavingKeyword()
+{
+  let itemId =
+    PlacesUtils.bookmarks.insertBookmark(PlacesUtils.unfiledBookmarksFolderId,
+                                         URIS[0],
+                                         PlacesUtils.bookmarks.DEFAULT_INDEX,
+                                         "test");
+  // The uri has a keyword, but this specific bookmark has not.
+  check_bookmark_keyword(itemId, null);
+  check_uri_keyword(URIS[0], "keyword");
+
+  waitForAsyncUpdates(function() {
+    check_orphans();
+    run_next_test();
+  });
+});
+
+add_test(function test_addSameKeywordToOtherURI()
+{
+  let itemId =
+    PlacesUtils.bookmarks.insertBookmark(PlacesUtils.unfiledBookmarksFolderId,
+                                         URIS[1],
+                                         PlacesUtils.bookmarks.DEFAULT_INDEX,
+                                         "test2");
+  check_bookmark_keyword(itemId, null);
+  check_uri_keyword(URIS[1], null);
+
+  PlacesUtils.bookmarks.setKeywordForBookmark(itemId, "kEyWoRd");
+  check_bookmark_keyword(itemId, "kEyWoRd");
+  check_uri_keyword(URIS[1], "kEyWoRd");
 
-  print("Add a bookmark with a keyword");
-  let itemId1 = bs.insertBookmark(folderId,
-                                  uri("http://test1.mozilla.org/"),
-                                  bs.DEFAULT_INDEX,
-                                  "test1");
-  check_keyword(itemId1, null, null);
-  bs.setKeywordForBookmark(itemId1, "keyword");
-  check_keyword(itemId1, "keyword", "keyword");
   // Check case insensitivity.
-  check_keyword(itemId1, "kEyWoRd", "kEyWoRd");
+  check_uri_keyword(URIS[0], "kEyWoRd");
+  check_bookmark_keyword(itemId, "keyword");
+  check_uri_keyword(URIS[1], "keyword");
+  check_uri_keyword(URIS[0], "keyword");
 
-  print("Add another bookmark with the same uri, should not inherit keyword.");
+  waitForAsyncUpdates(function() {
-  let itemId1_bis = bs.insertBookmark(folderId,
+    check_orphans();
-                                      uri("http://test1.mozilla.org/"),
+    run_next_test();
-                                      bs.DEFAULT_INDEX,
+  });
-                                      "test1_bis");
+});
 
-  check_keyword(itemId1_bis, null, "keyword");
+add_test(function test_removeBookmarkWithKeyword()
-  // Check case insensitivity.
+{
-  check_keyword(itemId1_bis, null, "kEyWoRd");
+  let itemId =
+    PlacesUtils.bookmarks.insertBookmark(PlacesUtils.unfiledBookmarksFolderId,
+                                         URIS[1],
+                                         PlacesUtils.bookmarks.DEFAULT_INDEX,
+                                         "test");
+  PlacesUtils.bookmarks.setKeywordForBookmark(itemId, "keyword");
+  check_bookmark_keyword(itemId, "keyword");
+  check_uri_keyword(URIS[1], "keyword");
 
-  print("Set same keyword on another bookmark with a different uri.");
+  // The keyword should not be removed from other bookmarks.
-  let itemId2 = bs.insertBookmark(folderId,
+  PlacesUtils.bookmarks.removeItem(itemId);
-                                  uri("http://test2.mozilla.org/"),
-                                  bs.DEFAULT_INDEX,
-                                  "test2");
-  check_keyword(itemId2, null, null);
-  bs.setKeywordForBookmark(itemId2, "kEyWoRd");
-  check_keyword(itemId1, "kEyWoRd", "kEyWoRd");
-  // Check case insensitivity.
-  check_keyword(itemId1, "keyword", "keyword");
-  check_keyword(itemId1_bis, null, "keyword");
-  check_keyword(itemId2, "keyword", "keyword");
 
-  print("Remove a bookmark with a keyword, it should not be removed from others");
+  check_uri_keyword(URIS[1], "keyword");
-  bs.removeItem(itemId2);
+  check_uri_keyword(URIS[0], "keyword");
-  check_keyword(itemId1, "keyword", "keyword");
 
-  print("Remove a folder containing bookmarks with keywords");
+  waitForAsyncUpdates(function() {
+    check_orphans();
+    run_next_test();
+  });
+});
+
+add_test(function test_removeFolderWithKeywordedBookmarks()
+{
   // Keyword should be removed as well.
-  bs.removeItem(folderId);
+  PlacesUtils.bookmarks.removeFolderChildren(PlacesUtils.unfiledBookmarksFolderId);
-  check_keyword(null, "keyword");
-}
 
+  check_uri_keyword(URIS[1], null);
+  check_uri_keyword(URIS[0], null);
+
+  waitForAsyncUpdates(function() {
+    check_orphans();
+    run_next_test();
+  });
+});
+
+function run_test()
+{
+  run_next_test();
+}