aljoscha commented on a change in pull request #14120:
URL: https://github.com/apache/flink/pull/14120#discussion_r534191802
##########
File path:
flink-streaming-java/src/main/java/org/apache/flink/streaming/api/operators/sort/KeyAndValueSerializer.java
##########
@@ -41,7 +41,7 @@
* [key-length] | <key> | <timestamp> | <record>
* </pre>
*/
-final class KeyAndValueSerializer<IN> extends TypeSerializer<Tuple2<byte[],
StreamRecord<IN>>> {
+public final class KeyAndValueSerializer<IN> extends
TypeSerializer<Tuple2<byte[], StreamRecord<IN>>> {
Review comment:
We shouldn't make this `public` just to make it accessible in the test.
We can just use a `"String"` for exclusion.
##########
File path:
flink-tests/src/test/java/org/apache/flink/test/completeness/TypeSerializerTestCoverageTest.java
##########
@@ -0,0 +1,180 @@
+/*
+ * 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.flink.test.completeness;
+
+import org.apache.flink.api.common.typeutils.SerializerTestBase;
+import
org.apache.flink.api.common.typeutils.SingleThreadAccessCheckingTypeSerializer;
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.TypeSerializerUpgradeTestBase;
+import org.apache.flink.api.common.typeutils.UnloadableDummyTypeSerializer;
+import org.apache.flink.api.common.typeutils.base.EnumSerializer;
+import org.apache.flink.api.common.typeutils.base.GenericArraySerializer;
+import org.apache.flink.api.common.typeutils.base.InstantSerializer;
+import org.apache.flink.api.common.typeutils.base.LocalDateSerializer;
+import org.apache.flink.api.common.typeutils.base.LocalDateTimeSerializer;
+import org.apache.flink.api.common.typeutils.base.LocalTimeSerializer;
+import org.apache.flink.api.common.typeutils.base.NullValueSerializer;
+import org.apache.flink.api.common.typeutils.base.VoidSerializer;
+import
org.apache.flink.api.common.typeutils.base.array.BooleanPrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.BytePrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.CharPrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.DoublePrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.FloatPrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.IntPrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.LongPrimitiveArraySerializer;
+import
org.apache.flink.api.common.typeutils.base.array.ShortPrimitiveArraySerializer;
+import org.apache.flink.api.common.typeutils.base.array.StringArraySerializer;
+import org.apache.flink.api.java.typeutils.runtime.CopyableValueSerializer;
+import org.apache.flink.api.java.typeutils.runtime.EitherSerializer;
+import org.apache.flink.api.java.typeutils.runtime.RowSerializer;
+import org.apache.flink.api.java.typeutils.runtime.Tuple0Serializer;
+import org.apache.flink.api.java.typeutils.runtime.TupleSerializer;
+import org.apache.flink.api.java.typeutils.runtime.ValueSerializer;
+import org.apache.flink.api.java.typeutils.runtime.WritableSerializer;
+import org.apache.flink.api.java.typeutils.runtime.kryo.KryoSerializer;
+import org.apache.flink.core.io.SimpleVersionedSerializerTypeSerializerProxy;
+import org.apache.flink.runtime.state.ArrayListSerializer;
+import org.apache.flink.runtime.state.ttl.TtlStateFactory;
+import org.apache.flink.streaming.api.datastream.CoGroupedStreams;
+import
org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction;
+import
org.apache.flink.streaming.api.operators.InternalTimersSnapshotReaderWriters;
+import org.apache.flink.streaming.api.operators.co.IntervalJoinOperator;
+import org.apache.flink.streaming.api.operators.sort.KeyAndValueSerializer;
+import org.apache.flink.streaming.api.windowing.windows.GlobalWindow;
+import org.apache.flink.streaming.api.windowing.windows.TimeWindow;
+import org.apache.flink.streaming.runtime.streamrecord.StreamElementSerializer;
+import org.apache.flink.util.TestLogger;
+
+import org.junit.Test;
+import org.reflections.Reflections;
+
+import java.lang.reflect.Modifier;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import static org.junit.Assert.fail;
+
+/**
+ * Scans the class path for type serializer and checks if there is a test for
it.
+ */
+public class TypeSerializerTestCoverageTest extends TestLogger {
+
+ @Test
+ public void testTypeSerializerTestCoverage() {
+ final Reflections reflections = new
Reflections("org.apache.flink");
+
+ final Set<Class<? extends TypeSerializer>> typeSerializers =
reflections.getSubTypesOf(TypeSerializer.class);
+
+ final Set<String> typeSerializerTestNames =
reflections.getSubTypesOf(SerializerTestBase.class)
+
.stream().map(Class::getName).collect(Collectors.toSet());
+ final Set<String> typeSerializerUpgradeTestNames =
reflections.getSubTypesOf(TypeSerializerUpgradeTestBase.class)
+
.stream().map(Class::getName).collect(Collectors.toSet());
+ final Set<String> typeSerializerUpgradeSetupNames =
reflections.getSubTypesOf(TypeSerializerUpgradeTestBase.PreUpgradeSetup.class)
+
.stream().map(Class::getSimpleName).collect(Collectors.toSet());
+
+ // type serializer whitelist for SerializerTestBase test
coverage
+ final List<String> serializerTestBaseWhitelist = Arrays.asList(
+ KeyAndValueSerializer.class.getName(),
+ ArrayListSerializer.class.getName(),
+ EitherSerializer.class.getName(),
+
SingleThreadAccessCheckingTypeSerializer.class.getName(),
+ GenericArraySerializer.class.getName(),
+ NullValueSerializer.class.getName(),
+ Tuple0Serializer.class.getName(),
+ CopyableValueSerializer.class.getName(),
+ VoidSerializer.class.getName(),
+ ValueSerializer.class.getName(),
+ RowSerializer.class.getName(),
+ StreamElementSerializer.class.getName(),
+ WritableSerializer.class.getName(),
+ KryoSerializer.class.getName(),
+ UnloadableDummyTypeSerializer.class.getName(),
+ TupleSerializer.class.getName(),
+ EnumSerializer.class.getName(),
+
CoGroupedStreams.UnionSerializer.class.getName(),
+ TtlStateFactory.TtlSerializer.class.getName(),
+ TimeWindow.Serializer.class.getName(),
+
InternalTimersSnapshotReaderWriters.LegacyTimerSerializer.class.getName(),
+
TwoPhaseCommitSinkFunction.StateSerializer.class.getName(),
+
IntervalJoinOperator.BufferEntrySerializer.class.getName(),
+ GlobalWindow.Serializer.class.getName(),
+
org.apache.flink.queryablestate.client.VoidNamespaceSerializer.class.getName(),
+
org.apache.flink.runtime.state.VoidNamespaceSerializer.class.getName()
+ );
+
+ // type serializer whitelist for TypeSerializerUpgradeTestBase
test coverage
+ final List<String> typeSerializerUpgradeTestBaseWhitelist =
Arrays.asList(
+ KeyAndValueSerializer.class.getName(),
+ InstantSerializer.class.getName(),
+
SingleThreadAccessCheckingTypeSerializer.class.getName(),
+
SimpleVersionedSerializerTypeSerializerProxy.class.getName(),
+ Tuple0Serializer.class.getName(),
+ CopyableValueSerializer.class.getName(),
+ VoidSerializer.class.getName(),
+ StringArraySerializer.class.getName(),
+ LocalDateTimeSerializer.class.getName(),
+ BooleanPrimitiveArraySerializer.class.getName(),
+ BytePrimitiveArraySerializer.class.getName(),
+ CharPrimitiveArraySerializer.class.getName(),
+ DoublePrimitiveArraySerializer.class.getName(),
+ FloatPrimitiveArraySerializer.class.getName(),
+ IntPrimitiveArraySerializer.class.getName(),
+ LongPrimitiveArraySerializer.class.getName(),
+ ShortPrimitiveArraySerializer.class.getName(),
+ LocalDateSerializer.class.getName(),
+ LocalTimeSerializer.class.getName(),
+ UnloadableDummyTypeSerializer.class.getName(),
+ TimeWindow.Serializer.class.getName(),
+
CoGroupedStreams.UnionSerializer.class.getName(),
+
InternalTimersSnapshotReaderWriters.LegacyTimerSerializer.class.getName(),
+
TwoPhaseCommitSinkFunction.StateSerializer.class.getName(),
+ GlobalWindow.Serializer.class.getName()
+ );
+
+ // check if a test exists for each type serializer
+ for (Class<? extends TypeSerializer> typeSerializer :
typeSerializers) {
+ // we skip abstract classes, test classes, inner
classes and scala classes to skip type serializer defined in test classes
+ if (Modifier.isAbstract(typeSerializer.getModifiers())
||
+
Modifier.isPrivate(typeSerializer.getModifiers()) ||
+
typeSerializer.getName().contains("test") ||
+
typeSerializer.getName().contains("Test") ||
+
typeSerializer.getName().contains("ITCase") ||
+
typeSerializer.getName().contains("$$anon") ||
+
typeSerializer.getName().contains("scala")) {
Review comment:
These exclusions are a bit too broad now. Like this, newly added Scala
`TypeSerializers` will not trigger the test.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
