Webアプリ開発/テストのお供に『WAITT』 #Java

Tomcat Launcherやtomcat-maven-pluginの融通の効かなさ加減に落胆し、waitt-maven-pluginを作ったわけですが、waitt-maven-pluginもtomcat7固定で環境や用途が限定されてしまっていたので、大幅に手を入れてプラッガブルなWAITTとして生まれ変わらせました。

WAITTとは

Webアプリケーションをローカルで動作確認したり、テスト環境用に起動したりするためのMavenプラグインです。

Spring bootでなくても、特別なコードを書かなくても、IDEの有償の機能を使わなくても、Tomcat7/Tomcat8/Jetty9など選択して、Webアプリを起動することができます。jarやwarを作る必要はありません。アプリケーションのクラスパスに何か付け加える必要もありません。

それからWAITTでは、起動したサーバ/アプリケーションに対してFeatureを追加することができます。

現状では、

カバレッジ (cobertura/JaCoCo)
ダッシュボード
トレーサ

の3種類のFeatureがあります。

設定と起動

簡単です。Webアプリプロジェクトのpomファイルに以下の行を書き加えます。

<plugin>
    <groupId>net.unit8.waitt</groupId>
    <artifactId>waitt-maven-plugin</artifactId>
    <version>1.0.0</version>
    <configuration>
        <servers>
            <server>
                <groupId>net.unit8.waitt.server</groupId>
                <artifactId>waitt-tomcat8</artifactId>
                <version>0.1.0</version>
            </server>
        </servers>
    </configuration>
</plugin>

そして、

% mvn waitt:run

でtomcat8にWebアプリがデプロイされて起動します。warやjarを作る必要はありません。

複数のサーバから選択する

以下のように

<plugin>
    <groupId>net.unit8.waitt</groupId>
    <artifactId>waitt-maven-plugin</artifactId>
    <version>1.0.0</version>
    <configuration>
        <servers>
            <server>
                <groupId>net.unit8.waitt.server</groupId>
                <artifactId>waitt-tomcat7</artifactId>
                <version>0.1.0</version>
            </server>
            <server>
                <groupId>net.unit8.waitt.server</groupId>
                <artifactId>waitt-tomcat8</artifactId>
                <version>0.1.0</version>
            </server>
            <server>
                <groupId>net.unit8.waitt.server</groupId>
                <artifactId>waitt-jetty9</artifactId>
                <version>0.1.0</version>
            </server>
        </servers>
    </configuration>
</plugin>

serversに複数サーバを登録しておくと、(インタラクティブモードの場合) 選択肢がでます。サーバを切り替えてテストするときも、いちいちpomを書き換えてあげる必要はないのです。

便利なFeatureたち

カバレッジ

これは旧バージョンにもあったのですが、手動のテストでもアプリケーションのコードカバレッジを取得するためのフィーチャです。標準(waitt-coverage)では、coberturaを使っていますが、Java8でまともに動作しないのでJaCoCo版(waitt-jacoco)もあります。

特にアプリケーション開発のメンテナンスフェーズにおいては、イジったところだけピンポイントでテストして、他への影響があって本番トラブルに繋がるなんてことがままあるため、コードカバレッジを見て影響範囲の確認をしながらテストをすることが重要だと考えています。

<features>
    <feature>
        <groupId>net.unit8.waitt.feature</groupId>
        <artifactId>waitt-jacoco</artifactId>
        <version>0.1.0</version>
    </feature>
</features>

waitt-coverage、またはwaitt-jacocoをfeatureに設定し、waitt:runし、いくつかアプリケーションを操作して、/_coverage/ にアクセスすると、以下のようなカバレッジレポートが表示されます。

ダッシュボード

SpringBootのアクチュエータよろしく、アプリケーションやサーバの情報を見ることができます。
ヒープダンプを表示したり、CPUとメモリのリソースグラフを表示したりできます。

waittのconfigureに以下のフィーチャを足すと使えます。adminはアプリケーションを再デプロイしたりするために必要です。

<features>
    <feature>
        <groupId>net.unit8.waitt.feature</groupId>
        <artifactId>waitt-dashboard</artifactId>
        <version>0.1.0</version>
    </feature>
    <feature>
        <groupId>net.unit8.waitt.feature</groupId>
        <artifactId>waitt-admin</artifactId>
        <version>0.1.0</version>
    </feature>
</features>

そして、waittを起動し、/_dashboard/にアクセスすると、色々なデータが見れます。

サーバのモニタリングと再起動

ヒープダンプ

トレーサ

これはWAITT上でのテストの状況を収集するためのフィーチャです。

発生したException
リクエストとレスポンスの内容

をElasticSearchにPOSTします。これらをKibanaで可視化できるわけです。

<features>
    <feature>
        <groupId>net.unit8.waitt.feature</groupId>
        <artifactId>waitt-tracer</artifactId>
        <version>0.1.0</version>
    </feature>
</features>

利用シーンA

何か、Aさん遅くまで残っているけど、どうしたんだろう?

たいていは、どこかでハマって試行錯誤しているものかと思います。コードいじってみて、ブラウザから動かして、何かエラーが出てるので書き直して、またブラウザから動かして… を繰り返していると、いつの間にか時間が経ってしまっている、誰かに聞こうにも詳しい人、もう帰っちゃってる、なんてことがありますよね!

tracerのフィーチャを使うと、各自のローカル環境で発生したExceptionを全部収集できます。これをKibanaでしきい値設定しておけば、ハマっている人をプロアクティブに見つけ出し、声をかけるなんてことができるわけです。

おせっかいですねー

利用シーンB

エビデンス、エビデンス、エビデンス...

リクエスト、レスポンスを収集するのでテストエビデンスとして使えます。同種のツールにはHTTPプロキシを使うものもありますが、SSLの場合はMan in the middleしなきゃいけない問題があります。トレーサはサーバに組み込まれて動作するのでその心配がありません。

最終的にはイマドキのExcelスクショの撮り方でレポーティングされるようにしたいと思っています。

まとめ

Spring bootの手軽さに垂涎していた非Spring文化圏のみなさん、WAITTを使えば似たような軽快な動作環境が得られます。ぜひお試しくださいませ。

あっ、なおSpring bootもWAITTから起動できますよ