Atomアドベントカレンダー2017の1日目の記事です。
2016年のアドベントカレンダーでAtomパッケージのテストの書き方を紹介したのですが、あの頃よりもテスト環境が進化しているので今年のアドベントカレンダーではその進化について紹介します。
今までのAtomのテスト環境はJasmine 1.3を独自に拡張したものでした。
Atomが出た当時のCoffeeScriptが流行っていた頃はおそらくピカピカだったのでしょう。ですが非同期処理のテストのためにasync/awaitをサポートしたmochaと、should/assert/expectといったアサーションから好みのものを選択できるchaiが一般的となった現代からすると残念ながら時代遅れと言わざるを得ません。
特にここ最近ではAtomのAPI自体が非同期対応のために徐々にPromiseを返すように変わってきており、パッケージがそれらのAPIに依存している場合はパッケージ自体に加えてテスト側でもPromiseに対応する必要があります。
Atom内部のV8のバージョンが上がったことでパッケージ本体ではasync/awaitが使えるようになったのですが、テストについてはフレームワークの問題でasync/awaitが使えないので段々とテストコードのメンテが辛くなってきていました。
何か良い方法はないものかと探しているうちに、最近のAtomコアモジュール周りではatom-mocha-test-runnerというモジュールを使ってJasmineを脱出していることを発見しました。
atom-mocha-test-runnerとは
昔のissue(#13899,#8968)を見たところ、Atom本体のテストフレームワークをリプレースするのは一旦諦めてpackage.jsonのatomTestRunnerで指定した別のテストランナーを使えるように拡張が行われたようです。
テストランナーは仕様を満たす必要があるので既にjsで有名なmochaなどを単に持ってくるだけでは動きません。
atom-mocha-test-runnerはその仕様を満たす、mochaでテストを実行できるテストランナーを簡単にビルドするためのモジュールです。
まさにAtomパッケージのテスト界における救世主というわけです。
使い方
詳しい使い方はアドベントカレンダーの別の日に改めて投稿する予定ですので、今回は最も簡単な使い方を紹介します。
まず、atom-mocha-test-runnerとchaiをdevDependenciesとしてインストールします。
npm i -D atom-mocha-test-runner chai
次にpackage.jsonに"atomTestRunner": "atom-mocha-test-runner"を追加します。
さらにspec/にある**spec.jsを**.test.jsにリネームします。これはatom-mocha-test-runnerが.test.jsまたは.test.coffeeの拡張子のファイルをテストとして認識するためです。
ではいよいよテスト自体をmochaとchaiを使って書き換えていきましょう。
今まで非同期処理を待つために使われていたwaitsForPromise()とruns()をmochaの非同期テストの構文に置き換えます。expect(...).toBe(true)といった独自のアサーションはexpect(...).to.be.trueといったchaiの書き方に直す必要があります。
expectが好みでなければassertに変えても良いでしょう。mochaが使えるようになったことでアサーションに関しては好みのものが使用可能です。
ちなみにmochaはimportする必要がありませんが、chaiはそれぞれのテストの中でimport { expect } from 'chai'をしておく必要があるので注意です。
最後にテストの実行方法ですが、今まで通りapm testでテストを実行可能です。
もしspec/というディレクトリ名をtest/に変えたい場合は代わりにatom --test test/を実行することでテストを走らせることができます。
atom-mocha-test-runnerに対応したパッケージを見るとspec/からtest/にリネームして、package.jsonのscriptsにatom --test test/を追加しnpm testでテストを実行できるようにしているものが多いようです。
実例
自分が探した中ではAtomのコアパッケージであるwelcomeとgithubが参考になりました。
welcome1
今回紹介したpackage.jsonに"atomTestRunner": "atom-mocha-test-runner"を指定するシンプルな方法です。
リポジトリの規模が小さいので参考にしやすいはずです。
github2
atom-mocha-test-runnerのデフォルト設定を使わずに、runner.jsでオプションを渡して挙動をカスタムしています。
runner.jsを使うパターンは別のエントリで紹介する予定です。
他にもGithub上でatomのorganizationの中で検索するとatom-mocha-test-runnerを使っているパッケージを見つけることができます。
まとめ
パッケージのテストランナーとしてatom-mocha-test-runnerを使うことで古いJasmine1.3の呪縛から逃れる方法を紹介しました。
今回のエントリでは紹介がメインでしたが、アドベントカレンダーの別の日のエントリで実際にatom-mocha-test-runnerに対応させる実践編の紹介をする予定です。こうご期待！