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 



88
89
90
 
# File 'lib/appmap/minitest.rb', line 88

def add_event_methods(event_methods)
  @event_methods += event_methods
end

.begin_test(test, name) ⇒ Object 



70
71
72
73
74
75
 
# File 'lib/appmap/minitest.rb', line 70

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 



84
85
86
 
# File 'lib/appmap/minitest.rb', line 84

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

.enabled? ⇒ Boolean

Returns:



125
126
127
 
# File 'lib/appmap/minitest.rb', line 125

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

.end_test(test, exception:) ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/appmap/minitest.rb', line 77

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:



66
67
68
 
# File 'lib/appmap/minitest.rb', line 66

def first_recording?
  @recording_count == 0
end

.init ⇒ Object 



62
63
64
 
# File 'lib/appmap/minitest.rb', line 62

def init
  FileUtils.mkdir_p APPMAP_OUTPUT_DIR
end

.metadata ⇒ Object 



14
15
16
 
# File 'lib/appmap/minitest.rb', line 14

def self.metadata
  AppMap.detect_metadata
end

.run ⇒ Object 



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

def run
  init
end

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



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

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