/*
 * 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 static org.testng.Assert.assertEquals;

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



/**
 * Test The equality matching rules and the equality matching rule api.
 */
public abstract class MatchingRuleTest extends SchemaTestCase
{
  /**
   * Generate invalid assertion values for the Matching Rule test.
   *
   * @return the data for the EqualityMatchingRulesInvalidValuestest.
   */
  @DataProvider(name = "matchingRuleInvalidAssertionValues")
  public Object[][] createMatchingRuleInvalidAssertionValues()
  {
    return createMatchingRuleInvalidAttributeValues();
  }



  /**
   * Generate invalid attribute values for the Matching Rule test.
   *
   * @return the data for the EqualityMatchingRulesInvalidValuestest.
   */
  @DataProvider(name = "matchingRuleInvalidAttributeValues")
  public abstract Object[][] createMatchingRuleInvalidAttributeValues();



  /**
   * Generate data for the Matching Rule test.
   *
   * @return the data for the equality matching rule test.
   */
  @DataProvider(name = "matchingrules")
  public abstract Object[][] createMatchingRuleTest();



  /**
   * Test the normalization and the comparison of valid values.
   */
  @Test(dataProvider = "matchingrules")
  public void matchingRules(final String value1, final String value2,
      final ConditionResult result) throws Exception
  {
    final MatchingRule rule = getRule();

    // normalize the 2 provided values and check that they are equals
    final ByteString normalizedValue1 = rule.normalizeAttributeValue(ByteString
        .valueOf(value1));
    final Assertion assertion = rule.getAssertion(ByteString.valueOf(value2));

    final ConditionResult liveResult = assertion.matches(normalizedValue1);
    assertEquals(result, liveResult);
  }



  /**
   * Test that invalid values are rejected.
   */
  @Test(expectedExceptions = DecodeException.class, dataProvider = "matchingRuleInvalidAssertionValues")
  public void matchingRulesInvalidAssertionValues(final String value)
      throws Exception
  {
    // Get the instance of the rule to be tested.
    final MatchingRule rule = getRule();

    rule.getAssertion(ByteString.valueOf(value));
  }



  /**
   * Test that invalid values are rejected.
   */
  @Test(expectedExceptions = DecodeException.class, dataProvider = "matchingRuleInvalidAttributeValues")
  public void matchingRulesInvalidAttributeValues(final String value)
      throws Exception
  {
    // Get the instance of the rule to be tested.
    final MatchingRule rule = getRule();

    rule.normalizeAttributeValue(ByteString.valueOf(value));
  }



  /**
   * Get an instance of the matching rule.
   *
   * @return An instance of the matching rule to test.
   */
  protected abstract MatchingRule getRule();
}