avmnu-sng/rspec-tracer

View on GitHub
features/step_definitions/report_steps.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

Then('The RSpecTracer should print the information') do |expected_output|
  output = last_command_started.output.lines
    .map(&:strip)
    .reject(&:empty?)
    .map { |line| line.sub(/\(FAILED(\s-\s\d+)\)$/, 'FAILED') }
    .map { |line| line.sub(/\s\(pid: \d+\)$/, '') }
    .map { |line| line.sub(/\s\(took 0(.\d{0,5})?\sseconds\)$/, '') }

  expected = expected_output.lines
    .map(&:strip)
    .reject(&:empty?)
    .map { |line| line.sub(/\(FAILED(\s-\s\d+)\)$/, 'FAILED') }

  expect(output & expected).to contain_exactly(*expected)
end

Then('The RSpecTracer should print {string} example {int} times') do |example, times|
  output = last_command_started.output.lines.map(&:strip).reject(&:empty?)

  expect(output.count(example)).to eq(times)
end

Then('The parallel processes information should have printed for {int} spec files') do |files_count|
  require 'parallel'

  major, minor = ENV['PARALLEL_TESTS_VERSION'].match(/~>\s(\d+).(\d+).*/).to_a.drop(1).map(&:to_i)
  all_pluralized = major < 3 || minor < 5

  processor_count = Parallel.processor_count
  processor_count = files_count if files_count < processor_count
  specs_per_process = files_count / processor_count

  if all_pluralized
    message = "#{processor_count} processes for #{files_count} specs, ~ #{specs_per_process} specs per process"
  else
    processor_info = "#{processor_count} #{processor_count > 1 ? 'processes' : 'process'}"
    specs_info = "#{files_count} #{files_count > 1 ? 'specs' : 'spec'}"
    per_process_info = "~ #{specs_per_process} #{specs_per_process > 1 ? 'specs' : 'spec'} per process"

    message = "#{processor_info} for #{specs_info}, #{per_process_info}"
  end

  expect(last_command_started.output).to include(message)
end

Then('The SimpleCov at_exit hook should have executed at the right time') do
  output = last_command_started.output.lines.map(&:strip).reject(&:empty?)
  idx = output.index('SimpleCov will now generate coverage report (<3 RSpec tracer)')

  expect(idx).not_to eq(nil)
  expect(output[idx + 1]).to eq('Running SimpleCov exit task using at_exit hook')
end

Then('The RSpecTracer should print the duplicate examples report') do |expected_output|
  output = last_command_started.output.lines.map(&:strip).reject(&:empty?)
  expected = expected_output.lines.map(&:strip).reject(&:empty?)

  idx = output.index(expected.first)
  output = output[idx...(idx + expected.length)]

  expect(output).to eq(expected)
end

Then('The RSpecTracer report should have been generated') do
  steps %(
    Then a directory named "#{@cache_dir}" should exist
    And the following files should exist:
      | #{@cache_dir}/last_run.json                       |
      | #{@cache_dir}/#{@run_id}/all_examples.json        |
      | #{@cache_dir}/#{@run_id}/all_files.json           |
      | #{@cache_dir}/#{@run_id}/dependency.json          |
      | #{@cache_dir}/#{@run_id}/examples_coverage.json   |
      | #{@cache_dir}/#{@run_id}/failed_examples.json     |
      | #{@cache_dir}/#{@run_id}/pending_examples.json    |
      | #{@cache_dir}/#{@run_id}/reverse_dependency.json  |
  )
end

Then('The last run report should have correct details') do |report_json|
  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/last_run.json"))
    attrs = %w[run_id actual_count example_count skipped_examples failed_examples pending_examples]
    report = report.slice(*attrs)

    expect(report).to eq(JSON.parse(report_json))
  end
end

Then('The all examples report should have correct details') do
  project_dir = File.dirname(__FILE__)
  data_file = File.join(project_dir, "../#{@data_dir}/all_examples.json")
  data = JSON.parse(File.read(data_file))

  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/all_examples.json"))

    expect(report.keys.sort).to eq(data.keys.sort)

    report.each_pair do |example_id, example|
      expect(example).to include(data[example_id])
    end
  end
end

Then('The all files report should have correct details') do |table|
  data = table.hashes.map { |a| [a['file_name'], a['file_digest']] }.to_h

  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/all_files.json"))

    expect(report.keys.sort).to eq(data.keys.sort)

    report.each_pair do |file_name, file_data|
      expect(file_data['digest']).to eq(data[file_name])
    end
  end
end

Then('There should be no flaky examples') do
  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/flaky_examples.json"))

    expect(report).to eq([])
  end
end

Then('The flaky example report should have correct details') do
  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/flaky_examples.json"))

    expect(report).to eq(%w[9479ac3d1030d06371c69081856ce7e0 c25a9aa240c4a72810d9ccfc0e2c10ad])
  end
end

Then('The failed example report should have correct details') do
  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/failed_examples.json"))
    example = case @project
              when 'rails_app'
                ['338f77315d8f7c01ea5551cd0759b110']
              when 'ruby_app'
                if @force_fail
                  %w[
                    9479ac3d1030d06371c69081856ce7e0
                    b5963ecab8d95c1024a46117fce4e907
                    c25a9aa240c4a72810d9ccfc0e2c10ad
                  ]
                else
                  ['b5963ecab8d95c1024a46117fce4e907']
                end
              when 'parallel_tests_ruby_app', 'parallel_tests_ruby_app_many_spec_files'
                %w[95f5a10aa098336083912eee9d6666cd b5963ecab8d95c1024a46117fce4e907]
              when 'calculator_2_app'
                ['1be34ddaa19469923b1a2c6798a5d15a']
              end

    expect(report).to eq(example)
  end
end

Then('The pending example report should have correct details') do
  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/pending_examples.json"))

    if @project == 'calculator_2_app'
      expect(report).to eq([])
    else
      expect(report).to eq(['94cd4d0e1d9ef63237421fe02085eb9a'])
    end
  end
end

Then('The dependency report should have correct details') do
  project_dir = File.dirname(__FILE__)
  data_file = File.join(project_dir, "../#{@data_dir}/dependency.json")
  data = JSON.parse(File.read(data_file))

  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/dependency.json"))

    expect(report.keys.sort).to eq(data.keys.sort)

    report.each_pair do |example_id, dependency|
      expect(dependency).to contain_exactly(*data[example_id])
    end

    dependency_files = Set.new
    report.each_value { |files| dependency_files |= files }

    all_files = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/all_files.json")).keys.to_set

    expect(dependency_files).to eq(all_files)
  end
end

Then('The reverse dependency report should have correct details') do
  project_dir = File.dirname(__FILE__)
  data_file = File.join(project_dir, "../#{@data_dir}/reverse_dependency.json")
  data = JSON.parse(File.read(data_file))

  cd('.') do
    report = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/reverse_dependency.json"))

    expect(report.keys.sort).to eq(data.keys.sort)

    report.each_pair do |example_id, dependency|
      expect(dependency).to eq(data[example_id])
    end

    all_files = JSON.parse(File.read("#{@cache_dir}/#{@run_id}/all_files.json")).keys.sort

    expect(report.keys.sort).to eq(all_files)
  end
end