/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2009 Sun Microsystems, Inc.
 */
package org.opends.sdk.schema;



import org.opends.sdk.Assertion;
import org.opends.sdk.ByteString;
import org.opends.sdk.ConditionResult;
import org.opends.sdk.DecodeException;
import org.testng.Assert;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;



/**
 * Ordering matching rule tests.
 */
public abstract class OrderingMatchingRuleTest extends SchemaTestCase
{
  /**
   * Create data for the OrderingMatchingRulesInvalidValues test.
   *
   * @return The data for the OrderingMatchingRulesInvalidValues test.
   */
  @DataProvider(name = "OrderingMatchingRuleInvalidValues")
  public abstract Object[][] createOrderingMatchingRuleInvalidValues();



  /**
   * Create data for the OrderingMatchingRules test.
   *
   * @return The data for the OrderingMatchingRules test.
   */
  @DataProvider(name = "Orderingmatchingrules")
  public abstract Object[][] createOrderingMatchingRuleTestData();



  /**
   * Test the comparison of valid values.
   */
  @Test(dataProvider = "Orderingmatchingrules")
  public void orderingMatchingRules(final String value1, final String value2,
      final int result) throws Exception
  {
    // Make sure that the specified class can be instantiated as a task.
    final MatchingRule ruleInstance = getRule();

    final ByteString normalizedValue1 = ruleInstance
        .normalizeAttributeValue(ByteString.valueOf(value1));
    final ByteString normalizedValue2 = ruleInstance
        .normalizeAttributeValue(ByteString.valueOf(value2));

    // Test the comparator
    final int comp = ruleInstance.comparator().compare(normalizedValue1,
        normalizedValue2);
    if (comp == 0)
    {
      Assert.assertEquals(comp, result);
    }
    else if (comp > 0)
    {
      Assert.assertTrue(result > 0);
    }
    else if (comp < 0)
    {
      Assert.assertTrue(result < 0);
    }

    Assertion a = ruleInstance.getGreaterOrEqualAssertion(ByteString
        .valueOf(value2));
    Assert.assertEquals(a.matches(normalizedValue1),
        result >= 0 ? ConditionResult.TRUE : ConditionResult.FALSE);

    a = ruleInstance.getLessOrEqualAssertion(ByteString.valueOf(value2));
    Assert.assertEquals(a.matches(normalizedValue1),
        result <= 0 ? ConditionResult.TRUE : ConditionResult.FALSE);

    a = ruleInstance.getAssertion(ByteString.valueOf(value2));
    Assert.assertEquals(a.matches(normalizedValue1),
        result < 0 ? ConditionResult.TRUE : ConditionResult.FALSE);
  }



  /**
   * Test that invalid values are rejected.
   */
  @Test(expectedExceptions = DecodeException.class, dataProvider = "OrderingMatchingRuleInvalidValues")
  public void orderingMatchingRulesInvalidValues(final String value)
      throws Exception
  {
    // Make sure that the specified class can be instantiated as a task.
    final MatchingRule ruleInstance = getRule();

    // normalize the 2 provided values
    ruleInstance.normalizeAttributeValue(ByteString.valueOf(value));
  }



  /**
   * Get the Ordering matching Rules that is to be tested.
   *
   * @return The Ordering matching Rules that is to be tested.
   */
  protected abstract MatchingRule getRule();
}