TestResult

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

Test result message containing the state of the test as well as a description and source position for test failures.

interface TestResult {

debugMessages?: string[];

errorPosition?: SourcePosition;

expressionReports?: ExpressionReport[];

functionCalls?: FunctionCall[];

state?: "STATE_UNSPECIFIED" | "SUCCESS" | "FAILURE";

visitedExpressions?: VisitedExpression[];

}

§Properties

debugMessages?: string[]

[src]

Debug messages related to test execution issues encountered during evaluation. Debug messages may be related to too many or too few invocations of function mocks or to runtime errors that occur during evaluation. For example: Unable to read variable [name: "resource"]

errorPosition?: SourcePosition

[src]

Position in the Source or Ruleset where the principle runtime error occurs. Evaluation of an expression may result in an error. Rules are deny by default, so a DENY expectation when an error is generated is valid. When there is a DENY with an error, the SourcePosition is returned. E.g. error_position { line: 19 column: 37 }

expressionReports?: ExpressionReport[]

[src]

The mapping from expression in the ruleset AST to the values they were evaluated to. Partially-nested to mirror AST structure. Note that this field is actually tracking expressions and not permission statements in contrast to the "visited_expressions" field above. Literal expressions are omitted.

functionCalls?: FunctionCall[]

[src]

The set of function calls made to service-defined methods. Function calls are included in the order in which they are encountered during evaluation, are provided for both mocked and unmocked functions, and included on the response regardless of the test state.

state?: "STATE_UNSPECIFIED" | "SUCCESS" | "FAILURE"

[src]

State of the test.

visitedExpressions?: VisitedExpression[]

[src]

The set of visited permission expressions for a given test. This returns the positions and evaluation results of all visited permission expressions which were relevant to the test case, e.g. match /path { allow read if: } For a detailed report of the intermediate evaluation states, see the expression_reports field