More than 5 years have passed since last update.

[Scala]sbt-scoverage で一部ファイルを除外する

Last updated at 2019-09-02Posted at 2019-08-19

sbt-scoverage、とても便利ですね。 plugin.sbt に記述するだけですぐにカバレッジ率を出してくれます。

plugin.sbt

addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.6.0")

// カバレッジ計測
sbt clean coverage test

// カバレッジレポート作成
sbt coverageReport

// 繋げてかく場合
sbt clean coverage test coverageReport

自分の環境だとこんな感じになっていました。

controllers.javascript のカバレッジ率が0%になってますね。そりゃそうです、書いてないですから。

これのせいで合計のカバレッジ率が下がってるとなるとちょっと納得いきませんね。という事で除外してみたいと思います。

除外する

coverageExcludedPackages

正規表現でカバレッジ測定の対象から除外できます。セミコロンで区切ります

build.sbt

coverageExcludedPackages := "<empty>;Reverse.*;.*AuthService.*;models\\.data\\..*"

これが使えそうですね。私のディレクトリ構成はこうなので

こうでしょうか。

build.sbt

coverageExcludedPackages := ".*controllers.javascript.*"

import Changes してから実行

sbt coverageReport

あれ・・・変わらないぞ

そもそもの公式ドキュメントの例として書かれている正規表現、最初に謎の物体が入っています。

build.sbt

<empty>;

セミコロンは区切り文字なのでわかるのですが、 <empty> ってなんなんでしょうね。

オバフロでも <empty> をつけて試してみて！ というコメントが付いている質問がありました。(http://danlec.com/st4k#questions/32331183)
とりあえず真似してみましょう。

coverageExcludedPackages := "<empty>;.*controllers.javascript.*"

sbt coverageReport

[info] Statement coverage.: 78.68%

お、カバレッジ率が上がった

という事で、78%に上昇しました。これが本来の値ですね。

なんで <empty>; がいるのか結構調べたのですが、全くわかりませんでした。
他の人も「よくわかんないけど必要だよ」みたいに言っているので、深く考えない方がいいかもしれません。(https://stackoverflow.com/questions/47940361/scoverage-how-to-exclude-files-and-packages)

中のコードを追っていたのですが、結構しんどくて諦めました・・・