AHeise commented on a change in pull request #16590: URL: https://github.com/apache/flink/pull/16590#discussion_r685810346
########## File path: flink-test-utils-parent/flink-connector-testing-framework/src/main/java/org/apache/flink/connectors/test/common/testsuites/TestSuiteBase.java ########## @@ -0,0 +1,430 @@ +/* + * 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.connectors.test.common.testsuites; + +import org.apache.flink.api.common.JobStatus; +import org.apache.flink.api.common.eventtime.WatermarkStrategy; +import org.apache.flink.api.common.typeutils.TypeSerializer; +import org.apache.flink.api.connector.source.Boundedness; +import org.apache.flink.connectors.test.common.environment.ClusterControllable; +import org.apache.flink.connectors.test.common.environment.TestEnvironment; +import org.apache.flink.connectors.test.common.external.ExternalContext; +import org.apache.flink.connectors.test.common.external.SourceSplitDataWriter; +import org.apache.flink.connectors.test.common.junit.annotations.Case; +import org.apache.flink.connectors.test.common.junit.extensions.TestLoggerExtension; +import org.apache.flink.connectors.test.common.junit.extensions.TestingFrameworkExtension; +import org.apache.flink.connectors.test.common.utils.JobStatusUtils; +import org.apache.flink.core.execution.JobClient; +import org.apache.flink.streaming.api.datastream.DataStreamSource; +import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; +import org.apache.flink.streaming.api.operators.collect.CollectResultIterator; +import org.apache.flink.streaming.api.operators.collect.CollectSinkOperator; +import org.apache.flink.streaming.api.operators.collect.CollectSinkOperatorFactory; +import org.apache.flink.streaming.api.operators.collect.CollectStreamSink; +import org.apache.flink.util.CloseableIterator; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.extension.ExtendWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.Iterator; +import java.util.List; +import java.util.NoSuchElementException; +import java.util.UUID; +import java.util.function.Function; +import java.util.stream.Collectors; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assumptions.assumeTrue; + +/** + * Base class for all test suites. + * + * <p>All cases should have well-descriptive JavaDoc, including: + * + * <ul> + * <li>What's the purpose of this case + * <li>Simple description of how this case works + * <li>Condition to fulfill in order to pass this case + * <li>Requirement of running this case + * </ul> + */ +@ExtendWith({TestingFrameworkExtension.class, TestLoggerExtension.class}) +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +public abstract class TestSuiteBase<T> { + + private static final Logger LOG = LoggerFactory.getLogger(TestSuiteBase.class); + + // ----------------------------- Basic test cases --------------------------------- + + /** + * Test connector source with only one split in the external system. + * + * <p>This test will create one split in the external system, write test data into it, and + * consume back via a Flink job with 1 parallelism. + * + * <p>The number and order of records consumed by Flink need to be identical to the test data + * written to the external system in order to pass this test. + * + * <p>A bounded source is required for this test. + */ + @Case + @DisplayName("Test source with single split") + public void testSourceSingleSplit(TestEnvironment testEnv, ExternalContext<T> externalContext) + throws Exception { + + // Write test data to external system + final Collection<T> testRecords = generateAndWriteTestData(externalContext); + + // Build and execute Flink job + StreamExecutionEnvironment execEnv = testEnv.createExecutionEnvironment(); + final CloseableIterator<T> resultIterator = + execEnv.fromSource( + externalContext.createSource(Boundedness.BOUNDED), + WatermarkStrategy.noWatermarks(), + "Tested Source") + .setParallelism(1) + .executeAndCollect("Source Single Split Test"); + + // Check test result + checkSingleSplitRecords(testRecords.iterator(), resultIterator); + resultIterator.close(); + } + + /** + * Test connector source with multiple splits in the external system + * + * <p>This test will create 4 splits in the external system, write test data to all splits, and + * consume back via a Flink job with 5 parallelism. + * + * <p>The number and order of records in each split consumed by Flink need to be identical to + * the test data written into the external system to pass this test. There's no requirement for + * record order across splits. + * + * <p>A bounded source is required for this test. + */ + @Case + @DisplayName("Test source with multiple splits") + public void testMultipleSplits(TestEnvironment testEnv, ExternalContext<T> externalContext) + throws Exception { + + final int splitNumber = 4; + final List<Collection<T>> testRecordCollections = new ArrayList<>(); + for (int i = 0; i < splitNumber; i++) { + testRecordCollections.add(generateAndWriteTestData(externalContext)); + } + + LOG.debug("Build and execute Flink job"); + StreamExecutionEnvironment execEnv = testEnv.createExecutionEnvironment(); + final CloseableIterator<T> resultIterator = + execEnv.fromSource( + externalContext.createSource(Boundedness.BOUNDED), + WatermarkStrategy.noWatermarks(), + "Tested Source") + .setParallelism(splitNumber) + .executeAndCollect("Source Multiple Split Test"); + + // Check test result + checkMultipleSplitRecords( + testRecordCollections.stream() + .map(Collection::iterator) + .collect(Collectors.toList()), + resultIterator); + resultIterator.close(); + } + + /** + * Test connector source with a redundant parallelism. + * + * <p>This test will create 4 split in the external system, write test data to all splits, and + * consume back via a Flink job with 5 parallelism, so at least one parallelism / source reader + * will be idle (assigned with no splits). If the split enumerator of the source doesn't signal + * NoMoreSplitsEvent to the idle source reader, the Flink job will never spin to FINISHED state. + * + * <p>The number and order of records in each split consumed by Flink need to be identical to + * the test data written into the external system to pass this test. There's no requirement for + * record order across splits. + * + * <p>A bounded source is required for this test. + */ + @Case + @DisplayName("Test source with at least one idle parallelism") + public void testRedundantParallelism( + TestEnvironment testEnv, ExternalContext<T> externalContext) throws Exception { + + final int splitNumber = 4; + final List<Collection<T>> testRecordCollections = new ArrayList<>(); + for (int i = 0; i < splitNumber; i++) { + testRecordCollections.add(generateAndWriteTestData(externalContext)); + } + + final CloseableIterator<T> resultIterator = + testEnv.createExecutionEnvironment() + .fromSource( + externalContext.createSource(Boundedness.BOUNDED), + WatermarkStrategy.noWatermarks(), + "Tested Source") + .setParallelism(splitNumber + 1) + .executeAndCollect("Redundant Parallelism Test"); + + checkMultipleSplitRecords( + testRecordCollections.stream() + .map(Collection::iterator) + .collect(Collectors.toList()), + resultIterator); + } + + /** + * Test connector source with task manager failover. + * + * <p>This test will create 1 split in the external system, write test record set A into the + * split, restart task manager to trigger job failover, write test record set B into the split, + * and terminate the Flink job finally. + * + * <p>The number and order of records consumed by Flink should be identical to A before the + * failover and B after the failover in order to pass the test. + * + * <p>An unbounded source is required for this test, since TaskManager failover will be + * triggered in the middle of the test. + */ + @Case + @Tag("failover") + @DisplayName("Test TaskManager failure") + public void testTaskManagerFailure(TestEnvironment testEnv, ExternalContext<T> externalContext) + throws Exception { + + checkEnvironmentIsControllable(testEnv); + + final Collection<T> testRecordsBeforeFailure = externalContext.generateTestData(); + final SourceSplitDataWriter<T> sourceSplitDataWriter = externalContext.createSourceSplit(); + sourceSplitDataWriter.writeRecords(testRecordsBeforeFailure); + + final StreamExecutionEnvironment env = testEnv.createExecutionEnvironment(); + + env.enableCheckpointing(50); + final DataStreamSource<T> dataStreamSource = + env.fromSource( + externalContext.createSource(Boundedness.CONTINUOUS_UNBOUNDED), + WatermarkStrategy.noWatermarks(), + "Tested Source") + .setParallelism(1); + + // Since DataStream API doesn't expose job client for executeAndCollect(), we have + // to reuse these part of code to get both job client and result iterator :-( + // ------------------------------------ START --------------------------------------------- + TypeSerializer<T> serializer = dataStreamSource.getType().createSerializer(env.getConfig()); + String accumulatorName = "dataStreamCollect_" + UUID.randomUUID(); + CollectSinkOperatorFactory<T> factory = + new CollectSinkOperatorFactory<>(serializer, accumulatorName); + CollectSinkOperator<T> operator = (CollectSinkOperator<T>) factory.getOperator(); + CollectResultIterator<T> iterator = + new CollectResultIterator<>( + operator.getOperatorIdFuture(), + serializer, + accumulatorName, + env.getCheckpointConfig()); + CollectStreamSink<T> sink = new CollectStreamSink<>(dataStreamSource, factory); + sink.name("Data stream collect sink"); + env.addOperator(sink.getTransformation()); + final JobClient jobClient = env.executeAsync("TaskManager Failover Test"); + iterator.setJobClient(jobClient); + // -------------------------------------- END --------------------------------------------- + + checkSingleSplitRecords( + testRecordsBeforeFailure.iterator(), iterator, testRecordsBeforeFailure.size()); + + // -------------------------------- Trigger failover --------------------------------------- + final ClusterControllable controller = (ClusterControllable) testEnv; + controller.triggerTaskManagerFailover(jobClient, () -> {}); + + JobStatusUtils.waitForJobStatus( + jobClient, Collections.singletonList(JobStatus.RUNNING), Duration.ofSeconds(30)); + + final Collection<T> testRecordsAfterFailure = externalContext.generateTestData(); Review comment: I think `generateTestData` should take a seed as a parameter so that we are sure that the implementation does not generate the same data. The test may be a false positive otherwise. -- 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]
