GatlingのSimulationをGradleタスクとしてシンプルに実行する

はじめに

Gatlingはレポートが見やすかったりと負荷テストをするのに便利ですね。
公式のGradleプラグインもあり、ドキュメントもしっかりしているので、Gradleからの実行も簡単です。

$ gradlew gatlingRun

とすれば、全てのSimulationを、

$ gradlew gatlingRun-foo.bar.fqcn.of.MySimulation

とすれば、任意のSimulationを個別に実行できます。

ただ、後者の実行方法が個人的にあまり好みでなく。。ハイフンとかドットとか優しくなくて、何かと阻害要因になりそう。。
なので、本記事では下記のようにシンプルなコマンドで実行するための方法を紹介します。

$ gradlew runMySimulation

公式ドキュメントの情報を読めば分かる方法ではあるものの、具体的なサンプルはなかったので忘れないように書いておきます。

見出しの通り、単純にGradleタスクを追加すればいい話なのですが、細かいポイントを書いておきます。

タスクのtypeにはio.gatling.gradle.GatlingRunTaskを指定する。
依存タスクとして、gatlingClassesとgatlingLogbackを指定しておく。（どちらも標準のgatlingRunタスクが依存しているタスクです。clean後などはclassファイルが存在しないため、gatlingClassesが事前に実行されていないと、ClassNotFoundExceptionが発生します）
追加するタスクにはグループを明示しておく。gatlingに限った話ではないですが、そうしないとother扱いで他の既存タスクとごちゃまぜになってしまい、IDEAなどGUIでタスクを実行する際に探しにくいので。。
実行対象はsimulationsクロージャで、includeすることで指定する。
includeにはSimulationのscalaファイルのソースルートからのパスを記載する。（パスにはsrc/gatling/scalaは含めない）
includeを複数記述することで複数の実行対象を指定することができる。または、パターンとして記述することでも複数の実行対象を含めることができる。パターンに関してはGradleのドキュメントを参照。