Integrating JMH into gradle

jmh.gradle

// Adds JMH integration to a project.
// Considering putting this file into gradle/ folder and include it with: 
//   apply from: rootProject.file('gradle/jmh.gradle')

sourceSets {
   jmh {
       compileClasspath += sourceSets.test.runtimeClasspath
       runtimeClasspath += sourceSets.test.runtimeClasspath
   }
}

dependencies {
   jmhCompile project
   jmhCompile 'org.openjdk.jmh:jmh-core:1.18'
   jmhAnnotationProcessor 'org.openjdk.jmh:jmh-generator-annprocess:1.18'
}

eclipse {
   classpath {
       plusConfigurations.add(configurations.jmhCompile)
       defaultOutputDir = file('build/classes-jmh-ide')
   }
}

task ('jmhHelp', description:'Print help for the jmh task') {
   doLast {  
      println ""
      println "Usage of jmh tasks:"
      println ""
	
      println "Only execute specific benchmark(s):"
      println "\t./gradlew jmh -Pinclude=\".*MyBenchmark.*\""

      println ""
      println "Specify extra profilers:"
      println "\t./gradlew jmh -Pprofilers=\"gc,stack\""

      println ""
      println "Prominent profilers (for full list call jmhProfilers task):"
      println "\tcomp - JitCompilations, tune your iterations"
      println "\tstack - which methods used most time"
      println "\tgc - print garbage collection stats"
      println "\ths_thr - thread usage"
	
      println ""
      println "Change report format from JSON to one of [CSV, JSON, NONE, SCSV, TEXT]:"
      println "\t./gradlew jmh -Pformat=csv"

      println ""
      println "Specify JVM arguments:"
      println "\t./gradlew jmh -PjvmArgs=\"-Dtest.cluster=local\""

      println ""
      println "Run in verification mode (execute benchmarks with minimum of fork/warmup-/benchmark-iterations):"
      println "\tgw jmh -Pverify"

      println ""
      println "Resources:"
      println "\thttp://tutorials.jenkov.com/java-performance/jmh.html (Introduction)"
      println "\thttp://hg.openjdk.java.net/code-tools/jmh/file/tip/jmh-samples/src/main/java/org/openjdk/jmh/samples/ (Samples)"
   }       
}

task jmhProfilers(type: JavaExec, description:'Lists the available profilers for the jmh task', group: 'Development') {
    classpath = sourceSets.jmh.runtimeClasspath
    main = 'org.openjdk.jmh.Main'
    args '-lprof'
}

task jmh(type: JavaExec, description: 'Executing JMH benchmarks') {
   classpath = sourceSets.jmh.runtimeClasspath
   main = 'org.openjdk.jmh.Main'

   def include = project.properties.get('include', '');
   def exclude = project.properties.get('exclude');
   def format = project.properties.get('format', 'json');
   def profilers = project.properties.get('profilers');
   def jvmArgs = project.properties.get('jvmArgs')
   def verify =  project.properties.get('verify');

   def resultFile = file("build/reports/jmh/result.${format}")
	
   args include
   if(exclude) {
       args '-e', exclude
   }
   if(verify != null) { // execute benchmarks with the minimum amount of execution (only to check if they are working)
       println "≥≥ Running in verify mode"
       args '-f' , 1
       args '-wi' , 1
       args '-i' , 1
   }
   args '-foe', 'true'   //fail-on-error
   args '-v', 'NORMAL'   //verbosity [SILENT, NORMAL, EXTRA]
   if(profilers) {
       profilers.split(',').each {
           args '-prof', it
       }
   }
   args '-jvmArgsPrepend', '-Xmx3072m'
   args '-jvmArgsPrepend', '-Xms3072m'
   if(jvmArgs) {
       for(jvmArg in jvmArgs.split(' ')) {
           args '-jvmArgsPrepend', jvmArg
       }
   }
  args '-rf', format
  args '-rff', resultFile
	
   doFirst {
       println "\nExecuting JMH with: $args \n"
       resultFile.parentFile.mkdirs()
   }
}

3 ways you can use this:

• Add it as gradle file into your project, and then include it from there, e.g:
  apply from: rootProject.file('gradle/jmh.gradle')
• Link the most current version of the gist directly:
  apply from: "https://gist.github.com/jzillmann/754bf625d43b91fcff295935cbfd1bff/raw"
• Link a specific version of the gist
  apply from: "https://gist.githubusercontent.com/jzillmann/754bf625d43b91fcff295935cbfd1bff/raw/ff0d804b199c0c89e71808ab9694bcc69c218be9/jmh.gradle"