テスト
test
、firebase-functions のテストコンパニオンとして機能するグローバル名前空間です。
test()
を使用して SDK を初期化し、オプションでオンライン テスト用に次のパラメーターを指定します。
-
firebaseConfig
テスト コードが操作できるように Firebase アプリを初期化するための Firebase 設定値 (データベースへの書き込みなど)。テスト専用のプロジェクトを使用することをお勧めします。省略した場合、モック構成値が使用され、テストは実際の Firebase アプリと対話せず、すべての Firebase メソッドをスタブする必要があります。 -
pathToServiceAccountKey
Firebase アプリの初期化時に使用されるサービス アカウント キー ファイルへのパス。
例えば:
const test = require('firebase-functions-test')(); // Offline mode
const test = require('firebase-functions-test')(firebaseConfigValues, path/to/key.json'); // Online mode
インターフェース
イベントコンテキストオプション
名前空間
分析
認証
クラッシュリティクス
データベース
消防署
パブサブ
ストレージ
メソッド
掃除
掃除()
クリーンアップタスクを完了します。
変更する
makeChange(before, after) はオブジェクトを返します
Firestore および Realtime Database のonWrite
およびonUpdate
関数のテスト データとして使用するChange
オブジェクトを作成します。
パラメータ | |
---|---|
前に | 物体 書き込みまたは更新前のスナップショット。 値は null であってはなりません。 |
後 | 物体 書き込みまたは更新後のスナップショット。 値は null であってはなりません。 |
- 戻り値
non-null Object
A テスト用のChange
オブジェクト。
モック構成
モック構成(構成)
functions.config()
によって返されるモック値。
パラメータ | |
---|---|
構成 | 物体 モックする構成を表すキーと値のペア。 値は null であってはなりません。 |
包む
Wrap(cloudFunction) はtest.WrappedFunctionを返します
テスト対象の関数を受け取り、テスト コードで呼び出すことができるWrappedFunction
を返します。
パラメータ | |
---|---|
クラウド機能 | 物体 CloudFunction は、__trigger でトリガー定義をエクスポートするオブジェクトであると同時に、Google Cloud Functions の JavaScript API を使用して関数として呼び出すこともできます。 値は null であってはなりません。 |
- 戻り値
non-null test.WrappedFunction
ラップされた関数
WrappedFunction(データ、オプション)
テスト データとイベント コンテキストのオプションのオーバーライド値を使用して呼び出すことができる関数タイプ。その後、提供されたテスト データと生成されたイベント コンテキストをラップした関数を呼び出します。
パラメータ | |
---|---|
データ | いかなるタイプ テストデータ。 値は null であってはなりません。 |
オプション | 物体 イベント コンテキストの値を 値は null の可能性があります。 |