构建单元测试

云端 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（v9 模块化或 v9 兼容）一起使用。该方法接受实时数据库实例的 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());