Module: SimpleCov::CommandGuesser

Relationships & Source Files
Defined in:	lib/simplecov/command_guesser.rb

Overview

Helper that tries to find out what test suite is running (for SimpleCov.command_name)

Class Attribute Summary

.original_run_command rw

Storage for the original command line call that invoked the test suite.

Class Method Summary

.guess
.from_command_line_options private
.from_defined_constants private
.from_env private

Class Attribute Details

.original_run_command (rw)

Storage for the original command line call that invoked the test suite. This has got to be stored as early as possible because i.e. rake and test/unit 2 have a habit of tampering with ARGV, which makes i.e. the automatic distinction between rails unit/functional/integration tests impossible without this cached item.

[ GitHub ]

# File 'lib/simplecov/command_guesser.rb', line 14


attr_accessor :original_run_command

Class Method Details

.from_command_line_options (private)

[ GitHub ]

# File 'lib/simplecov/command_guesser.rb', line 31


def from_command_line_options
  case original_run_command
  when /test\/functional\//, /test\/\{.*functional.*\}\//
    "Functional Tests"
  when /test\/integration\//
    "Integration Tests"
  when /test\//
    "Unit Tests"
  when /spec/
    "RSpec"
  when /cucumber/, /features/
    "Cucumber Features"
  end
end

.from_defined_constants (private)

[ GitHub ]

# File 'lib/simplecov/command_guesser.rb', line 46


def from_defined_constants
  # If the command regexps fail, let's try checking defined constants.
  if defined?(RSpec)
    "RSpec"
  elsif defined?(Test::Unit)
    "Unit Tests"
  elsif defined?(Minitest)
    "Minitest"
  elsif defined?(MiniTest)
    "MiniTest"
  else
    # TODO: Provide link to docs/wiki article
    warn "SimpleCov failed to recognize the test framework and/or suite used. Please specify manually using SimpleCov.command_name 'Unit Tests'."
    "Unknown Test Framework"
  end
end

.from_env (private)

[ GitHub ]

# File 'lib/simplecov/command_guesser.rb', line 22


def from_env
  # If being run from inside parallel_tests set the command name according to the process number
  return unless ENV["PARALLEL_TEST_GROUPS"] && ENV["TEST_ENV_NUMBER"]

  number = ENV.fetch("TEST_ENV_NUMBER", nil)
  number = "1" if number.empty?
  "(#{number}/#{ENV.fetch('PARALLEL_TEST_GROUPS', nil)})"
end

.guess

[ GitHub ]

# File 'lib/simplecov/command_guesser.rb', line 16


def guess
  from_env || from_command_line_options || from_defined_constants
end