単体テストを作成する

Cloud Firestore

Cloud Firestore

RulesTestEnvironment.clearFirestore() => Promise<void>

このメソッドは、Firestore エミュレータ用に構成された projectId に属する Firestore データベースのデータをクリアします。

RulesTestContext.firestore(settings?: Firestore.FirestoreSettings) => Firestore;

このメソッドは、このテストのコンテキストの Firestore インスタンスを取得します。返された Firebase JS Client SDK インスタンスは、クライアント SDK API（v9 モジュラーまたは v9 互換）で使用できます。

Realtime Database

Realtime Database

RulesTestEnvironment.clearDatabase() => Promise<void>

このメソッドは、Realtime Database エミュレータ用に構成された projectId に属する Realtime Database のデータをクリアします。

RulesTestContext.database(databaseURL?: Firestore.FirestoreSettings) => Firestore;

このテスト コンテキストの Realtime Database インスタンスを取得します。返された Firebase JS Client SDK インスタンスは、クライアント SDK API（v9 モジュラーまたは v9 互換）で使用できます。このメソッドは、Realtime Database インスタンスの URL を受け取ります。この URL が指定されている場合は、この URL から抽出されたパラメータを使用して、エミュレートされた名前空間のバージョンのインスタンスを返します。

Cloud Storage

Cloud Storage

RulesTestEnvironment.clearStorage() => Promise<void>

このメソッドは、Cloud Storage エミュレータ用に構成された projectId に属するストレージ バケットのオブジェクトとメタデータをクリアします。

RulesTestContext.storage(bucketUrl?: string) => Firebase Storage;

このメソッドは、エミュレータに接続するように構成された Storage インスタンスを返します。このメソッドは、テストのために Firebase Storage バケットの gs:// URL を受け取ります。この URL が指定されている場合は、エミュレートされたバケット名のバージョンの Storage インスタンスを返します。

Cloud Firestore

initializeTestApp({ projectId: string, auth: Object }) => FirebaseApp

このメソッドは、オプションで指定されたプロジェクト ID と auth 変数に対応する、初期化された Firebase アプリを返します。テストで使用するために、特定のユーザーとして認証されたアプリを作成するには、このメソッドを次のように使用します。

firebase.initializeTestApp({
  projectId: "my-test-project",
  auth: { uid: "alice", email: "alice@example.com" }
});

initializeAdminApp({ projectId: string }) => FirebaseApp

このメソッドは、初期化された管理者 Firebase アプリを返します。このアプリは、読み取りと書き込みを行う際にセキュリティ ルールを迂回します。テストの状態を設定するために、管理者として認証されたアプリを作成するには、このメソッドを次のように使用します。

firebase.initializeAdminApp({ projectId: "my-test-project" });
    

apps() => [FirebaseApp]。このメソッドは、現在初期化されているテストと管理アプリをすべて返します。テスト間またはテスト後にアプリを消去するには、このメソッドを次のように使用します。

Promise.all(firebase.apps().map(app => app.delete()))

loadFirestoreRules({ projectId: string, rules: Object }) => Promise

このメソッドは、ローカルで実行されているデータベースにルールを送信し、ルールを文字列として指定するオブジェクトを取ります。データベースのルールを設定するには、このメソッドを次のように使用します。

firebase.loadFirestoreRules({
  projectId: "my-test-project",
  rules: fs.readFileSync("/path/to/firestore.rules", "utf8")
});
    

assertFails(pr: Promise) => Promise

このメソッドは、入力が成功した場合は拒否され、入力が拒否された場合は成功する Promise を返します。データベースの読み取りや書き込みが失敗したかどうかをアサートするには、このメソッドを次のように使用します。

firebase.assertFails(app.firestore().collection("private").doc("super-secret-document").get());
    

assertSucceeds(pr: Promise) => Promise

このメソッドは、入力が成功した場合は成功し、入力が拒否された場合は拒否される Promise を返します。データベースの読み取りや書き込みが成功したかどうかをアサートするには、このメソッドを次のように使用します。

firebase.assertSucceeds(app.firestore().collection("public").doc("test-document").get());
    

clearFirestoreData({ projectId: string }) => Promise

このメソッドは、ローカルで実行中の Firestore インスタンス内の特定のプロジェクトに関連付けられているすべてのデータを消去します。テスト後のクリーンアップには、このメソッドを次のように使用します。

firebase.clearFirestoreData({
  projectId: "my-test-project"
});
   

Realtime Database

Realtime Database

initializeTestApp({ databaseName: string, auth: Object }) => FirebaseApp

テストで使用するために、特定のユーザーとして認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたデータベース名と auth 変数のオーバーライドに対応する、初期化された Firebase アプリを返します。

firebase.initializeTestApp({
  databaseName: "my-database",
  auth: { uid: "alice" }
});

initializeAdminApp({ databaseName: string }) => FirebaseApp

テストの状態を設定するために、管理者として認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたデータベース名に対応する初期化された管理者 Firebase アプリを返します。このアプリは、データベースに対する読み書きを行う際にセキュリティ ルールを迂回します。

firebase.initializeAdminApp({ databaseName: "my-database" });

loadDatabaseRules({ databaseName: string, rules: Object }) => Promise

データベースのルールを設定するには、このメソッドを次のように使用します。

ローカルで実行されているデータベースにルールを送信します。"databaseName" と "rules" を文字列として指定したオプション オブジェクトを取ります。

firebase
      .loadDatabaseRules({
        databaseName: "my-database",
        rules: "{'rules': {'.read': false, '.write': false}}"
      });

apps() => [FirebaseApp]

現在初期化されているテストと管理アプリをすべて返します。

テスト間またはテスト後にアプリを消去するには、このメソッドを次のように使用します（初期化済みのアプリでアクティブなリスナーを持つ場合は、JavaScript を終了できないのでご注意ください）。

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

入力が成功した場合は拒否され、入力が拒否された場合は成功する Promise を返します。

データベースの読み取りや書き込みに失敗したことをアサートするには、このメソッドを次のように使用します。

firebase.assertFails(app.database().ref("secret").once("value"));

assertSucceeds(pr: Promise) => Promise

入力が成功した場合は成功し、入力が拒否された場合は拒否される Promise を返します。

データベースの読み取りや書き込みが成功したことをアサートするには、このメソッドを次のように使用します。

firebase.assertSucceeds(app.database().ref("public").once("value"));

Cloud Storage

Cloud Storage

initializeTestApp({ storageBucket: string, auth: Object }) => FirebaseApp

テストで使用するために、特定のユーザーとして認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたストレージ バケット名と認証変数のオーバーライドに対応する、初期化された Firebase アプリを返します。

firebase.initializeTestApp({
  storageBucket: "my-bucket",
  auth: { uid: "alice" }
});

initializeAdminApp({ storageBucket: string }) => FirebaseApp

テストの状態を設定するために、管理者として認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたストレージ バケット名に対応する、初期化された管理 Firebase アプリを返します。このアプリは、バケットに対する読み書きを行う際にセキュリティ ルールを迂回します。

firebase.initializeAdminApp({ storageBucket: "my-bucket" });

loadStorageRules({ storageBucket: string, rules: Object }) => Promise

これを使用してストレージ バケットのルールを設定します。

ローカル管理のストレージ バケットにルールを送信します。"storageBucket" と "rules" を文字列として指定したオプション オブジェクトを取ります。

firebase
      .loadStorageRules({
        storageBucket: "my-bucket",
        rules: fs.readFileSync("/path/to/storage.rules", "utf8")
      });

apps() => [FirebaseApp]

現在初期化されているテストと管理アプリをすべて返します。

テスト間またはテスト後にアプリを消去するには、このメソッドを次のように使用します（初期化済みのアプリでアクティブなリスナーを持つ場合は、JavaScript を終了できないのでご注意ください）。

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

入力が成功した場合は拒否され、入力が拒否された場合は成功する Promise を返します。

これを使用して、ストレージ バケットの読み取りまたは書き込みに失敗したことをアサートします。

firebase.assertFails(app.storage().ref("letters/private.doc").getMetadata());

assertSucceeds(pr: Promise) => Promise

入力が成功した場合は成功し、入力が拒否された場合は拒否される Promise を返します。

これを使用して、ストレージ バケットの読み取りまたは書き込みが成功したことをアサートします。

firebase.assertFails(app.storage().ref("images/cat.png").getMetadata());

Cloud Firestore

Cloud Firestore

initializeTestApp({ projectId: string, auth: Object }) => FirebaseApp

このメソッドは、オプションで指定されたプロジェクト ID と auth 変数に対応する、初期化された Firebase アプリを返します。テストで使用するために、特定のユーザーとして認証されたアプリを作成するには、このメソッドを次のように使用します。

firebase.initializeTestApp({
  projectId: "my-test-project",
  auth: { uid: "alice", email: "alice@example.com" }
});

initializeAdminApp({ projectId: string }) => FirebaseApp

このメソッドは、初期化された管理者 Firebase アプリを返します。このアプリは、読み取りと書き込みを行う際にセキュリティ ルールを迂回します。テストの状態を設定するために、管理者として認証されたアプリを作成するには、このメソッドを次のように使用します。

firebase.initializeAdminApp({ projectId: "my-test-project" });
    

apps() => [FirebaseApp]。このメソッドは、現在初期化されているテストと管理アプリをすべて返します。テスト間またはテスト後にアプリを消去するには、このメソッドを次のように使用します。

Promise.all(firebase.apps().map(app => app.delete()))

loadFirestoreRules({ projectId: string, rules: Object }) => Promise

このメソッドは、ローカルで実行されているデータベースにルールを送信し、ルールを文字列として指定するオブジェクトを取ります。データベースのルールを設定するには、このメソッドを次のように使用します。

firebase.loadFirestoreRules({
  projectId: "my-test-project",
  rules: fs.readFileSync("/path/to/firestore.rules", "utf8")
});
    

assertFails(pr: Promise) => Promise

このメソッドは、入力が成功した場合は拒否され、入力が拒否された場合は成功する Promise を返します。データベースの読み取りや書き込みが失敗したかどうかをアサートするには、このメソッドを次のように使用します。

firebase.assertFails(app.firestore().collection("private").doc("super-secret-document").get());
    

assertSucceeds(pr: Promise) => Promise

このメソッドは、入力が成功した場合は成功し、入力が拒否された場合は拒否される Promise を返します。データベースの読み取りや書き込みが成功したかどうかをアサートするには、このメソッドを次のように使用します。

firebase.assertSucceeds(app.firestore().collection("public").doc("test-document").get());
    

clearFirestoreData({ projectId: string }) => Promise

このメソッドは、ローカルで実行中の Firestore インスタンス内の特定のプロジェクトに関連付けられているすべてのデータを消去します。テスト後のクリーンアップには、このメソッドを次のように使用します。

firebase.clearFirestoreData({
  projectId: "my-test-project"
});
   

Realtime Database

Realtime Database

initializeTestApp({ databaseName: string, auth: Object }) => FirebaseApp

テストで使用するために、特定のユーザーとして認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたデータベース名と auth 変数のオーバーライドに対応する、初期化された Firebase アプリを返します。

firebase.initializeTestApp({
  databaseName: "my-database",
  auth: { uid: "alice" }
});

initializeAdminApp({ databaseName: string }) => FirebaseApp

テストの状態を設定するために、管理者として認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたデータベース名に対応する初期化された管理者 Firebase アプリを返します。このアプリは、データベースに対する読み書きを行う際にセキュリティ ルールを迂回します。

firebase.initializeAdminApp({ databaseName: "my-database" });

loadDatabaseRules({ databaseName: string, rules: Object }) => Promise

データベースのルールを設定するには、このメソッドを次のように使用します。

ローカルで実行されているデータベースにルールを送信します。"databaseName" と "rules" を文字列として指定したオプション オブジェクトを取ります。

firebase
      .loadDatabaseRules({
        databaseName: "my-database",
        rules: "{'rules': {'.read': false, '.write': false}}"
      });

apps() => [FirebaseApp]

現在初期化されているテストと管理アプリをすべて返します。

テスト間またはテスト後にアプリを消去するには、このメソッドを次のように使用します（初期化済みのアプリでアクティブなリスナーを持つ場合は、JavaScript を終了できないのでご注意ください）。

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

入力が成功した場合は拒否され、入力が拒否された場合は成功する Promise を返します。

データベースの読み取りや書き込みに失敗したことをアサートするには、このメソッドを次のように使用します。

firebase.assertFails(app.database().ref("secret").once("value"));

assertSucceeds(pr: Promise) => Promise

入力が成功した場合は成功し、入力が拒否された場合は拒否される Promise を返します。

データベースの読み取りや書き込みが成功したことをアサートするには、このメソッドを次のように使用します。

firebase.assertSucceeds(app.database().ref("public").once("value"));

Cloud Storage

Cloud Storage

initializeTestApp({ storageBucket: string, auth: Object }) => FirebaseApp

テストで使用するために、特定のユーザーとして認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたストレージ バケット名と認証変数のオーバーライドに対応する、初期化された Firebase アプリを返します。

firebase.initializeTestApp({
  storageBucket: "my-bucket",
  auth: { uid: "alice" }
});

initializeAdminApp({ storageBucket: string }) => FirebaseApp

テストの状態を設定するために、管理者として認証されたアプリを作成するには、このメソッドを次のように使用します。

オプションで指定されたストレージ バケット名に対応する、初期化された管理 Firebase アプリを返します。このアプリは、バケットに対する読み書きを行う際にセキュリティ ルールを迂回します。

firebase.initializeAdminApp({ storageBucket: "my-bucket" });

loadStorageRules({ storageBucket: string, rules: Object }) => Promise

これを使用してストレージ バケットのルールを設定します。

ローカル管理のストレージ バケットにルールを送信します。"storageBucket" と "rules" を文字列として指定したオプション オブジェクトを取ります。

firebase
      .loadStorageRules({
        storageBucket: "my-bucket",
        rules: fs.readFileSync("/path/to/storage.rules", "utf8")
      });

apps() => [FirebaseApp]

現在初期化されているテストと管理アプリをすべて返します。

テスト間またはテスト後にアプリを消去するには、このメソッドを次のように使用します（初期化済みのアプリでアクティブなリスナーを持つ場合は、JavaScript を終了できないのでご注意ください）。

 Promise.all(firebase.apps().map(app => app.delete()))

assertFails(pr: Promise) => Promise

入力が成功した場合は拒否され、入力が拒否された場合は成功する Promise を返します。

これを使用して、ストレージ バケットの読み取りまたは書き込みに失敗したことをアサートします。

firebase.assertFails(app.storage().ref("letters/private.doc").getMetadata());

assertSucceeds(pr: Promise) => Promise

入力が成功した場合は成功し、入力が拒否された場合は拒否される Promise を返します。

これを使用して、ストレージ バケットの読み取りまたは書き込みが成功したことをアサートします。

firebase.assertFails(app.storage().ref("images/cat.png").getMetadata());