From 1fefbf93493a17a108d1567d9d2803ea652961b1 Mon Sep 17 00:00:00 2001
From: Stamatis Zampetakis <zabetak@gmail.com>
Date: Mon, 15 Jul 2024 16:10:41 +0200
Subject: [PATCH] [CALCITE-6470] Run specific JMH benchmarks without modifying
 sources

1. Add jmh.includes property to specify benchmarks to run.
2. Update README instructions for running JMH benchmarks.
---
 ubenchmark/README.md        | 33 +++++++++------------------------
 ubenchmark/build.gradle.kts |  6 ++++++
 2 files changed, 15 insertions(+), 24 deletions(-)

diff --git a/ubenchmark/README.md b/ubenchmark/README.md
index 17e8ef37423..0c212e22f23 100644
--- a/ubenchmark/README.md
+++ b/ubenchmark/README.md
@@ -24,35 +24,20 @@ the [jmh](https://openjdk.java.net/projects/code-tools/jmh/) framework.
 The benchmarks are tools for development and are not distributed as
 Calcite artifacts. (Besides, jmh's license does not allow that.)
 
-## Running all benchmark from the command line
-
 To run all benchmarks:
+```bash
+./gradlew :ubenchmark:jmh
+```
 
-    cd calcite
-    ./gradlew :ubenchmark:jmh
-
-## Running one benchmark from the command line
-
-To run just one benchmark, modify `ubenchmark/build.gradle.kts` and add the
-following task:
-
-```kotlin
-jmh {
-    includes = listOf("removeAllVertices.*Benchmark")
+To run one (or few) benchmark(s):
+```bash
+./gradlew :ubenchmark:jmh -Pjmh.includes=ParserInstantiationBenchmark
 }
 ```
 
-and run
-
-    ./gradlew :ubenchmark:jmh
-
-as before. In this case, `removeAllVertices.*Benchmark` is a
-regular expression that matches a few methods -- benchmarks -- in
-`class DefaultDirectedGraphBenchmark`.
-
-The `jmd-gradle-plugin` has
-[many other options](https://github.com/melix/jmh-gradle-plugin#configuration-options)
-but you will need to translate them from Groovy syntax to our Kotlin syntax.
+The `jmh.includes` property accepts a regular expression for benchmarks to be executed. The property maps to the
+`includes` [configuration option](https://github.com/melix/jmh-gradle-plugin#configuration-options) provided by the
+`jmh-gradle-plugin`.
 
 ## Recording results
 
diff --git a/ubenchmark/build.gradle.kts b/ubenchmark/build.gradle.kts
index 7d131ad8e6c..e1c6d1157dd 100644
--- a/ubenchmark/build.gradle.kts
+++ b/ubenchmark/build.gradle.kts
@@ -49,3 +49,9 @@ tasks.withType<JavaExec>().configureEach {
         classpath(File(layout.buildDirectory.asFile.get(), "jmh-generated-resources"))
     }
 }
+
+if (hasProperty("jmh.includes")) {
+    jmh {
+        includes = listOf(property("jmh.includes") as String)
+    }
+}