シェアする

BatsでシェルスクリプトやCLIプログラムのテストをする

シェアする

恥ずかしながら今まではシェルスクリプトで書いたプログラムのテストをするときは、echoprint-xオプションを駆使して行なっていたのですが、Batsというテストフレームワークがあることを知り早速使ってみました。

2017.9.7修正 コード他

Bats概要

Bashで動作するソフトウェアのテストフレームワークでBashで書かれています。テスト対象は、BashスクリプトだけでなくUnix上で動作するプログラムなら何でも可能なようです。というのはソースを見ると分かりますが、BatsはBashから任意のプログラムを実行しその結果の正当性(終了ステータスや出力)を検証できるような作りになっています。

早速インストールしてテストコードを書いてみます。MacでHomeBrewを使っている場合は、以下でインストール可能です。

実際にテストコードが動作する様子を見てみます。

シンタックス

テストコードのシンタックスは以下のようなになります。body部分はBashスクリプトとして実行されます。

setup、teardown

XUnitフレームワークのように、各テストブロック実行前後にsetup、teardownで定義された関数を実行することができます。

run

テストブロックの中では、runという関数が使えます。runは、任意のスクリプトやコマンド、関数を指定することができます。終了ステータスは$status、標準出力・標準エラー出力の結果は$outputという変数で参照できます。また、$linesという変数には改行区切りで配列参照が可能です。

skip

skipを使うと後続のコマンドを実行せずに次のテストに移ります。

実行すると以下のようになります。

load

load関数を実行すると、任意のスクリプトをsourceコマンドで読み込みます。拡張子は、.bashで指定する必要があります。

どのように実行されている?

test.batsのコードは、実際には以下のようなシェルスクリプトに変換されて実行されているようです。$TMPDIRを見ると実際のスクリプトを確認することができます。

ドキュメントにもあるように、.batsファイルのスクリプトはn+1回評価されます(n+1回、sourceコマンドで読み込みされます)。まず、上記の変換したファイルがsourceコマンドで読み込まれ、続いてbats_test_functionで実行するテスト関数が収集されます。この時、テスト関数は実行されません。続いて、bats_test_functionで登録された各テスト関数がsourceコマンドで読み込みされlibexec/bats-exec-testで実行されます。関数ごとにbats-exec-testコマンドを実行しますので、ある関数で設定した変数は、別の関数では参照できませんし、あるテストの設定が他のテストに影響しません。グルーバルな変数を使いたい場合は、@test{}の外に書く必要があります。

実際に確認してみます。echo "hoge"は、3回評価されるはずです。

これを実行すると、以下のような出力が得られます。テスト関数+1回分評価されていることが確認できました。

その他

何故か以下のようにダブルブラケットを連続して書いた場合、最後の式以外の結果が打倒でないにも関わらずテストをパスしてしまいました。。原因は追えていないので何とも言えませんが、とりあえず&&で対処してみました。
(2017.9.7 修正  “”の記述が不要でした) 2017.10.2

参考リンク

  • https://github.com/sstephenson/bats
  • http://qiita.com/5t111111/items/c4a382c7dd896c353d03
入門bash 第3版
入門bash 第3版

posted with amazlet at 16.05.07
Cameron Newham Bill Rosenblatt
オライリージャパン
売り上げランキング: 119,456

関連

Batsに影響を受けているのでインタフェースは似ていますが、実行アプローチは異なるテストツールを書きました。BAsh Unit test ToolでBaut(バウト)です。

スポンサーリンク
Translate »