class Google::Apis::FirebaserulesV1::TestCase

`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.

Attributes

expectation[RW]

Test expectation. Corresponds to the JSON property `expectation` @return [String]

expression_report_level[RW]

Specifies what should be included in the response. Corresponds to the JSON property `expressionReportLevel` @return [String]

function_mocks[RW]

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. Corresponds to the JSON property `functionMocks` @return [Array<Google::Apis::FirebaserulesV1::FunctionMock>]

path_encoding[RW]

Specifies whether paths (such as request.path) are encoded and how. Corresponds to the JSON property `pathEncoding` @return [String]

request[RW]

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. Corresponds to the JSON property `request` @return [Object]

resource[RW]

Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the `request.path` value. Corresponds to the JSON property `resource` @return [Object]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/firebaserules_v1/classes.rb, line 576
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/firebaserules_v1/classes.rb, line 581
def update!(**args)
  @expectation = args[:expectation] if args.key?(:expectation)
  @expression_report_level = args[:expression_report_level] if args.key?(:expression_report_level)
  @function_mocks = args[:function_mocks] if args.key?(:function_mocks)
  @path_encoding = args[:path_encoding] if args.key?(:path_encoding)
  @request = args[:request] if args.key?(:request)
  @resource = args[:resource] if args.key?(:resource)
end