Kiểm thử Quy tắc bảo mật của Cloud Firestore

Khi xây dựng ứng dụng, bạn nên khoá quyền truy cập vào cơ sở dữ liệu Cloud Firestore. Tuy nhiên, trước khi ra mắt, bạn cần có Cloud Firestore Security Rules chi tiết hơn. Với trình mô phỏng Cloud Firestore, ngoài việc tạo nguyên mẫu và kiểm thử các tính năng và hành vi chung của ứng dụng, bạn có thể viết mã kiểm thử đơn vị để kiểm tra hành vi của Cloud Firestore Security Rules.

Bắt đầu nhanh

Đối với một số trường hợp kiểm thử cơ bản có quy tắc đơn giản, hãy thử mẫu bắt đầu nhanh.

Tìm hiểu về Cloud Firestore Security Rules

Triển khai Firebase Authentication và Cloud Firestore Security Rules để xác thực, uỷ quyền và xác thực dữ liệu không cần máy chủ khi bạn sử dụng thư viện ứng dụng khách dành cho thiết bị di động và web.

Cloud Firestore Security Rules bao gồm hai phần:

1. Câu lệnh match xác định các tài liệu trong cơ sở dữ liệu của bạn.
2. Biểu thức allow kiểm soát quyền truy cập vào các tài liệu đó.

Firebase Authentication xác minh thông tin xác thực của người dùng và cung cấp nền tảng cho các hệ thống truy cập dựa trên người dùng và vai trò.

Mọi yêu cầu cơ sở dữ liệu từ thư viện ứng dụng web/thiết bị di động Cloud Firestore đều được đánh giá theo các quy tắc bảo mật của bạn trước khi đọc hoặc ghi bất kỳ dữ liệu nào. Nếu các quy tắc đó từ chối quyền truy cập vào bất kỳ đường dẫn tài liệu được chỉ định nào, thì toàn bộ yêu cầu sẽ không thành công.

Tìm hiểu thêm về Cloud Firestore Security Rules trong bài viết Bắt đầu sử dụng Cloud Firestore Security Rules.

Cài đặt trình mô phỏng

Để cài đặt trình mô phỏng Cloud Firestore, hãy sử dụng Firebase CLI và chạy lệnh dưới đây:

firebase setup:emulators:firestore

Chạy trình mô phỏng

Bắt đầu bằng cách khởi chạy một dự án Firebase trong thư mục đang hoạt động của bạn. Đây là bước đầu tiên phổ biến khi sử dụng Giao diện dòng lệnh (CLI) của Firebase.

firebase init

Khởi động trình mô phỏng bằng lệnh sau. Trình mô phỏng sẽ chạy cho đến khi bạn dừng quy trình này:

firebase emulators:start --only firestore

Trong nhiều trường hợp, bạn muốn khởi động trình mô phỏng, chạy một bộ kiểm thử, sau đó tắt trình mô phỏng sau khi chạy các kiểm thử. Bạn có thể dễ dàng thực hiện việc này bằng lệnh emulators:exec:

firebase emulators:exec --only firestore "./my-test-script.sh"

Khi khởi động, trình mô phỏng sẽ cố chạy trên cổng mặc định (8080). Bạn có thể thay đổi cổng trình mô phỏng bằng cách sửa đổi phần "emulators" của tệp firebase.json:

{
  // ...
  "emulators": {
    "firestore": {
      "port": "YOUR_PORT"
    }
  }
}

Trước khi bạn chạy trình mô phỏng

Trước khi bắt đầu sử dụng trình mô phỏng, hãy lưu ý những điều sau:

• Ban đầu, trình mô phỏng sẽ tải các quy tắc được chỉ định trong trường firestore.rules của tệp firebase.json. Tệp này sẽ nhận tên của một tệp cục bộ chứa Cloud Firestore Security Rules và áp dụng các quy tắc đó cho tất cả dự án. Nếu bạn không cung cấp đường dẫn tệp cục bộ hoặc sử dụng phương thức loadFirestoreRules như mô tả dưới đây, trình mô phỏng sẽ coi tất cả dự án là có các quy tắc mở.
• Mặc dù hầu hết SDK Firebase đều hoạt động trực tiếp với trình mô phỏng, nhưng chỉ thư viện @firebase/rules-unit-testing mới hỗ trợ tính năng mô phỏng auth trong Quy tắc bảo mật, giúp việc kiểm thử đơn vị trở nên dễ dàng hơn nhiều. Ngoài ra, thư viện này còn hỗ trợ một số tính năng dành riêng cho trình mô phỏng như xoá tất cả dữ liệu, như được liệt kê bên dưới.
• Trình mô phỏng cũng sẽ chấp nhận mã thông báo xác thực Firebase chính thức được cung cấp thông qua SDK ứng dụng và đánh giá các quy tắc theo đó, cho phép kết nối ứng dụng của bạn trực tiếp với trình mô phỏng trong quá trình tích hợp và kiểm thử thủ công.

Chạy kiểm thử đơn vị cục bộ

Chạy kiểm thử đơn vị cục bộ bằng SDK JavaScript phiên bản 9

Firebase phân phối thư viện kiểm thử đơn vị Quy tắc bảo mật bằng cả SDK JavaScript phiên bản 9 và SDK phiên bản 8. Các API thư viện khác nhau đáng kể. Bạn nên sử dụng thư viện kiểm thử v9. Thư viện này được sắp xếp hợp lý hơn và đòi hỏi ít thiết lập hơn để kết nối với trình mô phỏng, do đó, tránh được việc vô tình sử dụng tài nguyên phát hành chính thức. Để đảm bảo khả năng tương thích ngược, chúng tôi tiếp tục cung cấp thư viện kiểm thử v8.

• Các phương thức kiểm thử và hàm tiện ích phổ biến trong SDK phiên bản 9
• Các phương thức kiểm thử dành riêng cho trình mô phỏng trong SDK phiên bản 9

Sử dụng mô-đun @firebase/rules-unit-testing để tương tác với trình mô phỏng chạy cục bộ. Nếu bạn gặp lỗi hết thời gian chờ hoặc ECONNREFUSED, hãy kiểm tra kỹ để đảm bảo trình mô phỏng đang chạy.

Bạn nên sử dụng phiên bản Node.js gần đây để có thể sử dụng ký hiệu async/await. Hầu hết hành vi mà bạn có thể muốn kiểm thử đều liên quan đến các hàm không đồng bộ và mô-đun kiểm thử được thiết kế để hoạt động với mã dựa trên Lời hứa.

Thư viện Kiểm thử đơn vị theo quy tắc v9 luôn nhận biết được trình mô phỏng và không bao giờ chạm vào tài nguyên sản xuất của bạn.

Bạn nhập thư viện bằng cách sử dụng câu lệnh nhập mô-đun v9. Ví dụ:

import {
  assertFails,
  assertSucceeds,
  initializeTestEnvironment
} from "@firebase/rules-unit-testing"

// Use `const { … } = require("@firebase/rules-unit-testing")` if imports are not supported
// Or we suggest `const testing = require("@firebase/rules-unit-testing")` if necessary.

Sau khi nhập, việc triển khai kiểm thử đơn vị sẽ bao gồm:

• Tạo và định cấu hình RulesTestEnvironment bằng lệnh gọi đến initializeTestEnvironment.
• Thiết lập dữ liệu kiểm thử mà không kích hoạt Quy tắc, sử dụng một phương thức tiện lợi cho phép bạn tạm thời bỏ qua các quy tắc đó, RulesTestEnvironment.withSecurityRulesDisabled.
• Thiết lập bộ kiểm thử và mỗi hàm trước/sau kiểm thử bằng các lệnh gọi để dọn dẹp dữ liệu và môi trường kiểm thử, chẳng hạn như RulesTestEnvironment.cleanup() hoặc RulesTestEnvironment.clearFirestore().
• Triển khai các trường hợp kiểm thử mô phỏng trạng thái xác thực bằng cách sử dụng RulesTestEnvironment.authenticatedContext và RulesTestEnvironment.unauthenticatedContext.

Các phương thức và hàm tiện ích phổ biến

Ngoài ra, hãy xem các phương thức kiểm thử dành riêng cho trình mô phỏng trong SDK phiên bản 9.

initializeTestEnvironment() => RulesTestEnvironment

Hàm này khởi chạy môi trường kiểm thử cho quy tắc kiểm thử đơn vị. Trước tiên, hãy gọi hàm này để thiết lập kiểm thử. Để thực thi thành công, bạn cần chạy trình mô phỏng.

Hàm này chấp nhận một đối tượng không bắt buộc xác định TestEnvironmentConfig, có thể bao gồm mã dự án và chế độ cài đặt cấu hình trình mô phỏng.

let testEnv = await initializeTestEnvironment({
  projectId: "demo-project-1234",
  firestore: {
    rules: fs.readFileSync("firestore.rules", "utf8"),
  },
});

RulesTestEnvironment.authenticatedContext({ user_id: string, tokenOptions?: TokenOptions }) => RulesTestContext

Phương thức này sẽ tạo một RulesTestContext, hoạt động giống như một Người dùng xác thực đã được xác thực. Các yêu cầu được tạo thông qua ngữ cảnh được trả về sẽ có một mã thông báo xác thực mô phỏng được đính kèm. Bạn có thể tuỳ ý truyền một đối tượng xác định các thông báo xác nhận tuỳ chỉnh hoặc ghi đè cho tải trọng mã xác thực.

Sử dụng đối tượng ngữ cảnh kiểm thử được trả về trong các chương trình kiểm thử để truy cập vào mọi thực thể trình mô phỏng đã định cấu hình, bao gồm cả các thực thể được định cấu hình bằng initializeTestEnvironment.

// Assuming a Firestore app and the Firestore emulator for this example
import { setDoc } from "firebase/firestore";

const alice = testEnv.authenticatedContext("alice", { … });
// Use the Firestore instance associated with this context
await assertSucceeds(setDoc(alice.firestore(), '/users/alice'), { ... });

RulesTestEnvironment.unauthenticatedContext() => RulesTestContext

Phương thức này tạo một RulesTestContext, hoạt động như một ứng dụng khách không đăng nhập thông qua Xác thực. Các yêu cầu được tạo thông qua ngữ cảnh được trả về sẽ không có mã thông báo xác thực Firebase được đính kèm.

Sử dụng đối tượng ngữ cảnh kiểm thử được trả về trong các chương trình kiểm thử để truy cập vào mọi thực thể trình mô phỏng đã định cấu hình, bao gồm cả các thực thể được định cấu hình bằng initializeTestEnvironment.

// Assuming a Cloud Storage app and the Storage emulator for this example
import { getStorage, ref, deleteObject } from "firebase/storage";

const alice = testEnv.unauthenticatedContext();

// Use the Cloud Storage instance associated with this context
const desertRef = ref(alice.storage(), 'images/desert.jpg');
await assertSucceeds(deleteObject(desertRef));

RulesTestEnvironment.withSecurityRulesDisabled()

Chạy một hàm thiết lập kiểm thử với ngữ cảnh hoạt động như thể Quy tắc bảo mật bị tắt.

Phương thức này sử dụng một hàm callback, lấy bối cảnh bỏ qua Quy tắc bảo mật và trả về một hứa hẹn. Ngữ cảnh sẽ bị huỷ sau khi lời hứa giải quyết/từ chối.

RulesTestEnvironment.cleanup()

Phương thức này huỷ bỏ tất cả RulesTestContexts được tạo trong môi trường kiểm thử và dọn dẹp các tài nguyên cơ bản, cho phép thoát sạch.

Phương thức này không làm thay đổi trạng thái của trình mô phỏng theo bất kỳ cách nào. Để đặt lại dữ liệu giữa các lần kiểm thử, hãy sử dụng phương thức xoá dữ liệu dành riêng cho trình mô phỏng ứng dụng.

assertSucceeds(pr: Promise<any>)) => Promise<any>

Đây là hàm tiện ích của trường hợp kiểm thử.

Hàm này xác nhận rằng Lời hứa được cung cấp bao gồm một thao tác của trình mô phỏng sẽ được giải quyết mà không có lỗi vi phạm Quy tắc bảo mật.

await assertSucceeds(setDoc(alice.firestore(), '/users/alice'), { ... });

assertFails(pr: Promise<any>)) => Promise<any>

Đây là hàm tiện ích của trường hợp kiểm thử.

Hàm này xác nhận rằng Lời hứa được cung cấp bao gồm một thao tác của trình mô phỏng sẽ bị từ chối do vi phạm Quy tắc bảo mật.

await assertFails(setDoc(alice.firestore(), '/users/bob'), { ... });

Phương thức dành riêng cho trình mô phỏng

Ngoài ra, hãy xem các phương thức kiểm thử phổ biến và hàm tiện ích trong SDK phiên bản 9.

RulesTestEnvironment.clearFirestore() => Promise<void>

Phương thức này xoá dữ liệu trong cơ sở dữ liệu Firestore thuộc về 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 thực thể Firestore cho ngữ cảnh kiểm thử này. Bạn có thể sử dụng thực thể SDK ứng dụng JS Firebase được trả về với các API SDK ứng dụng (mô-đun v9 hoặc tương thích v9).

Hình ảnh hoá việc đánh giá quy tắc

Trình mô phỏng Cloud Firestore cho phép bạn hình dung các yêu cầu của ứng dụng trong giao diện người dùng của Bộ trình mô phỏng, bao gồm cả tính năng theo dõi đánh giá cho Quy tắc bảo mật Firebase.

Mở thẻ Firestore > Requests (Firestore > Yêu cầu) để xem trình tự đánh giá chi tiết cho từng yêu cầu.

Tạo báo cáo kiểm thử

Sau khi chạy một bộ kiểm thử, bạn có thể truy cập vào báo cáo phạm vi kiểm thử để biết cách đánh giá từng quy tắc bảo mật.

Để nhận báo cáo, hãy truy vấn một điểm cuối được hiển thị trên trình mô phỏng trong khi trình mô phỏng đang chạy. Đối với phiên bản thân thiện với trình duyệt, hãy sử dụng URL sau:

http://localhost:8080/emulator/v1/projects/<project_id>:ruleCoverage.html

Thao tác này sẽ chia các quy tắc của bạn thành các biểu thức và biểu thức con mà bạn có thể di chuột qua để biết thêm thông tin, bao gồm cả số lượt đánh giá và giá trị được trả về. Đối với phiên bản JSON thô của dữ liệu này, hãy thêm URL sau vào truy vấn của bạn:

http://localhost:8080/emulator/v1/projects/<project_id>:ruleCoverage

Sự khác biệt giữa trình mô phỏng và bản phát hành chính thức

1. Bạn không cần phải tạo dự án Cloud Firestore một cách rõ ràng. Trình mô phỏng sẽ tự động tạo mọi thực thể được truy cập.
2. Trình mô phỏng Cloud Firestore không hoạt động với luồng Firebase Authentication thông thường. Thay vào đó, trong SDK kiểm thử Firebase, chúng tôi đã cung cấp phương thức initializeTestApp() trong thư viện rules-unit-testing. Phương thức này sẽ lấy trường auth. Tên người dùng Firebase được tạo bằng phương thức này sẽ hoạt động như thể đã được xác thực thành công là bất kỳ thực thể nào mà bạn cung cấp. Nếu bạn truyền vào null, thì giá trị này sẽ hoạt động như một người dùng chưa được xác thực (ví dụ: các quy tắc auth != null sẽ không thành công).

Khắc phục các vấn đề đã biết

Khi sử dụng trình mô phỏng Cloud Firestore, bạn có thể gặp phải các vấn đề đã biết sau. Hãy làm theo hướng dẫn bên dưới để khắc phục mọi hành vi bất thường mà bạn đang gặp phải. Các ghi chú này được viết với sự lưu tâm đến thư viện kiểm thử đơn vị Quy tắc bảo mật, nhưng phương pháp chung đều có thể áp dụng cho mọi SDK Firebase.

Hành vi kiểm thử không nhất quán

Nếu các chương trình kiểm thử của bạn đôi khi đạt và không thành công, ngay cả khi không có bất kỳ thay đổi nào đối với quy trình kiểm thử, thì bạn có thể cần phải xác minh rằng các chương trình kiểm thử đó được sắp xếp đúng trình tự. Hầu hết các hoạt động tương tác với trình mô phỏng đều không đồng bộ, vì vậy, hãy kiểm tra kỹ để đảm bảo rằng tất cả mã không đồng bộ đều được sắp xếp theo trình tự đúng cách. Bạn có thể khắc phục trình tự bằng cách tạo chuỗi các lời hứa hoặc sử dụng ký hiệu await một cách linh hoạt.

Cụ thể, hãy xem xét các hoạt động không đồng bộ sau đây:

• Thiết lập quy tắc bảo mật, ví dụ: initializeTestEnvironment.
• Đọc và ghi dữ liệu, ví dụ: db.collection("users").doc("alice").get().
• Xác nhận hoạt động, bao gồm assertSucceeds và assertFails.

Kiểm thử chỉ vượt qua lần đầu tiên bạn tải trình mô phỏng

Trình mô phỏng có trạng thái. Nó lưu trữ tất cả dữ liệu được ghi vào bộ nhớ, vì vậy, mọi dữ liệu sẽ bị mất bất cứ khi nào trình mô phỏng tắt. Nếu bạn đang chạy nhiều lượt kiểm thử cho cùng một mã dự án, thì mỗi lượt kiểm thử có thể tạo ra dữ liệu có thể ảnh hưởng đến các lượt kiểm thử tiếp theo. Bạn có thể sử dụng bất kỳ phương thức nào sau đây để bỏ qua hành vi này:

• Sử dụng mã dự án duy nhất cho mỗi lần kiểm thử. Xin lưu ý rằng nếu chọn làm việc này, bạn sẽ cần gọi initializeTestEnvironment trong mỗi lần kiểm thử; các quy tắc chỉ tự động tải cho mã dự án mặc định.
• Điều chỉnh cấu trúc chương trình kiểm thử để chúng không tương tác với dữ liệu đã ghi trước đó (ví dụ: sử dụng một bộ sưu tập khác cho mỗi kiểm thử).
• Xoá tất cả dữ liệu được ghi trong quá trình kiểm thử.

Quá trình thiết lập kiểm thử rất phức tạp

Khi thiết lập kiểm thử, bạn có thể muốn sửa đổi dữ liệu theo cách mà Cloud Firestore Security Rules thực sự không cho phép. Nếu các quy tắc của bạn đang khiến quy trình thiết lập kiểm thử trở nên phức tạp, hãy thử sử dụng RulesTestEnvironment.withSecurityRulesDisabled trong các bước thiết lập để các thao tác đọc và ghi không kích hoạt lỗi PERMISSION_DENIED.

Sau đó, kiểm thử của bạn có thể thực hiện các thao tác dưới dạng người dùng đã xác thực hoặc chưa xác thực bằng cách sử dụng RulesTestEnvironment.authenticatedContext và unauthenticatedContext tương ứng. Điều này cho phép bạn xác thực rằng Cloud Firestore Security Rules cho phép/từ chối các trường hợp khác nhau một cách chính xác.