View Source GoogleApi.FirebaseRules.V1.Model.TestCase (google_api_firebase_rules v0.16.3)

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.


  • expectation (type: String.t, default: nil) - Test expectation.
  • expressionReportLevel (type: String.t, default: nil) - Specifies what should be included in the response.
  • functionMocks (type: list(GoogleApi.FirebaseRules.V1.Model.FunctionMock.t), default: nil) - 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 (type: String.t, default: nil) - Specifies whether paths (such as request.path) are encoded and how.
  • request (type: any(), default: nil) - 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 (type: any(), default: nil) - Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the request.path value.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.FirebaseRules.V1.Model.TestCase{
  expectation: String.t() | nil,
  expressionReportLevel: String.t() | nil,
  functionMocks: [GoogleApi.FirebaseRules.V1.Model.FunctionMock.t()] | nil,
  pathEncoding: String.t() | nil,
  request: any() | nil,
  resource: any() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.