This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 254b276c79a [FLINK-29041][tests] Add utility to test POJO compliance
without any Kryo usage
254b276c79a is described below
commit 254b276c79a5adce21269fae6722e3bf3ac15b78
Author: Chesnay Schepler <[email protected]>
AuthorDate: Fri Aug 19 10:27:13 2022 +0200
[FLINK-29041][tests] Add utility to test POJO compliance without any Kryo
usage
---
.../serialization/types_serialization.md | 1 +
.../serialization/types_serialization.md | 1 +
.../java/org/apache/flink/types/PojoTestUtils.java | 36 ++++++++++++++++++++++
.../org/apache/flink/types/PojoTestUtilsTest.java | 25 +++++++++++++++
4 files changed, 63 insertions(+)
diff --git
a/docs/content.zh/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
b/docs/content.zh/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
index 072e7ebaf97..4d4f1456c2b 100644
---
a/docs/content.zh/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
+++
b/docs/content.zh/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
@@ -116,6 +116,7 @@ You can also register your own custom serializer if
required; see [Serialization
Flink analyzes the structure of POJO types, i.e., it learns about the fields
of a POJO. As a result POJO types are easier to use than general types.
Moreover, Flink can process POJOs more efficiently than general types.
You can test whether your class adheres to the POJO requirements via
`org.apache.flink.types.PojoTestUtils#assertSerializedAsPojo()` from the
`flink-test-utils`.
+If you additionally want to ensure that no field of the POJO will be
serialized with Kryo, use `assertSerializedAsPojoWithoutKryo()` instead.
The following example shows a simple POJO with two public fields.
diff --git
a/docs/content/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
b/docs/content/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
index d8563c53ac3..34d21b5e211 100644
---
a/docs/content/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
+++
b/docs/content/docs/dev/datastream/fault-tolerance/serialization/types_serialization.md
@@ -117,6 +117,7 @@ You can also register your own custom serializer if
required; see [Serialization
Flink analyzes the structure of POJO types, i.e., it learns about the fields
of a POJO. As a result POJO types are easier to use than general types.
Moreover, Flink can process POJOs more efficiently than general types.
You can test whether your class adheres to the POJO requirements via
`org.apache.flink.types.PojoTestUtils#assertSerializedAsPojo()` from the
`flink-test-utils`.
+If you additionally want to ensure that no field of the POJO will be
serialized with Kryo, use `assertSerializedAsPojoWithoutKryo()` instead.
The following example shows a simple POJO with two public fields.
diff --git
a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/types/PojoTestUtils.java
b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/types/PojoTestUtils.java
index dbae4ed3a22..2cb0830311f 100644
---
a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/types/PojoTestUtils.java
+++
b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/types/PojoTestUtils.java
@@ -34,6 +34,9 @@ public class PojoTestUtils {
* {@link PojoSerializer}, as documented <a
*
href="https://nightlies.apache.org/flink/flink-docs-stable/docs/dev/datastream/fault-tolerance/serialization/types_serialization/#pojos";>here</a>.
*
+ * <p>Note that this check will succeed even if the Pojo is partially
serialized with Kryo. If
+ * this is not desired, use {@link
#assertSerializedAsPojoWithoutKryo(Class)} instead.
+ *
* @param clazz class to analyze
* @param <T> class type
* @throws AssertionError if instances of the class cannot be serialized
as a POJO
@@ -52,4 +55,37 @@ public class PojoTestUtils {
TypeExtractor.class.getCanonicalName())
.isInstanceOf(PojoSerializer.class);
}
+
+ /**
+ * Verifies that instances of the given class fulfill all conditions to be
serialized with the
+ * {@link PojoSerializer}, as documented <a
+ *
href="https://nightlies.apache.org/flink/flink-docs-stable/docs/dev/datastream/fault-tolerance/serialization/types_serialization/#pojos";>here</a>,
+ * without any field being serialized with Kryo.
+ *
+ * @param clazz class to analyze
+ * @param <T> class type
+ * @throws AssertionError if instances of the class cannot be serialized
as a POJO or required
+ * Kryo for one or more fields
+ */
+ public static <T> void assertSerializedAsPojoWithoutKryo(Class<T> clazz)
throws AssertionError {
+ final ExecutionConfig executionConfig = new ExecutionConfig();
+ executionConfig.disableGenericTypes();
+
+ final TypeInformation<T> typeInformation = TypeInformation.of(clazz);
+ final TypeSerializer<T> actualSerializer;
+ try {
+ actualSerializer =
typeInformation.createSerializer(executionConfig);
+ } catch (UnsupportedOperationException e) {
+ throw new AssertionError(e);
+ }
+
+ assertThat(actualSerializer)
+ .withFailMessage(
+ "Instances of the class '%s' cannot be serialized as a
POJO, but would use a '%s' instead. %n"
+ + "Re-run this test with INFO logging enabled
and check messages from the '%s' for possible reasons.",
+ clazz.getSimpleName(),
+ actualSerializer.getClass().getSimpleName(),
+ TypeExtractor.class.getCanonicalName())
+ .isInstanceOf(PojoSerializer.class);
+ }
}
diff --git
a/flink-test-utils-parent/flink-test-utils/src/test/java/org/apache/flink/types/PojoTestUtilsTest.java
b/flink-test-utils-parent/flink-test-utils/src/test/java/org/apache/flink/types/PojoTestUtilsTest.java
index c602eb01f50..6d9f399ea78 100644
---
a/flink-test-utils-parent/flink-test-utils/src/test/java/org/apache/flink/types/PojoTestUtilsTest.java
+++
b/flink-test-utils-parent/flink-test-utils/src/test/java/org/apache/flink/types/PojoTestUtilsTest.java
@@ -19,6 +19,8 @@ package org.apache.flink.types;
import org.junit.jupiter.api.Test;
+import java.util.List;
+
import static org.assertj.core.api.Assertions.assertThatThrownBy;
class PojoTestUtilsTest {
@@ -34,9 +36,32 @@ class PojoTestUtilsTest {
PojoTestUtils.assertSerializedAsPojo(Pojo.class);
}
+ @Test
+ void testPojoAcceptedIfKryoRequired() {
+ PojoTestUtils.assertSerializedAsPojo(PojoRequiringKryo.class);
+ }
+
+ @Test
+ void testWithoutKryoPojoAccepted() {
+ PojoTestUtils.assertSerializedAsPojoWithoutKryo(Pojo.class);
+ }
+
+ @Test
+ void testWithoutKryoPojoRejected() {
+ assertThatThrownBy(
+ () ->
+
PojoTestUtils.assertSerializedAsPojoWithoutKryo(
+ PojoRequiringKryo.class))
+ .isInstanceOf(AssertionError.class);
+ }
+
private static class NoPojo {}
public static class Pojo {
public int x;
}
+
+ public static class PojoRequiringKryo {
+ public List<Integer> x;
+ }
}
