lang/java/compiler/src/test/java/org/apache/avro/compiler/idl/TestLogicalTypes.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
 *
 *     https://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.avro.compiler.idl;

import org.apache.avro.LogicalType;
import org.apache.avro.LogicalTypes;
import org.apache.avro.Protocol;
import org.apache.avro.Schema;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

public class TestLogicalTypes {
  private Schema logicalTypeFields;

  @Before
  public void setup() throws ParseException {
    final ClassLoader cl = Thread.currentThread().getContextClassLoader();
    Idl idl = new Idl(cl.getResourceAsStream("logicalTypes.avdl"), "UTF-8");
    Protocol protocol = idl.CompilationUnit();

    logicalTypeFields = protocol.getType("org.apache.avro.test.LogicalTypeFields");
  }

  @Test
  public void testDateBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.date(), logicalTypeOfField("aDate"));
  }

  @Test
  public void testTimeMsBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.timeMillis(), logicalTypeOfField("aTime"));
  }

  @Test
  public void testTimestampMsBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.timestampMillis(), logicalTypeOfField("aTimestamp"));
  }

  @Test
  public void testLocalTimestampMsBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.localTimestampMillis(), logicalTypeOfField("aLocalTimestamp"));
  }

  @Test
  public void testDecimalBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.decimal(6, 2), logicalTypeOfField("pocketMoney"));
  }

  @Test
  public void testUuidBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.uuid(), logicalTypeOfField("identifier"));
  }

  @Test
  public void testAnnotatedLongBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.timestampMicros(), logicalTypeOfField("anotherTimestamp"));
  }

  @Test
  public void testAnnotatedBytesFieldBecomesLogicalType() {
    Assert.assertEquals(LogicalTypes.decimal(6, 2), logicalTypeOfField("allowance"));
  }

  @Test
  public void testIncorrectlyAnnotatedBytesFieldHasNoLogicalType() {
    Schema fieldSchema = logicalTypeFields.getField("byteArray").schema();

    Assert.assertNull(fieldSchema.getLogicalType());
    Assert.assertEquals("decimal", fieldSchema.getObjectProp("logicalType"));
    Assert.assertEquals(3000000000L, fieldSchema.getObjectProp("precision")); // Not an int, so not a valid precision
    Assert.assertEquals(0, fieldSchema.getObjectProp("scale"));
  }

  private LogicalType logicalTypeOfField(String name) {
    return logicalTypeFields.getField(name).schema().getLogicalType();
  }
}