Module: AppMap::RSpec

Defined in:
lib/appmap/rspec.rb

Defined Under Namespace

Classes: Recording, ScopeExample, ScopeExampleGroup

Constant Summary collapse

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

Class Method Summary collapse

Class Method Details

.add_event_methods(event_methods) ⇒ Object 



188
189
190
 
# File 'lib/appmap/rspec.rb', line 188

def add_event_methods(event_methods)
  @event_methods += event_methods
end

.begin_spec(example) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/appmap/rspec.rb', line 163

def begin_spec(example)
  @recording_count += 1
  # Disable RSpec recording for RSwag, because all the action happens in the before block.
  # The example is empty except for assertions. So RSwag has its own recorder, and RSpec
  # recording is disabled so it won't clobber the AppMap with empty data.
  recording = if example.metadata[:appmap] == false || example.metadata[:rswag]
                :disabled
              else
                Recording.new(example)
              end

  @recordings_by_example[example] = recording
end

.config ⇒ Object 



184
185
186
 
# File 'lib/appmap/rspec.rb', line 184

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

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
 
# File 'lib/appmap/rspec.rb', line 230

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

.end_spec(example, exception:) ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/appmap/rspec.rb', line 177

def end_spec(example, exception:)
  recording = @recordings_by_example.delete(example)
  return warn "No recording found for #{example}" unless recording

  recording.finish example.execution_result.exception || exception, exception unless recording == :disabled
end

.first_recording? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/appmap/rspec.rb', line 159

def first_recording?
  @recording_count == 0
end

.init ⇒ Object 



155
156
157
 
# File 'lib/appmap/rspec.rb', line 155

def init
  FileUtils.mkdir_p APPMAP_OUTPUT_DIR
end

.metadata ⇒ Object 



13
14
15
 
# File 'lib/appmap/rspec.rb', line 13

def self.metadata
  AppMap.detect_metadata
end

.run ⇒ Object 



234
235
236
 
# File 'lib/appmap/rspec.rb', line 234

def run
  init
end

.save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:, frameworks: [], recorder: nil) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/appmap/rspec.rb', line 192

def save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:, frameworks: [],
         recorder: nil)
  metadata = AppMap::RSpec.metadata.tap do |m|
    m[:name] = name
    m[:source_location] = source_location
    m[:app] = AppMap.configuration.name
    m[:frameworks] ||= []
    m[:frameworks] << {
      name: 'rspec',
      version: Gem.loaded_specs['rspec-core']&.version&.to_s
    }
    m[:frameworks] += frameworks
    m[:recorder] = recorder || {
      name: 'rspec',
      type: 'tests'
    }
    m[:test_status] = test_status
    m[:test_failure] = test_failure if test_failure
    if exception
      m[:exception] = Util.format_exception(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