Tworzenie testów jednostkowych

Cloud Firestore

Cloud Firestore

RulesTestEnvironment.clearFirestore() => Promise<void>

Ta metoda usuwa w bazie danych Firestore dane, które należą do Uprawnienia projectId zostały skonfigurowane dla emulatora Firestore.

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

Ta metoda pobiera instancję Firestore na potrzeby tego kontekstu testowego. Zwrócone wartości Instancji pakietu SDK Firebase JS Client SDK można używać z interfejsami API pakietu SDK klienta (modułowa wersja 9) lub zgodnego z wersją 9).

Realtime Database

Realtime Database

RulesTestEnvironment.clearDatabase() => Promise<void>

Ta metoda usuwa dane w Realtime Database należące do projectId skonfigurowanego dla emulatora Realtime Database.

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

Pobierz instancję Realtime Database dla tego kontekstu testowego. Zwrócony JS Firebase Instancji pakietu SDK klienta można używać z interfejsami API klienta pakietu SDK (modułowymi lub z przestrzenią nazw w wersji 9 lub nowszej). Metoda przyjmuje adres URL instancji bazy danych w czasie rzeczywistym. Jeśli jest określony, zwraca instancję emulowanej wersji przestrzeni nazw z parametrami wyodrębnionymi z adresu URL.

Cloud Storage

Cloud Storage

RulesTestEnvironment.clearStorage() => Promise<void>

Ta metoda usuwa obiekty i metadane w zasobnikach na dane należących do Ustawienie projectId zostało skonfigurowane dla emulatora Cloud Storage.

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

Ta metoda zwraca instancję Storage skonfigurowaną do połączenia z emulatorem. Metoda akceptuje adres URL gs:// do zasobnika Cloud Storage w celu przetestowania. Jeśli zwraca instancję Storage dla emulowanej wersji nazwy zasobnika.

Cloud Firestore

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

Ta metoda zwraca zainicjowaną aplikację Firebase odpowiadającą projektowi Identyfikator i zmienne uwierzytelniania określone w opcjach. Użyj tego, aby utworzyć aplikację uwierzytelnioną jako konkretny użytkownik do testów.

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

initializeAdminApp({ projectId: string }) => FirebaseApp

Ta metoda zwraca zainicjowaną aplikację Firebase dla administratora. Podczas odczytu i zapisu ta aplikacja pomija reguły zabezpieczeń. Użyj tego, aby utworzyć aplikację uwierzytelnioną jako administrator, aby ustawić stan testów.

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

apps() => [FirebaseApp] Ta metoda zwraca wszystkie obecnie zainicjowane aplikacje testowe i administracyjne. Za jego pomocą możesz wyczyścić aplikacje między testami lub po nich.

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

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

Ta metoda wysyła reguły do lokalnej bazy danych. Potrzebny jest obiekt który określa reguły w postaci ciągu znaków. Użyj tej metody, aby ustawić reguły dla swojej bazy danych.

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

assertFails(pr: Promise) => Promise

Ta metoda zwraca obietnicę, która jest odrzucana, jeśli dane wejściowe są poprawne lub które uda się w przypadku odrzucenia danych wejściowych. Służy do potwierdzenia, czy baza danych odczytywana lub nie można zapisać.

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

assertSucceeds(pr: Promise) => Promise

Ta metoda zwraca obietnicę, która jest spełniona, jeśli dane wejściowe są prawidłowe, i odrzucona, jeśli są odrzucone. Używaj go, aby stwierdzić, czy odczyt lub zapis bazy danych zakończył się powodzeniem.

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

clearFirestoreData({ projectId: string }) => Promise

Ta metoda usuwa wszystkie dane powiązane z konkretnym projektem w lokalnej instancji Firestore. Użyj tej metody, aby wyczyścić po testach.

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

Realtime Database

Realtime Database

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

Użyj tej opcji, aby utworzyć aplikację uwierzytelnioną jako określony użytkownik, która będzie używana w testach.

Zwraca zainicjowaną aplikację Firebase odpowiadającą nazwie bazy danych i uwierzytelnieniu zastąpienie zmiennej określone w opcjach.

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

initializeAdminApp({ databaseName: string }) => FirebaseApp

Użyj tej opcji, aby utworzyć aplikację uwierzytelnioną jako administrator, aby skonfigurować stan na potrzeby testów.

Zwraca zainicjowaną aplikację Firebase administratora odpowiadającą nazwie bazy danych określonej w opcjach. Ta aplikacja omija reguły zabezpieczeń podczas odczytu i zapisu do bazy danych.

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

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

Służy do ustawiania reguł bazy danych.

Wysyła reguły do lokalnej bazy danych. Pobiera obiekt opcji, który określa bazę danych „databaseName” i „reguły”, jako struny.

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

apps() => [FirebaseApp]

Zwraca wszystkie obecnie zainicjowane aplikacje testowe i administracyjne.

Użyj tej opcji, aby wyczyścić aplikacje między testami lub po ich zakończeniu (pamiętaj, że zainicjowane aplikacje z aktywnymi detektorami uniemożliwiają zamknięcie JavaScriptu):

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

assertFails(pr: Promise) => Promise

Zwraca obietnicę, która jest odrzucona, jeśli dane wejściowe są poprawne, i akceptowana, jeśli dane wejściowe zostały odrzucone.

Użyj go, aby zapewnić, że odczyt lub zapis bazy danych nie powiódł się:

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

assertSucceeds(pr: Promise) => Promise

Zwraca obietnicę, która jest skuteczna, jeśli dane wejściowe są spełnione, i jest odrzucana, jeśli dane wejściowe zostaną odrzucone.

Służy do potwierdzenia, że odczyt lub zapis bazy danych zakończył się powodzeniem:

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

Cloud Storage

Cloud Storage

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

Użyj tego pola, aby utworzyć aplikację uwierzytelnioną jako określony użytkownik do wykorzystania w testach.

Zwraca zainicjowaną aplikację Firebase odpowiadającą nazwie zasobnika na dane i zastąpienie zmiennej uwierzytelniania określone w opcjach.

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

initializeAdminApp({ storageBucket: string }) => FirebaseApp

Utwórz aplikację uwierzytelnioną jako administrator, aby skonfigurować stan na potrzeby testów.

Zwraca zainicjowaną przez administratora aplikację Firebase odpowiadającą nazwie zasobnika pamięci podręcznej podanej w opcjach. Ta aplikacja omija reguły zabezpieczeń podczas odczytywania i zapisuje dane w zasobniku.

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

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

Użyj go do skonfigurowania reguł zasobnika pamięci.

Wysyła reguły do zasobników na dane zarządzanego lokalnie. Pobiera obiekt opcji, który określa Twój „storageBucket” i „reguły”, jako struny.

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

apps() => [FirebaseApp]

Zwraca wszystkie aktualnie zainicjowane aplikacje testowe i administracyjne.

Użyj tej opcji, aby wyczyścić aplikacje między testami lub po ich zakończeniu (pamiętaj, że zainicjowane aplikacje z aktywnymi detektorami uniemożliwiają zamknięcie JavaScriptu):

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

assertFails(pr: Promise) => Promise

Zwraca obietnicę, która jest odrzucana, jeśli dane wejściowe są poprawne, i akceptowana, jeśli dane wejściowe zostały odrzucone.

Użyj tego polecenia, aby sprawdzić, czy odczyt lub zapis zasobnika magazynu nie zakończył się niepowodzeniem:

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

assertSucceeds(pr: Promise) => Promise

Zwraca obietnicę, która jest skuteczna, jeśli dane wejściowe są spełnione, i jest odrzucana, jeśli dane wejściowe zostały odrzucone.

Służy do potwierdzenia, że odczyt lub zapis w zasobniku na dane zakończył się powodzeniem:

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

Cloud Firestore

Cloud Firestore

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

Ta metoda zwraca zainicjowaną aplikację Firebase odpowiadającą projektowi Identyfikator i zmienne uwierzytelniania określone w opcjach. Użyj tego, aby utworzyć aplikację uwierzytelnioną jako konkretny użytkownik do testów.

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

initializeAdminApp({ projectId: string }) => FirebaseApp

Ta metoda zwraca zainicjowaną aplikację Firebase dla administratora. Podczas odczytu i zapisu ta aplikacja pomija reguły zabezpieczeń. Użyj tego, aby utworzyć aplikację uwierzytelnioną jako administrator, aby ustawić stan testów.

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

apps() => [FirebaseApp] Ta metoda zwraca wszystkie obecnie zainicjowane aplikacje testowe i administracyjne. Za jego pomocą możesz wyczyścić aplikacje między testami lub po nich.

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

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

Ta metoda wysyła reguły do lokalnej bazy danych. Potrzebny jest obiekt który określa reguły w postaci ciągu znaków. Użyj tej metody, aby ustawić reguły dla swojej bazy danych.

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

assertFails(pr: Promise) => Promise

Ta metoda zwraca obietnicę, która jest odrzucana, jeśli dane wejściowe są poprawne lub które uda się w przypadku odrzucenia danych wejściowych. Służy do potwierdzenia, czy baza danych odczytywana lub nie można zapisać.

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

assertSucceeds(pr: Promise) => Promise

Ta metoda zwraca obietnicę, która jest spełniona, jeśli dane wejściowe są prawidłowe, i odrzucona, jeśli są odrzucone. Używaj go, aby stwierdzić, czy odczyt lub zapis bazy danych zakończył się powodzeniem.

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

clearFirestoreData({ projectId: string }) => Promise

Ta metoda usuwa wszystkie dane powiązane z konkretnym projektem w lokalnej instancji Firestore. Użyj tej metody, aby wyczyścić po testach.

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

Realtime Database

Realtime Database

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

Użyj tej opcji, aby utworzyć aplikację uwierzytelnioną jako określony użytkownik, która będzie używana w testach.

Zwraca zainicjowaną aplikację Firebase odpowiadającą nazwie bazy danych i uwierzytelnieniu zastąpienie zmiennej określone w opcjach.

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

initializeAdminApp({ databaseName: string }) => FirebaseApp

Użyj tej opcji, aby utworzyć aplikację uwierzytelnioną jako administrator, aby skonfigurować stan na potrzeby testów.

Zwraca zainicjowaną aplikację Firebase administratora odpowiadającą nazwie bazy danych określonej w opcjach. Ta aplikacja omija reguły zabezpieczeń podczas odczytu i zapisu do bazy danych.

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

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

Służy do ustawiania reguł bazy danych.

Wysyła reguły do lokalnej bazy danych. Pobiera obiekt opcji, który określa bazę danych „databaseName” i „reguły”, jako struny.

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

apps() => [FirebaseApp]

Zwraca wszystkie obecnie zainicjowane aplikacje testowe i administracyjne.

Użyj tej opcji, aby wyczyścić aplikacje między testami lub po ich zakończeniu (pamiętaj, że zainicjowane aplikacje z aktywnymi detektorami uniemożliwiają zamknięcie JavaScriptu):

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

assertFails(pr: Promise) => Promise

Zwraca obietnicę, która jest odrzucona, jeśli dane wejściowe są poprawne, i akceptowana, jeśli dane wejściowe zostały odrzucone.

Użyj go, aby zapewnić, że odczyt lub zapis bazy danych nie powiódł się:

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

assertSucceeds(pr: Promise) => Promise

Zwraca obietnicę, która jest skuteczna, jeśli dane wejściowe są spełnione, i jest odrzucana, jeśli dane wejściowe zostaną odrzucone.

Służy do potwierdzenia, że odczyt lub zapis bazy danych zakończył się powodzeniem:

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

Cloud Storage

Cloud Storage

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

Użyj tego pola, aby utworzyć aplikację uwierzytelnioną jako określony użytkownik do wykorzystania w testach.

Zwraca zainicjowaną aplikację Firebase odpowiadającą nazwie zasobnika na dane i zastąpienie zmiennej uwierzytelniania określone w opcjach.

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

initializeAdminApp({ storageBucket: string }) => FirebaseApp

Utwórz aplikację uwierzytelnioną jako administrator, aby skonfigurować stan na potrzeby testów.

Zwraca zainicjowaną przez administratora aplikację Firebase odpowiadającą nazwie zasobnika pamięci podręcznej podanej w opcjach. Ta aplikacja omija reguły zabezpieczeń podczas odczytywania i zapisuje dane w zasobniku.

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

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

Użyj go do skonfigurowania reguł zasobnika pamięci.

Wysyła reguły do zasobników na dane zarządzanego lokalnie. Pobiera obiekt opcji, który określa Twój „storageBucket” i „reguły”, jako struny.

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

apps() => [FirebaseApp]

Zwraca wszystkie aktualnie zainicjowane aplikacje testowe i administracyjne.

Użyj tej opcji, aby wyczyścić aplikacje między testami lub po ich zakończeniu (pamiętaj, że zainicjowane aplikacje z aktywnymi detektorami uniemożliwiają zamknięcie JavaScriptu):

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

assertFails(pr: Promise) => Promise

Zwraca obietnicę, która jest odrzucana, jeśli dane wejściowe są poprawne, i akceptowana, jeśli dane wejściowe zostały odrzucone.

Użyj tego polecenia, aby sprawdzić, czy odczyt lub zapis zasobnika magazynu nie zakończył się niepowodzeniem:

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

assertSucceeds(pr: Promise) => Promise

Zwraca obietnicę, która jest skuteczna, jeśli dane wejściowe są spełnione, i jest odrzucana, jeśli dane wejściowe zostały odrzucone.

Służy do potwierdzenia, że odczyt lub zapis w zasobniku na dane zakończył się powodzeniem:

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