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
|
# frozen_string_literal: true
require "test_prof/memory_prof/tracker"
require "test_prof/memory_prof/printer"
module TestProf
# MemoryProf can help in detecting test examples causing memory spikes.
# It supports two metrics: RSS and allocations.
#
# Example:
#
# TEST_MEM_PROF='rss' rspec ...
# TEST_MEM_PROF='alloc' rspec ...
# TEST_MEM_PROF='gc' rspec ...
#
# By default MemoryProf shows the top 5 examples and groups (for RSpec) but you can
# set how many items to display with `TEST_MEM_PROF_COUNT`:
#
# TEST_MEM_PROF='rss' TEST_MEM_PROF_COUNT=10 rspec ...
#
# The examples block shows the amount of memory used by each example, and the groups
# block displays the memory allocated by other code defined in the groups. For example,
# RSpec groups may include heavy `before(:all)` (or `before_all`) setup blocks, so it is
# helpful to see which groups use the most amount of memory outside of their examples.
module MemoryProf
# MemoryProf configuration
class Configuration
MODES = %w[alloc rss gc].freeze
attr_reader :mode, :top_count
def initialize
self.mode = ENV["TEST_MEM_PROF"]
self.top_count = ENV["TEST_MEM_PROF_COUNT"]
end
def mode=(value)
@mode = MODES.include?(value) ? value.to_sym : :rss
end
def top_count=(value)
@top_count = value.to_i
@top_count = 5 unless @top_count.positive?
end
end
class << self
TRACKERS = {
alloc: AllocTracker,
rss: RssTracker,
gc: GCTracker
}.freeze
PRINTERS = {
alloc: AllocPrinter,
rss: RssPrinter,
gc: GCPrinter
}.freeze
def config
@config ||= Configuration.new
end
def configure
yield config
end
def tracker
tracker = TRACKERS[config.mode]
tracker.new(config.top_count)
end
def printer(tracker)
printer = PRINTERS[config.mode]
printer.new(tracker)
end
end
end
end
require "test_prof/memory_prof/rspec" if TestProf.rspec?
require "test_prof/memory_prof/minitest" if TestProf.minitest?
|
