You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by sn...@apache.org on 2026/08/05 12:59:10 UTC
(flink) 03/03: [FLINK-40284][tests] Archunit should fail in case of tests not matching name requirements
This is an automated email from the ASF dual-hosted git repository.
snuyanzin pushed a commit to branch release-1.20
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 9e051eb66df011e2588a89c5ed6c080f332e49c9
Author: Sergey Nuyanzin <sn...@gmail.com>
AuthorDate: Mon Aug 3 12:35:20 2026 +0200
[FLINK-40284][tests] Archunit should fail in case of tests not matching name requirements
This closes #28887.
---
.../architecture/TestCodeArchitectureTestBase.java | 3 +
.../flink/architecture/rules/TestNamingRules.java | 86 ++++++++++++++++++++++
2 files changed, 89 insertions(+)
diff --git a/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/TestCodeArchitectureTestBase.java b/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/TestCodeArchitectureTestBase.java
index a33ad9b6d66..9b7984d002b 100644
--- a/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/TestCodeArchitectureTestBase.java
+++ b/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/TestCodeArchitectureTestBase.java
@@ -19,6 +19,7 @@
package org.apache.flink.architecture;
import org.apache.flink.architecture.rules.ITCaseRules;
+import org.apache.flink.architecture.rules.TestNamingRules;
import com.tngtech.archunit.junit.ArchTest;
import com.tngtech.archunit.junit.ArchTests;
@@ -33,4 +34,6 @@ import com.tngtech.archunit.junit.ArchTests;
public class TestCodeArchitectureTestBase {
@ArchTest public static final ArchTests ITCASE = ArchTests.in(ITCaseRules.class);
+
+ @ArchTest public static final ArchTests TEST_NAMING = ArchTests.in(TestNamingRules.class);
}
diff --git a/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/rules/TestNamingRules.java b/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/rules/TestNamingRules.java
new file mode 100644
index 00000000000..79810fa043f
--- /dev/null
+++ b/flink-architecture-tests/flink-architecture-tests-test/src/main/java/org/apache/flink/architecture/rules/TestNamingRules.java
@@ -0,0 +1,86 @@
+/*
+ * 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.rules;
+
+import com.tngtech.archunit.base.DescribedPredicate;
+import com.tngtech.archunit.core.domain.JavaClass;
+import com.tngtech.archunit.junit.ArchTest;
+import com.tngtech.archunit.lang.ArchRule;
+
+import java.util.Arrays;
+import java.util.List;
+
+import static com.tngtech.archunit.core.domain.JavaModifier.ABSTRACT;
+import static org.apache.flink.architecture.common.GivenJavaClasses.javaClassesThat;
+
+/**
+ * Rules ensuring executable test classes are named so the build actually runs them.
+ *
+ * <p>Surefire only runs the unit include pattern {@code **}{@code /*Test.*} in the {@code test}
+ * phase; integration tests follow the {@code *ITCase} convention. A concrete class that carries (or
+ * inherits) JUnit test methods but is named otherwise (e.g. {@code *Tests}) is silently skipped by
+ * the unit run. This rule flags such classes so they are renamed to {@code *Test} or {@code
+ * *ITCase}.
+ */
+public class TestNamingRules {
+
+ /** JUnit 5 and (for modules still mid-migration) JUnit 4 test method annotations. */
+ private static final List<String> TEST_METHOD_ANNOTATIONS =
+ Arrays.asList(
+ "org.junit.jupiter.api.Test",
+ "org.junit.jupiter.api.TestTemplate",
+ "org.junit.jupiter.api.RepeatedTest",
+ "org.junit.jupiter.api.TestFactory",
+ "org.junit.jupiter.params.ParameterizedTest",
+ "org.junit.Test");
+
+ /**
+ * A class JUnit would execute: it declares or inherits a test method. {@code getAllMethods()}
+ * covers inherited {@code @TestTemplate} methods, e.g. semantic-test suites that only extend a
+ * base and add no annotation themselves.
+ */
+ private static final DescribedPredicate<JavaClass> ARE_EXECUTABLE_TEST_CLASSES =
+ DescribedPredicate.describe(
+ "are executable JUnit test classes",
+ clazz ->
+ clazz.getAllMethods().stream()
+ .anyMatch(
+ method ->
+ TEST_METHOD_ANNOTATIONS.stream()
+ .anyMatch(method::isAnnotatedWith)));
+
+ @ArchTest
+ public static final ArchRule TEST_CLASSES_SHOULD_BE_NAMED_TEST_OR_ITCASE =
+ javaClassesThat()
+ .areTopLevelClasses()
+ .and()
+ .doNotHaveModifier(ABSTRACT)
+ .and(ARE_EXECUTABLE_TEST_CLASSES)
+ .should()
+ .haveSimpleNameEndingWith("Test")
+ .orShould()
+ .haveSimpleNameEndingWith("Tests")
+ .orShould()
+ .haveSimpleNameEndingWith("ITCase")
+ // not every module has such classes
+ .allowEmptyShould(true)
+ .as(
+ "Executable test classes must be named *Test[s] or *ITCase so the surefire "
+ + "include pattern runs them");
+}