アサーションスクリプト

アサーションスクリプトは、ソフトウェアの条件や前提が正しいかどうかを検証するコード片で、期待される動作を自動的にチェックするためにテストでよく使用される。アサーションが失敗するとエラーを発生させ、ソフトウェアの正確性を確保する。

1.例

リクエストから返された結果が正しいかどうかをアサートする：

返されたデータを環境変数に書き込む：

レスポンスボディに指定された文字列が含まれているかチェックする：

2.構文リファレンス

2.1レスポンスボディが指定された文字列かどうかをチェックする

2.2JSON出力値をチェックする

2.3ヘッダーがContent-Typeとして設定されているかチェックする

2.4リクエストのレスポンス時間が200ミリ秒未満かチェックする

2.5HTTPステータスコードが200かチェックする

2.6HTTPステータスコード名に文字列が含まれているかチェックする

2.7POSTリクエストのステータスコードが正しいかチェックする

3.アサーションライブラリの使用方法

ApidogにはChaiJSがアサーションライブラリとして組み込まれている。以下は一般的に使用されるアサーションテストスクリプトの例だ。より多くの例については、ChaiJS expect BDDライブラリのドキュメントを参照してね。

3.1対象の文字列が別の文字列を含んでいることをアサートする

3.2対象が値と厳密に等しい（===）ことをアサートする

deepフラグがオンの場合、アサート対象は値となる：

deepフラグをオンにしてequalとpropertyアサーションを使用する場合、そのフラグは後続のアサーションでオブジェクト自体を比較するのではなく、オブジェクトのキーと値のペアを再帰的に比較することを可能にする。

3.3値との深い等価性をアサートする（deep.equal(value)と同等）

3.4現在の環境をアサートする

3.5データ構造をアサートする

TIP

他のアサーションを行う前に、.aメソッドを使用してテンプレートのデータ型をチェックすることを推奨する。

データ型は大文字と小文字を区別する。

3.6配列が空かどうかをチェックする

3.7.aメソッドを使用した後に配列が空かどうかをチェックする

3.8対象オブジェクトのキー値をアサートする

3.9対象オブジェクトが指定された属性を含むかどうかをアサートする

TIP

対象オブジェクトは、オブジェクト、セット、配列、またはマップである必要がある。

.keysの前に.allまたは.anyが付いていない場合、デフォルトで.allとなる。

対象オブジェクトの一部のデータ型でのみ.keysメソッドが使用できるため、最初に.aメソッドでデータ型をアサートすることを推奨する。

3.10対象オブジェクトの長さをアサートする

3.11対象オブジェクトのメンバー（members）をアサートする

TIP

デフォルトでは、.members は厳密な比較を使用する。

メンバーの順序は結果に影響しない。

3.12対象オブジェクトが指定された項目を含むことをアサートする

.include を使用する前に .a メソッドでデータ型を判定することを推奨する。

例：

アサーションスクリプト

1.例#

2.構文リファレンス#

2.1レスポンスボディが指定された文字列かどうかをチェックする#

2.2JSON出力値をチェックする#

2.3ヘッダーがContent-Typeとして設定されているかチェックする#

2.4リクエストのレスポンス時間が200ミリ秒未満かチェックする#

2.5HTTPステータスコードが200かチェックする#

2.6HTTPステータスコード名に文字列が含まれているかチェックする#

2.7POSTリクエストのステータスコードが正しいかチェックする#

3.アサーションライブラリの使用方法#

3.1対象の文字列が別の文字列を含んでいることをアサートする#

3.2対象が値と厳密に等しい（===）ことをアサートする#

3.3値との深い等価性をアサートする（deep.equal(value)と同等）#

3.4現在の環境をアサートする#

3.5データ構造をアサートする#

3.6配列が空かどうかをチェックする#

3.7.aメソッドを使用した後に配列が空かどうかをチェックする#

3.8対象オブジェクトのキー値をアサートする#

3.9対象オブジェクトが指定された属性を含むかどうかをアサートする#

3.10対象オブジェクトの長さをアサートする#

3.11対象オブジェクトのメンバー（members）をアサートする#

3.12対象オブジェクトが指定された項目を含むことをアサートする#

1.例

2.構文リファレンス

2.1レスポンスボディが指定された文字列かどうかをチェックする

2.2JSON出力値をチェックする

2.3ヘッダーがContent-Typeとして設定されているかチェックする

2.4リクエストのレスポンス時間が200ミリ秒未満かチェックする

2.5HTTPステータスコードが200かチェックする

2.6HTTPステータスコード名に文字列が含まれているかチェックする

2.7POSTリクエストのステータスコードが正しいかチェックする

3.アサーションライブラリの使用方法

3.1対象の文字列が別の文字列を含んでいることをアサートする

3.2対象が値と厳密に等しい（===）ことをアサートする

3.3値との深い等価性をアサートする（deep.equal(value)と同等）

3.4現在の環境をアサートする

3.5データ構造をアサートする

3.6配列が空かどうかをチェックする

3.7.aメソッドを使用した後に配列が空かどうかをチェックする

3.8対象オブジェクトのキー値をアサートする

3.9対象オブジェクトが指定された属性を含むかどうかをアサートする

3.10対象オブジェクトの長さをアサートする

3.11対象オブジェクトのメンバー（members）をアサートする

3.12対象オブジェクトが指定された項目を含むことをアサートする