Nails down record default spec for unions (#486)

linkedin · May 1, 2023 · 54e2c11 · 54e2c11
1 parent 2717123
commit 54e2c11
Show file tree

Hide file tree

Showing 5 changed files with 123 additions and 0 deletions.
diff --git a/...o/src/test/java/com/linkedin/avroutil1/compatibility/AvroWireFormatCompatibilityTest.java b/...o/src/test/java/com/linkedin/avroutil1/compatibility/AvroWireFormatCompatibilityTest.java
@@ -9,7 +9,9 @@
 import com.linkedin.avroutil1.testcommon.TestUtil;
 import org.apache.avro.AvroTypeException;
 import org.apache.avro.Schema;
+import org.apache.avro.generic.GenericData;
 import org.apache.avro.generic.GenericDatumReader;
+import org.apache.avro.generic.GenericRecord;
 import org.apache.avro.generic.IndexedRecord;
 import org.apache.avro.io.BinaryDecoder;
 import org.apache.avro.io.Decoder;
@@ -98,4 +100,39 @@ public void testCompatibleJsonParsingOfWrongNumericLiterals() throws Exception {
     Assert.assertEquals(deserialized2.get(schema.getField("floatField").pos()), 3.0f);
     Assert.assertEquals(deserialized2.get(schema.getField("doubleField").pos()), 4.0d);
   }
+
+  @Test
+  public void demonstrateDefaultRecordsUnionFieldMustBeFirstElement() throws Exception {
+    Schema writerSchema =
+        AvroCompatibilityHelper.parse(TestUtil.load("allavro/RecordWithDefaultUnionField_writer.avsc"));
+    GenericData.Record record = new GenericData.Record(writerSchema);
+    byte[] bytes = AvroCodecUtil.serializeBinary(record);
+
+    // uses 1st field (correct)
+    Schema correctReaderSchema =
+        AvroCompatibilityHelper.parse(TestUtil.load("allavro/RecordWithDefaultUnionFieldCorrect_reader.avsc"));
+    GenericRecord deserializedGenericRecord =
+        AvroCodecUtil.deserializeAsGeneric(bytes, writerSchema, correctReaderSchema);
+    Assert.assertEquals(deserializedGenericRecord.get("mainField").toString(), "{\"f1\": \"default\"}");
+
+    // tries to use 2nd field as default (object notation)
+    Schema incorrectReaderSchemaUsingObjectNotation = AvroCompatibilityHelper.parse(
+        TestUtil.load("allavro/RecordWithDefaultUnionFieldIncorrectObjectNotation_reader.avsc"));
+    try {
+      AvroCodecUtil.deserializeAsGeneric(bytes, writerSchema, incorrectReaderSchemaUsingObjectNotation);
+      Assert.fail("Expected exception");
+    } catch (Exception e) {
+      Assert.assertTrue(e.getClass().getName().contains("AvroTypeException"));
+    }
+
+    // tries to use 2nd field as default (flat notation)
+    Schema incorrectReaderSchemaUsingFlatNotation = AvroCompatibilityHelper.parse(
+        TestUtil.load("allavro/RecordWithDefaultUnionFieldIncorrectFlatNotation_reader.avsc"));
+    try {
+      AvroCodecUtil.deserializeAsGeneric(bytes, writerSchema, incorrectReaderSchemaUsingFlatNotation);
+      Assert.fail("Expected exception");
+    } catch (Exception e) {
+      Assert.assertTrue(e.getClass().getName().contains("AvroTypeException"));
+    }
+  }
 }
diff --git a/...r-tests-allavro/src/test/resources/allavro/RecordWithDefaultUnionFieldCorrect_reader.avsc b/...r-tests-allavro/src/test/resources/allavro/RecordWithDefaultUnionFieldCorrect_reader.avsc
@@ -0,0 +1,26 @@
+{
+  "type": "record",
+  "name": "SchemaWithRecordDefault",
+  "fields": [
+    {
+      "name": "mainField",
+      "type": {
+        "type": "record",
+        "name": "InnerRecord",
+        "fields": [
+          {
+            "name": "f1",
+            "type": [
+              "string",
+              "int",
+              "null"
+            ]
+          }
+        ]
+      },
+      "default": {
+        "f1": "default"
+      }
+    }
+  ]
+}
diff --git a/...o/src/test/resources/allavro/RecordWithDefaultUnionFieldIncorrectFlatNotation_reader.avsc b/...o/src/test/resources/allavro/RecordWithDefaultUnionFieldIncorrectFlatNotation_reader.avsc
@@ -0,0 +1,26 @@
+{
+  "type": "record",
+  "name": "SchemaWithRecordDefault",
+  "fields": [
+    {
+      "name": "mainField",
+      "type": {
+        "type": "record",
+        "name": "InnerRecord",
+        "fields": [
+          {
+            "name": "f1",
+            "type": [
+              "string",
+              "int",
+              "null"
+            ]
+          }
+        ]
+      },
+      "default": {
+        "f1": null
+      }
+    }
+  ]
+}
diff --git a/...src/test/resources/allavro/RecordWithDefaultUnionFieldIncorrectObjectNotation_reader.avsc b/...src/test/resources/allavro/RecordWithDefaultUnionFieldIncorrectObjectNotation_reader.avsc
@@ -0,0 +1,28 @@
+{
+  "type": "record",
+  "name": "SchemaWithRecordDefault",
+  "fields": [
+    {
+      "name": "mainField",
+      "type": {
+        "type": "record",
+        "name": "InnerRecord",
+        "fields": [
+          {
+            "name": "f1",
+            "type": [
+              "string",
+              "int",
+              "null"
+            ]
+          }
+        ]
+      },
+      "default": {
+        "f1": {
+          "int": 1
+        }
+      }
+    }
+  ]
+}
diff --git a/...s/helper-tests-allavro/src/test/resources/allavro/RecordWithDefaultUnionField_writer.avsc b/...s/helper-tests-allavro/src/test/resources/allavro/RecordWithDefaultUnionField_writer.avsc
@@ -0,0 +1,6 @@
+{
+  "type": "record",
+  "name": "SchemaWithRecordDefault",
+  "fields": [
+  ]
+}