สร้างการทดสอบหน่วย

Firebase Local Emulator Suite ช่วยให้ตรวจสอบ คุณสมบัติและการทำงาน ของแอปของคุณอย่างสมบูรณ์ได้ง่ายขึ้น นอกจากนี้ยังเป็นเครื่องมือที่ยอดเยี่ยมสำหรับการตรวจสอบการกำหนดค่ากฎความปลอดภัยของ Firebase ใช้ Firebase Emulators เพื่อเรียกใช้และทำการทดสอบหน่วยโดยอัตโนมัติในสภาพแวดล้อมภายในเครื่อง วิธีการที่ระบุไว้ในเอกสารนี้จะช่วยคุณในการสร้างและทำให้การทดสอบหน่วยเป็นอัตโนมัติสำหรับแอปของคุณที่ตรวจสอบกฎของคุณ

หากคุณยังไม่ได้ ตั้งค่า ให้ตั้งค่า Firebase Emulators

ก่อนที่คุณจะเรียกใช้โปรแกรมจำลอง

ก่อนที่คุณจะเริ่มใช้โปรแกรมจำลอง ให้คำนึงถึงสิ่งต่อไปนี้:

  • เริ่มแรก อีมูเลเตอร์จะโหลดกฎที่ระบุในฟิลด์ firestore.rules หรือ 'storage.rules' ของไฟล์ firebase.json ของคุณ หากไม่มีไฟล์และคุณไม่ได้ใช้ loadFirestoreRules หรือ 'loadStorageRules' ตามที่อธิบายไว้ด้านล่าง อีมูเลเตอร์จะถือว่าโปรเจ็กต์ทั้งหมดมีกฎแบบเปิด
  • แม้ว่า Firebase SDK ส่วนใหญ่ จะทำงานกับอีมูเลเตอร์โดยตรง มีเพียงไลบรารี @firebase/rules-unit-testing เท่านั้นที่รองรับการเยาะเย้ย auth ในกฎความปลอดภัย ทำให้การทดสอบหน่วยง่ายขึ้นมาก นอกจากนี้ ไลบรารียังสนับสนุนคุณลักษณะเฉพาะของโปรแกรมจำลองบางอย่าง เช่น การล้างข้อมูลทั้งหมด ตามรายการด้านล่าง
  • อีมูเลเตอร์ยังยอมรับโทเค็น Firebase Auth ที่ใช้งานจริงที่จัดหาให้ผ่าน Client SDK และประเมินกฎตามลำดับ ซึ่งช่วยให้เชื่อมต่อแอปพลิเคชันของคุณโดยตรงกับอีมูเลเตอร์ในการผสานรวมและการทดสอบด้วยตนเอง

ความแตกต่างระหว่างตัวจำลองฐานข้อมูลและการผลิต

  • คุณไม่จำเป็นต้องสร้างอินสแตนซ์ฐานข้อมูลอย่างชัดเจน โปรแกรมจำลองจะสร้างอินสแตนซ์ฐานข้อมูลที่เข้าถึงได้โดยอัตโนมัติ
  • ฐานข้อมูลใหม่แต่ละฐานข้อมูลเริ่มต้นด้วยกฎแบบปิด ดังนั้นผู้ใช้ที่ไม่ใช่ผู้ดูแลระบบจะไม่สามารถอ่านหรือเขียนได้
  • ฐานข้อมูลที่จำลองแต่ละฐานข้อมูลจะใช้ขีดจำกัดและโควต้าของ แผน Spark (ที่โดดเด่นที่สุดคือ การจำกัดแต่ละอินสแตนซ์ไว้ที่ 100 การเชื่อมต่อพร้อมกัน)
  • ฐานข้อมูลใด ๆ จะยอมรับสตริง "owner" เป็นโทเค็นการตรวจสอบสิทธิ์ของผู้ดูแลระบบ
  • ขณะนี้อีมูเลเตอร์ไม่มีการโต้ตอบกับผลิตภัณฑ์ Firebase อื่นๆ โดยเฉพาะอย่างยิ่ง โฟลว์การตรวจสอบสิทธิ์ Firebase ปกติไม่ทำงาน คุณสามารถใช้เมธอด initializeTestApp() ในไลบรารี rules-unit-testing ซึ่งใช้ฟิลด์ auth แทน ออบเจ็กต์ Firebase ที่สร้างขึ้นโดยใช้เมธอดนี้ทำงานเหมือนกับว่าได้ตรวจสอบสิทธิ์เรียบร้อยแล้วว่าเป็นเอนทิตีใดก็ตามที่คุณระบุ หากคุณส่งผ่าน null มันจะทำงานเป็นผู้ใช้ที่ไม่ผ่านการตรวจสอบสิทธิ์ ( auth != null จะล้มเหลว เป็นต้น)

การโต้ตอบกับโปรแกรมจำลองฐานข้อมูลเรียลไทม์

อินสแตนซ์ฐานข้อมูลเรียลไทม์ของ Firebase ที่ใช้งานจริงสามารถเข้าถึงได้ที่โดเมนย่อยของ firebaseio.com และคุณสามารถเข้าถึง REST api ได้ดังนี้:

https://<database_name>.firebaseio.com/path/to/my/data.json

อีมูเลเตอร์ทำงานแบบโลคัล และมีให้ที่ localhost:9000 ในการโต้ตอบกับอินสแตนซ์ฐานข้อมูลเฉพาะ คุณจะต้องใช้พารามิเตอร์การสืบค้น ns เพื่อระบุชื่อฐานข้อมูล

http://localhost:9000/path/to/my/data.json?ns=<database_name>

เรียกใช้การทดสอบหน่วยในพื้นที่ด้วย JavaScript SDK เวอร์ชัน 9

Firebase เผยแพร่ไลบรารีการทดสอบหน่วยกฎความปลอดภัยด้วย JavaScript SDK เวอร์ชัน 9 และ SDK เวอร์ชัน 8 API ของไลบรารีนั้นแตกต่างกันอย่างมาก เราขอแนะนำไลบรารีการทดสอบ v9 ซึ่งมีความคล่องตัวมากกว่าและต้องการการตั้งค่าน้อยกว่าเพื่อเชื่อมต่อกับอีมูเลเตอร์ ดังนั้นจึงหลีกเลี่ยงการใช้ทรัพยากรการผลิตโดยไม่ได้ตั้งใจได้อย่างปลอดภัย สำหรับความเข้ากันได้แบบย้อนหลัง เรายังคงทำให้ ไลบรารีการทดสอบ v8 พร้อมใช้งาน

ใช้โมดูล @firebase/rules-unit-testing เพื่อโต้ตอบกับโปรแกรมจำลองที่ทำงานในเครื่อง หากคุณได้รับไทม์เอาต์หรือข้อผิดพลาด ECONNREFUSED ให้ตรวจสอบอีกครั้งว่าอีมูเลเตอร์กำลังทำงานอยู่จริง

เราขอแนะนำอย่างยิ่งให้ใช้ Node.js เวอร์ชันล่าสุด เพื่อให้คุณสามารถใช้สัญลักษณ์ async/await ลักษณะการทำงานเกือบทั้งหมดที่คุณอาจต้องการทดสอบเกี่ยวข้องกับฟังก์ชันแบบอะซิงโครนัส และโมดูลการทดสอบได้รับการออกแบบให้ทำงานกับโค้ดแบบ Promise

ไลบรารีการทดสอบหน่วยกฎ v9 จะรับรู้ถึงอีมูเลเตอร์เสมอและจะไม่แตะต้องทรัพยากรการผลิตของคุณ

คุณนำเข้าไลบรารีโดยใช้คำสั่งการนำเข้าโมดูลาร์ v9 ตัวอย่างเช่น:

import {
  assertFails,
  assertSucceeds,
  initializeTestEnvironment,
  RulesTestEnvironment,
} 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.

เมื่อนำเข้าแล้ว การดำเนินการทดสอบหน่วยจะเกี่ยวข้องกับ:

  • การสร้างและกำหนดค่า RulesTestEnvironment ด้วยการเรียก initializeTestEnvironment
  • การตั้งค่าข้อมูลทดสอบโดยไม่เรียกใช้กฎ โดยใช้วิธีอำนวยความสะดวกที่อนุญาตให้คุณข้ามกฎได้ชั่วคราว RulesTestEnvironment.withSecurityRulesDisabled
  • การตั้งค่าชุดทดสอบและต่อการทดสอบก่อน/หลัง hooks พร้อมการเรียกเพื่อล้างข้อมูลการทดสอบและสภาพแวดล้อม เช่น RulesTestEnvironment.cleanup() หรือ RulesTestEnvironment.clearFirestore()
  • การใช้กรณีทดสอบที่เลียนแบบสถานะการตรวจสอบสิทธิ์โดยใช้ RulesTestEnvironment.authenticatedContext และ RulesTestEnvironment.unauthenticatedContext

วิธีการทั่วไปและฟังก์ชั่นยูทิลิตี้

โปรดดู วิธีทดสอบเฉพาะโปรแกรมจำลองใน v9 SDK

initializeTestEnvironment() => RulesTestEnvironment

ฟังก์ชันนี้เริ่มต้นสภาพแวดล้อมการทดสอบสำหรับการทดสอบหน่วยกฎ เรียกใช้ฟังก์ชันนี้ก่อนสำหรับการตั้งค่าการทดสอบ การดำเนินการที่ประสบความสำเร็จต้องใช้โปรแกรมจำลองการทำงาน

ฟังก์ชันยอมรับอ็อบเจ็กต์ทางเลือกที่กำหนด TestEnvironmentConfig ซึ่งสามารถประกอบด้วย ID โปรเจ็กต์และการตั้งค่าคอนฟิกูเรชันอีมูเลเตอร์

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

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

เมธอดนี้จะสร้าง RulesTestContext ซึ่งทำงานเหมือนกับผู้ใช้ Authentication คำขอที่สร้างผ่านบริบทที่ส่งคืนจะมีโทเค็นการตรวจสอบสิทธิ์จำลองที่แนบมาด้วย หรือส่งผ่านอ็อบเจ็กต์ที่กำหนดการอ้างสิทธิ์หรือการแทนที่แบบกำหนดเองสำหรับเพย์โหลดโทเค็นการตรวจสอบสิทธิ์

ใช้อ็อบเจ็กต์บริบทการทดสอบที่ส่งคืนในการทดสอบของคุณเพื่อเข้าถึงอินสแตนซ์อีมูเลเตอร์ที่กำหนดค่าไว้ รวมถึงอินสแตนซ์ที่กำหนดค่าด้วย 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

เมธอดนี้จะสร้าง RulesTestContext ซึ่งทำงานเหมือนกับไคลเอนต์ที่ไม่ได้เข้าสู่ระบบผ่านการตรวจสอบสิทธิ์ คำขอที่สร้างผ่านบริบทที่ส่งคืนจะไม่มีการแนบโทเค็น Firebase Auth

ใช้อ็อบเจ็กต์บริบทการทดสอบที่ส่งคืนในการทดสอบของคุณเพื่อเข้าถึงอินสแตนซ์อีมูเลเตอร์ที่กำหนดค่าไว้ รวมถึงอินสแตนซ์ที่กำหนดค่าด้วย 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()

เรียกใช้ฟังก์ชันการตั้งค่าการทดสอบด้วยบริบทที่ทำงานเหมือนกับว่ากฎความปลอดภัยถูกปิดใช้งาน

เมธอดนี้ใช้ฟังก์ชันเรียกกลับ ซึ่งใช้บริบทการข้ามกฎความปลอดภัยและส่งคืนสัญญา บริบทจะถูกทำลายเมื่อคำสัญญาได้รับการแก้ไข/ปฏิเสธ

RulesTestEnvironment.cleanup()

เมธอดนี้ทำลาย RulesTestContexts ทั้งหมดที่สร้างขึ้นในสภาพแวดล้อมการทดสอบและล้างทรัพยากรพื้นฐาน อนุญาตให้ออกจากระบบได้อย่างสมบูรณ์

วิธีนี้ไม่ได้เปลี่ยนสถานะของอีมูเลเตอร์แต่อย่างใด หากต้องการรีเซ็ตข้อมูลระหว่างการทดสอบ ให้ใช้วิธีล้างข้อมูลเฉพาะโปรแกรมจำลองโปรแกรมจำลอง

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

นี่คือฟังก์ชันยูทิลิตี้กรณีทดสอบ

ฟังก์ชันนี้ยืนยันว่า Promise ที่ล้อมรอบการดำเนินการจำลองจะได้รับการแก้ไขโดยไม่มีการละเมิดกฎความปลอดภัย

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

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

นี่คือฟังก์ชันยูทิลิตี้กรณีทดสอบ

ฟังก์ชันนี้ยืนยันว่า Promise ที่ล้อมรอบการดำเนินการจำลองจะถูกปฏิเสธโดยมีการละเมิดกฎความปลอดภัย

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

วิธีการจำเพาะของโปรแกรมจำลอง

โปรดดู วิธีการทดสอบทั่วไปและฟังก์ชันยูทิลิตี้ใน v9 SDK

Cloud Firestore

Cloud Firestore

RulesTestEnvironment.clearFirestore() => Promise<void>

วิธีนี้จะล้างข้อมูลในฐานข้อมูล Firestore ที่เป็นของ projectId ที่กำหนดค่าไว้สำหรับตัวจำลอง Firestore

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

เมธอดนี้รับอินสแตนซ์ Firestore สำหรับบริบทการทดสอบนี้ อินสแตนซ์ Firebase JS Client SDK ที่ส่งคืนสามารถใช้กับไคลเอ็นต์ SDK API (v9 modular หรือ v9 compat)

ฐานข้อมูลเรียลไทม์

ฐานข้อมูลเรียลไทม์

RulesTestEnvironment.clearDatabase() => Promise<void>

วิธีนี้จะล้างข้อมูลใน Realtime Database ที่เป็นของ projectId ที่กำหนดค่าไว้สำหรับโปรแกรมจำลอง Realtime Database

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

รับอินสแตนซ์ฐานข้อมูลเรียลไทม์สำหรับบริบทการทดสอบนี้ อินสแตนซ์ Firebase JS Client SDK ที่ส่งคืนสามารถใช้กับไคลเอ็นต์ SDK API (v9 modular หรือ v9 compat) เมธอดยอมรับ URL ของอินสแตนซ์ฐานข้อมูลเรียลไทม์ หากระบุไว้ ส่งคืนอินสแตนซ์สำหรับเนมสเปซเวอร์ชันจำลองพร้อมพารามิเตอร์ที่แยกจาก URL

การจัดเก็บเมฆ

การจัดเก็บเมฆ

RulesTestEnvironment.clearStorage() => Promise<void>

เมธอดนี้จะล้างออบเจ็กต์และข้อมูลเมตาในบัคเก็ตพื้นที่เก็บข้อมูลที่เป็นของ projectId ที่กำหนดค่าไว้สำหรับโปรแกรมจำลอง Cloud Storage

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

เมธอดนี้ส่งคืนอินสแตนซ์ Storage ที่กำหนดค่าให้เชื่อมต่อกับอีมูเลเตอร์ เมธอดยอมรับ gs:// url ไปยัง Firebase Storage Bucket สำหรับการทดสอบ หากระบุไว้ ส่งคืนอินสแตนซ์ Storage สำหรับชื่อบัคเก็ตเวอร์ชันจำลอง

รันการทดสอบหน่วยในพื้นที่ด้วย v8 JavaScript SDK

เลือกผลิตภัณฑ์เพื่อดูวิธีการที่ Firebase Test SDK ใช้ในการเชื่อมต่อกับโปรแกรมจำลอง

Cloud Firestore

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

เมธอดนี้ส่งคืนแอป 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

ใช้สิ่งนี้เพื่อสร้างแอพที่รับรองความถูกต้องเป็นผู้ใช้เฉพาะเพื่อใช้ในการทดสอบ

ส่งคืนแอพ firebase ที่เริ่มต้นซึ่งสอดคล้องกับชื่อฐานข้อมูลและการแทนที่ตัวแปร auth ที่ระบุในตัวเลือก

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

initializeAdminApp({ databaseName: string }) => FirebaseApp

ใช้สิ่งนี้เพื่อสร้างแอปที่รับรองความถูกต้องในฐานะผู้ดูแลระบบเพื่อตั้งค่าสถานะสำหรับการทดสอบ

ส่งคืนแอป firebase ผู้ดูแลระบบเริ่มต้นที่สอดคล้องกับชื่อฐานข้อมูลที่ระบุในตัวเลือก แอพนี้ข้ามกฎความปลอดภัยเมื่ออ่านและเขียนไปยังฐานข้อมูล

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

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

ใช้สิ่งนี้เพื่อกำหนดกฎของฐานข้อมูลของคุณ

ส่งกฎไปยังฐานข้อมูลที่ทำงานอยู่ในเครื่อง ใช้อ็อบเจ็กต์ตัวเลือกที่ระบุ "databaseName" และ "rules" ของคุณเป็นสตริง

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

ใช้สิ่งนี้เพื่อสร้างแอพที่รับรองความถูกต้องเป็นผู้ใช้เฉพาะเพื่อใช้ในการทดสอบ

ส่งคืนแอป firebase ที่เริ่มต้นซึ่งสอดคล้องกับชื่อที่เก็บข้อมูลของที่เก็บข้อมูลและการแทนที่ตัวแปร auth ที่ระบุในตัวเลือก

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" และ "กฎ" ของคุณเป็นสตริง

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());

API ไลบรารี RUT สำหรับ JS SDK v8

เลือกผลิตภัณฑ์เพื่อดูวิธีการที่ Firebase Test SDK ใช้ในการเชื่อมต่อกับโปรแกรมจำลอง

Cloud Firestore

Cloud Firestore

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

เมธอดนี้ส่งคืนแอป 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

ใช้สิ่งนี้เพื่อสร้างแอพที่รับรองความถูกต้องเป็นผู้ใช้เฉพาะเพื่อใช้ในการทดสอบ

ส่งคืนแอพ firebase ที่เริ่มต้นซึ่งสอดคล้องกับชื่อฐานข้อมูลและการแทนที่ตัวแปร auth ที่ระบุในตัวเลือก

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

initializeAdminApp({ databaseName: string }) => FirebaseApp

ใช้สิ่งนี้เพื่อสร้างแอปที่รับรองความถูกต้องในฐานะผู้ดูแลระบบเพื่อตั้งค่าสถานะสำหรับการทดสอบ

ส่งคืนแอป firebase ผู้ดูแลระบบเริ่มต้นที่สอดคล้องกับชื่อฐานข้อมูลที่ระบุในตัวเลือก แอพนี้ข้ามกฎความปลอดภัยเมื่ออ่านและเขียนไปยังฐานข้อมูล

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

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

ใช้สิ่งนี้เพื่อกำหนดกฎของฐานข้อมูลของคุณ

ส่งกฎไปยังฐานข้อมูลที่ทำงานอยู่ในเครื่อง ใช้อ็อบเจ็กต์ตัวเลือกที่ระบุ "databaseName" และ "rules" ของคุณเป็นสตริง

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

ใช้สิ่งนี้เพื่อสร้างแอพที่รับรองความถูกต้องเป็นผู้ใช้เฉพาะเพื่อใช้ในการทดสอบ

ส่งคืนแอป firebase ที่เริ่มต้นซึ่งสอดคล้องกับชื่อที่เก็บข้อมูลของที่เก็บข้อมูลและการแทนที่ตัวแปร auth ที่ระบุในตัวเลือก

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" และ "กฎ" ของคุณเป็นสตริง

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());