Class: Google::Apis::FirebaserulesV1::TestCase

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firebaserules_v1/classes.rb,
generated/google/apis/firebaserules_v1/representations.rb,
generated/google/apis/firebaserules_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TestCase

Returns a new instance of TestCase.



617
618
619
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 617

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#expectation ⇒ String

Test expectation. Corresponds to the JSON property expectation

Returns:

  • (String) 


571
572
573
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 571

def expectation
  @expectation
end

#expression_report_level ⇒ String

Specifies what should be included in the response. Corresponds to the JSON property expressionReportLevel

Returns:

  • (String) 


576
577
578
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 576

def expression_report_level
  @expression_report_level
end

#function_mocks ⇒ Array<Google::Apis::FirebaserulesV1::FunctionMock>

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

Returns:



583
584
585
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 583

def function_mocks
  @function_mocks
end

#path_encoding ⇒ String

Specifies whether paths (such as request.path) are encoded and how. Corresponds to the JSON property pathEncoding

Returns:

  • (String) 


588
589
590
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 588

def path_encoding
  @path_encoding
end

#request ⇒ Object

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<string, string> headers | map<string, string> method | string params | map<string, string> 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

Returns:

  • (Object) 


608
609
610
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 608

def request
  @request
end

#resource ⇒ Object

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

Returns:

  • (Object) 


615
616
617
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 615

def resource
  @resource
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



622
623
624
625
626
627
628
629
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 622

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