browser_0_library_left_pane_migration.js

Enable keyboard shortcuts

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim:set ts=2 sw=2 sts=2 et: */

/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**

 *  Test we correctly migrate Library left pane to the latest version.

 *  Note: this test MUST be the first between browser chrome tests, or results

 *        of next tests could be unexpected due to PlacesUIUtils getters.

*/

const TEST_URI = "http://www.mozilla.org/";

function onLibraryReady(organizer) {

      // Check left pane.

      ok(PlacesUIUtils.leftPaneFolderId > 0,

         "Left pane folder correctly created");

      var leftPaneItems =

        PlacesUtils.annotations

                   .getItemsWithAnnotation(PlacesUIUtils.ORGANIZER_FOLDER_ANNO);

      is(leftPaneItems.length, 1,

         "We correctly have only 1 left pane folder");

      var leftPaneRoot = leftPaneItems[0];

      is(leftPaneRoot, PlacesUIUtils.leftPaneFolderId,

         "leftPaneFolderId getter has correct value");

      // Check version has been upgraded.

      var version =

        PlacesUtils.annotations.getItemAnnotation(leftPaneRoot,

                                                  PlacesUIUtils.ORGANIZER_FOLDER_ANNO);

      is(version, PlacesUIUtils.ORGANIZER_LEFTPANE_VERSION,

         "Left pane version has been correctly upgraded");

      // Check left pane is populated.

      organizer.PlacesOrganizer.selectLeftPaneQuery('AllBookmarks');

      is(organizer.PlacesOrganizer._places.selectedNode.itemId,

         PlacesUIUtils.leftPaneQueries["AllBookmarks"],

         "Library left pane is populated and working");

      // Close Library window.

      organizer.close();

      // No need to cleanup anything, we have a correct left pane now.

      finish();

function test() {

  waitForExplicitFinish();

  // Sanity checks.

  ok(PlacesUtils, "PlacesUtils is running in chrome context");

  ok(PlacesUIUtils, "PlacesUIUtils is running in chrome context");

  ok(PlacesUIUtils.ORGANIZER_LEFTPANE_VERSION > 0,

     "Left pane version in chrome context, current version is: " + PlacesUIUtils.ORGANIZER_LEFTPANE_VERSION );

  // Check if we have any left pane folder already set, remove it eventually.

  var leftPaneItems = PlacesUtils.annotations

                                 .getItemsWithAnnotation(PlacesUIUtils.ORGANIZER_FOLDER_ANNO);

  if (leftPaneItems.length > 0) {

    // The left pane has already been created, touching it now would cause

    // next tests to rely on wrong values (and possibly crash)

    is(leftPaneItems.length, 1, "We correctly have only 1 left pane folder");

    // Check version.

    var version = PlacesUtils.annotations.getItemAnnotation(leftPaneItems[0],

                                                            PlacesUIUtils.ORGANIZER_FOLDER_ANNO);

    is(version, PlacesUIUtils.ORGANIZER_LEFTPANE_VERSION, "Left pane version is actual");

    ok(true, "left pane has already been created, skipping test");

    finish();

    return;

  // Create a fake left pane folder with an old version (current version - 1).

  var fakeLeftPaneRoot =

    PlacesUtils.bookmarks.createFolder(PlacesUtils.placesRootId, "",

                                       PlacesUtils.bookmarks.DEFAULT_INDEX);

  PlacesUtils.annotations.setItemAnnotation(fakeLeftPaneRoot,

                                            PlacesUIUtils.ORGANIZER_FOLDER_ANNO,

                                            PlacesUIUtils.ORGANIZER_LEFTPANE_VERSION - 1,

0,

                                            PlacesUtils.annotations.EXPIRE_NEVER);

  // Check fake left pane root has been correctly created.

  var leftPaneItems =

    PlacesUtils.annotations.getItemsWithAnnotation(PlacesUIUtils.ORGANIZER_FOLDER_ANNO);

  is(leftPaneItems.length, 1, "We correctly have only 1 left pane folder");

  is(leftPaneItems[0], fakeLeftPaneRoot, "left pane root itemId is correct");

  // Check version.

  var version = PlacesUtils.annotations.getItemAnnotation(fakeLeftPaneRoot,

                                                          PlacesUIUtils.ORGANIZER_FOLDER_ANNO);

  is(version, PlacesUIUtils.ORGANIZER_LEFTPANE_VERSION - 1, "Left pane version correctly set");

  // Open Library, this will upgrade our left pane version.

  openLibrary(onLibraryReady);