Emacs Lisp と Travis CI （2016年5月版）

1 Emacs Lisp の Travis CI 事情

Emacs Lisp のパッケージをテストするには最低限どんなツールを使うか？ CI サービスに依存しない周辺ツールについて知ることができた．今回の成果はもちろんこれに集約される． https://github.com/karronoli/redpen-paragraph.el

以前の Travis CI では「language: emacs-lisp」という設定で elisp をサポートしていたらしい．現在はそのようなサポートはなく sudo も使わずにテストを実行するのが実行速度の点で望ましいらしい．ただし現状の Travis CI と elisp でのカバレッジ計測まで含めたユニットテストの実行方法についてまとまった情報は見つけられなかった．なので elisp でパッケージを作ってる人には役に立つんじゃないかと思う．

2 準備

まずは ERT でユニットテストを書く．話はそれから．

2.1 使いたいEmacsのバージョンを決める

Travis CI をコンテナベースで使う際には sudo が使えないのでパッケージマネージャ経由で使えるEmacsの種類には制限がある．使えるのはemacs23とemacs24でemacs-snapshotは使えない． https://github.com/travis-ci/apt-package-whitelist/blob/master/ubuntu-precise もちろん emacs-snapshot に関して PR はとっくに出ている．しかも複数のPRが出ている．その結果コンフリクト，そして今に至るまで放置されているようだ．

2.2 .travis.yml

これはどのプロジェクトにも使い回せると思う．

https://github.com/karronoli/redpen-paragraph.el/blob/231374deb1013ece803455444b72e0a8cf9b43a1/.travis.yml

language: generic

sudo: false

addons:
  apt:
    sources:
    - cassou-emacs
    packages:
    - emacs24

env:
  matrix:
    - EMACS=emacs24

before_install:
  - git clone https://github.com/cask/cask.git "$HOME/.cask"
  - export PATH="$HOME/.cask/bin:$PATH"
install:
  - cask install
script:
  - cask exec ert-runner

# Local Variables:
# coding: utf-8
# End:

テストを実行するだけなら ert-run-tests-batch-and-exit を直接使えばいい．でもカバレッジの計測をするには Ert-runner を経由する必要があるらしい．カバレッジの計測には undercover というのを使う．それらを使えるようにするために cask コマンドを使えるようにする．

2.3 Cask

package-file を希望のファイル名に変更．適宜依存関係を設定すれば使える． https://github.com/karronoli/redpen-paragraph.el/blob/231374deb1013ece803455444b72e0a8cf9b43a1/Cask

(source melpa)

(package-file "redpen-paragraph.el")

(development
  (depends-on "undercover")
  (depends-on "ert-runner"))

2.4 test/test-helper.el

undercover 関数に渡すファイル名は要変更． https://github.com/karronoli/redpen-paragraph.el/blob/231374deb1013ece803455444b72e0a8cf9b43a1/test/test-helper.el

(require 'undercover)
(undercover "redpen-paragraph.el")

2.5 .ert-runner

カレントディレクトリは明示的に追加する必要がある． https://github.com/karronoli/redpen-paragraph.el/blob/231374deb1013ece803455444b72e0a8cf9b43a1/.ert-runner

-L .

3 結果

カバレッジ計測の結果は coveralls を使った，というより undercover.el には /tmp 辺りに書き出す機能はあるんだけどなぜかローカルでは確認できていない． https://travis-ci.org/karronoli/redpen-paragraph.el/ https://coveralls.io/github/karronoli/redpen-paragraph.el

初めはテストが実行できるだけの状態だったものが Cask を使ったパッケージの依存関係の記述と（C1っぽい）カバレッジの計測ができるようになった．良かった良かった．