Method: projects.test

string

Required. For tests against source, the resource name must refer to the project: Format: projects/{project_id}

{
  "testCases": [
    {
      object (TestCase)
    }
  ]
}

object (TestCase)

Collection of test cases associated with the TestSuite.

{
  "expectation": enum (Expectation),
  "request": value,
  "resource": value,
  "functionMocks": [
    {
      object (FunctionMock)
    }
  ],
  "pathEncoding": enum (PathEncoding),
  "expressionReportLevel": enum (ExpressionReportLevel)
}

enum (Expectation)

Test expectation.

value (Value format)

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:

If the request value is not well-formed for the service, the request will be rejected as an invalid argument.

value (Value format)

Optional resource value as it appears in persistent storage before the request is fulfilled.

The resource type depends on the request.path value.

object (FunctionMock)

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

enum (PathEncoding)

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

enum (ExpressionReportLevel)

Specifies what should be included in the response.

{
  "function": string,
  "args": [
    {
      object (Arg)
    }
  ],
  "result": {
    object (Result)
  }
}

string

The name of the function.

The function name must match one provided by a service declaration.

object (Arg)

The list of Arg values to match. The order in which the arguments are provided is the order in which they must appear in the function invocation.

object (Result)

The mock result of the function call.

{

  // Union field type can be only one of the following:
  "exactValue": value,
  "anyValue": {
    object
  }
  // End of list of possible types for union field type.
}

value (Value format)

Argument exactly matches value provided.

object

Argument matches any value provided.

{

  // Union field type can be only one of the following:
  "value": value,
  "undefined": {
    object
  }
  // End of list of possible types for union field type.
}

value (Value format)

The result is an actual value. The type of the value must match that of the type declared by the service.

object

The result is undefined, meaning the result could not be computed.

{
  "sourcePosition": {
    object (SourcePosition)
  },
  "description": string,
  "severity": enum (Severity)
}

object (SourcePosition)

Position of the issue in the Source.

string

Short error description.

enum (Severity)

The severity of the issue.

{
  "fileName": string,
  "line": integer,
  "column": integer,
  "currentOffset": integer,
  "endOffset": integer
}

string

Name of the File.

integer

Line number of the source fragment. 1-based.

integer

First column on the source line associated with the source fragment.

integer

Start position relative to the beginning of the file.

integer

End position relative to the beginning of the file.

{
  "state": enum (State),
  "debugMessages": [
    string
  ],
  "errorPosition": {
    object (SourcePosition)
  },
  "functionCalls": [
    {
      object (FunctionCall)
    }
  ],
  "visitedExpressions": [
    {
      object (VisitedExpression)
    }
  ],
  "expressionReports": [
    {
      object (ExpressionReport)
    }
  ]
}

enum (State)

State of the test.

string

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"]

object (SourcePosition)

Position in the Source 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. errorPosition { line: 19 column: 37 }

object (FunctionCall)

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.

object (VisitedExpression)

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: <expr>
}

For a detailed report of the intermediate evaluation states, see the expressionReports field

object (ExpressionReport)

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 "visitedExpressions" field above. Literal expressions are omitted.

{
  "function": string,
  "args": [
    value
  ]
}

string

Name of the function invoked.

value (Value format)

The arguments that were provided to the function.

{
  "sourcePosition": {
    object (SourcePosition)
  },
  "value": value
}

object (SourcePosition)

Position in the Source where an expression was visited.

value (Value format)

The evaluated value for the visited expression, e.g. true/false

{
  "sourcePosition": {
    object (SourcePosition)
  },
  "values": [
    {
      object (ValueCount)
    }
  ],
  "children": [
    {
      object (ExpressionReport)
    }
  ]
}

object (SourcePosition)

Position of expression in original rules source.

object (ValueCount)

Values that this expression evaluated to when encountered.

object (ExpressionReport)

Subexpressions

{
  "value": value,
  "count": integer
}

value (Value format)

The return value of the expression

integer

The number of times that expression returned.