最近やってる開発で以前書いた方法でTravisCIからCoverallsにカバレッジレポートを転送しようかと思ったのですが、デフォルト設定ではできないパターンがあったので行った対応とか書いてみます。

環境


  • sbt-coveralls 1.2.7

です。このsbt-coverallsプラグインでTravisCIからCoverallsにカバレッジレポートを転送します。

結論


先に結論を書いておくと、リポジトリのルートにbuild.sbtがない場合はsbt-coverallsプラグインの設定でgitリポジトリのパスを指定しないといけません。

構成とか


まず、今回のプロジェクトのディレクトリ構成はこんなかんじです。サブディレクトリにbuild.sbtを配置していました。

1
2
3
4
5
6
7
8
9
.
├── README.md
├── server-side
| ├── build.sbt
| ├── project
| ...
|
├── .travis.yml
...

次に.travis.ymlはこうです。

1
2
3
4
5
6
7
8
9
10
11
12
sudo: false
language: scala
scala:
- 2.12.6
jdk:
- oraclejdk8
before_script:
- "cd server-side"
script:
- "sbt clean coverage test"
after_success:
- "sbt coverageReport coveralls"

サブディレクトリに切り替えてからビルド処理を行っています。

NoHeadException


これでビルドを走らせるとafter_successsbt coverageReport coverallsのカバレッジレポート転送処理が失敗します。ただし、失敗しますといってもafter_successキーが失敗するだけで、ビルドそのものに影響はありません。失敗するのはあくまでカバレッジレポートの転送だけです。

ログを確認すると下記のように「NoHeadException: No HEAD exists and no explicit starting revision was specified」というエラーが出力されていました。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 sbt coverageReport coveralls
[info] Loading settings for project server-side-build from plugins.sbt ...
[info] Loading project definition from /home/travis/build/YoshinoriN/ExampleProject/server-side/project
[info] Loading settings for project server-side from build.sbt ...

...(省略)

[info] Written HTML coverage report [/home/travis/build/YoshinoriN/ExampleProject/server-side/target/scala-2.12/scoverage-report/index.html]
[info] Statement coverage.: 4.31%
[info] Branch coverage....: 6.25%
[info] Coverage reports completed
[info] All done. Coverage was [4.31%]
[success] Total time: 5 s, completed Jan 13, 2019 3:30:32 PM
[info] Repository = ./.git
[error] org.eclipse.jgit.api.errors.NoHeadException: No HEAD exists and no explicit starting revision was specified
[error] at org.eclipse.jgit.api.LogCommand.call(LogCommand.java:148)
[error] at org.scoverage.coveralls.GitClient.lastCommit(GitClient.scala:63)
[error] at org.scoverage.coveralls.CoverallPayloadWriter.addGitInfo(CoverallPayloadWriter.scala:52)
[error] at org.scoverage.coveralls.CoverallPayloadWriter.start(CoverallPayloadWriter.scala:39)
[error] at org.scoverage.coveralls.CoverallsPlugin$.$anonfun$coverallsTask$2(CoverallsPlugin.scala:89)
[error] at org.scoverage.coveralls.CoverallsPlugin$.$anonfun$coverallsTask$2$adapted(CoverallsPlugin.scala:54)
[error] at scala.Function1.$anonfun$compose$1(Function1.scala:44)
[error] at sbt.internal.util.$tilde$greater.$anonfun$$u2219$1(TypeFunctions.scala:40)
[error] at sbt.std.Transform$$anon$4.work(System.scala:67)
[error] at sbt.Execute.$anonfun$submit$2(Execute.scala:269)
[error] at sbt.internal.util.ErrorHandling$.wideConvert(ErrorHandling.scala:16)
[error] at sbt.Execute.work(Execute.scala:278)
[error] at sbt.Execute.$anonfun$submit$1(Execute.scala:269)
[error] at sbt.ConcurrentRestrictions$$anon$4.$anonfun$submitValid$1(ConcurrentRestrictions.scala:178)
[error] at sbt.CompletionService$$anon$2.call(CompletionService.scala:37)
[error] at java.util.concurrent.FutureTask.run(FutureTask.java:266)
[error] at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
[error] at java.util.concurrent.FutureTask.run(FutureTask.java:266)
[error] at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
[error] at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
[error] at java.lang.Thread.run(Thread.java:748)
[error] (coveralls) org.eclipse.jgit.api.errors.NoHeadException: No HEAD exists and no explicit starting revision was specified
[error] Total time: 1 s, completed Jan 13, 2019 3:30:33 PM

例外の前の行を見るとわかるのですが[info] Repository = ./.gitというログが出力されており、どうもsbt-coverallsの処理でgitリポジトリ(.gitディレクトリ)を使ってごにょごにょしているみたいです。今回はビルド前にディレクトリをサブディレクトリに切り替えており、当然サブディレクトリに.gitディレクトリはありません。

じゃあ、ルートディレクトリに変更してからsbt coverageReport coverallsを実行すればええかな?

といえばそういうわけでもなく、どうも調べた限りではsbtのタスクはbuild.sbtが存在するディレクトリでしか実行できないようです。つまりcd .. && sbt coverageReport coverallsとかでルートディレクトリに移動してから実行してもダメなんですね。今度はbuild.sbtがないと怒られてしまう。

sbt-coverallsのgitディレクトリ設定を変更する


あ、これ困ったな~。なんて思ってたんですが、ちゃんとPull Reqが出てて設定できるようになってました。

Configurable Git Repository Location

今回の場合だとbuild.sbtに下記のような感じで.gitディレクトリは一階層上であるということを示してやれば良いです。

1
org.scoverage.coveralls.Imports.CoverallsKeys.coverallsGitRepoLocation := Some("..")

後はビルド実行すれば通ります。先ほどと違って[info] Repository = ../.gitというふうに一階層をみにいっているのもログに出てます。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
19.41s$ sbt coverageReport coveralls
[info] Loading settings for project server-side-build from plugins.sbt ...
[info] Loading project definition from /home/travis/build/YoshinoriN/ExampleProject/server-side/project

...(省略)

[info] All done. Coverage was [4.31%]
[success] Total time: 5 s, completed Jan 15, 2019 10:14:46 AM
[info] Repository = ../.git
[info] Generating reports for 33 files
[info] Adding file reports to the coveralls file (coveralls.json)
[info] Uploading the coveralls file (coveralls.json)
[info] Uploading to https://coveralls.io succeeded: Job #47.1
[info] https://coveralls.io/jobs/44141391
[info] (results may not appear immediately)
[success] Total time: 3 s, completed Jan 15, 2019 10:14:50 AM

おわり。