michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: Cu.import("resource://gre/modules/BookmarkJSONUtils.jsm");
michael@0: 
michael@0: function run_test() {
michael@0:   run_next_test();
michael@0: }
michael@0: 
michael@0: const LOAD_IN_SIDEBAR_ANNO = "bookmarkProperties/loadInSidebar";
michael@0: const DESCRIPTION_ANNO = "bookmarkProperties/description";
michael@0: 
michael@0: // An object representing the contents of bookmarks.json.
michael@0: let test_bookmarks = {
michael@0:   menu: [
michael@0:     { title: "Mozilla Firefox",
michael@0:       children: [
michael@0:         { title: "Help and Tutorials",
michael@0:           url: "http://en-us.www.mozilla.com/en-US/firefox/help/",
michael@0:           icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHWSURBVHjaYvz//z8DJQAggJiQOe/fv2fv7Oz8rays/N+VkfG/iYnJfyD/1+rVq7ffu3dPFpsBAAHEAHIBCJ85c8bN2Nj4vwsDw/8zQLwKiO8CcRoQu0DxqlWrdsHUwzBAAIGJmTNnPgYa9j8UqhFElwPxf2MIDeIrKSn9FwSJoRkAEEAM0DD4DzMAyPi/G+QKY4hh5WAXGf8PDQ0FGwJ22d27CjADAAIIrLmjo+MXA9R2kAHvGBA2wwx6B8W7od6CeQcggKCmCEL8bgwxYCbUIGTDVkHDBia+CuotgACCueD3TDQN75D4xmAvCoK9ARMHBzAw0AECiBHkAlC0Mdy7x9ABNA3obAZXIAa6iKEcGlMVQHwWyjYuL2d4v2cPg8vZswx7gHyAAAK7AOif7SAbOqCmn4Ha3AHFsIDtgPq/vLz8P4MSkJ2W9h8ggBjevXvHDo4FQUQg/kdypqCg4H8lUIACnQ/SOBMYI8bAsAJFPcj1AAEEjwVQqLpAbXmH5BJjqI0gi9DTAAgDBBCcAVLkgmQ7yKCZxpCQxqUZhAECCJ4XgMl493ug21ZD+aDAXH0WLM4A9MZPXJkJIIAwTAR5pQMalaCABQUULttBGCCAGCnNzgABBgAMJ5THwGvJLAAAAABJRU5ErkJggg=="
michael@0:         },
michael@0:         { title: "Customize Firefox",
michael@0:           url: "http://en-us.www.mozilla.com/en-US/firefox/customize/",
michael@0:           icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHWSURBVHjaYvz//z8DJQAggJiQOe/fv2fv7Oz8rays/N+VkfG/iYnJfyD/1+rVq7ffu3dPFpsBAAHEAHIBCJ85c8bN2Nj4vwsDw/8zQLwKiO8CcRoQu0DxqlWrdsHUwzBAAIGJmTNnPgYa9j8UqhFElwPxf2MIDeIrKSn9FwSJoRkAEEAM0DD4DzMAyPi/G+QKY4hh5WAXGf8PDQ0FGwJ22d27CjADAAIIrLmjo+MXA9R2kAHvGBA2wwx6B8W7od6CeQcggKCmCEL8bgwxYCbUIGTDVkHDBia+CuotgACCueD3TDQN75D4xmAvCoK9ARMHBzAw0AECiBHkAlC0Mdy7x9ABNA3obAZXIAa6iKEcGlMVQHwWyjYuL2d4v2cPg8vZswx7gHyAAAK7AOif7SAbOqCmn4Ha3AHFsIDtgPq/vLz8P4MSkJ2W9h8ggBjevXvHDo4FQUQg/kdypqCg4H8lUIACnQ/SOBMYI8bAsAJFPcj1AAEEjwVQqLpAbXmH5BJjqI0gi9DTAAgDBBCcAVLkgmQ7yKCZxpCQxqUZhAECCJ4XgMl493ug21ZD+aDAXH0WLM4A9MZPXJkJIIAwTAR5pQMalaCABQUULttBGCCAGCnNzgABBgAMJ5THwGvJLAAAAABJRU5ErkJggg=="
michael@0:         },
michael@0:         { title: "Get Involved",
michael@0:           url: "http://en-us.www.mozilla.com/en-US/firefox/community/",
michael@0:           icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHWSURBVHjaYvz//z8DJQAggJiQOe/fv2fv7Oz8rays/N+VkfG/iYnJfyD/1+rVq7ffu3dPFpsBAAHEAHIBCJ85c8bN2Nj4vwsDw/8zQLwKiO8CcRoQu0DxqlWrdsHUwzBAAIGJmTNnPgYa9j8UqhFElwPxf2MIDeIrKSn9FwSJoRkAEEAM0DD4DzMAyPi/G+QKY4hh5WAXGf8PDQ0FGwJ22d27CjADAAIIrLmjo+MXA9R2kAHvGBA2wwx6B8W7od6CeQcggKCmCEL8bgwxYCbUIGTDVkHDBia+CuotgACCueD3TDQN75D4xmAvCoK9ARMHBzAw0AECiBHkAlC0Mdy7x9ABNA3obAZXIAa6iKEcGlMVQHwWyjYuL2d4v2cPg8vZswx7gHyAAAK7AOif7SAbOqCmn4Ha3AHFsIDtgPq/vLz8P4MSkJ2W9h8ggBjevXvHDo4FQUQg/kdypqCg4H8lUIACnQ/SOBMYI8bAsAJFPcj1AAEEjwVQqLpAbXmH5BJjqI0gi9DTAAgDBBCcAVLkgmQ7yKCZxpCQxqUZhAECCJ4XgMl493ug21ZD+aDAXH0WLM4A9MZPXJkJIIAwTAR5pQMalaCABQUULttBGCCAGCnNzgABBgAMJ5THwGvJLAAAAABJRU5ErkJggg=="
michael@0:         },
michael@0:         { title: "About Us",
michael@0:           url: "http://en-us.www.mozilla.com/en-US/about/",
michael@0:           icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHWSURBVHjaYvz//z8DJQAggJiQOe/fv2fv7Oz8rays/N+VkfG/iYnJfyD/1+rVq7ffu3dPFpsBAAHEAHIBCJ85c8bN2Nj4vwsDw/8zQLwKiO8CcRoQu0DxqlWrdsHUwzBAAIGJmTNnPgYa9j8UqhFElwPxf2MIDeIrKSn9FwSJoRkAEEAM0DD4DzMAyPi/G+QKY4hh5WAXGf8PDQ0FGwJ22d27CjADAAIIrLmjo+MXA9R2kAHvGBA2wwx6B8W7od6CeQcggKCmCEL8bgwxYCbUIGTDVkHDBia+CuotgACCueD3TDQN75D4xmAvCoK9ARMHBzAw0AECiBHkAlC0Mdy7x9ABNA3obAZXIAa6iKEcGlMVQHwWyjYuL2d4v2cPg8vZswx7gHyAAAK7AOif7SAbOqCmn4Ha3AHFsIDtgPq/vLz8P4MSkJ2W9h8ggBjevXvHDo4FQUQg/kdypqCg4H8lUIACnQ/SOBMYI8bAsAJFPcj1AAEEjwVQqLpAbXmH5BJjqI0gi9DTAAgDBBCcAVLkgmQ7yKCZxpCQxqUZhAECCJ4XgMl493ug21ZD+aDAXH0WLM4A9MZPXJkJIIAwTAR5pQMalaCABQUULttBGCCAGCnNzgABBgAMJ5THwGvJLAAAAABJRU5ErkJggg=="
michael@0:         }
michael@0:       ]
michael@0:     },
michael@0:     {
michael@0:       type: Ci.nsINavHistoryResultNode.RESULT_TYPE_SEPARATOR
michael@0:     },
michael@0:     { title: "test",
michael@0:       description: "folder test comment",
michael@0:       dateAdded: 1177541020000000,
michael@0:       //lastModified: 1177541050000000,
michael@0:       children: [
michael@0:         { title: "test post keyword",
michael@0:           description: "item description",
michael@0:           dateAdded: 1177375336000000,
michael@0:           //lastModified: 1177375423000000,
michael@0:           keyword: "test",
michael@0:           sidebar: true,
michael@0:           postData: "hidden1%3Dbar&text1%3D%25s",
michael@0:           charset: "ISO-8859-1"
michael@0:         }
michael@0:       ]
michael@0:     }
michael@0:   ],
michael@0:   toolbar: [
michael@0:     { title: "Getting Started",
michael@0:       url: "http://en-us.www.mozilla.com/en-US/firefox/central/",
michael@0:       icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAHWSURBVHjaYvz//z8DJQAggJiQOe/fv2fv7Oz8rays/N+VkfG/iYnJfyD/1+rVq7ffu3dPFpsBAAHEAHIBCJ85c8bN2Nj4vwsDw/8zQLwKiO8CcRoQu0DxqlWrdsHUwzBAAIGJmTNnPgYa9j8UqhFElwPxf2MIDeIrKSn9FwSJoRkAEEAM0DD4DzMAyPi/G+QKY4hh5WAXGf8PDQ0FGwJ22d27CjADAAIIrLmjo+MXA9R2kAHvGBA2wwx6B8W7od6CeQcggKCmCEL8bgwxYCbUIGTDVkHDBia+CuotgACCueD3TDQN75D4xmAvCoK9ARMHBzAw0AECiBHkAlC0Mdy7x9ABNA3obAZXIAa6iKEcGlMVQHwWyjYuL2d4v2cPg8vZswx7gHyAAAK7AOif7SAbOqCmn4Ha3AHFsIDtgPq/vLz8P4MSkJ2W9h8ggBjevXvHDo4FQUQg/kdypqCg4H8lUIACnQ/SOBMYI8bAsAJFPcj1AAEEjwVQqLpAbXmH5BJjqI0gi9DTAAgDBBCcAVLkgmQ7yKCZxpCQxqUZhAECCJ4XgMl493ug21ZD+aDAXH0WLM4A9MZPXJkJIIAwTAR5pQMalaCABQUULttBGCCAGCnNzgABBgAMJ5THwGvJLAAAAABJRU5ErkJggg=="
michael@0:     },
michael@0:     { title: "Latest Headlines",
michael@0:       url: "http://en-us.fxfeeds.mozilla.com/en-US/firefox/livebookmarks/",
michael@0:       feedUrl: "http://en-us.fxfeeds.mozilla.com/en-US/firefox/headlines.xml"
michael@0:     }
michael@0:   ],
michael@0:   unfiled: [
michael@0:     { title: "Example.tld",
michael@0:       url: "http://example.tld/"
michael@0:     }
michael@0:   ]
michael@0: };
michael@0: 
michael@0: // Exported bookmarks file pointer.
michael@0: let bookmarksExportedFile;
michael@0: 
michael@0: add_task(function test_import_bookmarks() {
michael@0:   let bookmarksFile = OS.Path.join(do_get_cwd().path, "bookmarks.json");
michael@0: 
michael@0:   yield BookmarkJSONUtils.importFromFile(bookmarksFile, true);
michael@0:   yield testImportedBookmarks();
michael@0: });
michael@0: 
michael@0: add_task(function test_export_bookmarks() {
michael@0:   bookmarksExportedFile = OS.Path.join(OS.Constants.Path.profileDir,
michael@0:                                        "bookmarks.exported.json");
michael@0:   yield BookmarkJSONUtils.exportToFile(bookmarksExportedFile);
michael@0: });
michael@0: 
michael@0: add_task(function test_import_exported_bookmarks() {
michael@0:   remove_all_bookmarks();
michael@0:   yield BookmarkJSONUtils.importFromFile(bookmarksExportedFile, true);
michael@0:   yield testImportedBookmarks();
michael@0: });
michael@0: 
michael@0: add_task(function test_import_ontop() {
michael@0:   remove_all_bookmarks();
michael@0:   yield BookmarkJSONUtils.importFromFile(bookmarksExportedFile, true);
michael@0:   yield BookmarkJSONUtils.exportToFile(bookmarksExportedFile);
michael@0:   yield BookmarkJSONUtils.importFromFile(bookmarksExportedFile, true);
michael@0:   yield testImportedBookmarks();
michael@0: });
michael@0: 
michael@0: add_task(function test_clean() {
michael@0:   remove_all_bookmarks();
michael@0: });
michael@0: 
michael@0: function testImportedBookmarks() {
michael@0:   for (let group in test_bookmarks) {
michael@0:     do_print("[testImportedBookmarks()] Checking group '" + group + "'");
michael@0: 
michael@0:     let root;
michael@0:     switch (group) {
michael@0:       case "menu":
michael@0:         root =
michael@0:           PlacesUtils.getFolderContents(PlacesUtils.bookmarksMenuFolderId).root;
michael@0:         break;
michael@0:       case "toolbar":
michael@0:         root =
michael@0:           PlacesUtils.getFolderContents(PlacesUtils.toolbarFolderId).root;
michael@0:         break;
michael@0:       case "unfiled":
michael@0:         root =
michael@0:           PlacesUtils.getFolderContents(PlacesUtils.unfiledBookmarksFolderId).root;
michael@0:         break;
michael@0:     }
michael@0: 
michael@0:     let items = test_bookmarks[group];
michael@0:     do_check_eq(root.childCount, items.length);
michael@0: 
michael@0:     for (let key in items) {
michael@0:       yield checkItem(items[key], root.getChild(key));
michael@0:     }
michael@0: 
michael@0:     root.containerOpen = false;
michael@0:   }
michael@0: }
michael@0: 
michael@0: function checkItem(aExpected, aNode) {
michael@0:   let id = aNode.itemId;
michael@0: 
michael@0:   return Task.spawn(function() {
michael@0:     for (prop in aExpected) {
michael@0:       switch (prop) {
michael@0:         case "type":
michael@0:           do_check_eq(aNode.type, aExpected.type);
michael@0:           break;
michael@0:         case "title":
michael@0:           do_check_eq(aNode.title, aExpected.title);
michael@0:           break;
michael@0:         case "description":
michael@0:           do_check_eq(PlacesUtils.annotations.getItemAnnotation(
michael@0:                       id, DESCRIPTION_ANNO), aExpected.description);
michael@0:           break;
michael@0:         case "dateAdded":
michael@0:           do_check_eq(PlacesUtils.bookmarks.getItemDateAdded(id),
michael@0:                       aExpected.dateAdded);
michael@0:           break;
michael@0:         case "lastModified":
michael@0:           do_check_eq(PlacesUtils.bookmarks.getItemLastModified(id),
michael@0:                       aExpected.lastModified);
michael@0:           break;
michael@0:         case "url":
michael@0:           if (!("feedUrl" in aExpected))
michael@0:             do_check_eq(aNode.uri, aExpected.url);
michael@0:           break;
michael@0:         case "icon":
michael@0:           let (deferred = Promise.defer(), data) {
michael@0:             PlacesUtils.favicons.getFaviconDataForPage(
michael@0:               NetUtil.newURI(aExpected.url),
michael@0:               function (aURI, aDataLen, aData, aMimeType) {
michael@0:                 deferred.resolve(aData);
michael@0:               });
michael@0:             data = yield deferred.promise;
michael@0:             let base64Icon = "data:image/png;base64," +
michael@0:                              base64EncodeString(String.fromCharCode.apply(String, data));
michael@0:             do_check_true(base64Icon == aExpected.icon);
michael@0:           }
michael@0:           break;
michael@0:         case "keyword":
michael@0:           break;
michael@0:         case "sidebar":
michael@0:           do_check_eq(PlacesUtils.annotations.itemHasAnnotation(
michael@0:                       id, LOAD_IN_SIDEBAR_ANNO), aExpected.sidebar);
michael@0:           break;
michael@0:         case "postData":
michael@0:           do_check_eq(PlacesUtils.annotations.getItemAnnotation(
michael@0:                       id, PlacesUtils.POST_DATA_ANNO), aExpected.postData);
michael@0:           break;
michael@0:         case "charset":
michael@0:           let testURI = NetUtil.newURI(aNode.uri);
michael@0:           do_check_eq((yield PlacesUtils.getCharsetForURI(testURI)), aExpected.charset);
michael@0:           break;
michael@0:         case "feedUrl":
michael@0:           let livemark = yield PlacesUtils.livemarks.getLivemark({ id: id });
michael@0:           do_check_eq(livemark.siteURI.spec, aExpected.url);
michael@0:           do_check_eq(livemark.feedURI.spec, aExpected.feedUrl);
michael@0:           break;
michael@0:         case "children":
michael@0:           let folder = aNode.QueryInterface(Ci.nsINavHistoryContainerResultNode);
michael@0:           do_check_eq(folder.hasChildren, aExpected.children.length > 0);
michael@0:           folder.containerOpen = true;
michael@0:           do_check_eq(folder.childCount, aExpected.children.length);
michael@0: 
michael@0:           aExpected.children.forEach(function (item, index) checkItem(item, folder.getChild(index)));
michael@0: 
michael@0:           folder.containerOpen = false;
michael@0:           break;
michael@0:         default:
michael@0:           throw new Error("Unknown property");
michael@0:       }
michael@0:     }
michael@0:   });
michael@0: }