simplecov 0.4.2 → 0.5.2

data/cucumber.yml

@@ -0,0 +1,13 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip"
+interp_opts = if defined?(RUBY_ENGINE)
+  " --tags ~@exclude-#{RUBY_ENGINE}"
+else
+  ''
+end
+%>
+default: <%= std_opts %><%= interp_opts %> features
+wip: --tags @wip:30 --wip features<%= interp_opts %>
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip<%= interp_opts %>

data/features/config_adapters.feature

@@ -0,0 +1,44 @@
+@test_unit @config @adapters
+Feature:
+
+  In order to re-use SimpleCov settings across projects,
+  adapters can be defined that hold configuration settings
+  that can be loaded at once.
+
+  Background:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      """
+
+  Scenario: Defining and using a custom adapter
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.adapters.define 'custom_command' do
+        command_name "Adapter Command"
+      end
+
+      SimpleCov.start do
+        load_adapter 'test_frameworks'
+        load_adapter 'custom_command'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Adapter Command" within "#footer"
+
+  Scenario: Using existing adapter in custom adapter and supplying adapter to start command
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.adapters.define 'my_adapter' do
+        load_adapter 'test_frameworks'
+        command_name "My Adapter"
+      end
+
+      SimpleCov.start 'my_adapter'
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using My Adapter" within "#footer"

data/features/config_autoload.feature

@@ -0,0 +1,46 @@
+@test_unit @rspec @config
+Feature:
+
+  If you have multiple test suites, it can be a bit cumbersome
+  to keep the configuration across them in sync. SimpleCov
+  is able to find a config file called '.simplecov' that resides
+  in your project's root and will automatically use it when
+  loaded.
+
+  This gives you the ability to configure SimpleCov just once
+  and then use the same configuration on all test suites simply
+  by doing a 'require "simplecov"'
+
+  Scenario:
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.start do
+        add_filter 'test.rb'
+        add_filter 'spec.rb'
+      end
+      """
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      """
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      """
+
+    When I successfully run `bundle exec rake test`
+    And I open the coverage report generated with `bundle exec rspec spec`
+    Then the report should be based upon:
+      | RSpec      |
+      | Unit Tests |
+
+    And I should see the groups:
+      | name      | coverage | files |
+      | All Files | 90.7%    | 4     |
+
+    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 |  87.5 %  |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |

data/features/config_command_name.feature

@@ -0,0 +1,33 @@
+@test_unit @rspec @merging @config
+Feature: Custom names for individual test suites
+
+  Each test suite needs a name it can be identified by. SimpleCov tries
+  best to detect Rails' Unit, Functional, Integration tests as well as regular
+  Test/Unit, RSpec and Cucumber, but if that is insufficient, each test suite
+  config can be given a custom command name using SimpleCov.command_name.
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        command_name "I'm in UR Unitz"
+      end
+      """
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        command_name "Dreck macht Speck"
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then the report should be based upon:
+      | I'm in UR Unitz |
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then the report should be based upon:
+      | Dreck macht Speck |
+      | I'm in UR Unitz   |
+

data/features/config_coverage_dir.feature

@@ -0,0 +1,20 @@
+@test_unit @config
+Feature:
+
+  The output directory for test coverage can be customized
+  with the SimpleCov.coverage_dir setting. All coverage reports
+  will be put there instead of the default 'coverage' directory
+  in your project's root.
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        coverage_dir 'test/simplecov'
+      end
+      """
+
+    When I successfully run `bundle exec rake test`
+    Then a coverage report should have been generated in "test/simplecov"
+    And a directory named "coverage" should not exist

data/features/config_deactivate_merging.feature

@@ -0,0 +1,42 @@
+@test_unit @rspec @merging @config
+Feature:
+
+  If merging of test suite results is not desired, it can be deactivated,
+  thus leading to the coverage report being overwritten with the latest results
+  of a single test suite on each run of any suite.
+
+  It's probably preferrable to generate the individual suite results into separate
+  output directories instead (see SimpleCov.coverage_dir), but it is possible :)
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        use_merging false
+      end
+      """
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        use_merging false
+      end
+      """
+
+    When I successfully run `bundle exec rake test`
+    Then a file named "coverage/index.html" should exist
+      But a file named "coverage/.resultset.json" should not exist
+
+    Given I open the coverage report
+    Then the report should be based upon:
+      | Unit Tests |
+
+    When I successfully run `bundle exec rspec spec`
+    Then a file named "coverage/index.html" should exist
+      But a file named "coverage/.resultset.json" should not exist
+
+    Given I open the coverage report
+    Then the report should be based upon:
+      | RSpec |
+

data/features/config_merge_timeout.feature

@@ -0,0 +1,38 @@
+@test_unit @rspec @merging @config
+Feature:
+
+  The maximum time between resultset merges can be customized
+  using SimpleCov.merge_timeout SECONDS. This can be helpful for
+  long-running test-suites that fail to merge because of the time
+  between individual suite finishes is more then the default timeout
+  of 10 minutes.
+
+  Here, for the sake of testing the opposite case is shown, choosing
+  a merge timeout so short that the first test suite's results actually
+  are out of date when the second suite finishes and thus does not end up
+  in the report.
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        merge_timeout 1
+      end
+      """
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        merge_timeout 1
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then the report should be based upon:
+      | Unit Tests |
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then the report should be based upon:
+      | RSpec |
+

data/features/config_project_name.feature

@@ -0,0 +1,27 @@
+@test_unit @config
+Feature:
+
+  SimpleCov guesses the project name from the project root dir's name.
+  If this is not sufficient for you, you can specify a custom name using
+  SimpleCov.project_name('xyz')
+
+
+  Scenario: Guessed name
+    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 "Code coverage for Project"
+
+  Scenario: Custom name
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start { project_name "Superfancy 2.0" }
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "Code coverage for Superfancy 2.0"

data/features/config_styles.feature

@@ -0,0 +1,93 @@
+@test_unit @config
+Feature:
+
+  There's several ways to configure SimpleCov. All of those
+  config schemes below are equivalent and can be chosen by personal
+  preference or project requirements.
+
+  Background:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      """
+
+  Scenario: Inside start block
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.start do
+        add_filter 'test'
+        command_name 'Config Test Runner'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Config Test Runner" within "#footer"
+
+  Scenario: Explicitly before start block
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.add_filter 'test'
+      SimpleCov.command_name 'Config Test Runner'
+      SimpleCov.start
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Config Test Runner" within "#footer"
+
+  Scenario: Explicitly after start block
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.start
+      SimpleCov.add_filter 'test'
+      SimpleCov.command_name 'Config Test Runner'
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Config Test Runner" within "#footer"
+
+  Scenario: Using configure block after start
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.start
+      SimpleCov.configure do
+        add_filter 'test'
+        command_name 'Config Test Runner'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Config Test Runner" within "#footer"
+
+  Scenario: Using configure block before start
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.configure do
+        add_filter 'test'
+        command_name 'Config Test Runner'
+      end
+      SimpleCov.start
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Config Test Runner" within "#footer"
+
+  Scenario: Mixing configure and start block config
+    Given a file named ".simplecov" with:
+      """
+      SimpleCov.configure do
+        command_name 'Config Test Runner'
+      end
+      SimpleCov.start do
+        add_filter 'test'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see "4 files in total."
+    And I should see "using Config Test Runner" within "#footer"
+

data/features/cucumber_basic.feature

@@ -0,0 +1,29 @@
+@cucumber
+Feature:
+
+  Simply adding the basic simplecov lines to a project should get
+  the user a coverage report after running `cucumber features`
+
+  Scenario:
+    Given SimpleCov for Cucumber is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start
+      """
+
+    When I open the coverage report generated with `bundle exec cucumber features`
+    Then I should see the groups:
+      | name      | coverage | files |
+      | All Files | 91.38%   | 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 %  |
+      | features/step_definitions/my_steps.rb   | 100.0 %  |
+      | features/support/simplecov_config.rb    | 100.0 %  |
+
+    And the report should be based upon:
+      | Cucumber Features |

data/features/merging_test_unit_and_rspec.feature

@@ -0,0 +1,44 @@
+@test_unit @rspec @merging
+Feature:
+
+  Test suites like RSpec and Test/Unit should be merged automatically
+  when both have been run recently. The coverage report will feature
+  the joined results of all test suites that are using SimpleCov.
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        add_filter 'test.rb'
+        add_filter 'spec.rb'
+      end
+      """
+    And SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      SimpleCov.start do
+        add_filter 'test.rb'
+        add_filter 'spec.rb'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then the report should be based upon:
+      | Unit Tests |
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then the report should be based upon:
+      | RSpec      |
+      | Unit Tests |
+
+    And I should see the groups:
+      | name      | coverage | files |
+      | All Files | 90.7%    | 4     |
+
+    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 |  87.5 %  |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |