npm ライブラリを travis-ci でテストして Coveralls でカバレッジを計測する

travis-ci と Coveralls を使って自動テストとカバレッジの計測を行えるようにしてみた。
starhoshi/rescue-fire このレポジトリで実際に動かしている。

Test

今回は yarn と jest を使う。

yarn run jest --coverage

このコマンドだけでテストとカバレッジの出力が同時にできて便利。

travis-ci

目的のレポジトリを ON にして

Build only if .travis.yml is preset を ON。

これで下準備は完了なので、レポジトリに .travis.yml を作る。

package.json と yarn.lock があると勝手に yarn install をしてくれる。dist: trusty にするとデフォルトで yarn が install 済みの Ubuntu を使えるっぽい。

language: node_js
node_js:
  - node
dist: trusty
sudo: false
cache: yarn
script: yarn run jest --coverage

まずこれで travis-ci でテストが動かせるようになった。

• 参考
  • https://docs.travis-ci.com/user/languages/javascript-with-nodejs#Travis-CI-supports-yarn
  • Travis CIでYarn(pkg)を使う設定 (node.js) - Qiita

Coveralls

travis と同様に、目的のレポジトリを ON にする。

travis でテストしたカバレッジ結果を Coveralls に投げる必要があるので、ライブラリを追加する。

yarn add --dev coveralls

最後にカバレッジ結果を投げるように .travis.yml を修正する。Token などは設定する必要がなく、勝手にやってくれるっぽい。

script: yarn run test --coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

これで travis, Coveralls の設定は終わり。

• 参考
  • Jest --coverage : help · Issue #126 · nickmerwin/node-coveralls

おわり

上記の手順をした後に git push するとテストが回り、カバレッジが集計される。

travis, Coveralls それぞれのバッジも設定できるので、 README に貼っておくと見栄えが良い。

https://github.com/starhoshi/rescue-fire