JavaScript エンジン V8 を使ってライブラリの開発にユニットテストを利用したい

JavaScript

大きなプログラムになると JavaScript といえどもブラウザから操作してテストする以外にも、単体でコマンドラインからテストしたくなりますね。

JsUnit はどうなのか

JavaScript のユニットテストフレームワークというと、xUnit の JsUnit が思い浮かびます。使ったことがなかったので、ちょっと調べてみました。

どうも JsUnit は html ファイルを開いてブラウザベースでテスト実行するみたいです。共同でテストに使えるサーバーコンポーネントもあるようですが、専用の HTTP サービスを立ち上げて使うようです。

やっぱり CUI で使えるインタプリタとかシェルベースでだと便利です。

V8 を使えないのか

以前 id:amachang さんの Google Chrome の JavaScript エンジン V8 を試す - IT戦記 をみて、V8 の shell を試しにコンパイルしていました。
v8/sample/shell.cc をさらっと見てみると、

  // Bind the global 'print' function to the C++ Print callback.
  global->Set(v8::String::New("print"), v8::FunctionTemplate::New(Print));
  // Bind the global 'load' function to the C++ Load callback.
  global->Set(v8::String::New("load"), v8::FunctionTemplate::New(Load));

と print, load がネイティブ関数として組み込まれていることがわかります。
だから JavaScript での Ruby の irb みたいに使えるのです。

試しみる

/tmp/lib.js ã‚’

function bold(text){ return "<b>" + text + "</b>" }

と作り、読み込ませて使ってみる。

% ./shell
V8 version 0.4.6
> load("/tmp/lib.js");
> var b = bold("Title");
> print(b);
<b>Title</b>
> quit();

というわけ、load を使って他の js ファイルをロードできます。これならユニットテストも可能ですね。

ユニットテスト

ユニットテストといえば、実行結果を assertXXXX な関数で照合するのが一般的です。v8 にはもともと JavaScript のコア機能のユニットテストが入っています。 v8/test/mjsunit/*.js にたくさんあります。

mjsunit.js

このファイルを見るとアサート関数が一通り定義されているのでそのまま使えそうです。

// Copyright 2008 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

function MjsUnitAssertionError(message) {
  this.message = message;
}

MjsUnitAssertionError.prototype.toString = function () {
  return this.message;
}

/*
 * This file is included in all mini jsunit test cases.  The test
 * framework expects lines that signal failed tests to start with
 * the f-word and ignore all other lines.
 */

function fail(expected, found, name_opt) {
  var start;
  if (name_opt) {
    // Fix this when we ditch the old test runner.
    start = "Fail" + "ure (" + name_opt + "): ";
  } else {
    start = "Fail" + "ure:";
  }
  throw new MjsUnitAssertionError(start + " expected <" + expected + "> found <" + found + ">");
}


function assertEquals(expected, found, name_opt) {
  if (expected != found) {
    fail(expected, found, name_opt);
  }
}


function assertArrayEquals(expected, found, name_opt) {
  var start = "";
  if (name_opt) {
    start = name_opt + " - ";
  }
  assertEquals(expected.length, found.length, start + "array length");
  if (expected.length == found.length) {
    for (var i = 0; i < expected.length; ++i) {
      assertEquals(expected[i], found[i], start + "array element at index " + i);
    }
  }
}


function assertTrue(value, name_opt) {
  assertEquals(true, value, name_opt);
}


function assertFalse(value, name_opt) {
  assertEquals(false, value, name_opt);
}


function assertNaN(value, name_opt) {
  if (!isNaN(value)) {
    fail("NaN", value, name_opt);
  }
}


function assertThrows(code) {
  var threwException = true;
  try {
    eval(code);
    threwException = false;
  } catch (e) {
    // Do nothing.
  }
  if (!threwException) assertTrue(false, "did not throw exception");
}


function assertInstanceof(obj, type) {
  if (!(obj instanceof type)) {
    assertTrue(false, "Object <" + obj + "> is not an instance of <" + type + ">");
  }
}


function assertDoesNotThrow(code) {
  try {
    eval(code);
  } catch (e) {
    assertTrue(false, "threw an exception");
  }
}


function assertUnreachable(name_opt) {
  // Fix this when we ditch the old test runner.
  var message = "Fail" + "ure: unreachable"
  if (name_opt) {
    message += " - " + name_opt;
  }
  throw new MjsUnitAssertionError(message);
}

テストしてみよう

先ほどの lib.js の bold 関数をテストしてみましょう。

test.js

テスト用の js ファイルです。 /usr/local/v8 に V8 はチェックアウトおよびコンパイルしてます。

// load mjsunit 
load("/usr/local/v8/test/mjsunit/mjsunit.js");

// load target js file
load("/tmp/lib.js");

/*
 * Test Start
 */
var a = "にほんご";
var b = bold(a);

assertEquals(b, "<b>にほんご</b>");

実行してみましょう。

% ./shell test.js
% echo $?
0

わざと失敗させてみます。

assertEquals(b, "<b>FAIL</b>");

を test.js に追記して、実行してみます。

% /usr/local/v8/shell start.js
/usr/local/v8/test/mjsunit/mjsunit.js:50: Failure: expected <<b>にほんご</b>> found <<b>FAIL</b>>
  throw new MjsUnitAssertionError(start + " expected <" + expected + "> found 
  ^
% echo $?
1

終了コードがちゃんと 1 に変わっていますね。これならエラーも捕捉できます。

まとめ

V8 を用いてライブラリのユニットテストが行えることがわかりました。
（実行のためのラップスクリプトを書こうっと…）