text: /**
   *    Copyright (C) 2013 10gen Inc.
   *
   *    This program is free software: you can redistribute it and/or  modify
   *    it under the terms of the GNU Affero General Public License, version 3,
   *    as published by the Free Software Foundation.
   *
   *    This program is distributed in the hope that it will be useful,
   *    but WITHOUT ANY WARRANTY; without even the implied warranty of
   *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   *    GNU Affero General Public License for more details.
   *
   *    You should have received a copy of the GNU Affero General Public License
   *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
   *
   *    As a special exception, the copyright holders give permission to link the
   *    code of portions of this program with the OpenSSL library under certain
   *    conditions as described in each individual source file and distribute
   *    linked combinations including the program with the OpenSSL library. You
   *    must comply with the GNU Affero General Public License in all respects for
   *    all of the code used other than as permitted herein. If you modify file(s)
   *    with this exception, you may extend this exception to your version of the
   *    file(s), but you are not obligated to do so. If you do not wish to do so,
   *    delete this exception statement from your version. If you delete this
   *    exception statement from all source files in the program, then also delete
   *    it in the license file.
   */
  
  /**
   * This file contains tests for mongo/db/query/query_planner.cpp
   */
  
  #include "mongo/db/jsobj.h"
  #include "mongo/db/json.h"
  #include "mongo/db/matcher/expression_parser.h"
  #include "mongo/db/query/query_planner.h"
  #include "mongo/db/query/query_solution.h"
  #include "mongo/unittest/unittest.h"
  #include "mongo/util/assert_util.h"
  #include <ostream>
  
  namespace mongo {
  
  class QueryPlannerTestLib {
  public:
      /**
       * @param testSoln -- a BSON representation of a query solution
       * @param trueSoln -- the root node of a query solution tree
       *
       * Returns true if the BSON representation matches the actual
       * tree, otherwise returns false.
       */
      static bool solutionMatches(const BSONObj& testSoln, const QuerySolutionNode* trueSoln);
  
      static bool solutionMatches(const std::string& testSoln, const QuerySolutionNode* trueSoln) {
          return solutionMatches(fromjson(testSoln), trueSoln);
      }
  };
  
  }  // namespace mongo
  