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

Khi xây dựng ứng dụng, bạn có thể muố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 sẽ cần các chi tiết hơn Cloud Firestore Security Rules. Với trình mô phỏng Cloud Firestore, ngoài việc tạo 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 các bài 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 dùng 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, cấp quyền và xác thực dữ liệu không máy chủ khi bạn sử dụng thư viện ứng dụng web và thiết bị di động.

Cloud Firestore Security Rules bao gồm 2 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á dựa trên 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 nào được chỉ định, 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ắ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 bên dưới:

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 làm việc của bạn. Đây là bước đầu tiên thường gặp khi sử dụng Firebase CLI.

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 kết thúc quy trình:

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 các bài kiểm thử chạy. Bạn có thể thực hiện việc này một cách dễ dàng 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ố gắng chạy trên một 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 của bạn:

{
  // ...
  "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. Trình mô phỏng này dự kiế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ả bên dưới, thì trình mô phỏng sẽ coi tất cả dự án đều có quy tắc mở.
  • Mặc dù hầu hết các SDK Firebase hoạt động trực tiếp với trình mô phỏng, nhưng chỉ thư viện @firebase/rules-unit-testing hỗ trợ mô phỏng auth trong Quy tắc bảo mật, giúp các bài 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, chẳng hạn 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 Firebase Auth sản xuất được cung cấp thông qua SDK ứng dụng và đánh giá các quy tắc cho phù hợp, cho phép kết nối trực tiếp ứng dụng của bạn với trình mô phỏng trong các bài kiểm thử tích hợp và thủ công.

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

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

Firebase phân phối một 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. API thư viện khác biệt đáng kể. Bạn nên sử dụng thư viện kiểm thử phiên bản 9. Thư viện này được tinh giản hơn và yêu cầu ít bước thiết lập hơn để kết nối với trình mô phỏng, nhờ đó tránh được việc vô tình sử dụng các tài nguyên sản xuất một cách an toàn. Để đả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ử phiên bản 8.

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 lỗi ECONNREFUSED, hãy kiểm tra kỹ để đảm bảo rằng trình mô phỏng thực sự đ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 mọi 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 Promise.

Thư viện Kiểm thử đơn vị quy tắc phiên bản 9 luôn nhận biết được trình mô phỏng và không bao giờ ảnh hưởng đến 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ác câu lệnh nhập mô-đun phiên bản 9. 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 các bài 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 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à các móc nối trước/sau mỗi bài 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

Hãy xem thêm 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 thử nghiệm để kiểm thử đơn vị quy tắc. Hãy gọi hàm này trước để 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 tạo RulesTestContext, hoạt động giống như một người dùng Xác thự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ã thông báo Xác thực mô phỏng được đính kèm. Bạn có thể truyền một đối tượng xác định các yêu cầu hoặc ghi đè tuỳ chỉnh cho tải trọng mã thông báo Xác thực.

Sử dụng đối tượng ngữ cảnh kiểm thử được trả về trong các bài 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ả những 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().doc('/users/alice'), { ... });

RulesTestEnvironment.unauthenticatedContext() => RulesTestContext

Phương thức này tạo RulesTestContext, hoạt động giống như một ứng dụng 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 Firebase Auth được đính kèm.

Sử dụng đối tượng ngữ cảnh kiểm thử được trả về trong các bài 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ả những 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 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, hàm này sử dụng ngữ cảnh bỏ qua Quy tắc bảo mật và trả về một lời hứa. Ngữ cảnh sẽ bị huỷ sau khi lời hứa phân giải / từ chối.

RulesTestEnvironment.cleanup()

Phương thức này sẽ huỷ tất cả RulesTestContexts được tạo trong môi trường thử nghiệm 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 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 bài 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 hiệu dụng trường hợp kiểm thử.

Hàm này khẳng định rằng Lời hứa được cung cấp bao bọc một thao tác trình mô phỏng sẽ được phân giải mà không có 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 hiệu dụng trường hợp kiểm thử.

Hàm này khẳng định rằng Lời hứa được cung cấp bao bọc một thao tác 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'), { ... });

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

Hãy xem thêm 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.

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 Firebase JS được trả về với các API SDK ứng dụng (mô-đun phiên bản 9 hoặc khả năng tương thích phiên bản 9).

Hình dung các lượt đánh giá quy tắc

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

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

Trình theo dõi yêu cầu của Trình mô phỏng Firestore cho thấy các lượt đánh giá Quy tắc bảo mật

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 các báo cáo mức độ kiểm thử cho thấy cách đánh giá từng quy tắc bảo mật của bạn.

Để 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 khi trình mô phỏng đang chạy. Để có 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ề. Để có 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 quy trình 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ử dụng trường auth. Firebase handle được tạo bằng phương thức này sẽ hoạt động như thể đã xác thực thành công dưới dạng bất kỳ thực thể nào bạn cung cấp. Nếu bạn truyền null, thì thực thể này sẽ hoạt động như một người dùng chưa xác thực (auth != null sẽ không thành công, ví dụ).

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 dựa trên thư viện kiểm thử đơn vị Quy tắc bảo mật, nhưng các phương pháp chung có thể áp dụng cho mọi Firebase SDK.

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

Nếu các bài kiểm thử của bạn đôi khi thành công và đôi khi không thành công, ngay cả khi không có bất kỳ thay đổi nào đối với chính các bài kiểm thử đó, thì bạn có thể cần xác minh rằng chúng được sắp xếp theo đúng trình tự. Hầu hết các 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 đúng trình tự. Bạn có thể khắc phục trình tự bằng cách xâu chuỗi các lời hứa hoặc sử dụng ký hiệu await một cách tự do.

Cụ thể, hãy xem lại các thao tác không đồng bộ sau:

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

Các bài kiểm thử chỉ thành công trong lần đầu tiên bạn tải trình mô phỏng

Trình mô phỏng có trạng thái. Trình mô phỏng này 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 bài kiểm thử dựa trên cùng một mã dự án, thì mỗi bài kiểm thử có thể tạo ra dữ liệu có thể ảnh hưởng đến các bài 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 bài kiểm thử. Xin lưu ý rằng nếu chọn làm như vậy, bạn sẽ cần gọi initializeTestEnvironment trong mỗi bài kiểm thử; các quy tắc chỉ được tự động tải cho mã dự án mặc định.
  • Cấu trúc lại các bài 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 bài kiểm thử).
  • Xoá tất cả dữ liệu được ghi trong quá trình kiểm thử.

Việc 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 khiến việc 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 đó, bài kiểm thử của bạn có thể thực hiện các thao tác với tư cách là 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 đúng các trường hợp khác nhau.