Class: Google::Apis::FirebaserulesV1::TestResult

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

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

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) ⇒ TestResult

Returns a new instance of TestResult.



688
689
690
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 688

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

Instance Attribute Details

#debug_messages ⇒ Array<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"] Corresponds to the JSON property debugMessages

Returns:

  • (Array<String>) 


644
645
646
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 644

def debug_messages
  @debug_messages
end

#error_position ⇒ Google::Apis::FirebaserulesV1::SourcePosition

Position in the Source content including its line, column number, and an index of the File in the Source message. Used for debug purposes. Corresponds to the JSON property errorPosition

Returns:



650
651
652
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 650

def error_position
  @error_position
end

#expression_reports ⇒ Array<Google::Apis::FirebaserulesV1::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 "visited_expressions" field above. Literal expressions are omitted. Corresponds to the JSON property expressionReports

Returns:



659
660
661
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 659

def expression_reports
  @expression_reports
end

#function_calls ⇒ Array<Google::Apis::FirebaserulesV1::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. Corresponds to the JSON property functionCalls

Returns:



667
668
669
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 667

def function_calls
  @function_calls
end

#state ⇒ String

State of the test. Corresponds to the JSON property state

Returns:

  • (String) 


672
673
674
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 672

def state
  @state
end

#visited_expressions ⇒ Array<Google::Apis::FirebaserulesV1::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 expression_reports field Corresponds to the JSON property visitedExpressions

Returns:



686
687
688
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 686

def visited_expressions
  @visited_expressions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



693
694
695
696
697
698
699
700
 
# File 'generated/google/apis/firebaserules_v1/classes.rb', line 693

def update!(**args)
  @debug_messages = args[:debug_messages] if args.key?(:debug_messages)
  @error_position = args[:error_position] if args.key?(:error_position)
  @expression_reports = args[:expression_reports] if args.key?(:expression_reports)
  @function_calls = args[:function_calls] if args.key?(:function_calls)
  @state = args[:state] if args.key?(:state)
  @visited_expressions = args[:visited_expressions] if args.key?(:visited_expressions)
end