Class: TestProf::EventProf::RSpecListener

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/test_prof/event_prof/rspec.rb

Overview

:nodoc:

Constant Summary collapse

NOTIFICATIONS = 
%i[
  example_group_started
  example_group_finished
  example_started
  example_finished
].freeze

Constants included from Logging

Logging::COLORS

Instance Method Summary collapse

Methods included from Logging

#build_log_msg, #colorize, #log

Constructor Details

#initialize ⇒ RSpecListener

Returns a new instance of RSpecListener.



20
21
22
23
24
 
# File 'lib/test_prof/event_prof/rspec.rb', line 20

def initialize
  @profiler = EventProf.build

  log :info, "EventProf enabled (#{@profiler.events.join(", ")})"
end

Instance Method Details

#example_finished(notification) ⇒ Object 



40
41
42
 
# File 'lib/test_prof/event_prof/rspec.rb', line 40

def example_finished(notification)
  @profiler.example_finished notification.example
end

#example_group_finished(notification) ⇒ Object 



31
32
33
34
 
# File 'lib/test_prof/event_prof/rspec.rb', line 31

def example_group_finished(notification)
  return unless notification.group.top_level?
  @profiler.group_finished notification.group
end

#example_group_started(notification) ⇒ Object 



26
27
28
29
 
# File 'lib/test_prof/event_prof/rspec.rb', line 26

def example_group_started(notification)
  return unless notification.group.top_level?
  @profiler.group_started notification.group
end

#example_started(notification) ⇒ Object 



36
37
38
 
# File 'lib/test_prof/event_prof/rspec.rb', line 36

def example_started(notification)
  @profiler.example_started notification.example
end

#print ⇒ Object 



44
45
46
 
# File 'lib/test_prof/event_prof/rspec.rb', line 44

def print
  @profiler.each(&method(:report))
end

#report(profiler) ⇒ Object 



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
 
# File 'lib/test_prof/event_prof/rspec.rb', line 48

def report(profiler)
  result = profiler.results
  time_percentage = time_percentage(profiler.total_time, profiler.absolute_run_time)

  msgs = []

  msgs <<
    <<~MSG
      EventProf results for #{profiler.event}

      Total time: #{profiler.total_time.duration} of #{profiler.absolute_run_time.duration} (#{time_percentage}%)
      Total events: #{profiler.total_count}

      Top #{profiler.top_count} slowest suites (by #{profiler.rank_by}):

    MSG

  result[:groups].each do |group|
    description = group[:id].top_level_description
    location = group[:id].metadata[:location]
    time = group[:time]
    run_time = group[:run_time]
    time_percentage = time_percentage(time, run_time)

    msgs <<
      <<~GROUP
        #{description.truncate} (#{location}) – #{time.duration} (#{group[:count]} / #{group[:examples]}) of #{run_time.duration} (#{time_percentage}%)
      GROUP
  end

  if result[:examples]
    msgs << "\nTop #{profiler.top_count} slowest tests (by #{profiler.rank_by}):\n\n"

    result[:examples].each do |example|
      description = example[:id].description
      location = example[:id].metadata[:location]
      time = example[:time]
      run_time = example[:run_time]
      time_percentage = time_percentage(time, run_time)

      msgs <<
        <<~GROUP
          #{description.truncate} (#{location}) – #{time.duration} (#{example[:count]}) of #{run_time.duration} (#{time_percentage}%)
        GROUP
    end
  end

  log :info, msgs.join

  stamp!(profiler) if EventProf.config.stamp?
end

#stamp!(profiler) ⇒ Object 



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
 
# File 'lib/test_prof/event_prof/rspec.rb', line 100

def stamp!(profiler)
  result = profiler.results

  stamper = RSpecStamp::Stamper.new

  examples = Hash.new { |h, k| h[k] = [] }

  (result[:groups].to_a + result.fetch(:examples, []).to_a)
    .map { |obj| obj[:id].metadata[:location] }.each do |location|
    file, line = location.split(":")
    examples[file] << line.to_i
  end

  examples.each do |file, lines|
    stamper.stamp_file(file, lines.uniq)
  end

  msgs = []

  msgs <<
    <<~MSG
      RSpec Stamp results

      Total patches: #{stamper.total}
      Total files: #{examples.keys.size}

      Failed patches: #{stamper.failed}
      Ignored files: #{stamper.ignored}
    MSG

  log :info, msgs.join
end

#time_percentage(time, total_time) ⇒ Object 



133
134
135
 
# File 'lib/test_prof/event_prof/rspec.rb', line 133

def time_percentage(time, total_time)
  (time / total_time * 100).round(2)
end