chrome/browser/bookmarks/bookmark_model_test_utils.h

// Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_BOOKMARKS_BOOKMARK_MODEL_TEST_UTILS_H_
#define CHROME_BROWSER_BOOKMARKS_BOOKMARK_MODEL_TEST_UTILS_H_

#include <string>

#include "base/basictypes.h"

class BookmarkModel;
class BookmarkNode;

// Contains utilities for bookmark model related tests.
class BookmarkModelTestUtils {
 public:
  // Verifies that the two given bookmark models are the same.
  // The IDs of the bookmark nodes are compared only if check_ids is true.
  static void AssertModelsEqual(BookmarkModel* expected,
                                BookmarkModel* actual,
                                bool check_ids);

  // Return the descendants of |node| as a string useful for verifying node
  // modifications. The format of the resulting string is:
  //
  //           result = node " " , { node " " }
  //             node = bookmark title | folder
  //           folder = folder title ":[ " { node " " } "]"
  //   bookmark title = (* string with no spaces *)
  //     folder title = (* string with no spaces *)
  //
  // Example: "a f1:[ b d c ] d f2:[ e f g ] h "
  //
  // (Logically, we should use |string16|s, but it's more convenient for test
  // purposes to use (UTF-8) |std::string|s.)
  static std::string ModelStringFromNode(const BookmarkNode* node);

  // Create and add the node hierarchy specified by |nodeString| to the
  // bookmark node given by |node|. The string has the same format as
  // specified for ModelStringFromNode. The new nodes added to |node|
  // are appended to the end of node's existing subnodes, if any.
  // |model| must be the model of which |node| is a member.
  // NOTE: The string format is very rigid and easily broken if not followed
  //       exactly (since we're using a very simple parser).
  static void AddNodesFromModelString(BookmarkModel* model,
                                      const BookmarkNode* node,
                                      const std::string& model_string);

 private:
  DISALLOW_IMPLICIT_CONSTRUCTORS(BookmarkModelTestUtils);
};

#endif  // CHROME_BROWSER_BOOKMARKS_BOOKMARK_MODEL_TEST_UTILS_H_