構建單元測試

雲端 Firestore

雲端 Firestore

RulesTestEnvironment.clearFirestore() => Promise<void>

此方法清除 Firestore 數據庫中屬於為 Firestore 模擬器配置的projectId數據。

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

此方法為此測試上下文獲取一個 Firestore 實例。返回的 Firebase JS 客戶端 SDK 實例可以與客戶端 SDK API（v9 模塊化或 v9 兼容）一起使用。

實時數據庫

實時數據庫

RulesTestEnvironment.clearDatabase() => Promise<void>

此方法會清除實時數據庫中屬於為實時數據庫模擬器配置的projectId數據。

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

獲取此測試上下文的實時數據庫實例。返回的 Firebase JS 客戶端 SDK 實例可以與客戶端 SDK API（模塊化或命名空間，版本 9 或更高版本）一起使用。該方法接受實時數據庫實例的 URL。如果指定，則返回具有從 URL 中提取的參數的命名空間模擬版本的實例。

雲儲存

雲儲存

RulesTestEnvironment.clearStorage() => Promise<void>

此方法清除屬於為 Cloud Storage 模擬器配置的projectId存儲桶中的對象和元數據。

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

此方法返回一個配置為連接到模擬器的存儲實例。該方法接受 Firebase 存儲桶的gs:// url 以進行測試。如果指定，則返回存儲桶名稱模擬版本的存儲實例。

雲端 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

此方法返回一個承諾，如果輸入成功則拒絕該承諾，如果輸入被拒絕則該承諾成功。如果數據庫讀取或寫入失敗，請使用它來斷言。

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

assertSucceeds(pr: 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

使用它來創建一個應用程序作為特定用戶進行身份驗證以在測試中使用。

返回與選項中指定的數據庫名稱和 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

使用它來設置數據庫的規則。

將規則發送到本地運行的數據庫。採用一個選項對象，該對象將您的“數據庫名稱”和“規則”指定為字符串。

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

返回一個承諾，如果輸入成功則拒絕，如果輸入被拒絕則返回成功。

使用它來斷言數據庫讀取或寫入失敗：

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

assertSucceeds(pr: Promise) => Promise

返回一個承諾，如果輸入成功則成功，如果輸入被拒絕則被拒絕。

使用它來斷言數據庫讀取或寫入成功：

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

雲儲存

雲儲存

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

使用它來創建一個應用程序作為特定用戶進行身份驗證以在測試中使用。

返回與選項中指定的存儲桶名稱和 auth 變量覆蓋相對應的初始化 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

返回一個承諾，如果輸入成功則拒絕，如果輸入被拒絕則返回成功。

使用它來斷言存儲桶讀取或寫入失敗：

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

assertSucceeds(pr: Promise) => Promise

返回一個承諾，如果輸入成功則成功，如果輸入被拒絕則被拒絕。

使用它來斷言存儲桶讀取或寫入成功：

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

雲端 Firestore

雲端 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

此方法返回一個承諾，如果輸入成功則拒絕該承諾，如果輸入被拒絕則該承諾成功。如果數據庫讀取或寫入失敗，請使用它來斷言。

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

assertSucceeds(pr: 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

使用它來創建一個應用程序作為特定用戶進行身份驗證以在測試中使用。

返回與選項中指定的數據庫名稱和 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

使用它來設置數據庫的規則。

將規則發送到本地運行的數據庫。採用一個選項對象，該對象將您的“數據庫名稱”和“規則”指定為字符串。

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

返回一個承諾，如果輸入成功則拒絕，如果輸入被拒絕則返回成功。

使用它來斷言數據庫讀取或寫入失敗：

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

assertSucceeds(pr: Promise) => Promise

返回一個承諾，如果輸入成功則成功，如果輸入被拒絕則被拒絕。

使用它來斷言數據庫讀取或寫入成功：

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

雲儲存

雲儲存

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

使用它來創建一個應用程序作為特定用戶進行身份驗證以在測試中使用。

返回與選項中指定的存儲桶名稱和 auth 變量覆蓋相對應的初始化 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

返回一個承諾，如果輸入成功則拒絕，如果輸入被拒絕則返回成功。

使用它來斷言存儲桶讀取或寫入失敗：

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

assertSucceeds(pr: Promise) => Promise

返回一個承諾，如果輸入成功則成功，如果輸入被拒絕則被拒絕。

使用它來斷言存儲桶讀取或寫入成功：

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