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 



90
91
92
 
# File 'lib/appmap/minitest.rb', line 90

def add_event_methods(event_methods)
  @event_methods += event_methods
end

.begin_test(test, name) ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/appmap/minitest.rb', line 72

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 



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

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

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


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

def enabled?
  AppMap.recording_enabled?(:minitest)
end

.end_test(test, exception:) ⇒ Object 



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

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

Returns:

  • (Boolean) 


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

def first_recording?
  @recording_count == 0
end

.init ⇒ Object 



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

def init
  FileUtils.mkdir_p APPMAP_OUTPUT_DIR
end

.metadata ⇒ Object 



16
17
18
 
# File 'lib/appmap/minitest.rb', line 16

def self.metadata
  AppMap.detect_metadata
end

.run ⇒ Object 



132
133
134
 
# File 'lib/appmap/minitest.rb', line 132

def run
  init
end

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



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

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',
      type: 'tests'
    }
    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), appmap)
end