simplecov 0.4.2 → 0.5.2

data/features/rspec_basic.feature

@@ -0,0 +1,31 @@
+@rspec
+Feature:
+
+  Simply adding the basic simplecov lines to a project should get
+  the user a coverage report after running `rspec`
+
+  Scenario:
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start
+      """
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 90.91%   | 6     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/some_class.rb         | 80.0 %  |
+      | lib/faked_project/framework_specific.rb | 75.0 %   |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |
+      | spec/meta_magic_spec.rb                 | 100.0 %  |
+      | spec/some_class_spec.rb                 | 100.0 %  |
+
+      # Note: faked_spec.rb is not appearing here since that's the first unit test file
+      # loaded by Rake, and only there test_helper is required, which then loads simplecov
+      # and triggers tracking of all other loaded files! Solution for this would be to
+      # configure simplecov in this first test instead of test_helper.

data/features/rspec_groups_and_filters_basic.feature

@@ -0,0 +1,29 @@
+@rspec
+Feature:
+
+  Defining some groups and filters should give a corresponding
+  coverage report that respects those settings after running rspec
+
+  Scenario:
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        add_group 'Libs', 'lib/faked_project/'
+        add_filter '/spec/'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    And I should see the groups:
+      | name      | coverage | files |
+      | All Files | 88.37%   | 4     |
+      | Libs      | 86.11%   | 3     |
+      | Ungrouped | 100.0%   | 1     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/some_class.rb         | 80.0 %  |
+      | lib/faked_project/framework_specific.rb | 75.0 %   |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |

data/features/rspec_groups_and_filters_complex.feature

@@ -0,0 +1,35 @@
+@rspec
+Feature: Sophisticated grouping and filtering on RSpec
+
+  Defining groups and filters can be done by passing blocks or strings.
+  Blocks get each SimpleCov::SourceFile instance passed an can use arbitrary
+  and potentially weird conditions to remove files from the report or add them
+  to specific groups.
+
+  Scenario:
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        add_group 'By block' do |src_file|
+          src_file.filename =~ /MaGiC/i
+        end
+        add_group 'By string', 'project/meta_magic'
+
+        add_filter 'faked_project.rb'
+        # Remove all files that include "describe" in their source
+        add_filter {|src_file| src_file.lines.any? {|line| line.src =~ /describe/ } }
+        add_filter {|src_file| src_file.covered_percent < 100 }
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 100.0%   | 1     |
+      | By block  | 100.0%   | 1     |
+      | By string | 100.0%   | 1     |
+
+    And I should see the source files:
+      | name                            | coverage |
+      | lib/faked_project/meta_magic.rb | 100.0 %  |

data/features/rspec_without_simplecov.feature

@@ -0,0 +1,20 @@
+@rspec
+Feature:
+
+  Running specs without simplecov configuration
+
+  Scenario: No config at all
+    When I successfully run `bundle exec rspec spec`
+    Then no coverage report should have been generated
+
+  Scenario: Configured, but not started
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.configure do
+        add_filter 'somefilter'
+      end
+      """
+
+    When I successfully run `bundle exec rspec spec`
+    Then no coverage report should have been generated

data/features/step_definitions/html_steps.rb

@@ -0,0 +1,42 @@
+module GroupHelpers
+  def available_groups
+    all('#content .file_list_container')
+  end
+
+  def available_source_files
+    all('.source_files .source_table')
+  end
+end
+World(GroupHelpers)
+
+
+Then /^I should see the groups:$/ do |table|
+  expected_groups = table.hashes
+  # Given group names should be the same number than those rendered in report
+  expected_groups.count.should == available_groups.count
+
+  # Verify each of the expected groups has a file list container and corresponding title and coverage number
+  # as well as the correct number of links to files.
+  expected_groups.each do |group|
+    with_scope "#content ##{group["name"].gsub(/[^a-z]/i, '')}.file_list_container" do
+      file_count_in_group = page.all('a.src_link').count
+      file_count_in_group.should == group["files"].to_i
+
+      with_scope "h2" do
+        page.should have_content(group["name"])
+        page.should have_content(group["coverage"])
+      end
+    end
+  end
+end
+
+Then /^I should see the source files:$/ do |table|
+  expected_files = table.hashes
+  expected_files.length.should == available_source_files.count
+
+  # Find all filenames and their coverage present in coverage report
+  files = available_source_files.map {|f| {"name" => f.find('h3').text, "coverage" => f.find('.header span').text} }
+
+  files.sort_by {|hsh| hsh["name"] }.should == expected_files.sort_by {|hsh| hsh["name"] }
+end
+

data/features/step_definitions/simplecov_steps.rb

@@ -0,0 +1,61 @@
+# Just a shortcut to make framework setup more readable
+# The test project is using separate config files to avoid specifying all of
+# test/spec_helper in the features every time.
+Given /^SimpleCov for (.*) is configured with:$/ do |framework, config_body|
+  framework_dir = case framework
+    when /RSpec/i
+      "spec"
+    when /Test\/Unit/i
+      "test"
+    when /Cucumber/i
+      "features/support"
+    else
+      raise ArgumentError, "Could not identify test framework #{framework}!"
+  end
+  
+  steps %Q{
+    Given a file named "#{framework_dir}/simplecov_config.rb" with:
+      """
+      #{config_body}
+      """
+  }
+end
+
+When /^I open the coverage report generated with `([^`]+)`$/ do |command|
+  steps %Q{
+    When I successfully run `#{command}`
+    Then a coverage report should have been generated
+    When I open the coverage report
+  }
+end
+
+Then /^a coverage report should have been generated(?: in "([^"]*)")?$/ do |coverage_dir|
+  coverage_dir ||= 'coverage'
+  steps %Q{
+    Then the output should contain "Coverage report generated"
+    And a directory named "#{coverage_dir}" should exist
+    And the following files should exist:
+      | #{coverage_dir}/index.html      |
+      | #{coverage_dir}/.resultset.json |
+  }
+end
+
+Then /^no coverage report should have been generated(?: in "([^"]*)")?$/ do |coverage_dir|
+  coverage_dir ||= 'coverage'
+  steps %Q{
+    Then the output should not contain "Coverage report generated"
+    And a directory named "#{coverage_dir}" should not exist
+    And the following files should not exist:
+      | #{coverage_dir}/index.html      |
+      | #{coverage_dir}/.resultset.json |
+  }
+end
+
+Then /^the report should be based upon:$/ do |table|
+  frameworks = table.raw.flatten
+  steps %Q{
+    Then the output should contain "Coverage report generated for #{frameworks.join(", ")}"
+    And I should see "using #{frameworks.join(", ")}" within "#footer"
+  }
+end
+

data/features/step_definitions/transformers.rb

@@ -0,0 +1,13 @@
+#
+# Enforce the alphabetical execution of specs because rspec 2+ executes them
+# randomly with `rspec spec` while we need them in an accurate order for coverage
+# reports that include the spec files.
+#
+# This is due to the fact that coverage will not include the first loaded spec/test file.
+# To get predictable coverage results, we need to know which one that is...
+#
+Transform "bundle exec rspec spec" do |t|
+  files = nil # Avoid shadowing
+  in_current_dir { files = Dir['spec/**/*_spec.rb'] }
+  "bundle exec rspec #{files.sort.join(' ')}"
+end

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,64 @@
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(locator) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+When /^I open the coverage report$/ do
+  visit '/'
+end
+
+Given /^(?:|I )am on (.+)$/ do |path|
+  visit path
+end
+
+When /^(?:|I )go to (.+)$/ do |path|
+  visit path
+end
+
+When /^(?:|I )press "([^"]*)"(?: within "([^"]*)")?$/ do |button, selector|
+  with_scope(selector) do
+    click_button(button)
+  end
+end
+
+When /^(?:|I )follow "([^"]*)"(?: within "([^"]*)")?$/ do |link, selector|
+  with_scope(selector) do
+    click_link(link)
+  end
+end
+
+Then /^(?:|I )should see "([^"]*)"(?: within "([^"]*)")?$/ do |text, selector|
+  with_scope(selector) do
+    page.should have_content(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/(?: within "([^"]*)")?$/ do |regexp, selector|
+  regexp = Regexp.new(regexp)
+  with_scope(selector) do
+    page.should have_xpath('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"(?: within "([^"]*)")?$/ do |text, selector|
+  with_scope(selector) do
+    page.should have_no_content(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/(?: within "([^"]*)")?$/ do |regexp, selector|
+  regexp = Regexp.new(regexp)
+  with_scope(selector) do
+    page.should have_no_xpath('//*', :text => regexp)
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end
+
+Then /^print the page$/ do
+  puts page.body
+end

data/features/support/env.rb

@@ -0,0 +1,26 @@
+unless RUBY_VERSION =~ /1\.9/
+  $stderr.puts "Sorry, Cucumber features are only meant to run on Ruby 1.9 for now :("
+  exit 0
+end
+
+require 'bundler'
+Bundler.setup
+require 'aruba/cucumber'
+require 'capybara/cucumber'
+
+# Fake rack app for capybara that just returns the latest coverage report from aruba temp project dir
+Capybara.app = lambda {|env|
+  [200, {'Content-Type' => 'text/html'},
+    [File.read(File.join(File.dirname(__FILE__), '../../tmp/aruba/project', 'coverage/index.html'))]]
+}
+
+Before do
+  @aruba_timeout_seconds = 20
+  this_dir = File.dirname(__FILE__)
+  # Clean up and create blank state for fake project
+  in_current_dir do
+    FileUtils.rm_rf 'project'
+    FileUtils.cp_r File.join(this_dir, '../../test/faked_project/'), 'project'
+  end
+  Given 'I cd to "project"'
+end

data/features/test_unit_basic.feature

@@ -0,0 +1,34 @@
+@test_unit
+Feature:
+
+  Simply adding the basic simplecov lines to a project should get
+  the user a coverage report after running `rake test`
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 91.53%   | 6     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/some_class.rb         | 80.0 %   |
+      | lib/faked_project/framework_specific.rb | 75.0 %   |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |
+      | test/meta_magic_test.rb                 | 100.0 %  |
+      | test/some_class_test.rb                 | 100.0 %  |
+
+      # Note: faked_test.rb is not appearing here since that's the first unit test file
+      # loaded by Rake, and only there test_helper is required, which then loads simplecov
+      # and triggers tracking of all other loaded files! Solution for this would be to
+      # configure simplecov in this first test instead of test_helper.
+
+    And the report should be based upon:
+      | Unit Tests |

data/features/test_unit_groups_and_filters_basic.feature

@@ -0,0 +1,29 @@
+@test_unit
+Feature:
+
+  Defining some groups and filters should give a corresponding
+  coverage report that respects those settings after running tests
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        add_group 'Libs', 'lib/faked_project/'
+        add_filter '/test/'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 88.37%   | 4     |
+      | Libs      | 86.11%   | 3     |
+      | Ungrouped | 100.0%   | 1     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/some_class.rb         |  80.0 %  |
+      | lib/faked_project/framework_specific.rb |  75.0 %  |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |

data/features/test_unit_groups_and_filters_complex.feature

@@ -0,0 +1,35 @@
+@test_unit
+Feature: Sophisticated grouping and filtering on Test/Unit
+
+  Defining groups and filters can be done by passing blocks or strings.
+  Blocks get each SimpleCov::SourceFile instance passed an can use arbitrary
+  and potentially weird conditions to remove files from the report or add them
+  to specific groups.
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        add_group 'By block' do |src_file|
+          src_file.filename =~ /MaGiC/i
+        end
+        add_group 'By string', 'project/meta_magic'
+
+        add_filter 'faked_project.rb'
+        # Remove all files that include "describe" in their source
+        add_filter {|src_file| src_file.lines.any? {|line| line.src =~ /TestCase/ } }
+        add_filter {|src_file| src_file.covered_percent < 100 }
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 100.0%   | 1     |
+      | By block  | 100.0%   | 1     |
+      | By string | 100.0%   | 1     |
+
+    And I should see the source files:
+      | name                            | coverage |
+      | lib/faked_project/meta_magic.rb | 100.0 %  |

data/features/test_unit_without_simplecov.feature

@@ -0,0 +1,20 @@
+@test_unit
+Feature:
+
+  Running unit tests without simplecov configuration
+
+  Scenario: No config at all
+    When I successfully run `bundle exec rake test`
+    Then no coverage report should have been generated
+
+  Scenario: Configured, but not started
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.configure do
+        add_filter 'somefilter'
+      end
+      """
+
+    When I successfully run `bundle exec rake test`
+    Then no coverage report should have been generated