1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
|
# frozen_string_literal: true
require 'cucumber/messages'
require 'cucumber/messages/helpers/time_conversion'
module Cucumber
module Core
module Test
module Result
TYPES = %i[failed ambiguous flaky skipped undefined pending passed unknown].freeze
STRICT_AFFECTED_TYPES = %i[flaky undefined pending].freeze
def self.ok?(type, strict: StrictConfiguration.new)
class_name = type.to_s.slice(0, 1).capitalize + type.to_s.slice(1..-1)
const_get(class_name).ok?(strict: strict.strict?(type))
end
# Defines to_sym on a result class for the given result type
#
# Defines predicate methods on a result class with only the given one returning true
def self.query_methods(result_type)
Module.new do
define_method :to_sym do
result_type
end
TYPES.each do |possible_result_type|
define_method("#{possible_result_type}?") do
possible_result_type == to_sym
end
end
end
end
# Null object for results. Represents the state where we haven't run anything yet
class Unknown
include Result.query_methods :unknown
def describe_to(_visitor, *_args)
self
end
def with_filtered_backtrace(_filter)
self
end
def to_message
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::UNKNOWN,
duration: UnknownDuration.new.to_message_duration
)
end
end
class Passed
include Result.query_methods :passed
attr_accessor :duration
def self.ok?(*)
true
end
def initialize(duration)
raise ArgumentError unless duration
@duration = duration
end
def describe_to(visitor, *)
visitor.passed(*)
visitor.duration(duration, *)
self
end
def to_s
'✓'
end
def to_message
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::PASSED,
duration: duration.to_message_duration
)
end
def ok?(*)
self.class.ok?
end
def with_appended_backtrace(_step)
self
end
def with_filtered_backtrace(_filter)
self
end
end
class Failed
include Result.query_methods :failed
attr_reader :duration, :exception
def self.ok?(*)
false
end
def initialize(duration, exception)
raise ArgumentError unless duration
raise ArgumentError unless exception
@duration = duration
@exception = exception
end
def describe_to(visitor, *)
visitor.failed(*)
visitor.duration(duration, *)
visitor.exception(exception, *) if exception
self
end
def to_s
'✗'
end
def to_message
begin
message = exception.backtrace.join("\n")
rescue NoMethodError
message = ''
end
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::FAILED,
duration: duration.to_message_duration,
message: message
)
end
def ok?(*)
self.class.ok?
end
def with_duration(new_duration)
self.class.new(new_duration, exception)
end
def with_appended_backtrace(step)
exception.backtrace << step.backtrace_line if step.respond_to?(:backtrace_line)
self
end
def with_filtered_backtrace(filter)
self.class.new(duration, filter.new(exception.dup).exception)
end
end
# Flaky is not used directly as an execution result, but is used as a
# reporting result type for test cases that fails and the passes on
# retry, therefore only the class method self.ok? is needed.
class Flaky
def self.ok?(strict: false)
!strict
end
end
# Base class for exceptions that can be raised in a step definition causing the step to have that result.
class Raisable < StandardError
attr_reader :message, :duration
def initialize(message = '', duration = UnknownDuration.new, backtrace = nil)
@message = message
@duration = duration
super(message)
set_backtrace(backtrace) if backtrace
end
def with_message(new_message)
self.class.new(new_message, duration, backtrace)
end
def with_duration(new_duration)
self.class.new(message, new_duration, backtrace)
end
def with_appended_backtrace(step)
return self unless step.respond_to?(:backtrace_line)
set_backtrace([]) unless backtrace
backtrace << step.backtrace_line
self
end
def with_filtered_backtrace(filter)
return self unless backtrace
filter.new(dup).exception
end
def ok?(strict: StrictConfiguration.new)
self.class.ok?(strict: strict.strict?(to_sym))
end
end
class Ambiguous < Raisable
include Result.query_methods :ambiguous
def self.ok?(*)
false
end
def describe_to(visitor, *)
visitor.ambiguous(*)
visitor.duration(duration, *)
self
end
def to_s
'A'
end
def to_message
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::AMBIGUOUS,
duration: duration.to_message_duration
)
end
end
class Undefined < Raisable
include Result.query_methods :undefined
def self.ok?(strict: false)
!strict
end
def describe_to(visitor, *)
visitor.undefined(*)
visitor.duration(duration, *)
self
end
def to_s
'?'
end
def to_message
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::UNDEFINED,
duration: duration.to_message_duration
)
end
end
class Skipped < Raisable
include Result.query_methods :skipped
def self.ok?(*)
true
end
def describe_to(visitor, *)
visitor.skipped(*)
visitor.duration(duration, *)
self
end
def to_s
'-'
end
def to_message
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::SKIPPED,
duration: duration.to_message_duration
)
end
end
class Pending < Raisable
include Result.query_methods :pending
def self.ok?(strict: false)
!strict
end
def describe_to(visitor, *)
visitor.pending(self, *)
visitor.duration(duration, *)
self
end
def to_s
'P'
end
def to_message
Cucumber::Messages::TestStepResult.new(
status: Cucumber::Messages::TestStepResultStatus::PENDING,
duration: duration.to_message_duration
)
end
end
# Handles the strict settings for the result types that are
# affected by the strict options (that is the STRICT_AFFECTED_TYPES).
class StrictConfiguration
attr_accessor :settings
private :settings
def initialize(strict_types = [])
@settings = STRICT_AFFECTED_TYPES.to_h { |t| [t, :default] }
strict_types.each do |type|
set_strict(true, type)
end
end
def strict?(type = nil)
if type.nil?
settings.each_value do |value|
return true if value == true
end
false
else
return false unless settings.key?(type)
return false unless set?(type)
settings[type]
end
end
def set_strict(setting, type = nil)
if type.nil?
STRICT_AFFECTED_TYPES.each { |type| set_strict(setting, type) }
else
settings[type] = setting
end
end
def merge!(other)
settings.each_key do |type|
set_strict(other.strict?(type), type) if other.set?(type)
end
self
end
def set?(type)
settings[type] != :default
end
end
#
# An object that responds to the description protocol from the results and collects summary information.
#
# e.g.
# summary = Result::Summary.new
# Result::Passed.new(0).describe_to(summary)
# puts summary.total_passed
# => 1
#
class Summary
attr_reader :exceptions, :durations
def initialize
@totals = Hash.new { 0 }
@exceptions = []
@durations = []
end
def method_missing(name, *_args)
if name =~ /^total_/
get_total(name)
else
increment_total(name)
end
end
def respond_to_missing?(*)
true
end
def ok?(strict: StrictConfiguration.new)
TYPES.each do |type|
return false if get_total(type).positive? && !Result.ok?(type, strict: strict)
end
true
end
def exception(exception)
@exceptions << exception
self
end
def duration(duration)
@durations << duration
self
end
def total(for_status = nil)
if for_status
@totals.fetch(for_status, 0)
else
@totals.values.reduce(0) { |total, count| total + count }
end
end
def decrement_failed
@totals[:failed] -= 1
end
private
def get_total(method_name)
status = method_name.to_s.gsub('total_', '').to_sym
@totals.fetch(status, 0)
end
def increment_total(status)
@totals[status] += 1
self
end
end
class Duration
include Cucumber::Messages::Helpers::TimeConversion
attr_reader :nanoseconds
def initialize(nanoseconds)
@nanoseconds = nanoseconds
end
def to_message_duration
duration_hash = seconds_to_duration(nanoseconds.to_f / NANOSECONDS_PER_SECOND)
Cucumber::Messages::Duration.new(seconds: duration_hash[:seconds], nanos: duration_hash[:nanos])
end
def seconds_to_duration(seconds_float)
seconds, second_modulus = seconds_float.divmod(1)
nanos = second_modulus * NANOSECONDS_PER_SECOND
{ seconds: seconds, nanos: nanos.to_i }
end
end
class UnknownDuration
def tap
self
end
def nanoseconds
raise '#nanoseconds only allowed to be used in #tap block'
end
def to_message_duration
Cucumber::Messages::Duration.new(seconds: 0, nanos: 0)
end
end
end
end
end
end
|