Antarmuka RulesTestEnvironment

Tanda Tangan:

export interface RulesTestEnvironment 

Properti

Metode

RulesTestEnvironment.emulators

Salinan hanya baca dari konfigurasi emulator yang ditentukan atau ditemukan saat pembuatan lingkungan pengujian.

Tanda Tangan:

readonly emulators: {
        database?: HostAndPort;
        firestore?: HostAndPort;
        storage?: HostAndPort;
    };

RulesTestEnvironment.projectId

Project ID yang ditentukan atau ditemukan saat pembuatan lingkungan pengujian.

Tanda Tangan:

readonly projectId: string;

RulesTestEnvironment.authenticatedContext()

Buat RulesTestContext yang berperilaku seperti pengguna Firebase Auth yang diautentikasi.

Permintaan yang dibuat melalui konteks yang ditampilkan akan memiliki token Firebase Auth tiruan yang dilampirkan.

Tanda Tangan:

authenticatedContext(user_id: string, tokenOptions?: TokenOptions): RulesTestContext;

Parameter

Hasil:

RulesTestContext

Contoh

const alice = testEnv.authenticatedContext('alice');
await assertSucceeds(getDoc(alice.firestore(), '/doc/readable/by/alice'), { ... });

RulesTestEnvironment.cleanup()

Di bagian paling akhir dari kode pengujian Anda, panggil fungsi pembersihan. Hancurkan semua RulesTestContexts yang dibuat di lingkungan pengujian dan membersihkan resource yang mendasarinya, sehingga memungkinkan keluar secara bersih.

Metode ini tidak mengubah status di emulator dengan cara apa pun. Untuk mereset data di antara pengujian, lihat clearDatabase(), clearFirestore(), dan clearStorage().

Tanda Tangan:

cleanup(): Promise<void>;

Hasil:

Janji<void>

RulesTestEnvironment.clearDatabase()

Hapus semua data di namespace emulator Realtime Database.

Tanda Tangan:

clearDatabase(): Promise<void>;

Hasil:

Janji<void>

RulesTestEnvironment.clearFirestore()

Hapus data di database Firestore default untuk projectId di emulator Firestore.

Tanda Tangan:

clearFirestore(): Promise<void>;

Hasil:

Janji<void>

RulesTestEnvironment.clearStorage()

Menghapus metadata dan file Storage di bucket active di emulator Storage.

Tanda Tangan:

clearStorage(): Promise<void>;

Hasil:

Janji<void>

RulesTestEnvironment.unauthenticatedContext()

Buat RulesTestContext yang berperilaku seperti klien yang TIDAK login melalui Firebase Auth.

Permintaan yang dibuat melalui konteks yang ditampilkan tidak akan menyertakan token Firebase Auth.

Tanda Tangan:

unauthenticatedContext(): RulesTestContext;

Hasil:

RulesTestContext

Contoh

const unauthed = testEnv.unauthenticatedContext();
await assertFails(getDoc(unauthed.firestore(), '/private/doc'), { ... });

RulesTestEnvironment.withSecurityRulesDisabled()

Tanda Tangan:

withSecurityRulesDisabled(callback: (context: RulesTestContext) => Promise<void>): Promise<void>;

Parameter

Hasil:

Janji<void>