RulesTestEnvironment interface

Signature:

export interface RulesTestEnvironment 

Properties

Methods

RulesTestEnvironment.emulators

A readonly copy of the emulator config specified or discovered at test environment creation.

Signature:

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

RulesTestEnvironment.projectId

The project ID specified or discovered at test environment creation.

Signature:

readonly projectId: string;

RulesTestEnvironment.authenticatedContext()

Create a RulesTestContext which behaves like an authenticated Firebase Auth user.

Requests created via the returned context will have a mock Firebase Auth token attached.

Signature:

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

Parameters

Returns:

RulesTestContext

Example

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

RulesTestEnvironment.cleanup()

At the very end of your test code, call the cleanup function. Destroy all RulesTestContexts created in test environment and clean up the underlying resources, allowing a clean exit.

This method does not change the state in emulators in any way. To reset data between tests, see clearDatabase(), clearFirestore() and clearStorage().

Signature:

cleanup(): Promise<void>;

Returns:

Promise<void>

RulesTestEnvironment.clearDatabase()

Clear all data in the Realtime Database emulator namespace.

Signature:

clearDatabase(): Promise<void>;

Returns:

Promise<void>

RulesTestEnvironment.clearFirestore()

Clear data in the default Firestore database for projectId in the Firestore emulator.

Signature:

clearFirestore(): Promise<void>;

Returns:

Promise<void>

RulesTestEnvironment.clearStorage()

Clear Storage files and metadata in the active bucket in the Storage emulator.

Signature:

clearStorage(): Promise<void>;

Returns:

Promise<void>

RulesTestEnvironment.unauthenticatedContext()

Create a RulesTestContext which behaves like client that is NOT logged in via Firebase Auth.

Requests created via the returned context will not have Firebase Auth tokens attached.

Signature:

unauthenticatedContext(): RulesTestContext;

Returns:

RulesTestContext

Example

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

RulesTestEnvironment.withSecurityRulesDisabled()

Signature:

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

Parameters

Returns:

Promise<void>