gecko/toolkit/components/places/tests/bookmarks/test_onBeforeItemRemoved_observer.js

/* -*- 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 mozilla.org 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):
 *   Shawn Wilsher <me@shawnwilsher.com> (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 ***** */

/**
 * Added with bug 468305 to test that onBeforeItemRemoved is dispatched before
 * removed always with the right id.
 */

////////////////////////////////////////////////////////////////////////////////
//// Globals and Constants

let bs = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].
         getService(Ci.nsINavBookmarksService);

////////////////////////////////////////////////////////////////////////////////
//// Observer

function Observer(aExpectedId)
{
}
Observer.prototype =
{
  checked: false,
  onItemMovedCalled: false,
  onItemRemovedCalled: false,
  onBeginUpdateBatch: function() {
  },
  onEndUpdateBatch: function() {
  },
  onItemAdded: function(id, folder, index) {
  },
  onBeforeItemRemoved: function(id) {
    this.removedId = id;
  },
  onItemRemoved: function(id, folder, index) {
    do_check_false(this.checked);
    do_check_eq(this.removedId, id);
    this.onItemRemovedCalled = true;
  },
  onItemChanged: function(id, property, isAnnotationProperty, value) {
  },
  onItemVisited: function(id, visitID, time) {
  },
  onItemMoved: function(id, oldParent, oldIndex, newParent, newIndex) {
    this.onItemMovedCalled = true;
  },
  QueryInterface: function(iid) {
    if (iid.equals(Ci.nsINavBookmarkObserver) ||
        iid.equals(Ci.nsISupports)) {
      return this;
    }
    throw Cr.NS_ERROR_NO_INTERFACE;
  }
};

////////////////////////////////////////////////////////////////////////////////
//// Test Functions

function test_removeItem()
{
  // First we add the item we are going to remove.
  let id = bs.insertBookmark(bs.unfiledBookmarksFolder,
                             uri("http://mozilla.org"), bs.DEFAULT_INDEX, "t");

  // Add our observer, and remove it.
  let observer = new Observer(id);
  bs.addObserver(observer, false);
  bs.removeItem(id);

  // Make sure we were notified!
  do_check_true(observer.onItemRemovedCalled);
  bs.removeObserver(observer);
}

function test_removeFolder()
{
  // First we add the item we are going to remove.
  let id = bs.createFolder(bs.unfiledBookmarksFolder, "t", bs.DEFAULT_INDEX);

  // Add our observer, and remove it.
  let observer = new Observer(id);
  bs.addObserver(observer, false);
  bs.removeItem(id);

  // Make sure we were notified!
  do_check_true(observer.onItemRemovedCalled);
  bs.removeObserver(observer);
}

function test_removeFolderChildren()
{
  // First we add the item we are going to remove.
  let fid = bs.createFolder(bs.unfiledBookmarksFolder, "tf", bs.DEFAULT_INDEX);
  let id = bs.insertBookmark(fid, uri("http://mozilla.org"), bs.DEFAULT_INDEX,
                             "t");

  // Add our observer, and remove it.
  let observer = new Observer(id);
  bs.addObserver(observer, false);
  bs.removeFolderChildren(fid);

  // Make sure we were notified!
  do_check_true(observer.onItemRemovedCalled);
  bs.removeObserver(observer);
}

function test_setItemIndex()
{
  // First we add the item we are going to move, and one additional one.
  let id = bs.insertBookmark(bs.unfiledBookmarksFolder,
                             uri("http://mozilla.org/1"), 0, "t1");
  bs.insertBookmark(bs.unfiledBookmarksFolder, uri("http://mozilla.org/2"), 1,
                    "t1");

  // Add our observer, and move it.
  let observer = new Observer(id);
  bs.addObserver(observer, false);
  bs.setItemIndex(id, 2);

  // Make sure we were notified!
  do_check_true(observer.onItemMovedCalled);
  bs.removeObserver(observer);
}

////////////////////////////////////////////////////////////////////////////////
//// Test Runner

let tests = [
  test_removeItem,
  test_removeFolder,
  test_removeFolderChildren,
  test_setItemIndex,
];
function run_test()
{
  tests.forEach(function(test) test());
}