TestCase

import type { TestCase } from "https://googleapis.deno.dev/v1/firebaserules:v1.ts";

TestCase messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the request, resource, and function_mocks to mock a function call to a service-provided function. The request object represents context present at request-time. The resource is the value of the target resource as it appears in persistent storage before the request is executed.

interface TestCase {

expectation?: "EXPECTATION_UNSPECIFIED" | "ALLOW" | "DENY";

expressionReportLevel?:

| "LEVEL_UNSPECIFIED"

| "NONE"

| "FULL"

| "VISITED";

functionMocks?: FunctionMock[];

pathEncoding?: "ENCODING_UNSPECIFIED" | "URL_ENCODED" | "PLAIN";

request?: any;

resource?: any;

}

§Properties

expectation?: "EXPECTATION_UNSPECIFIED" | "ALLOW" | "DENY"

[src]

Test expectation.

expressionReportLevel?: "LEVEL_UNSPECIFIED" | "NONE" | "FULL" | "VISITED"

[src]

Specifies what should be included in the response.

functionMocks?: FunctionMock[]

[src]

Optional function mocks for service-defined functions. If not set, any service defined function is expected to return an error, which may or may not influence the test outcome.

pathEncoding?: "ENCODING_UNSPECIFIED" | "URL_ENCODED" | "PLAIN"

[src]

Specifies whether paths (such as request.path) are encoded and how.

request?: any

[src]

Request context. The exact format of the request context is service-dependent. See the appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | string auth.token | map headers | map method | string params | map path | string time | google.protobuf.Timestamp If the request value is not well-formed for the service, the request will be rejected as an invalid argument.

resource?: any

[src]

Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the request.path value.