This is an automated email from the ASF dual-hosted git repository. martijnvisser pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
commit b9054ee2207032acf4734e231784b26c468ce062 Author: Jing Ge <gej...@gmail.com> AuthorDate: Mon Apr 4 16:55:37 2022 +0200 [FLINK-26011][csv][test] add ArchUnit tests for the test code --- .../41d59928-b3fa-4aa2-8b1b-221c1031bd0c | 6 ++++ .../4f408a58-7016-48fe-8c50-81da98b1601d | 0 .../flink-csv/archunit-violations/stored.rules | 4 +++ flink-formats/flink-csv/pom.xml | 8 +++++ .../architecture/TestCodeArchitectureTest.java | 40 ++++++++++++++++++++++ .../src/test/resources/archunit.properties | 31 +++++++++++++++++ 6 files changed, 89 insertions(+) diff --git a/flink-formats/flink-csv/archunit-violations/41d59928-b3fa-4aa2-8b1b-221c1031bd0c b/flink-formats/flink-csv/archunit-violations/41d59928-b3fa-4aa2-8b1b-221c1031bd0c new file mode 100644 index 00000000000..9f1b399a5f6 --- /dev/null +++ b/flink-formats/flink-csv/archunit-violations/41d59928-b3fa-4aa2-8b1b-221c1031bd0c @@ -0,0 +1,6 @@ +org.apache.flink.formats.csv.CsvFilesystemBatchITCase does not satisfy: only one of the following predicates match:\ +* reside in a package 'org.apache.flink.runtime.*' and contain any fields that are static, final, and of type InternalMiniClusterExtension and annotated with @RegisterExtension\ +* reside outside of package 'org.apache.flink.runtime.*' and contain any fields that are static, final, and of type MiniClusterExtension and annotated with @RegisterExtension\ +* reside in a package 'org.apache.flink.runtime.*' and is annotated with @ExtendWith with class InternalMiniClusterExtension\ +* reside outside of package 'org.apache.flink.runtime.*' and is annotated with @ExtendWith with class MiniClusterExtension\ + or contain any fields that are public, static, and of type MiniClusterWithClientResource and final and annotated with @ClassRule or contain any fields that is of type MiniClusterWithClientResource and public and final and not static and annotated with @Rule \ No newline at end of file diff --git a/flink-formats/flink-csv/archunit-violations/4f408a58-7016-48fe-8c50-81da98b1601d b/flink-formats/flink-csv/archunit-violations/4f408a58-7016-48fe-8c50-81da98b1601d new file mode 100644 index 00000000000..e69de29bb2d diff --git a/flink-formats/flink-csv/archunit-violations/stored.rules b/flink-formats/flink-csv/archunit-violations/stored.rules new file mode 100644 index 00000000000..a9a503644c2 --- /dev/null +++ b/flink-formats/flink-csv/archunit-violations/stored.rules @@ -0,0 +1,4 @@ +# +#Mon Apr 04 16:55:01 CEST 2022 +Tests\ inheriting\ from\ AbstractTestBase\ should\ have\ name\ ending\ with\ ITCase=4f408a58-7016-48fe-8c50-81da98b1601d +ITCASE\ tests\ should\ use\ a\ MiniCluster\ resource\ or\ extension=41d59928-b3fa-4aa2-8b1b-221c1031bd0c diff --git a/flink-formats/flink-csv/pom.xml b/flink-formats/flink-csv/pom.xml index 7498026f096..c45e2af0225 100644 --- a/flink-formats/flink-csv/pom.xml +++ b/flink-formats/flink-csv/pom.xml @@ -102,6 +102,14 @@ under the License. <scope>test</scope> </dependency> + <!-- ArchUit test dependencies --> + + <dependency> + <groupId>org.apache.flink</groupId> + <artifactId>flink-architecture-tests-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> <groupId>org.apache.flink</groupId> <artifactId>flink-table-api-scala-bridge_${scala.binary.version}</artifactId> diff --git a/flink-formats/flink-csv/src/test/java/org/apache/flink/architecture/TestCodeArchitectureTest.java b/flink-formats/flink-csv/src/test/java/org/apache/flink/architecture/TestCodeArchitectureTest.java new file mode 100644 index 00000000000..081d6e0fd9a --- /dev/null +++ b/flink-formats/flink-csv/src/test/java/org/apache/flink/architecture/TestCodeArchitectureTest.java @@ -0,0 +1,40 @@ +/* + * 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.architecture; + +import org.apache.flink.architecture.common.ImportOptions; + +import com.tngtech.archunit.core.importer.ImportOption; +import com.tngtech.archunit.junit.AnalyzeClasses; +import com.tngtech.archunit.junit.ArchTest; +import com.tngtech.archunit.junit.ArchTests; + +/** Architecture tests for test code. */ +@AnalyzeClasses( + packages = {"org.apache.flink.formats.csv"}, + importOptions = { + ImportOption.OnlyIncludeTests.class, + ImportOptions.ExcludeScalaImportOption.class, + ImportOptions.ExcludeShadedImportOption.class + }) +public class TestCodeArchitectureTest { + + @ArchTest + public static final ArchTests COMMON_TESTS = ArchTests.in(TestCodeArchitectureTestBase.class); +} diff --git a/flink-formats/flink-csv/src/test/resources/archunit.properties b/flink-formats/flink-csv/src/test/resources/archunit.properties new file mode 100644 index 00000000000..15be88c95ba --- /dev/null +++ b/flink-formats/flink-csv/src/test/resources/archunit.properties @@ -0,0 +1,31 @@ +# +# 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. +# + +# By default we allow removing existing violations, but fail when new violations are added. +freeze.store.default.allowStoreUpdate=true + +# Enable this if a new (frozen) rule has been added in order to create the initial store and record the existing violations. +#freeze.store.default.allowStoreCreation=true + +# Enable this to add allow new violations to be recorded. +# NOTE: Adding new violations should be avoided when possible. If the rule was correct to flag a new +# violation, please try to avoid creating the violation. If the violation was created due to a +# shortcoming of the rule, file a JIRA issue so the rule can be improved. +#freeze.refreeze=true + +freeze.store.default.path=archunit-violations