開発者ブログ
自習室 » QUnit API

QUnit API

Last modified by simdy on 2014/04/10, 20:25

QUnit API

テストを実行するメソッド

  • test( name, expected, test )
    • テストを実行します。test関数の中では最低一つ以上のアサーションメソッドが実行される必要があります。
    • アサーションメソッドを呼ばない場合、その事でエラーになることはありません。
引数名引数型解説
nameStringテスト名
expectedNumberアサーション数を指定(オプション)
testFunction実行する関数(最低一つ以上のアサート関数を含む必要がある)
  • asyncTest( name, expected, test )
    • 非同期にテストを実行します。テスト終了後にstop()メソッドを呼ぶ為、必ずtest関数の中でstart()を呼ぶ必要があります。
    • start()を呼ばない場合、アサーションメソッドは実行されません(その事でエラーにはなりません)
引数名引数型解説
nameStringテスト名
expectedNumberアサーション数を指定(オプション)
testFunction実行する関数(最低一つ以上のアサート関数を含む必要がある)
 
  • expect( amount )
    • テストに成功した回数を検知します。多くても少なくてもテストに失敗します。
引数名引数型解説
amountIntegerテストに成功した回数(多くても少なくてもエラー)
  • module( name, lifecycle )
    • テストモジュール名を定義する関数です。。module()関数を呼ぶと、次にmodule()関数を記述するまでに定義された関数は、全て前のmodule()に所属します。
    • lifecycleオブジェクトの中にsetup()関数とtearDown()関数を含めておくと、モジュールに所属するテスト関数が開始する前にsetup()関数が、テストの終了後にtearDown()関数が、各テスト関数の開始ごとにそれぞれ呼び出されます。
引数名引数型解説
nameStringテストモジュール名
lifecycleOptions(オプション設定用のプレーンな(Object)setup()とtearDown()を組み込む為の
オブジェクト(オプション)
  • QUnit.init( )
    • テストケースの初期化を行うメソッド(通常は明示的に呼ぶ必要はありません)
  • QUnit.reset( )
    • ブラウザでテストしている場合、#mainまたは#qunit-fixture要素を初期状態に戻します。
    • 各テストの終了ごとに自動的に呼ばれます。

      テストのアサーションメソッド
  • ok( state, message )
引数名引数型解説
stateBoolean条件。trueであればテストにパス
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • equal( actual, expected, message )
    「actual==expected」であればパス
引数名引数型解説
actualObjectテストする結果
expectedObject期待される結果
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • notEqual( actual, expected, message )
    • 「actual!=expected」であればパス
引数名引数型解説
actualObjectテストする結果
expectedObject期待される結果
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • deepEqual( actual, expected, message )
    • actualとexpectedのプロパティを再帰的に比較して、全て等しければパス
    • Array、Object型の詳細な比較に用いる
引数名引数型解説
actualObjectテストする結果
expectedObject期待される結果
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • notDeepEqual( actual, expected, message )
    • actualとexpectedのプロパティを再帰的に比較して、違うものがあればパス
    • Array、Object型の詳細な比較に用いる
引数名引数型解説
actualObjectテストする結果
expectedObject期待される結果
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • strictEqual( actual, expected, message )
    • 「actual === expected」であればパス
引数名引数型解説
actualObjectテストする結果
expectedObject期待される結果
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • notStrictEqual( actual, expected, message )
    • 「actual !== expected」であればパス
引数名引数型解説
actualObjectテストする結果
expectedObject期待される結果
messageStringテスト結果と一緒に表示するメッセージ
(オプション)
  • raises( state, message )
    • 関数が例外を投げるかどうかをテストするアサーション関数
引数名引数型解説
stateFunction関数が例外を投げたらテストにパス
messageStringテスト結果と一緒に表示するメッセージ
(オプション)

非同期テストで利用するメソッド

  • start( )
    • 一時停止したテストを再開します。
  • stop( count )
    • テストを一時停止します。
引数名引数型解説
countIntegerstopを解除するために必要なstart()を呼ぶ回数(オプション デフォルト:1)

Copyright (C) 2012-2017 NS Solutions Corporation, All Rights Reserved.