Merge pull request #4075 from graphql-java/ban-fork-2

dondonz · web-flow · commit 21bcb4a452a4 · 2025-08-07T11:02:19.000+10:00
Prohibit JMH tests from having more than 2 forks
diff --git a/build.gradle b/build.gradle
@@ -144,6 +144,7 @@ dependencies {
 
     testImplementation 'org.testng:testng:7.11.0' // use for reactive streams test inheritance
     testImplementation "com.tngtech.archunit:archunit-junit5:1.4.1"
+    testImplementation 'org.openjdk.jmh:jmh-core:1.37' // required for ArchUnit to check JMH tests
 
     antlr 'org.antlr:antlr4:' + antlrVersion
 
@@ -309,13 +310,17 @@ artifacts {
 
 List<TestDescriptor> failedTests = []
 
-test {
+tasks.withType(Test) {
     useJUnitPlatform()
     testLogging {
         events "FAILED", "SKIPPED"
         exceptionFormat = "FULL"
     }
 
+    // Required for JMH ArchUnit tests
+    classpath += sourceSets.jmh.output
+    dependsOn "jmhClasses"
+
     afterTest { TestDescriptor descriptor, TestResult result ->
         if (result.getFailedTestCount() > 0) {
             failedTests.add(descriptor)
@@ -327,34 +332,11 @@ tasks.register('testWithJava17', Test) {
     javaLauncher = javaToolchains.launcherFor {
         languageVersion = JavaLanguageVersion.of(17)
     }
-    useJUnitPlatform()
-    testLogging {
-        events "FAILED", "SKIPPED"
-        exceptionFormat = "FULL"
-    }
-
-    afterTest { TestDescriptor descriptor, TestResult result ->
-        if (result.getFailedTestCount() > 0) {
-            failedTests.add(descriptor)
-        }
-    }
-
 }
 tasks.register('testWithJava11', Test) {
     javaLauncher = javaToolchains.launcherFor {
         languageVersion = JavaLanguageVersion.of(11)
     }
-    useJUnitPlatform()
-    testLogging {
-        events "FAILED", "SKIPPED"
-        exceptionFormat = "FULL"
-    }
-
-    afterTest { TestDescriptor descriptor, TestResult result ->
-        if (result.getFailedTestCount() > 0) {
-            failedTests.add(descriptor)
-        }
-    }
 }
 test.dependsOn testWithJava17
 test.dependsOn testWithJava11
diff --git a/src/jmh/java/benchmark/AssertBenchmark.java b/src/jmh/java/benchmark/AssertBenchmark.java
@@ -18,7 +18,7 @@
 
 @Warmup(iterations = 2, time = 5, batchSize = 50)
 @Measurement(iterations = 3, batchSize = 50)
-@Fork(3)
+@Fork(2)
 public class AssertBenchmark {
 
     private static final int LOOPS = 100;
diff --git a/src/jmh/java/benchmark/AstPrinterBenchmark.java b/src/jmh/java/benchmark/AstPrinterBenchmark.java
@@ -16,7 +16,7 @@
 
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3, time = 10)
-@Fork(3)
+@Fork(2)
 public class AstPrinterBenchmark {
     /**
      * Note: this query is a redacted version of a real query
diff --git a/src/jmh/java/benchmark/ChainedInstrumentationBenchmark.java b/src/jmh/java/benchmark/ChainedInstrumentationBenchmark.java
@@ -35,7 +35,7 @@
 @State(Scope.Benchmark)
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class ChainedInstrumentationBenchmark {
 
     @Param({"0", "1", "10"})
diff --git a/src/jmh/java/benchmark/CompletableFuturesBenchmark.java b/src/jmh/java/benchmark/CompletableFuturesBenchmark.java
@@ -23,7 +23,7 @@
 @State(Scope.Benchmark)
 @Warmup(iterations = 2, time = 1)
 @Measurement(iterations = 3, time = 10, batchSize = 10)
-@Fork(3)
+@Fork(2)
 public class CompletableFuturesBenchmark {
 
 
diff --git a/src/jmh/java/benchmark/CreateExtendedSchemaBenchmark.java b/src/jmh/java/benchmark/CreateExtendedSchemaBenchmark.java
@@ -27,7 +27,7 @@
  */
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class CreateExtendedSchemaBenchmark {
 
     private static final String SDL = mkSDL();
diff --git a/src/jmh/java/benchmark/CreateSchemaBenchmark.java b/src/jmh/java/benchmark/CreateSchemaBenchmark.java
@@ -18,7 +18,7 @@
 
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class CreateSchemaBenchmark {
 
     static String largeSDL = BenchmarkUtils.loadResource("large-schema-3.graphqls");
diff --git a/src/jmh/java/benchmark/GetterAccessBenchmark.java b/src/jmh/java/benchmark/GetterAccessBenchmark.java
@@ -13,7 +13,7 @@
 
 @Warmup(iterations = 2, time = 5, batchSize = 500)
 @Measurement(iterations = 3, batchSize = 500)
-@Fork(3)
+@Fork(2)
 public class GetterAccessBenchmark {
 
     public static class Pojo {
diff --git a/src/jmh/java/benchmark/IntMapBenchmark.java b/src/jmh/java/benchmark/IntMapBenchmark.java
@@ -15,7 +15,7 @@
 @State(Scope.Benchmark)
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class IntMapBenchmark {
 
     @Benchmark
diff --git a/src/jmh/java/benchmark/IntrospectionBenchmark.java b/src/jmh/java/benchmark/IntrospectionBenchmark.java
@@ -21,7 +21,7 @@
 @State(Scope.Benchmark)
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class IntrospectionBenchmark {
 
     @Benchmark
diff --git a/src/jmh/java/benchmark/MapBenchmark.java b/src/jmh/java/benchmark/MapBenchmark.java
@@ -25,7 +25,7 @@
 @State(Scope.Benchmark)
 @Warmup(iterations = 2, time = 1)
 @Measurement(iterations = 3, time = 1, batchSize = 1000)
-@Fork(3)
+@Fork(2)
 public class MapBenchmark {
 
     @Param({"10", "50", "300"})
diff --git a/src/jmh/java/benchmark/OverlappingFieldValidationBenchmark.java b/src/jmh/java/benchmark/OverlappingFieldValidationBenchmark.java
@@ -35,7 +35,7 @@
 @State(Scope.Benchmark)
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class OverlappingFieldValidationBenchmark {
 
     @State(Scope.Benchmark)
diff --git a/src/jmh/java/benchmark/PropertyFetcherBenchMark.java b/src/jmh/java/benchmark/PropertyFetcherBenchMark.java
@@ -16,7 +16,7 @@
 
 @Warmup(iterations = 2, time = 5, batchSize = 50)
 @Measurement(iterations = 3, batchSize = 50)
-@Fork(3)
+@Fork(2)
 public class PropertyFetcherBenchMark {
 
     @Benchmark
diff --git a/src/jmh/java/benchmark/SchemaTransformerBenchmark.java b/src/jmh/java/benchmark/SchemaTransformerBenchmark.java
@@ -30,7 +30,7 @@
 @BenchmarkMode(Mode.AverageTime)
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3, time = 10)
-@Fork(3)
+@Fork(2)
 @OutputTimeUnit(TimeUnit.MILLISECONDS)
 public class SchemaTransformerBenchmark {
 
diff --git a/src/jmh/java/benchmark/SimpleQueryBenchmark.java b/src/jmh/java/benchmark/SimpleQueryBenchmark.java
@@ -28,7 +28,7 @@
 
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class SimpleQueryBenchmark {
 
     private static final int NUMBER_OF_FRIENDS = 10 * 100;
diff --git a/src/jmh/java/benchmark/TwitterBenchmark.java b/src/jmh/java/benchmark/TwitterBenchmark.java
@@ -35,7 +35,7 @@
 
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class TwitterBenchmark {
     private static final int BREADTH = 150;
     private static final int DEPTH = 150;
diff --git a/src/jmh/java/benchmark/TypeDefinitionParserVersusSerializeBenchmark.java b/src/jmh/java/benchmark/TypeDefinitionParserVersusSerializeBenchmark.java
@@ -21,7 +21,7 @@
 
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 public class TypeDefinitionParserVersusSerializeBenchmark {
 
     static SchemaParser schemaParser = new SchemaParser();
diff --git a/src/jmh/java/benchmark/ValidatorBenchmark.java b/src/jmh/java/benchmark/ValidatorBenchmark.java
@@ -28,7 +28,7 @@
 @BenchmarkMode(Mode.AverageTime)
 @Warmup(iterations = 2, time = 5)
 @Measurement(iterations = 3)
-@Fork(3)
+@Fork(2)
 @OutputTimeUnit(TimeUnit.MILLISECONDS)
 public class ValidatorBenchmark {
 
diff --git a/src/test/groovy/graphql/archunit/JMHForkArchRuleTest.groovy b/src/test/groovy/graphql/archunit/JMHForkArchRuleTest.groovy
@@ -0,0 +1,50 @@
+package graphql.archunit
+
+import com.tngtech.archunit.core.domain.JavaClass
+import com.tngtech.archunit.core.importer.ClassFileImporter
+import com.tngtech.archunit.lang.ArchCondition
+import com.tngtech.archunit.lang.ConditionEvents
+import com.tngtech.archunit.lang.EvaluationResult
+import com.tngtech.archunit.lang.SimpleConditionEvent
+import org.openjdk.jmh.annotations.Fork
+import spock.lang.Specification
+
+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes
+
+class JMHForkArchRuleTest extends Specification {
+
+    def "JMH benchmarks on classes should not have a fork value greater than 2"() {
+        given:
+        def importedClasses = new ClassFileImporter()
+                .importPackages("benchmark", "performance", "graphql.execution")
+
+        def rule = classes()
+                .that().areAnnotatedWith(Fork.class)
+                .and().areTopLevelClasses()
+                .should(haveForkValueNotGreaterThan(2))
+
+        when:
+        EvaluationResult result = rule.evaluate(importedClasses)
+
+        then:
+        !result.hasViolation()
+
+        cleanup:
+        if (result.hasViolation()) {
+            println result.getFailureReport().toString()
+        }
+    }
+
+    private static ArchCondition<JavaClass> haveForkValueNotGreaterThan(int maxFork) {
+        return new ArchCondition<JavaClass>("have a @Fork value of at most $maxFork") {
+            @Override
+            void check(JavaClass javaClass, ConditionEvents events) {
+                def forkAnnotation = javaClass.getAnnotationOfType(Fork.class)
+                if (forkAnnotation.value() > maxFork) {
+                    def message = "Class ${javaClass.name} has a @Fork value of ${forkAnnotation.value()} which is > $maxFork"
+                    events.add(SimpleConditionEvent.violated(javaClass, message))
+                }
+            }
+        }
+    }
+}
diff --git a/src/test/groovy/graphql/archunit/NullabilityAnnotationUsageTest.groovy b/src/test/groovy/graphql/archunit/NullabilityAnnotationUsageTest.groovy
@@ -1,4 +1,4 @@
-package graphql
+package graphql.archunit
 
 import com.tngtech.archunit.core.domain.JavaClasses
 import com.tngtech.archunit.core.importer.ClassFileImporter
