/usr/lib/ruby/vendor_ruby/rspec/core/reporter.rb is in ruby-rspec-core 3.7.0c1e0m0s1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | module RSpec::Core
# A reporter will send notifications to listeners, usually formatters for the
# spec suite run.
class Reporter
# @private
RSPEC_NOTIFICATIONS = Set.new(
[
:close, :deprecation, :deprecation_summary, :dump_failures, :dump_pending,
:dump_profile, :dump_summary, :example_failed, :example_group_finished,
:example_group_started, :example_passed, :example_pending, :example_started,
:message, :seed, :start, :start_dump, :stop, :example_finished
])
def initialize(configuration)
@configuration = configuration
@listeners = Hash.new { |h, k| h[k] = Set.new }
@examples = []
@failed_examples = []
@pending_examples = []
@duration = @start = @load_time = nil
@non_example_exception_count = 0
@setup_default = lambda {}
@setup = false
end
# @private
attr_reader :examples, :failed_examples, :pending_examples
# @private
def setup_profiler
@profiler = Profiler.new
register_listener @profiler, *Profiler::NOTIFICATIONS
end
# Registers a listener to a list of notifications. The reporter will send
# notification of events to all registered listeners.
#
# @param listener [Object] An obect that wishes to be notified of reporter
# events
# @param notifications [Array] Array of symbols represents the events a
# listener wishes to subscribe too
def register_listener(listener, *notifications)
notifications.each do |notification|
@listeners[notification.to_sym] << listener
end
true
end
# @private
def prepare_default(loader, output_stream, deprecation_stream)
@setup_default = lambda do
loader.setup_default output_stream, deprecation_stream
end
end
# @private
def registered_listeners(notification)
@listeners[notification].to_a
end
# @overload report(count, &block)
# @overload report(count, &block)
# @param expected_example_count [Integer] the number of examples being run
# @yield [Block] block yields itself for further reporting.
#
# Initializes the report run and yields itself for further reporting. The
# block is required, so that the reporter can manage cleaning up after the
# run.
#
# @example
#
# reporter.report(group.examples.size) do |r|
# example_groups.map {|g| g.run(r) }
# end
#
def report(expected_example_count)
start(expected_example_count)
begin
yield self
ensure
finish
end
end
# @private
def start(expected_example_count, time=RSpec::Core::Time.now)
@start = time
@load_time = (@start - @configuration.start_time).to_f
notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)
end
# @param message [#to_s] A message object to send to formatters
#
# Send a custom message to supporting formatters.
def message(message)
notify :message, Notifications::MessageNotification.new(message)
end
# @param event [Symbol] Name of the custom event to trigger on formatters
# @param options [Hash] Hash of arguments to provide via `CustomNotification`
#
# Publish a custom event to supporting registered formatters.
# @see RSpec::Core::Notifications::CustomNotification
def publish(event, options={})
if RSPEC_NOTIFICATIONS.include? event
raise "RSpec::Core::Reporter#publish is intended for sending custom " \
"events not internal RSpec ones, please rename your custom event."
end
notify event, Notifications::CustomNotification.for(options)
end
# @private
def example_group_started(group)
notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
end
# @private
def example_group_finished(group)
notify :example_group_finished, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
end
# @private
def example_started(example)
@examples << example
notify :example_started, Notifications::ExampleNotification.for(example)
end
# @private
def example_finished(example)
notify :example_finished, Notifications::ExampleNotification.for(example)
end
# @private
def example_passed(example)
notify :example_passed, Notifications::ExampleNotification.for(example)
end
# @private
def example_failed(example)
@failed_examples << example
notify :example_failed, Notifications::ExampleNotification.for(example)
end
# @private
def example_pending(example)
@pending_examples << example
notify :example_pending, Notifications::ExampleNotification.for(example)
end
# @private
def deprecation(hash)
notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)
end
# @private
# Provides a way to notify of an exception that is not tied to any
# particular example (such as an exception encountered in a :suite hook).
# Exceptions will be formatted the same way they normally are.
def notify_non_example_exception(exception, context_description)
@configuration.world.non_example_failure = true
@non_example_exception_count += 1
example = Example.new(AnonymousExampleGroup, context_description, {})
presenter = Formatters::ExceptionPresenter.new(exception, example, :indentation => 0)
message presenter.fully_formatted(nil)
end
# @private
def finish
close_after do
stop
notify :start_dump, Notifications::NullNotification
notify :dump_pending, Notifications::ExamplesNotification.new(self)
notify :dump_failures, Notifications::ExamplesNotification.new(self)
notify :deprecation_summary, Notifications::NullNotification
unless mute_profile_output?
notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples,
@configuration.profile_examples,
@profiler.example_groups)
end
notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,
@pending_examples, @load_time,
@non_example_exception_count)
notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
end
end
# @private
def close_after
yield
ensure
close
end
# @private
def stop
@duration = (RSpec::Core::Time.now - @start).to_f if @start
notify :stop, Notifications::ExamplesNotification.new(self)
end
# @private
def notify(event, notification)
ensure_listeners_ready
registered_listeners(event).each do |formatter|
formatter.__send__(event, notification)
end
end
# @private
def abort_with(msg, exit_status)
message(msg)
close
exit!(exit_status)
end
# @private
def fail_fast_limit_met?
return false unless (fail_fast = @configuration.fail_fast)
if fail_fast == true
@failed_examples.any?
else
fail_fast <= @failed_examples.size
end
end
private
def ensure_listeners_ready
return if @setup
@setup_default.call
@setup = true
end
def close
notify :close, Notifications::NullNotification
end
def mute_profile_output?
# Don't print out profiled info if there are failures and `--fail-fast` is
# used, it just clutters the output.
!@configuration.profile_examples? || fail_fast_limit_met?
end
def seed_used?
@configuration.seed && @configuration.seed_used?
end
end
# @private
# # Used in place of a {Reporter} for situations where we don't want reporting output.
class NullReporter
def self.method_missing(*)
# ignore
end
private_class_method :method_missing
end
end
|