Xây dựng các bài kiểm tra đơn vị

Cửa hàng đám mây

Cửa hàng đám mây

RulesTestEnvironment.clearFirestore() => Promise<void>

Phương thức này xóa dữ liệu trong cơ sở dữ liệu Firestore thuộc projectId được định cấu hình cho trình mô phỏng Firestore.

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

Phương thức này lấy một phiên bản Firestore cho bối cảnh thử nghiệm này. Phiên bản SDK khách Firebase JS được trả về có thể được sử dụng với API SDK khách (tương thích mô-đun v9 hoặc tương thích v9).

Cơ sở dữ liệu thời gian thực

Cơ sở dữ liệu thời gian thực

RulesTestEnvironment.clearDatabase() => Promise<void>

Phương pháp này xóa dữ liệu trong Cơ sở dữ liệu thời gian thực thuộc về projectId được định cấu hình cho trình mô phỏng Cơ sở dữ liệu thời gian thực.

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

Nhận phiên bản Cơ sở dữ liệu thời gian thực cho bối cảnh thử nghiệm này. Phiên bản SDK khách Firebase JS được trả về có thể được sử dụng với API SDK khách (mô-đun hoặc không gian tên, phiên bản 9 trở lên). Phương thức này chấp nhận một URL của phiên bản Cơ sở dữ liệu thời gian thực. Nếu được chỉ định, trả về một phiên bản cho phiên bản mô phỏng của không gian tên với các tham số được trích xuất từ ​​URL.

Lưu trữ đám mây

Lưu trữ đám mây

RulesTestEnvironment.clearStorage() => Promise<void>

Phương thức này xóa các đối tượng và siêu dữ liệu trong nhóm lưu trữ thuộc projectId được định cấu hình cho trình mô phỏng Cloud Storage.

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

Phương thức này trả về một phiên bản Storage được định cấu hình để kết nối với trình mô phỏng. Phương thức này chấp nhận url gs:// vào Nhóm lưu trữ Firebase để thử nghiệm. Nếu được chỉ định, trả về phiên bản Bộ nhớ cho phiên bản mô phỏng của tên nhóm.

Cửa hàng đám mây

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

Phương thức này trả về ứng dụng Firebase được khởi tạo tương ứng với ID dự án và biến xác thực được chỉ định trong các tùy chọn. Sử dụng tính năng này để tạo ứng dụng được xác thực là một người dùng cụ thể để sử dụng trong các thử nghiệm.

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

initializeAdminApp({ projectId: string }) => FirebaseApp

Phương thức này trả về ứng dụng Firebase của quản trị viên đã khởi tạo. Ứng dụng này bỏ qua các quy tắc bảo mật khi thực hiện đọc và ghi. Sử dụng tính năng này để tạo ứng dụng được xác thực với tư cách quản trị viên nhằm đặt trạng thái cho các thử nghiệm.

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

apps() => [FirebaseApp] Phương thức này trả về tất cả các ứng dụng quản trị và thử nghiệm hiện được khởi tạo. Sử dụng tính năng này để dọn dẹp ứng dụng giữa hoặc sau khi kiểm tra.

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

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

Phương pháp này gửi các quy tắc đến cơ sở dữ liệu đang chạy cục bộ. Nó lấy một đối tượng chỉ định các quy tắc dưới dạng một chuỗi. Sử dụng phương pháp này để đặt quy tắc cho cơ sở dữ liệu của bạn.

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

assertFails(pr: Promise) => Promise

Phương thức này trả về một lời hứa bị từ chối nếu đầu vào thành công hoặc thành công nếu đầu vào bị từ chối. Sử dụng điều này để xác nhận nếu cơ sở dữ liệu đọc hoặc ghi không thành công.

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

assertSucceeds(pr: Promise) => Promise

Phương thức này trả về một lời hứa thành công nếu đầu vào thành công và bị từ chối nếu đầu vào bị từ chối. Sử dụng điều này để xác nhận xem cơ sở dữ liệu có đọc hoặc ghi thành công hay không.

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

clearFirestoreData({ projectId: string }) => Promise

Phương pháp này xóa tất cả dữ liệu được liên kết với một dự án cụ thể trong phiên bản Firestore đang chạy cục bộ. Sử dụng phương pháp này để dọn dẹp sau khi kiểm tra.

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

Cơ sở dữ liệu thời gian thực

Cơ sở dữ liệu thời gian thực

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

Sử dụng tính năng này để tạo ứng dụng được xác thực là một người dùng cụ thể để sử dụng trong các thử nghiệm.

Trả về ứng dụng firebase đã khởi tạo tương ứng với tên cơ sở dữ liệu và ghi đè biến xác thực được chỉ định trong tùy chọn.

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

initializeAdminApp({ databaseName: string }) => FirebaseApp

Sử dụng tính năng này để tạo ứng dụng được xác thực với tư cách quản trị viên nhằm thiết lập trạng thái cho các thử nghiệm.

Trả về ứng dụng firebase quản trị viên đã khởi tạo tương ứng với tên cơ sở dữ liệu được chỉ định trong tùy chọn. Ứng dụng này bỏ qua các quy tắc bảo mật khi đọc và ghi vào cơ sở dữ liệu.

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

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

Sử dụng điều này để đặt quy tắc cơ sở dữ liệu của bạn.

Gửi quy tắc đến cơ sở dữ liệu đang chạy cục bộ. Lấy một đối tượng tùy chọn chỉ định "databaseName" và "quy tắc" của bạn dưới dạng chuỗi.

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

apps() => [FirebaseApp]

Trả về tất cả các ứng dụng quản trị và thử nghiệm hiện được khởi tạo.

Sử dụng tính năng này để dọn sạch ứng dụng giữa hoặc sau khi kiểm tra (lưu ý rằng các ứng dụng được khởi tạo với trình xử lý đang hoạt động sẽ ngăn không cho JavaScript thoát):

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

assertFails(pr: Promise) => Promise

Trả về một lời hứa bị từ chối nếu đầu vào thành công và thành công nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng việc đọc hoặc ghi cơ sở dữ liệu không thành công:

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

assertSucceeds(pr: Promise) => Promise

Trả về một lời hứa thành công nếu đầu vào thành công và bị từ chối nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng việc đọc hoặc ghi cơ sở dữ liệu thành công:

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

Lưu trữ đám mây

Lưu trữ đám mây

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

Sử dụng tính năng này để tạo ứng dụng được xác thực là một người dùng cụ thể để sử dụng trong các thử nghiệm.

Trả về ứng dụng firebase đã khởi tạo tương ứng với tên nhóm lưu trữ và ghi đè biến xác thực được chỉ định trong tùy chọn.

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

initializeAdminApp({ storageBucket: string }) => FirebaseApp

Sử dụng tính năng này để tạo ứng dụng được xác thực với tư cách quản trị viên nhằm thiết lập trạng thái cho các thử nghiệm.

Trả về ứng dụng firebase quản trị viên đã khởi tạo tương ứng với tên nhóm lưu trữ được chỉ định trong tùy chọn. Ứng dụng này bỏ qua các quy tắc bảo mật khi đọc và ghi vào vùng lưu trữ.

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

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

Sử dụng điều này để đặt quy tắc cho nhóm lưu trữ của bạn.

Gửi quy tắc đến vùng lưu trữ được quản lý cục bộ. Lấy một đối tượng tùy chọn chỉ định "storageBucket" và "quy tắc" của bạn dưới dạng chuỗi.

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

apps() => [FirebaseApp]

Trả về tất cả các ứng dụng quản trị và thử nghiệm hiện được khởi tạo.

Sử dụng tính năng này để dọn sạch ứng dụng giữa hoặc sau khi kiểm tra (lưu ý rằng các ứng dụng được khởi tạo với trình xử lý đang hoạt động sẽ ngăn không cho JavaScript thoát):

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

assertFails(pr: Promise) => Promise

Trả về một lời hứa bị từ chối nếu đầu vào thành công và thành công nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng việc đọc hoặc ghi bộ lưu trữ không thành công:

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

assertSucceeds(pr: Promise) => Promise

Trả về một lời hứa thành công nếu đầu vào thành công và bị từ chối nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng bộ lưu trữ đã đọc hoặc ghi thành công:

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

Cửa hàng đám mây

Cửa hàng đám mây

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

Phương thức này trả về ứng dụng Firebase được khởi tạo tương ứng với ID dự án và biến xác thực được chỉ định trong các tùy chọn. Sử dụng tính năng này để tạo ứng dụng được xác thực là một người dùng cụ thể để sử dụng trong các thử nghiệm.

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

initializeAdminApp({ projectId: string }) => FirebaseApp

Phương thức này trả về ứng dụng Firebase của quản trị viên đã khởi tạo. Ứng dụng này bỏ qua các quy tắc bảo mật khi thực hiện đọc và ghi. Sử dụng tính năng này để tạo ứng dụng được xác thực với tư cách quản trị viên nhằm đặt trạng thái cho các thử nghiệm.

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

apps() => [FirebaseApp] Phương thức này trả về tất cả các ứng dụng quản trị và thử nghiệm hiện được khởi tạo. Sử dụng tính năng này để dọn dẹp ứng dụng giữa hoặc sau khi kiểm tra.

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

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

Phương pháp này gửi các quy tắc đến cơ sở dữ liệu đang chạy cục bộ. Nó lấy một đối tượng chỉ định các quy tắc dưới dạng một chuỗi. Sử dụng phương pháp này để đặt quy tắc cho cơ sở dữ liệu của bạn.

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

assertFails(pr: Promise) => Promise

Phương thức này trả về một lời hứa bị từ chối nếu đầu vào thành công hoặc thành công nếu đầu vào bị từ chối. Sử dụng điều này để xác nhận nếu cơ sở dữ liệu đọc hoặc ghi không thành công.

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

assertSucceeds(pr: Promise) => Promise

Phương thức này trả về một lời hứa thành công nếu đầu vào thành công và bị từ chối nếu đầu vào bị từ chối. Sử dụng điều này để xác nhận xem cơ sở dữ liệu có đọc hoặc ghi thành công hay không.

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

clearFirestoreData({ projectId: string }) => Promise

Phương pháp này xóa tất cả dữ liệu được liên kết với một dự án cụ thể trong phiên bản Firestore đang chạy cục bộ. Sử dụng phương pháp này để dọn dẹp sau khi kiểm tra.

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

Cơ sở dữ liệu thời gian thực

Cơ sở dữ liệu thời gian thực

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

Sử dụng tính năng này để tạo ứng dụng được xác thực là một người dùng cụ thể để sử dụng trong các thử nghiệm.

Trả về ứng dụng firebase đã khởi tạo tương ứng với tên cơ sở dữ liệu và ghi đè biến xác thực được chỉ định trong tùy chọn.

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

initializeAdminApp({ databaseName: string }) => FirebaseApp

Sử dụng tính năng này để tạo ứng dụng được xác thực với tư cách quản trị viên nhằm thiết lập trạng thái cho các thử nghiệm.

Trả về ứng dụng firebase quản trị viên đã khởi tạo tương ứng với tên cơ sở dữ liệu được chỉ định trong tùy chọn. Ứng dụng này bỏ qua các quy tắc bảo mật khi đọc và ghi vào cơ sở dữ liệu.

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

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

Sử dụng điều này để đặt quy tắc cơ sở dữ liệu của bạn.

Gửi quy tắc đến cơ sở dữ liệu đang chạy cục bộ. Lấy một đối tượng tùy chọn chỉ định "databaseName" và "quy tắc" của bạn dưới dạng chuỗi.

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

apps() => [FirebaseApp]

Trả về tất cả các ứng dụng quản trị và thử nghiệm hiện được khởi tạo.

Sử dụng tính năng này để dọn sạch ứng dụng giữa hoặc sau khi kiểm tra (lưu ý rằng các ứng dụng được khởi tạo với trình xử lý đang hoạt động sẽ ngăn không cho JavaScript thoát):

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

assertFails(pr: Promise) => Promise

Trả về một lời hứa bị từ chối nếu đầu vào thành công và thành công nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng việc đọc hoặc ghi cơ sở dữ liệu không thành công:

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

assertSucceeds(pr: Promise) => Promise

Trả về một lời hứa thành công nếu đầu vào thành công và bị từ chối nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng việc đọc hoặc ghi cơ sở dữ liệu thành công:

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

Lưu trữ đám mây

Lưu trữ đám mây

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

Sử dụng tính năng này để tạo ứng dụng được xác thực là một người dùng cụ thể để sử dụng trong các thử nghiệm.

Trả về ứng dụng firebase đã khởi tạo tương ứng với tên nhóm lưu trữ và ghi đè biến xác thực được chỉ định trong tùy chọn.

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

initializeAdminApp({ storageBucket: string }) => FirebaseApp

Sử dụng tính năng này để tạo ứng dụng được xác thực với tư cách quản trị viên nhằm thiết lập trạng thái cho các thử nghiệm.

Trả về ứng dụng firebase quản trị viên đã khởi tạo tương ứng với tên nhóm lưu trữ được chỉ định trong tùy chọn. Ứng dụng này bỏ qua các quy tắc bảo mật khi đọc và ghi vào vùng lưu trữ.

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

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

Sử dụng điều này để đặt quy tắc cho nhóm lưu trữ của bạn.

Gửi quy tắc đến vùng lưu trữ được quản lý cục bộ. Lấy một đối tượng tùy chọn chỉ định "storageBucket" và "quy tắc" của bạn dưới dạng chuỗi.

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

apps() => [FirebaseApp]

Trả về tất cả các ứng dụng quản trị và thử nghiệm hiện được khởi tạo.

Sử dụng tính năng này để dọn sạch ứng dụng giữa hoặc sau khi kiểm tra (lưu ý rằng các ứng dụng được khởi tạo với trình xử lý đang hoạt động sẽ ngăn không cho JavaScript thoát):

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

assertFails(pr: Promise) => Promise

Trả về một lời hứa bị từ chối nếu đầu vào thành công và thành công nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng việc đọc hoặc ghi bộ lưu trữ không thành công:

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

assertSucceeds(pr: Promise) => Promise

Trả về một lời hứa thành công nếu đầu vào thành công và bị từ chối nếu đầu vào bị từ chối.

Sử dụng điều này để xác nhận rằng bộ lưu trữ đã đọc hoặc ghi thành công:

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