/*jshint globalstrict:false, strict:false, maxlen: 500 */
/*global assertTrue, assertEqual, assertNotEqual, AQL_EXPLAIN */

////////////////////////////////////////////////////////////////////////////////
/// @brief tests for index usage
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2010-2012 triagens GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Jan Steemann
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

var jsunity = require("jsunity");
var db = require("@arangodb").db;

////////////////////////////////////////////////////////////////////////////////
/// @brief test suite
////////////////////////////////////////////////////////////////////////////////

function optimizerStatsTestSuite () {
  var c;

  return {
    setUp : function () {
      db._drop("UnitTestsCollection");
      c = db._create("UnitTestsCollection");
    },

    tearDown : function () {
      db._drop("UnitTestsCollection");
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test for-loop
////////////////////////////////////////////////////////////////////////////////

    testForLoop : function () {
      var query = "FOR i IN " + c.name() + " RETURN i";

      var stats = AQL_EXPLAIN(query).stats;
      assertTrue(stats.hasOwnProperty("plansCreated"));
      assertTrue(stats.hasOwnProperty("rulesExecuted"));
      assertTrue(stats.hasOwnProperty("rulesSkipped"));

      assertEqual(1, stats.plansCreated);
      assertNotEqual(0, stats.rulesExecuted);
      assertEqual(0, stats.rulesSkipped);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test for-loop permutation
////////////////////////////////////////////////////////////////////////////////

    testForLoopPermutation : function () {
      var query = "FOR i IN " + c.name() + " FOR j IN " + c.name() + " RETURN i";

      var stats = AQL_EXPLAIN(query).stats;
      assertTrue(stats.hasOwnProperty("plansCreated"));
      assertTrue(stats.hasOwnProperty("rulesExecuted"));
      assertTrue(stats.hasOwnProperty("rulesSkipped"));

      assertEqual(2, stats.plansCreated);
      assertNotEqual(0, stats.rulesExecuted);
      assertEqual(0, stats.rulesSkipped);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test for-loop permutation
////////////////////////////////////////////////////////////////////////////////

    testForLoopPermutationDisabled : function () {
      var query = "FOR i IN " + c.name() + " FOR j IN " + c.name() + " RETURN i";

      var stats = AQL_EXPLAIN(query, null, { optimizer: { rules: [ "-interchange-adjacent-enumerations" ] } }).stats;
      assertTrue(stats.hasOwnProperty("plansCreated"));
      assertTrue(stats.hasOwnProperty("rulesExecuted"));
      assertTrue(stats.hasOwnProperty("rulesSkipped"));

      assertEqual(1, stats.plansCreated);
      assertNotEqual(0, stats.rulesExecuted);
      assertEqual(1, stats.rulesSkipped);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test for-loop permutation
////////////////////////////////////////////////////////////////////////////////

    testForLoopPermutationAllDisabled : function () {
      var query = "FOR i IN " + c.name() + " FOR j IN " + c.name() + " RETURN i";

      var stats = AQL_EXPLAIN(query, null, { optimizer: { rules: [ "-all" ] } }).stats;
      assertTrue(stats.hasOwnProperty("plansCreated"));
      assertTrue(stats.hasOwnProperty("rulesExecuted"));
      assertTrue(stats.hasOwnProperty("rulesSkipped"));

      assertEqual(1, stats.plansCreated);
      assertTrue(1, stats.rulesExecuted);
      assertNotEqual(0, stats.rulesSkipped);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test for-loop permutation, maxNumberOfPlans
////////////////////////////////////////////////////////////////////////////////

    testForLoopPermutationMaxNumberOfPlans : function () {
      var query = "FOR i IN " + c.name() + " FOR j IN " + c.name() + " RETURN i";

      var stats = AQL_EXPLAIN(query, null, { maxNumberOfPlans: 1 }).stats;
      assertTrue(stats.hasOwnProperty("plansCreated"));
      assertTrue(stats.hasOwnProperty("rulesExecuted"));
      assertTrue(stats.hasOwnProperty("rulesSkipped"));

      assertEqual(1, stats.plansCreated);
    }

  };
}

////////////////////////////////////////////////////////////////////////////////
/// @brief executes the test suite
////////////////////////////////////////////////////////////////////////////////

jsunity.run(optimizerStatsTestSuite);

return jsunity.done();