[FLINK-35490] Migrate tests to JUnit 5 and AssertJ #3742

yuxiqian · 2024-11-19T12:39:09Z

This is a sequel PR based on @morazow's great work in #3395.

Currently, there are way too many unit tests and assertion frameworks, including JUnit-4 style Assert, JUnit-5 style Assertions, Hamcrest Matchers, AssertJ fluent assertions. JUnit 4, 5 (Jupier and Vintage) test frameworks are also used altogether, which is prone to mistakes.

Among all these solutions, AssertJ is generally regarded as the most readable and expressive, and used as the assertion standard in many other projects like Apache Iceberg.

This PR migrates all existing test cases to JUnit 5 + AssertJ combination, with an enforced rule defined in spotless style check to forbid using any other testing / asserting frameworks.

yuxiqian · 2024-11-20T08:09:41Z

Most changes are just repetitive while some needs more attention:

Created wrapper classes AbstractTestBaseProxy because Flink's original version was targeted to JUnit 4
Created ExternalResourceProxy and StaticExternalResourceProxy to use JUnit 4 style @Rules and @ClassRules as JUnit 5 Extensions
Modified checkstyle.xml to forbid using any other testing / asserting frameworks (copied from https://github.com/apache/iceberg/blob/main/.baseline/checkstyle/checkstyle.xml)

cc @GOODBOY008 @whhe @ruanhang1993 @morazow

morazow

Thanks @yuxiqian 🚀 This is massive effort, thanks a lot!

I have added some suggestions, I will go over it again later on. Let's try to get this finalized soon

...ctor-kafka/src/test/java/org/apache/flink/cdc/connectors/kafka/sink/KafkaDataSinkITCase.java

morazow · 2024-12-01T22:49:50Z

...se/src/test/java/org/apache/flink/cdc/connectors/base/MySqlChangeEventSourceExampleTest.java

-        assertTrue(expected != null && actual != null);
-        assertEquals(expected.size(), actual.size());
-        assertArrayEquals(expected.toArray(new String[0]), actual.toArray(new String[0]));
+        Assertions.assertThat(actual).containsExactlyInAnyOrderElementsOf(expected);


...nector-db2-cdc/src/test/java/org/apache/flink/cdc/connectors/db2/source/Db2SourceITCase.java

...src/test/java/org/apache/flink/cdc/connectors/mongodb/source/MongoDBFullChangelogITCase.java

...ysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlSourceTestBase.java

flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/parser/JaninoCompilerTest.java

...igration-testcases/src/test/java/org/apache/flink/cdc/migration/tests/MigrationTestBase.java

morazow · 2024-12-01T23:39:08Z

...src/test/java/org/apache/flink/cdc/connectors/tests/utils/FlinkContainerTestEnvironment.java

-            return Arrays.asList("1.19.1", "1.20.0");
+        if (Objects.isNull(flinkVersion)) {
+            throw new IllegalArgumentException(
+                    "No Flink version specified to run this test. Please use -DspecifiedFlinkVersion to pass one.");


Previous test has default value. But it is good idea to throw here, since the release cycle is very frequent nowadays 👍

flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mongodb-cdc/pom.xml

yuxiqian · 2024-12-03T02:14:22Z

Thanks for the quick review! Addressed comments and resolved conflicts.

yuxiqian · 2025-01-20T07:04:30Z

Rebased and resolved conflicts again. Maybe we can work on this right after cutting branch to minimize the rebase chore. @leonardBang

Signed-off-by: yuxiqian <34335406+yuxiqian@users.noreply.github.com> # Conflicts: # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-elasticsearch/pom.xml # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-starrocks/pom.xml # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-db2-cdc/src/test/java/org/apache/flink/cdc/connectors/db2/table/Db2ConnectorITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mongodb-cdc/src/test/java/org/apache/flink/cdc/connectors/mongodb/table/MongoDBConnectorITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mongodb-cdc/src/test/java/org/apache/flink/cdc/connectors/mongodb/table/MongoDBRegexFilterITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/table/MySqlConnectorITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-oracle-cdc/src/test/java/org/apache/flink/cdc/connectors/oracle/table/OracleConnectorITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-postgres-cdc/src/test/java/org/apache/flink/cdc/connectors/postgres/table/PostgreSQLConnectorITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-postgres-cdc/src/test/java/org/apache/flink/cdc/connectors/postgres/table/PostgreSQLSavepointITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-sqlserver-cdc/src/test/java/org/apache/flink/cdc/connectors/sqlserver/table/SqlServerConnectorITCase.java # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/pom.xml # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/src/test/java/org/apache/flink/cdc/pipeline/tests/utils/PipelineTestEnvironment.java # flink-cdc-e2e-tests/flink-cdc-source-e2e-tests/src/test/java/org/apache/flink/cdc/connectors/tests/utils/FlinkContainerTestEnvironment.java # Conflicts: # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/table/MySqlConnectorITCase.java # Conflicts: # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/source/assigners/state/PendingSplitsStateSerializerTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-oceanbase-cdc/src/test/java/org/apache/flink/cdc/connectors/oceanbase/table/OceanBaseMySQLModeITCase.java # Conflicts: # flink-cdc-connect/flink-cdc-source-connectors/flink-cdc-base/src/test/java/org/apache/flink/cdc/connectors/base/source/assigner/state/PendingSplitsStateSerializerTest.java # Conflicts: # flink-cdc-connect/flink-cdc-source-connectors/flink-cdc-base/src/test/java/org/apache/flink/cdc/connectors/base/GenericConnectionPoolTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-cdc-base/src/test/java/org/apache/flink/cdc/connectors/base/MySqlChangeEventSourceExampleTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-cdc-base/src/test/java/org/apache/flink/cdc/connectors/base/source/assigner/state/PendingSplitsStateSerializerTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-cdc-base/src/test/java/org/apache/flink/cdc/connectors/base/source/meta/split/SourceSplitSerializerTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-cdc-base/src/test/java/org/apache/flink/cdc/connectors/base/testutils/UniqueDatabase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/source/assigners/state/PendingSplitsStateSerializerTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-postgres-cdc/src/test/java/org/apache/flink/cdc/connectors/postgres/source/fetch/PostgresScanFetchTaskTest.java # flink-cdc-e2e-tests/flink-cdc-source-e2e-tests/src/test/java/org/apache/flink/cdc/connectors/tests/OracleE2eITCase.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/parser/JaninoCompilerTest.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/parser/TransformParserTest.java # Conflicts: # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/src/test/java/org/apache/flink/cdc/pipeline/tests/MysqlE2eITCase.java # Conflicts: # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-mysql/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlPipelineITCase.java # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/src/test/java/org/apache/flink/cdc/pipeline/tests/RouteE2eITCase.java # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/src/test/java/org/apache/flink/cdc/pipeline/tests/utils/PipelineTestEnvironment.java # flink-cdc-migration-tests/flink-cdc-migration-testcases/src/test/java/org/apache/flink/cdc/migration/tests/SchemaManagerMigrationTest.java # flink-cdc-migration-tests/flink-cdc-migration-testcases/src/test/java/org/apache/flink/cdc/migration/tests/SchemaRegistryMigrationTest.java # flink-cdc-migration-tests/flink-cdc-migration-testcases/src/test/java/org/apache/flink/cdc/migration/tests/TableChangeInfoMigrationTest.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/operators/schema/coordinator/SchemaDerivationTest.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/operators/schema/regular/SchemaEvolveTest.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/operators/schema/regular/SchemaOperatorTest.java # Conflicts: # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-paimon/src/test/java/org/apache/flink/cdc/connectors/paimon/sink/PaimonMetadataApplierTest.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-paimon/src/test/java/org/apache/flink/cdc/connectors/paimon/sink/v2/PaimonSinkITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-oceanbase-cdc/src/test/java/org/apache/flink/cdc/connectors/oceanbase/table/OceanBaseMySQLModeITCase.java # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/pom.xml # Conflicts: # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/debezium/reader/SnapshotSplitReaderTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlSourceTestBase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/source/assigners/MySqlHybridSplitAssignerTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/source/assigners/MySqlSnapshotSplitAssignerTest.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/table/MySqlTableSourceFactoryTest.java # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/src/test/java/org/apache/flink/cdc/pipeline/tests/utils/PipelineTestEnvironment.java # flink-cdc-pipeline-model/src/test/java/org/apache/flink/cdc/runtime/model/TestOpenAIChatModel.java # flink-cdc-pipeline-model/src/test/java/org/apache/flink/cdc/runtime/model/TestOpenAIEmbeddingModel.java # Conflicts: # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-doris/src/test/java/org/apache/flink/cdc/connectors/doris/sink/DorisMetadataApplierITCase.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-elasticsearch/src/test/java/org/apache/flink/cdc/connectors/elasticsearch/sink/ElasticsearchDataSinkFactoryTest.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-paimon/src/test/java/org/apache/flink/cdc/connectors/paimon/sink/v2/PaimonSinkITCase.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-starrocks/src/test/java/org/apache/flink/cdc/connectors/starrocks/sink/StarRocksMetadataApplierITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-postgres-cdc/src/test/java/org/apache/flink/cdc/connectors/postgres/source/PostgresSourceITCase.java # flink-cdc-e2e-tests/flink-cdc-pipeline-e2e-tests/src/test/java/org/apache/flink/cdc/pipeline/tests/MySqlToDorisE2eITCase.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/parser/TransformParserTest.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/serializer/SerializerTestBase.java # flink-cdc-runtime/src/test/java/org/apache/flink/cdc/runtime/serializer/schema/DataTypeSerializerTest.java # tools/maven/checkstyle.xml # Conflicts: # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-doris/src/test/java/org/apache/flink/cdc/connectors/doris/sink/DorisRowConverterTest.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-mysql/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlDataSourceFactoryTest.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-mysql/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlFullTypesITCase.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-mysql/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlMetadataAccessorITCase.java # flink-cdc-connect/flink-cdc-pipeline-connectors/flink-cdc-pipeline-connector-mysql/src/test/java/org/apache/flink/cdc/connectors/mysql/source/MySqlPipelineITCase.java # flink-cdc-connect/flink-cdc-source-connectors/flink-connector-mysql-cdc/src/test/java/org/apache/flink/cdc/connectors/mysql/table/MySqlTableSourceFactoryTest.java

yuxiqian force-pushed the FLINK-35490 branch 5 times, most recently from 3ee96e2 to c2d2f94 Compare November 20, 2024 07:50

yuxiqian force-pushed the FLINK-35490 branch from c2d2f94 to 7603a2d Compare November 20, 2024 07:51

yuxiqian force-pushed the FLINK-35490 branch 2 times, most recently from b56570d to a4f142c Compare November 20, 2024 09:32

morazow suggested changes Dec 1, 2024

View reviewed changes

yuxiqian force-pushed the FLINK-35490 branch 2 times, most recently from 2797740 to 15b3ef2 Compare December 3, 2024 02:14

yuxiqian force-pushed the FLINK-35490 branch from 15b3ef2 to 9e4352b Compare December 6, 2024 06:34

yuxiqian force-pushed the FLINK-35490 branch 3 times, most recently from 957c68d to 62c057b Compare December 25, 2024 06:13

github-actions bot removed the migration-tests label Dec 25, 2024

yuxiqian force-pushed the FLINK-35490 branch 4 times, most recently from b746ddd to 2fbac7e Compare January 16, 2025 08:54

yuxiqian force-pushed the FLINK-35490 branch from 2fbac7e to 33d8579 Compare January 20, 2025 06:14

yuxiqian force-pushed the FLINK-35490 branch from 33d8579 to de9ebb3 Compare February 7, 2025 12:43

github-actions bot added oceanbase-pipeline-connector add-ons maxcompute-pipeline-connector labels Feb 7, 2025

yuxiqian force-pushed the FLINK-35490 branch from 732793c to 064d936 Compare February 8, 2025 06:43

yuxiqian force-pushed the FLINK-35490 branch from 78831e1 to 2948846 Compare February 8, 2025 08:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-35490] Migrate tests to JUnit 5 and AssertJ #3742

[FLINK-35490] Migrate tests to JUnit 5 and AssertJ #3742

yuxiqian commented Nov 19, 2024

yuxiqian commented Nov 20, 2024 •

edited

Loading

morazow left a comment

morazow Dec 1, 2024

morazow Dec 1, 2024

yuxiqian commented Dec 3, 2024 •

edited

Loading

yuxiqian commented Jan 20, 2025 •

edited

Loading

[FLINK-35490] Migrate tests to JUnit 5 and AssertJ #3742

Are you sure you want to change the base?

[FLINK-35490] Migrate tests to JUnit 5 and AssertJ #3742

Conversation

yuxiqian commented Nov 19, 2024

yuxiqian commented Nov 20, 2024 • edited Loading

morazow left a comment

Choose a reason for hiding this comment

morazow Dec 1, 2024

Choose a reason for hiding this comment

morazow Dec 1, 2024

Choose a reason for hiding this comment

yuxiqian commented Dec 3, 2024 • edited Loading

yuxiqian commented Jan 20, 2025 • edited Loading

yuxiqian commented Nov 20, 2024 •

edited

Loading

yuxiqian commented Dec 3, 2024 •

edited

Loading

yuxiqian commented Jan 20, 2025 •

edited

Loading