rdblue commented on code in PR #3202: URL: https://github.com/apache/parquet-java/pull/3202#discussion_r2073868996
########## parquet-variant/src/test/java/org/apache/parquet/variant/TestVariantArrayBuilder.java: ########## @@ -0,0 +1,293 @@ +/* + * 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.parquet.variant; + +import org.junit.Assert; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class TestVariantArrayBuilder { + private static final Logger LOG = LoggerFactory.getLogger(TestVariantArrayBuilder.class); + + @Test + public void testEmptyArrayBuilder() { + VariantBuilder b = new VariantBuilder(); + VariantArrayBuilder a = b.startArray(); + b.endArray(); + VariantTestUtil.testVariant(b.build(), v -> { + VariantTestUtil.checkType(v, VariantUtil.ARRAY, Variant.Type.ARRAY); + Assert.assertEquals(0, v.numArrayElements()); + }); + } + + @Test + public void testLargeArraySizeBuilder() { + VariantBuilder b = new VariantBuilder(); + VariantArrayBuilder a = b.startArray(); + for (int i = 0; i < 511; i++) { + a.appendInt(i); + } + b.endArray(); + VariantTestUtil.testVariant(b.build(), v -> { + VariantTestUtil.checkType(v, VariantUtil.ARRAY, Variant.Type.ARRAY); + Assert.assertEquals(511, v.numArrayElements()); + for (int i = 0; i < 511; i++) { + VariantTestUtil.checkType(v.getElementAtIndex(i), VariantUtil.PRIMITIVE, Variant.Type.INT); + Assert.assertEquals(i, v.getElementAtIndex(i).getInt()); + } + }); + } + + @Test + public void testMixedArrayBuilder() { + VariantBuilder b = new VariantBuilder(); + VariantArrayBuilder arrBuilder = b.startArray(); + arrBuilder.appendBoolean(true); + VariantObjectBuilder obj = arrBuilder.startObject(); + obj.appendKey("key"); + obj.appendInt(321); + arrBuilder.endObject(); + arrBuilder.appendLong(1234567890); + { + // build a nested array + VariantArrayBuilder nestedBuilder = arrBuilder.startArray(); + { + // build a nested empty array + nestedBuilder.startArray(); + nestedBuilder.endArray(); + } + nestedBuilder.appendString("variant"); + nestedBuilder.startObject(); + nestedBuilder.endObject(); + arrBuilder.endArray(); + } + b.endArray(); + + VariantTestUtil.testVariant(b.build(), v -> { + VariantTestUtil.checkType(v, VariantUtil.ARRAY, Variant.Type.ARRAY); + Assert.assertEquals(4, v.numArrayElements()); + VariantTestUtil.checkType(v.getElementAtIndex(0), VariantUtil.PRIMITIVE, Variant.Type.BOOLEAN); + Assert.assertTrue(v.getElementAtIndex(0).getBoolean()); + + VariantTestUtil.checkType(v.getElementAtIndex(1), VariantUtil.OBJECT, Variant.Type.OBJECT); + Assert.assertEquals(1, v.getElementAtIndex(1).numObjectElements()); + VariantTestUtil.checkType( + v.getElementAtIndex(1).getFieldByKey("key"), VariantUtil.PRIMITIVE, Variant.Type.INT); + Assert.assertEquals(321, v.getElementAtIndex(1).getFieldByKey("key").getInt()); + + VariantTestUtil.checkType(v.getElementAtIndex(2), VariantUtil.PRIMITIVE, Variant.Type.LONG); + Assert.assertEquals(1234567890, v.getElementAtIndex(2).getLong()); + + VariantTestUtil.checkType(v.getElementAtIndex(3), VariantUtil.ARRAY, Variant.Type.ARRAY); + Variant nested = v.getElementAtIndex(3); + Assert.assertEquals(3, nested.numArrayElements()); + VariantTestUtil.checkType(nested.getElementAtIndex(0), VariantUtil.ARRAY, Variant.Type.ARRAY); + Assert.assertEquals(0, nested.getElementAtIndex(0).numArrayElements()); + VariantTestUtil.checkType(nested.getElementAtIndex(1), VariantUtil.SHORT_STR, Variant.Type.STRING); + Assert.assertEquals("variant", nested.getElementAtIndex(1).getString()); + VariantTestUtil.checkType(nested.getElementAtIndex(2), VariantUtil.OBJECT, Variant.Type.OBJECT); + Assert.assertEquals(0, nested.getElementAtIndex(2).numObjectElements()); + }); + } + + private void buildNested(int i, VariantArrayBuilder obj) { + if (i > 0) { + obj.appendString("str" + i); + buildNested(i - 1, obj.startArray()); + obj.endArray(); + } + } + + @Test + public void testNestedBuilder() { + VariantBuilder b = new VariantBuilder(); + buildNested(1000, b.startArray()); + b.endArray(); + + VariantTestUtil.testVariant(b.build(), v -> { + Variant curr = v; + for (int i = 1000; i >= 0; i--) { + VariantTestUtil.checkType(curr, VariantUtil.ARRAY, Variant.Type.ARRAY); + if (i == 0) { + Assert.assertEquals(0, curr.numArrayElements()); + } else { + Assert.assertEquals(2, curr.numArrayElements()); + VariantTestUtil.checkType(curr.getElementAtIndex(0), VariantUtil.SHORT_STR, Variant.Type.STRING); + Assert.assertEquals("str" + i, curr.getElementAtIndex(0).getString()); + curr = curr.getElementAtIndex(1); + } + } + }); + } + + private void testArrayOffsetSizeBuilder(String randomString) { + VariantBuilder b = new VariantBuilder(); + VariantArrayBuilder arrBuilder = b.startArray(); + arrBuilder.appendString(randomString); + arrBuilder.appendBoolean(true); + arrBuilder.appendLong(1234567890); + b.endArray(); + + VariantTestUtil.testVariant(b.build(), v -> { + VariantTestUtil.checkType(v, VariantUtil.ARRAY, Variant.Type.ARRAY); + Assert.assertEquals(3, v.numArrayElements()); + VariantTestUtil.checkType(v.getElementAtIndex(0), VariantUtil.PRIMITIVE, Variant.Type.STRING); + Assert.assertEquals(randomString, v.getElementAtIndex(0).getString()); + VariantTestUtil.checkType(v.getElementAtIndex(1), VariantUtil.PRIMITIVE, Variant.Type.BOOLEAN); + Assert.assertTrue(v.getElementAtIndex(1).getBoolean()); + VariantTestUtil.checkType(v.getElementAtIndex(2), VariantUtil.PRIMITIVE, Variant.Type.LONG); + Assert.assertEquals(1234567890, v.getElementAtIndex(2).getLong()); + }); + } + + @Test + public void testArrayTwoByteOffsetBuilder() { + // a string larger than 255 bytes to push the value offset size above 1 byte + testArrayOffsetSizeBuilder(VariantTestUtil.randomString(300)); + } + + @Test + public void testArrayThreeByteOffsetBuilder() { + // a string larger than 65535 bytes to push the value offset size above 2 bytes + testArrayOffsetSizeBuilder(VariantTestUtil.randomString(70_000)); + } + + @Test + public void testArrayFourByteOffsetBuilder() { + // a string larger than 16777215 bytes to push the value offset size above 3 bytes + testArrayOffsetSizeBuilder(VariantTestUtil.randomString(16_800_000)); + } + + @Test + public void testMissingEndArray() { + VariantBuilder b = new VariantBuilder(); + b.startArray(); + try { + b.build(); + Assert.fail("Expected Exception when calling build() without endArray()"); + } catch (Exception e) { + // expected + } + } + + @Test + public void testMissingStartArray() { + VariantBuilder b = new VariantBuilder(); + try { + b.endArray(); + Assert.fail("Expected Exception when calling endArray() without startArray()"); + } catch (Exception e) { + // expected + } + } + + @Test + public void testInvalidAppendDuringArray() { + VariantBuilder b = new VariantBuilder(); + b.startArray(); + try { + b.appendInt(1); + Assert.fail("Expected Exception when calling append() before endArray()"); Review Comment: I don't think this exception message is helpful because the API is a bit confusing. Some similar builders (like Jackson) would change the state of the current builder, rather than forcing the caller to use a new builder that is returned. It's okay to make this choice about how the builders are related, but the error message needs to tell the caller what to do. In this case, the caller should be informed that `append` methods must be called on the builder returned by `startArray` and `endArray` is called on the original builder when those are complete. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
