/*
* 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.datasketches.hive.cpc;
import static org.apache.datasketches.Util.DEFAULT_UPDATE_SEED;
import java.util.Arrays;
import java.util.List;
import org.apache.datasketches.cpc.CpcSketch;
import org.apache.datasketches.hive.common.BytesWritableHelper;
import org.apache.hadoop.hive.ql.exec.UDFArgumentException;
import org.apache.hadoop.hive.ql.exec.UDFArgumentTypeException;
import org.apache.hadoop.hive.ql.parse.SemanticException;
import org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator;
import org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator.Mode;
import org.apache.hadoop.hive.ql.udf.generic.GenericUDAFParameterInfo;
import org.apache.hadoop.hive.ql.udf.generic.SimpleGenericUDAFParameterInfo;
import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspectorFactory;
import org.apache.hadoop.hive.serde2.objectinspector.PrimitiveObjectInspector.PrimitiveCategory;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.PrimitiveObjectInspectorFactory;
import org.apache.hadoop.hive.serde2.typeinfo.TypeInfoFactory;
import org.apache.hadoop.io.BytesWritable;
import org.apache.hadoop.io.IntWritable;
import org.apache.hadoop.io.LongWritable;
import org.testng.Assert;
import org.testng.annotations.Test;
@SuppressWarnings({"javadoc","resource"})
public class UnionSketchUDAFTest {
private static final ObjectInspector intInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableObjectInspector(PrimitiveCategory.INT);
private static final ObjectInspector longInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableObjectInspector(PrimitiveCategory.LONG);
private static final ObjectInspector stringInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableObjectInspector(PrimitiveCategory.STRING);
private static final ObjectInspector binaryInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableObjectInspector(PrimitiveCategory.BINARY);
private static final ObjectInspector structInspector = ObjectInspectorFactory.getStandardStructObjectInspector(
Arrays.asList("lgK", "seed", "sketch"),
Arrays.asList(intInspector, longInspector, binaryInspector)
);
static final ObjectInspector intConstantInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableConstantObjectInspector(TypeInfoFactory.intTypeInfo, null);
static final ObjectInspector longConstantInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableConstantObjectInspector(TypeInfoFactory.longTypeInfo, null);
static final ObjectInspector stringConstantInspector =
PrimitiveObjectInspectorFactory.getPrimitiveWritableConstantObjectInspector(TypeInfoFactory.stringTypeInfo, null);
@Test(expectedExceptions = { UDFArgumentException.class })
public void tooFewArguments() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentException.class })
public void tooManyArguments() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intConstantInspector, longConstantInspector, stringConstantInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void invalidCategoryArg1() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { structInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void invalidTypeArg1() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { intInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void invalidCategoryArg2() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, structInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void invalidTypeArg2() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, stringInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void arg2NotConstant() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void invalidCategoryArg3() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intConstantInspector, structInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void invalidTypeArg3() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intConstantInspector, stringInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
@Test(expectedExceptions = { UDFArgumentTypeException.class })
public void arg3NotConstant() throws SemanticException {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intConstantInspector, longInspector };
GenericUDAFParameterInfo params = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
new UnionSketchUDAF().getEvaluator(params);
}
// PARTIAL1 mode (Map phase in Map-Reduce): iterate + terminatePartial
@Test
public void partial1ModeDefaultParams() throws Exception {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector };
GenericUDAFParameterInfo info = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
try (GenericUDAFEvaluator eval = new UnionSketchUDAF().getEvaluator(info)) {
ObjectInspector resultInspector = eval.init(Mode.PARTIAL1, inspectors);
DataToSketchUDAFTest.checkIntermediateResultInspector(resultInspector);
State state = (State) eval.getNewAggregationBuffer();
CpcSketch sketch1 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch1.update(1);
eval.iterate(state, new Object[] {new BytesWritable(sketch1.toByteArray())});
CpcSketch sketch2 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch2.update(2);
eval.iterate(state, new Object[] {new BytesWritable(sketch2.toByteArray())});
Object result = eval.terminatePartial(state);
Assert.assertNotNull(result);
Assert.assertTrue(result instanceof List);
List<?> r = (List<?>) result;
Assert.assertEquals(r.size(), 3);
Assert.assertEquals(((IntWritable) r.get(0)).get(), SketchEvaluator.DEFAULT_LG_K);
Assert.assertEquals(((LongWritable) r.get(1)).get(), DEFAULT_UPDATE_SEED);
CpcSketch resultSketch = CpcSketch.heapify(BytesWritableHelper.wrapAsMemory((BytesWritable) r.get(2)));
Assert.assertEquals(resultSketch.getLgK(), SketchEvaluator.DEFAULT_LG_K);
Assert.assertEquals(resultSketch.getEstimate(), 2.0, 0.01);
}
}
@Test
public void partial1ModeExplicitParams() throws Exception {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intConstantInspector, longConstantInspector };
GenericUDAFParameterInfo info = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
try (GenericUDAFEvaluator eval = new UnionSketchUDAF().getEvaluator(info)) {
ObjectInspector resultInspector = eval.init(Mode.PARTIAL1, inspectors);
DataToSketchUDAFTest.checkIntermediateResultInspector(resultInspector);
final int lgK = 10;
final long seed = 123;
State state = (State) eval.getNewAggregationBuffer();
CpcSketch sketch1 = new CpcSketch(lgK, seed);
sketch1.update(1);
eval.iterate(state, new Object[] {new BytesWritable(sketch1.toByteArray()),
new IntWritable(lgK), new LongWritable(seed)});
CpcSketch sketch2 = new CpcSketch(lgK, seed);
sketch2.update(2);
eval.iterate(state, new Object[] {new BytesWritable(sketch2.toByteArray()),
new IntWritable(lgK), new LongWritable(seed)});
Object result = eval.terminatePartial(state);
Assert.assertNotNull(result);
Assert.assertTrue(result instanceof List);
List<?> r = (List<?>) result;
Assert.assertEquals(r.size(), 3);
Assert.assertEquals(((IntWritable) r.get(0)).get(), lgK);
Assert.assertEquals(((LongWritable) r.get(1)).get(), seed);
CpcSketch resultSketch = CpcSketch.heapify(BytesWritableHelper.wrapAsMemory((BytesWritable) r.get(2)), seed);
Assert.assertEquals(resultSketch.getLgK(), lgK);
Assert.assertEquals(resultSketch.getEstimate(), 2.0, 0.01);
}
}
// PARTIAL2 mode (Combine phase in Map-Reduce): merge + terminatePartial
@Test
public void partial2Mode() throws Exception {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector };
GenericUDAFParameterInfo info = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
try (GenericUDAFEvaluator eval = new UnionSketchUDAF().getEvaluator(info)) {
ObjectInspector resultInspector = eval.init(Mode.PARTIAL2, new ObjectInspector[] {structInspector});
DataToSketchUDAFTest.checkIntermediateResultInspector(resultInspector);
State state = (State) eval.getNewAggregationBuffer();
CpcSketch sketch1 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch1.update(1);
eval.merge(state, Arrays.asList(
new IntWritable(SketchEvaluator.DEFAULT_LG_K),
new LongWritable(DEFAULT_UPDATE_SEED),
new BytesWritable(sketch1.toByteArray()))
);
CpcSketch sketch2 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch2.update(2);
eval.merge(state, Arrays.asList(
new IntWritable(SketchEvaluator.DEFAULT_LG_K),
new LongWritable(DEFAULT_UPDATE_SEED),
new BytesWritable(sketch2.toByteArray()))
);
Object result = eval.terminatePartial(state);
Assert.assertNotNull(result);
Assert.assertTrue(result instanceof List);
List<?> r = (List<?>) result;
Assert.assertEquals(r.size(), 3);
Assert.assertEquals(((IntWritable) r.get(0)).get(), SketchEvaluator.DEFAULT_LG_K);
Assert.assertEquals(((LongWritable) r.get(1)).get(), DEFAULT_UPDATE_SEED);
CpcSketch resultSketch = CpcSketch.heapify(BytesWritableHelper.wrapAsMemory((BytesWritable) r.get(2)));
Assert.assertEquals(resultSketch.getLgK(), SketchEvaluator.DEFAULT_LG_K);
Assert.assertEquals(resultSketch.getEstimate(), 2.0, 0.01);
eval.reset(state);
result = eval.terminate(state);
Assert.assertNull(result);
}
}
// FINAL mode (Reduce phase in Map-Reduce): merge + terminate
@Test
public void finalMode() throws Exception {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector };
GenericUDAFParameterInfo info = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
try (GenericUDAFEvaluator eval = new UnionSketchUDAF().getEvaluator(info)) {
ObjectInspector resultInspector = eval.init(Mode.FINAL, new ObjectInspector[] {structInspector});
DataToSketchUDAFTest.checkFinalResultInspector(resultInspector);
State state = (State) eval.getNewAggregationBuffer();
CpcSketch sketch1 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch1.update(1);
eval.merge(state, Arrays.asList(
new IntWritable(SketchEvaluator.DEFAULT_LG_K),
new LongWritable(DEFAULT_UPDATE_SEED),
new BytesWritable(sketch1.toByteArray()))
);
CpcSketch sketch2 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch2.update(2);
eval.merge(state, Arrays.asList(
new IntWritable(SketchEvaluator.DEFAULT_LG_K),
new LongWritable(DEFAULT_UPDATE_SEED),
new BytesWritable(sketch2.toByteArray()))
);
Object result = eval.terminate(state);
Assert.assertNotNull(result);
Assert.assertTrue(result instanceof BytesWritable);
CpcSketch resultSketch = CpcSketch.heapify(BytesWritableHelper.wrapAsMemory((BytesWritable) result));
Assert.assertEquals(resultSketch.getEstimate(), 2.0, 0.01);
}
}
// COMPLETE mode (single mode, alternative to MapReduce): iterate + terminate
@Test
public void completeModeDefaultParams() throws Exception {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector };
GenericUDAFParameterInfo info = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
try (GenericUDAFEvaluator eval = new UnionSketchUDAF().getEvaluator(info)) {
ObjectInspector resultInspector = eval.init(Mode.COMPLETE, inspectors);
DataToSketchUDAFTest.checkFinalResultInspector(resultInspector);
State state = (State) eval.getNewAggregationBuffer();
CpcSketch sketch1 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch1.update(1);
eval.iterate(state, new Object[] {new BytesWritable(sketch1.toByteArray())});
CpcSketch sketch2 = new CpcSketch(SketchEvaluator.DEFAULT_LG_K);
sketch2.update(2);
eval.iterate(state, new Object[] {new BytesWritable(sketch2.toByteArray())});
Object result = eval.terminate(state);
Assert.assertNotNull(result);
Assert.assertTrue(result instanceof BytesWritable);
CpcSketch resultSketch = CpcSketch.heapify(BytesWritableHelper.wrapAsMemory((BytesWritable) result));
Assert.assertEquals(resultSketch.getEstimate(), 2.0, 0.01);
eval.reset(state);
result = eval.terminate(state);
Assert.assertNull(result);
}
}
@Test
public void completeModeExplicitParams() throws Exception {
ObjectInspector[] inspectors = new ObjectInspector[] { binaryInspector, intConstantInspector, longConstantInspector };
GenericUDAFParameterInfo info = new SimpleGenericUDAFParameterInfo(inspectors, false, false, false);
try (GenericUDAFEvaluator eval = new UnionSketchUDAF().getEvaluator(info)) {
ObjectInspector resultInspector = eval.init(Mode.COMPLETE, inspectors);
DataToSketchUDAFTest.checkFinalResultInspector(resultInspector);
final int lgK = 4;
final long seed = 123;
State state = (State) eval.getNewAggregationBuffer();
CpcSketch sketch1 = new CpcSketch(lgK, seed);
sketch1.update(1);
eval.iterate(state, new Object[] {new BytesWritable(sketch1.toByteArray()),
new IntWritable(lgK), new LongWritable(seed)});
CpcSketch sketch2 = new CpcSketch(lgK, seed);
sketch2.update(2);
eval.iterate(state, new Object[] {new BytesWritable(sketch2.toByteArray()),
new IntWritable(lgK), new LongWritable(seed)});
Object result = eval.terminate(state);
Assert.assertNotNull(result);
Assert.assertTrue(result instanceof BytesWritable);
CpcSketch resultSketch = CpcSketch.heapify(BytesWritableHelper.wrapAsMemory((BytesWritable) result), seed);
Assert.assertEquals(resultSketch.getLgK(), lgK);
Assert.assertEquals(resultSketch.getEstimate(), 2.0, 0.03);
eval.reset(state);
result = eval.terminate(state);
Assert.assertNull(result);
}
}
}
