Class: Kensho::Cucumber::Formatter

Inherits:
Object
  • Object
show all
Defined in:
lib/kensho/cucumber/formatter.rb

Constant Summary collapse

SEVERITY_TAGS = 
Kensho::Schema::SEVERITY.dup.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Formatter

Returns a new instance of Formatter.



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
 
# File 'lib/kensho/cucumber/formatter.rb', line 42

def initialize(config)
  @config = config
  @ast_lookup = nil
  if defined?(::Cucumber::Formatter::AstLookup)
    begin
      @ast_lookup = ::Cucumber::Formatter::AstLookup.new(config)
    rescue StandardError
      @ast_lookup = nil
    end
  end
  @output_dir = File.expand_path(ENV['KENSHO_OUTPUT'] || (defined?(Kensho::Cucumber::DEFAULT_OUTPUT) ? Kensho::Cucumber::DEFAULT_OUTPUT : 'kensho-results'))
  @cases_dir = File.join(@output_dir, 'cases')
  @attachments_dir = File.join(@output_dir, 'attachments')
  @project = {
    'name' => ENV['KENSHO_PROJECT_NAME'] || 'Unknown project',
    'slug' => ENV['KENSHO_PROJECT_SLUG'] || Kensho::Schema.slugify(ENV['KENSHO_PROJECT_NAME'] || 'unknown')
  }
  @run_id = ENV['KENSHO_RUN_ID'] || Kensho::Schema.default_run_id
  @started_at = Kensho::Schema.iso_now
  @started_perf = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  @rootpath = Dir.pwd
  @cases_by_id = {}
  @ids_seen = Hash.new(0)

  # Per-test-case scratch keyed by test_case (Cucumber's TestCase obj).
  @scratch = {}

  FileUtils.mkdir_p(@cases_dir)
  FileUtils.mkdir_p(@attachments_dir)

  bind_events!
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



40
41
42
 
# File 'lib/kensho/cucumber/formatter.rb', line 40

def config
  @config
end

Instance Method Details

#bind_events! ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/kensho/cucumber/formatter.rb', line 75

def bind_events!
  return unless @config.respond_to?(:on_event)

  @config.on_event(:test_case_started)  { |event| on_test_case_started(event) }
  @config.on_event(:test_step_finished) { |event| on_test_step_finished(event) }
  @config.on_event(:test_case_finished) { |event| on_test_case_finished(event) }
  @config.on_event(:test_run_finished)  { |_event| on_test_run_finished }
end

#cucumber_version ⇒ Object 



501
502
503
504
505
506
507
 
# File 'lib/kensho/cucumber/formatter.rb', line 501

def cucumber_version
  if defined?(::Cucumber::VERSION)
    ::Cucumber::VERSION.to_s
  else
    'unknown'
  end
end

#duration_ms_from_result(result) ⇒ Object 



458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/kensho/cucumber/formatter.rb', line 458

def duration_ms_from_result(result)
  return 0 unless result.respond_to?(:duration) && result.duration

  d = result.duration
  if d.respond_to?(:nanoseconds)
    (d.nanoseconds / 1_000_000.0).round
  elsif d.respond_to?(:to_f)
    (d.to_f * 1000.0).round
  else
    0
  end
end

#feature_and_rule(test_case) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/kensho/cucumber/formatter.rb', line 351

def feature_and_rule(test_case)
  feature = nil
  rule = nil
  if @ast_lookup
    uri = test_case.location.file rescue nil
    if uri
      doc = nil
      begin
        doc = @ast_lookup.gherkin_document(uri)
      rescue StandardError
        doc = nil
      end
      if doc && doc.respond_to?(:feature) && doc.feature
        feature = doc.feature.name.to_s if doc.feature.respond_to?(:name)
        rule = walk_for_rule(doc.feature, test_case.location.lines.max) if doc.feature.respond_to?(:children)
      end
    end
  end
  [feature, rule]
end

#labels_from_tags(tags) ⇒ Object 



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/kensho/cucumber/formatter.rb', line 404

def labels_from_tags(tags)
  labels = {}
  tags.each do |t|
    next unless t.start_with?('kensho.label.')

    rest = t.sub('kensho.label.', '')
    key, value = rest.split('=', 2)
    next if key.nil? || key.empty?

    labels[key] = (value || 'true').to_s
  end
  labels
end

#links_from_tags(tags) ⇒ Object 



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/kensho/cucumber/formatter.rb', line 418

def links_from_tags(tags)
  links = []
  tags.each do |t|
    if t.start_with?('kensho.url.')
      rest = t.sub('kensho.url.', '')
      kind, url = rest.split('=', 2)
      next if url.nil? || url.empty?

      link = { 'url' => url }
      link['kind'] = kind if kind && !kind.empty?
      links << link
    elsif t.start_with?('kensho.link.')
      rest = t.sub('kensho.link.', '')
      kind, label = rest.split('=', 2)
      next if label.nil? || label.empty?

      link = { 'url' => label, 'label' => label }
      link['kind'] = kind if kind && !kind.empty?
      links << link
    end
  end
  links
end

#map_case_status(result) ⇒ Object 



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/kensho/cucumber/formatter.rb', line 442

def map_case_status(result)
  return 'pass' if result.respond_to?(:passed?) && result.passed?
  return 'fail' if result.respond_to?(:failed?) && result.failed?
  return 'broken' if result.respond_to?(:undefined?) && result.undefined?
  return 'broken' if result.class.name.to_s.end_with?('::Undefined', '::Ambiguous')
  return 'skip'   if result.respond_to?(:skipped?) && result.skipped?
  return 'skip'   if result.respond_to?(:pending?) && result.pending?

  'pass'
end

#map_step_status(result) ⇒ Object 



453
454
455
456
 
# File 'lib/kensho/cucumber/formatter.rb', line 453

def map_step_status(result)
  s = map_case_status(result)
  s == 'broken' ? 'fail' : s
end

#on_test_case_finished(event) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/kensho/cucumber/formatter.rb', line 212

def on_test_case_finished(event)
  test_case = event.test_case
  scratch = @scratch.delete(test_case.object_id)
  return unless scratch

  case_obj = scratch[:case_obj]
  result = event.result

  status =
    if result.respond_to?(:passed?) && result.passed?
      scratch[:worst_status] == 'pass' ? 'pass' : scratch[:worst_status]
    elsif result.respond_to?(:failed?) && result.failed?
      'fail'
    elsif result.respond_to?(:undefined?) && result.undefined?
      'broken'
    elsif result.respond_to?(:skipped?) && result.skipped?
      'skip'
    elsif result.respond_to?(:pending?) && result.pending?
      'skip'
    else
      scratch[:worst_status]
    end

  duration_ms = [(((Process.clock_gettime(Process::CLOCK_MONOTONIC) - scratch[:started_perf]) * 1000.0).round), 0].max

  case_obj['status']     = status
  case_obj['finishedAt'] = Kensho::Schema.iso_now
  case_obj['duration']   = duration_ms
  case_obj['steps']      = scratch[:steps] unless scratch[:steps].empty?

  if scratch[:first_exception] || scratch[:first_error]
    ex = scratch[:first_exception]
    message = ex ? ex.message.to_s.lines.first.to_s.strip : scratch[:first_error].to_s.lines.first.to_s.strip
    err = { 'message' => message.empty? ? 'failure' : message }
    if ex
      err['type']  = ex.class.name.to_s
      stack = [ex.message.to_s]
      stack.concat(Array(ex.backtrace).first(20))
      err['stack'] = stack.join("\n")
    elsif scratch[:first_error] && scratch[:first_error].to_s != message
      err['stack'] = scratch[:first_error].to_s
    end
    case_obj['errors'] = [err]
  end

  case_obj['attachments'] = scratch[:attachments] unless scratch[:attachments].empty?

  # Runtime annotations (Kensho.* helpers) win over tag-derived values.
  unless scratch[:rt_labels].empty?
    case_obj['labels'] = (case_obj['labels'] || {}).merge(scratch[:rt_labels])
  end
  unless scratch[:rt_links].empty?
    case_obj['links'] = (case_obj['links'] || []) + scratch[:rt_links]
  end
  unless scratch[:rt_parameters].empty?
    case_obj['parameters'] = (case_obj['parameters'] || []) + scratch[:rt_parameters]
  end
  unless scratch[:rt_tags].empty?
    existing = case_obj['tags'] || []
    merged = existing.dup
    scratch[:rt_tags].each { |t| merged << t unless merged.include?(t) }
    case_obj['tags'] = merged
  end
  unless scratch[:rt_behavior].empty?
    case_obj['behavior'] = (case_obj['behavior'] || {}).merge(scratch[:rt_behavior])
  end
  case_obj['severity']    = scratch[:rt_severity]    if scratch[:rt_severity]
  case_obj['owner']       = scratch[:rt_owner]       if scratch[:rt_owner]
  case_obj['description'] = scratch[:rt_description]  if scratch[:rt_description]
  case_obj['flaky']       = true                     if scratch[:flaky]
  case_obj['muted']       = true                     if scratch[:muted]

  @cases_by_id[case_obj['id']] = case_obj
  write_case(case_obj)
ensure
  Kensho::Cucumber::State.current = nil
end

#on_test_case_started(event) ⇒ Object

——- per-event handlers ——- #



86
87
88
89
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/kensho/cucumber/formatter.rb', line 86

def on_test_case_started(event)
  test_case = event.test_case
  @current_test_case = test_case
  scenario_name = test_case.name.to_s
  feature_uri = test_case.location.file rescue nil
  feature_uri ||= (test_case.respond_to?(:source_location) ? test_case.source_location.file : nil)
  feature_name, rule_name = feature_and_rule(test_case)

  full_name = [feature_name, scenario_name].compact.reject(&:empty?).join(' › ')
  file_path = relpath(feature_uri, @rootpath)
  line = (test_case.location.lines.first rescue nil) || (test_case.location.line rescue nil)

  base_id = Kensho::Schema.stable_case_id(full_name, file_path)
  seen = @ids_seen[base_id]
  case_id = seen.zero? ? base_id : "#{base_id}_#{seen + 1}"
  @ids_seen[base_id] = seen + 1

  tags = (test_case.tags || []).map { |t| t.respond_to?(:name) ? t.name.to_s : t.to_s }
  clean_tags = tags.map { |t| t.start_with?('@') ? t[1..] : t }

  severity = severity_from_tags(clean_tags)
  labels = labels_from_tags(clean_tags)
  links = links_from_tags(clean_tags)

  plain_tags = clean_tags.reject do |t|
    t.start_with?('kensho.label.') || t.start_with?('kensho.link.') ||
      t.start_with?('kensho.url.') || t.start_with?('severity:') ||
      SEVERITY_TAGS.include?(t)
  end

  behavior = {}
  behavior['feature']  = feature_name.to_s if feature_name && !feature_name.empty?
  behavior['epic']     = rule_name.to_s    if rule_name && !rule_name.empty?
  behavior['scenario'] = scenario_name     if scenario_name && !scenario_name.empty?

  case_obj = {
    'id'        => case_id,
    'name'      => scenario_name,
    'fullName'  => full_name,
    'status'    => 'skip',
    'startedAt' => Kensho::Schema.iso_now,
    'duration'  => 0,
    'retries'   => 0,
    'platform'  => Kensho::Schema.normalize_os
  }
  case_obj['filePath'] = file_path if file_path
  case_obj['line']     = line.to_i if line
  case_obj['suite']    = [feature_name].compact.reject(&:empty?)
  case_obj.delete('suite') if case_obj['suite'].empty?
  case_obj['tags']     = plain_tags unless plain_tags.empty?
  case_obj['severity'] = severity if severity
  case_obj['labels']   = labels   unless labels.empty?
  case_obj['links']    = links    unless links.empty?
  case_obj['behavior'] = behavior unless behavior.empty?

  scratch = {
    case_obj: case_obj,
    started_perf: Process.clock_gettime(Process::CLOCK_MONOTONIC),
    started_iso: case_obj['startedAt'],
    steps: [],
    step_index: 0,
    worst_status: 'pass',
    first_error: nil,
    first_exception: nil,
    attachments: [],
    rt_labels: {},
    rt_links: [],
    rt_parameters: [],
    rt_tags: [],
    rt_behavior: {},
    rt_severity: nil,
    rt_owner: nil,
    rt_description: nil,
    flaky: false,
    muted: false
  }
  @scratch[test_case.object_id] = scratch
  Kensho::Cucumber::State.current = scratch
end

#on_test_run_finished ⇒ Object 



290
291
292
293
294
 
# File 'lib/kensho/cucumber/formatter.rb', line 290

def on_test_run_finished
  write_run_json
rescue StandardError => e
  warn "[kensho] failed to write run.json: #{e.message}"
end

#on_test_step_finished(event) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/kensho/cucumber/formatter.rb', line 166

def on_test_step_finished(event)
  test_case = @current_test_case
  return unless test_case

  scratch = @scratch[test_case.object_id]
  return unless scratch

  step = event.test_step
  result = event.result

  title, parameters = step_title_and_params(step)
  # Cucumber emits hooks as test steps with no Gherkin source; skip
  # those from the timeline so the report shows just the user steps.
  return if title.nil?

  status = map_step_status(result)
  case_status = map_case_status(result)
  if case_status == 'fail' || case_status == 'broken'
    scratch[:worst_status] = case_status
  elsif case_status == 'skip' && scratch[:worst_status] == 'pass'
    scratch[:worst_status] = 'skip'
  end

  if (result.respond_to?(:failed?) && result.failed?) ||
     (result.respond_to?(:exception) && result.exception)
    scratch[:first_exception] ||= result.exception if result.respond_to?(:exception)
    scratch[:first_error] ||= (result.respond_to?(:exception) && result.exception) ?
                              result.exception.message.to_s :
                              result.to_s
  end

  duration_ms = duration_ms_from_result(result)
  idx = scratch[:step_index]
  scratch[:step_index] += 1

  step_obj = {
    'id'        => "step_#{idx}_#{SecureRandom.hex(3)}",
    'title'     => title,
    'status'    => status,
    'startedAt' => Kensho::Schema.iso_now,
    'duration'  => duration_ms
  }
  step_obj['parameters'] = parameters unless parameters.empty?
  scratch[:steps] << step_obj
end

#relpath(path, root) ⇒ Object 



509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/kensho/cucumber/formatter.rb', line 509

def relpath(path, root)
  return nil unless path

  absolute_path = File.absolute_path(path.to_s)
  absolute_root = File.absolute_path(root.to_s)
  if absolute_path.start_with?(absolute_root + File::SEPARATOR)
    absolute_path[(absolute_root.length + 1)..]
  else
    path.to_s.sub(%r{\A\./}, '')
  end
end

#severity_from_tags(tags) ⇒ Object 



395
396
397
398
399
400
401
402
 
# File 'lib/kensho/cucumber/formatter.rb', line 395

def severity_from_tags(tags)
  tags.each do |t|
    return t.split(':', 2)[1].to_s.downcase if t.start_with?('severity:') &&
                                               SEVERITY_TAGS.include?(t.split(':', 2)[1].to_s.downcase)
    return t.downcase if SEVERITY_TAGS.include?(t.downcase)
  end
  nil
end

#step_title_and_params(step) ⇒ Object

——- helpers ——- #



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/kensho/cucumber/formatter.rb', line 298

def step_title_and_params(step)
  return [nil, []] if step.respond_to?(:hook?) && step.hook?

  text =
    if step.respond_to?(:text)
      step.text.to_s
    elsif step.respond_to?(:name)
      step.name.to_s
    else
      ''
    end
  return [nil, []] if text.empty?

  keyword = ''
  gherkin_step = nil
  if @ast_lookup
    begin
      src = @ast_lookup.step_source(step)
      gherkin_step = src && src.respond_to?(:step) ? src.step : nil
    rescue StandardError
      gherkin_step = nil
    end
    keyword = gherkin_step.keyword.to_s if gherkin_step && gherkin_step.respond_to?(:keyword)
  end
  title = keyword && !keyword.empty? ? "#{keyword}#{text}" : text

  params = []
  if gherkin_step && gherkin_step.respond_to?(:data_table) && gherkin_step.data_table
    rows = gherkin_step.data_table.rows
    rows.each_with_index do |row, ri|
      cells = row.respond_to?(:cells) ? row.cells : []
      cells.each_with_index do |cell, ci|
        value = cell.respond_to?(:value) ? cell.value.to_s : cell.to_s
        params << {
          'name' => "row#{ri}.col#{ci}",
          'value' => value,
          'kind' => 'data-row'
        }
      end
    end
  end
  if gherkin_step && gherkin_step.respond_to?(:doc_string) && gherkin_step.doc_string
    ds = gherkin_step.doc_string
    params << {
      'name' => 'docstring',
      'value' => ds.respond_to?(:content) ? ds.content.to_s : ds.to_s,
      'kind' => 'argument'
    }
  end

  [title, params]
end

#walk_for_rule(feature, line) ⇒ Object 



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/kensho/cucumber/formatter.rb', line 372

def walk_for_rule(feature, line)
  feature.children.each do |child|
    next unless child.respond_to?(:rule) && child.rule

    rule = child.rule
    # Lines covered by this rule include all its scenarios.
    covered = false
    if rule.respond_to?(:children)
      rule.children.each do |sc_child|
        next unless sc_child.respond_to?(:scenario) && sc_child.scenario

        if sc_child.scenario.location.line == line ||
           sc_child.scenario.steps.any? { |s| s.location.line == line }
          covered = true
          break
        end
      end
    end
    return rule.name.to_s if covered && rule.respond_to?(:name)
  end
  nil
end

#write_case(case_obj) ⇒ Object 



471
472
473
474
475
476
 
# File 'lib/kensho/cucumber/formatter.rb', line 471

def write_case(case_obj)
  path = File.join(@cases_dir, "#{case_obj['id']}.json")
  File.write(path, JSON.pretty_generate(case_obj))
rescue StandardError => e
  warn "[kensho] could not write #{File.basename(path)}: #{e.message}"
end

#write_run_json ⇒ Object 



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/kensho/cucumber/formatter.rb', line 478

def write_run_json
  finished_at = Kensho::Schema.iso_now
  cases = @cases_by_id.values
  totals = { 'pass' => 0, 'fail' => 0, 'broken' => 0, 'skip' => 0 }
  cases.each { |c| totals[c['status']] += 1 if totals.key?(c['status']) }
  duration_ms = [((Process.clock_gettime(Process::CLOCK_MONOTONIC) - @started_perf) * 1000.0).round, 0].max
  framework_version = cucumber_version

  run = {
    'schemaVersion' => Kensho::Schema::SCHEMA_VERSION,
    'id'            => @run_id,
    'project'       => @project,
    'framework'     => { 'name' => 'cucumber-ruby', 'version' => framework_version },
    'env'           => Kensho::Schema.env_info(framework_version: framework_version),
    'startedAt'     => @started_at,
    'finishedAt'    => finished_at,
    'totals'        => totals,
    'durationMs'    => duration_ms,
    'testCases'     => cases
  }
  File.write(File.join(@output_dir, 'run.json'), JSON.pretty_generate(run))
end