lucene/core/src/test/org/apache/lucene/document/TestFieldType.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.lucene.document;


import java.lang.reflect.Method;
import org.apache.lucene.index.DocValuesType;
import org.apache.lucene.index.IndexOptions;
import org.apache.lucene.index.PointValues;
import org.apache.lucene.util.LuceneTestCase;

import com.carrotsearch.randomizedtesting.generators.RandomPicks;

/** simple testcases for concrete impl of IndexableFieldType */
public class TestFieldType extends LuceneTestCase {
  
  public void testEquals() throws Exception {
    FieldType ft = new FieldType();
    assertEquals(ft, ft);
    assertFalse(ft.equals(null));
    
    FieldType ft2 = new FieldType();
    assertEquals(ft, ft2);
    assertEquals(ft.hashCode(), ft2.hashCode());
    
    FieldType ft3 = new FieldType();
    ft3.setIndexOptions(IndexOptions.DOCS_AND_FREQS);
    assertFalse(ft3.equals(ft));
    
    FieldType ft4 = new FieldType();
    ft4.setDocValuesType(DocValuesType.BINARY);
    assertFalse(ft4.equals(ft));
    
    FieldType ft5 = new FieldType();
    ft5.setIndexOptions(IndexOptions.DOCS_AND_FREQS_AND_POSITIONS);
    assertFalse(ft5.equals(ft));
    
    FieldType ft6 = new FieldType();
    ft6.setStored(true);
    assertFalse(ft6.equals(ft));
    
    FieldType ft7 = new FieldType();
    ft7.setOmitNorms(true);
    assertFalse(ft7.equals(ft));
    
    FieldType ft10 = new FieldType();
    ft10.setStoreTermVectors(true);
    assertFalse(ft10.equals(ft));
    
    FieldType ft11 = new FieldType();
    ft11.setDimensions(1, 4);
    assertFalse(ft11.equals(ft));
  }

  public void testPointsToString() {
    FieldType ft = new FieldType();
    ft.setDimensions(1, Integer.BYTES);
    assertEquals("pointDimensionCount=1,pointIndexDimensionCount=1,pointNumBytes=4", ft.toString());
  }

  /**
   * FieldType's attribute map should not be modifiable/add after freeze
   */
  public void testAttributeMapFrozen() {
    FieldType ft = new FieldType();
    ft.putAttribute("dummy", "d");
    ft.freeze();
    expectThrows(IllegalStateException.class, () -> ft.putAttribute("dummy", "a"));
  }

  /**
   * FieldType's attribute map can be changed if not frozen
   */
  public void testAttributeMapNotFrozen() {
    FieldType ft = new FieldType();
    ft.putAttribute("dummy", "d");
    ft.putAttribute("dummy", "a");
    assertEquals(ft.getAttributes().size(), 1);
    assertEquals(ft.getAttributes().get("dummy"), "a");
  }

  private static Object randomValue(Class<?> clazz) {
    if (clazz.isEnum()) {
      return RandomPicks.randomFrom(random(), clazz.getEnumConstants());
    } else if (clazz == boolean.class) {
      return random().nextBoolean();
    } else if (clazz == int.class) {
      return 1 + random().nextInt(100);
    }
    throw new AssertionError("Don't know how to generate a " + clazz);
  }

  private static FieldType randomFieldType() throws Exception {
    // setDimensions handled special as values must be in-bounds.
    Method setDimensionsMethodA = FieldType.class.getMethod("setDimensions", int.class, int.class);
    Method setDimensionsMethodB = FieldType.class.getMethod("setDimensions", int.class, int.class, int.class);
    FieldType ft = new FieldType();
    for (Method method : FieldType.class.getMethods()) {
      if (method.getName().startsWith("set")) {
        final Class<?>[] parameterTypes = method.getParameterTypes();
        final Object[] args = new Object[parameterTypes.length];
        if (method.equals(setDimensionsMethodA)) {
          args[0] = 1 + random().nextInt(PointValues.MAX_INDEX_DIMENSIONS);
          args[1] = 1 + random().nextInt(PointValues.MAX_NUM_BYTES);
        } else if (method.equals(setDimensionsMethodB)) {
          args[0] = 1 + random().nextInt(PointValues.MAX_DIMENSIONS);
          args[1] = 1 + Math.min((Integer)args[0] - 1, random().nextInt(PointValues.MAX_INDEX_DIMENSIONS));
          args[2] = 1 + random().nextInt(PointValues.MAX_NUM_BYTES);
        } else {
          for (int i = 0; i < args.length; ++i) {
            args[i] = randomValue(parameterTypes[i]);
          }
        }
        method.invoke(ft, args);
      }
    }
    return ft;
  }

  public void testCopyConstructor() throws Exception {
    final int iters = 10;
      for (int iter = 0; iter < iters; ++iter) {
      FieldType ft = randomFieldType();
      FieldType ft2 = new FieldType(ft);
      assertEquals(ft, ft2);
    }
  }
}