単体テストを作成する

クラウド ファイアストア

クラウド ファイアストア

RulesTestEnvironment.clearFirestore() => Promise<void>

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

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

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

リアルタイム データベース

リアルタイム データベース

RulesTestEnvironment.clearDatabase() => Promise<void>

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

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

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

クラウドストレージ

クラウドストレージ

RulesTestEnvironment.clearStorage() => Promise<void>

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

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

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

クラウド ファイアストア

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"
});
   

リアルタイム データベース

リアルタイム データベース

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

これを使用して、テストで使用する特定のユーザーとして認証されたアプリを作成します。

オプションで指定されたデータベース名と認証変数オーバーライドに対応する、初期化された 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"));

クラウドストレージ

クラウドストレージ

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());

クラウド ファイアストア

クラウド ファイアストア

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"
});
   

リアルタイム データベース

リアルタイム データベース

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

これを使用して、テストで使用する特定のユーザーとして認証されたアプリを作成します。

オプションで指定されたデータベース名と認証変数オーバーライドに対応する、初期化された 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"));

クラウドストレージ

クラウドストレージ

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());