module SimpleCov
Helper that tries to find out what test suite is running (for SimpleCov.command_name)
Bundles the configuration options used for SimpleCov. All methods defined here are usable from SimpleCov directly. Please check out SimpleCov documentation for further info.
An array of SimpleCov SourceFile instances with additional collection helper methods for calculating coverage across them etc.
A ridiculously simple formatter for SimpleCov results.
Profiles are SimpleCov configuration procs that can be easily loaded using ::start :rails and defined using
SimpleCov.profiles.define :foo do # SimpleCov configuration here, same as in SimpleCov.configure end
Singleton that is responsible for caching, loading and merging SimpleCov::Results into a single result for coverage analysis based upon multiple test suites.
Constants
- VERSION
Attributes
Public Class Methods
Finds files that were to be tracked but were not loaded and initializes the line-by-line coverage to zero (if relevant) or nil (comments / whitespace etc).
# File lib/simplecov.rb, line 64 def add_not_loaded_files(result) if tracked_files result = result.dup Dir[tracked_files].each do |file| absolute = File.expand_path(file) result[absolute] ||= LinesClassifier.new.classify(File.foreach(absolute)) end end result end
Clear out the previously cached .result. Primarily useful in testing
# File lib/simplecov.rb, line 168 def clear_result @result = nil end
Returns the exit status from the exit exception
# File lib/simplecov.rb, line 183 def exit_status_from_exception return SimpleCov::ExitCodes::SUCCESS unless exit_exception if exit_exception.is_a?(SystemExit) exit_exception.status else SimpleCov::ExitCodes::EXCEPTION end end
Applies the configured filters to the given array of SimpleCov::SourceFile items
# File lib/simplecov.rb, line 113 def filtered(files) result = files.clone filters.each do |filter| result = result.reject { |source_file| filter.matches?(source_file) } end SimpleCov::FileList.new result end
@api private
# File lib/simplecov.rb, line 258 def final_result_process? # checking for ENV["TEST_ENV_NUMBER"] to determine if the tess are being run in parallel !defined?(ParallelTests) || !ENV["TEST_ENV_NUMBER"] || ParallelTests.number_of_running_processes <= 1 end
Applies the configured groups to the given array of SimpleCov::SourceFile items
# File lib/simplecov.rb, line 124 def grouped(files) grouped = {} grouped_files = [] groups.each do |name, filter| grouped[name] = SimpleCov::FileList.new(files.select { |source_file| filter.matches?(source_file) }) grouped_files += grouped[name] end if !groups.empty? && !(other_files = files.reject { |source_file| grouped_files.include?(source_file) }).empty? grouped["Ungrouped"] = SimpleCov::FileList.new(other_files) end grouped end
# File lib/simplecov.rb, line 144 def load_adapter(name) warn "#{Kernel.caller.first}: [DEPRECATION] #load_adapter is deprecated. Use #load_profile instead." load_profile(name) end
Applies the profile of given name on SimpleCov configuration
# File lib/simplecov.rb, line 140 def load_profile(name) profiles.load(name) end
@api private
Usage:
exit_status = SimpleCov.process_result(SimpleCov.result, exit_status)
# File lib/simplecov.rb, line 219 def process_result(result, exit_status) return exit_status if exit_status != SimpleCov::ExitCodes::SUCCESS # Existing errors covered_percent = result.covered_percent.round(2) result_exit_status = result_exit_status(result, covered_percent) if result_exit_status == SimpleCov::ExitCodes::SUCCESS # No result errors write_last_run(covered_percent) end final_result_process? ? result_exit_status : SimpleCov::ExitCodes::SUCCESS end
Returns the result for the current coverage run, merging it across test suites from cache using SimpleCov::ResultMerger if use_merging is activated (default)
# File lib/simplecov.rb, line 81 def result return @result if result? # Collect our coverage result if running @result = SimpleCov::Result.new add_not_loaded_files(Coverage.result) end # If we're using merging of results, store the current result # first (if there is one), then merge the results and return those if use_merging wait_for_other_processes SimpleCov::ResultMerger.store_result(@result) if result? @result = SimpleCov::ResultMerger.merged_result end @result ensure self.running = false end
Returns nil if the result has not been computed Otherwise, returns the result
# File lib/simplecov.rb, line 106 def result? defined?(@result) && @result end
@api private
rubocop:disable Metrics/MethodLength
# File lib/simplecov.rb, line 233 def result_exit_status(result, covered_percent) covered_percentages = result.covered_percentages.map { |percentage| percentage.round(2) } if covered_percent < SimpleCov.minimum_coverage $stderr.printf("Coverage (%.2f%%) is below the expected minimum coverage (%.2f%%).\n", covered_percent, SimpleCov.minimum_coverage) SimpleCov::ExitCodes::MINIMUM_COVERAGE elsif covered_percentages.any? { |p| p < SimpleCov.minimum_coverage_by_file } $stderr.printf("File (%s) is only (%.2f%%) covered. This is below the expected minimum coverage per file of (%.2f%%).\n", result.least_covered_file, covered_percentages.min, SimpleCov.minimum_coverage_by_file) SimpleCov::ExitCodes::MINIMUM_COVERAGE elsif (last_run = SimpleCov::LastRun.read) coverage_diff = last_run["result"]["covered_percent"] - covered_percent if coverage_diff > SimpleCov.maximum_coverage_drop $stderr.printf("Coverage has dropped by %.2f%% since the last time (maximum allowed: %.2f%%).\n", coverage_diff, SimpleCov.maximum_coverage_drop) SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP else SimpleCov::ExitCodes::SUCCESS end else SimpleCov::ExitCodes::SUCCESS end end
@api private
Called from at_exit block
# File lib/simplecov.rb, line 197 def run_exit_tasks! exit_status = SimpleCov.exit_status_from_exception SimpleCov.at_exit.call # Don't modify the exit status unless the result has already been # computed exit_status = SimpleCov.process_result(SimpleCov.result, exit_status) if SimpleCov.result? # Force exit with stored status (see github issue #5) # unless it's nil or 0 (see github issue #281) if exit_status && exit_status > 0 $stderr.printf("SimpleCov failed with exit %d", exit_status) Kernel.exit exit_status end end
Capture the current exception if it exists This will get called inside the at_exit block
# File lib/simplecov.rb, line 176 def set_exit_exception @exit_exception = $ERROR_INFO end
Sets up SimpleCov to run against your project. You can optionally specify a profile to use as well as configuration with a block:
SimpleCov.start OR SimpleCov.start 'rails' # using rails profile OR SimpleCov.start do add_filter 'test' end OR SimpleCov.start 'rails' do add_filter 'test' end
Please check out the RDoc for SimpleCov::Configuration to find about available config options
# File lib/simplecov.rb, line 45 def start(profile = nil, &block) if SimpleCov.usable? load_profile(profile) if profile configure(&block) if block_given? @result = nil self.running = true self.pid = Process.pid Coverage.start else warn "WARNING: SimpleCov is activated, but you're not running Ruby 1.9+ - no coverage analysis will happen" warn "Starting with SimpleCov 1.0.0, even no-op compatibility with Ruby <= 1.8 will be entirely dropped." false end end
Checks whether we're on a proper version of Ruby (likely 1.9+) which provides coverage support
# File lib/simplecov.rb, line 153 def usable? return @usable if defined?(@usable) && !@usable.nil? @usable = begin require "coverage" require "simplecov/jruby_fix" true rescue LoadError false end end
@api private
# File lib/simplecov.rb, line 266 def wait_for_other_processes return unless defined?(ParallelTests) && final_result_process? ParallelTests.wait_for_other_processes_to_finish end
@api private
# File lib/simplecov.rb, line 274 def write_last_run(covered_percent) SimpleCov::LastRun.write(:result => {:covered_percent => covered_percent}) end