Module: AppMap::Minitest

Defined in:
lib/appmap/minitest.rb

Overview

Integration of AppMap with Minitest. When enabled with APPMAP=true, the AppMap tracer will be activated around each test.

Defined Under Namespace

Classes: Recording

Constant Summary collapse

APPMAP_OUTPUT_DIR = 
'tmp/appmap/minitest'
LOG = 
( ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true' )

Class Method Summary collapse

Class Method Details

.add_event_methods(event_methods) ⇒ Object 



86
87
88
 
# File 'lib/appmap/minitest.rb', line 86

def add_event_methods(event_methods)
  @event_methods += event_methods
end

.begin_test(test, name) ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/appmap/minitest.rb', line 68

def begin_test(test, name)
  AppMap.info 'Configuring AppMap recorder for Minitest' if first_recording?
  @recording_count += 1

  @recordings_by_test[test.object_id] = Recording.new(test, name)
end

.config ⇒ Object 



82
83
84
 
# File 'lib/appmap/minitest.rb', line 82

def config
  @config or raise "AppMap is not configured"
end

.enabled? ⇒ Boolean 



123
124
125
 
# File 'lib/appmap/minitest.rb', line 123

def enabled?
  ENV['APPMAP'] == 'true'
end

.end_test(test, exception:) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/appmap/minitest.rb', line 75

def end_test(test, exception:)
  recording = @recordings_by_test.delete(test.object_id)
  return warn "No recording found for #{test}" unless recording

  recording.finish exception
end

.first_recording? ⇒ Boolean 



64
65
66
 
# File 'lib/appmap/minitest.rb', line 64

def first_recording?
  @recording_count == 0
end

.init ⇒ Object 



60
61
62
 
# File 'lib/appmap/minitest.rb', line 60

def init
  FileUtils.mkdir_p APPMAP_OUTPUT_DIR
end

.metadata ⇒ Object 



12
13
14
 
# File 'lib/appmap/minitest.rb', line 12

def self.metadata
  AppMap.detect_metadata
end

.run ⇒ Object 



127
128
129
 
# File 'lib/appmap/minitest.rb', line 127

def run
  init
end

.save(name:, class_map:, source_location:, test_status:, exception:, events:) ⇒ Object 



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
 
# File 'lib/appmap/minitest.rb', line 90

def save(name:, class_map:, source_location:, test_status:, exception:, events:)
  metadata = AppMap::Minitest.metadata.tap do |m|
    m[:name] = name
    m[:source_location] = source_location
    m[:app] = AppMap.configuration.name
    m[:frameworks] ||= []
    m[:frameworks] << {
      name: 'minitest',
      version: Gem.loaded_specs['minitest']&.version&.to_s
    }
    m[:recorder] = {
      name: 'minitest'
    }
    m[:test_status] = test_status
    if exception
      m[:exception] = {
        class: exception.class.name,
        message: AppMap::Event::MethodEvent.display_string(exception.to_s)
      }
    end
  end

  appmap = {
    version: AppMap::APPMAP_FORMAT_VERSION,
    metadata: metadata,
    classMap: class_map,
    events: events
  }.compact
  fname = AppMap::Util.scenario_filename(name)

  AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
end