mattwynne-cucover 0.0.4 → 0.1.0

data/features/lazy_run.feature

@@ -0,0 +1,79 @@
+Feature: Lazy Run
+  In order to get rapid feedback, stay motivated and keep my concentration
+  As a developer
+  I want to be able to run only the features that could have been affected by the changes I've made
+  
+  Background:
+    And I am using the simple example app
+    And I have run cucover -- features/call_foo.feature
+  
+  Scenario: Change nothing and run same feature again
+    When I run cucover -- -q features/call_foo.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo
+
+        Scenario: Call Foo
+      
+      [ Cucover - Skipping clean scenario ]
+          When I call Foo
+      
+      1 scenario (1 skipped)
+      1 step (1 skipped)
+      
+      """
+      
+  Scenario: Change irrelevant source file and run same feature again
+    When I edit the source file lib/bar.rb
+    When I run cucover -- features/call_foo.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo
+      
+        Scenario: Call Foo # features/call_foo.feature:3
+
+      [ Cucover - Skipping clean scenario ]
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+      
+      1 scenario (1 skipped)
+      1 step (1 skipped)
+      
+      """  
+      
+  Scenario: Touch feature file and run same feature again
+    When I edit the source file features/call_foo.feature
+    And I run cucover -- features/call_foo.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo
+
+        Scenario: Call Foo # features/call_foo.feature:3
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+
+      1 scenario (1 passed)
+      1 step (1 passed)
+      
+      """
+  
+  Scenario: Touch one source file and try to run lots of features
+    When I edit the source file lib/bar.rb
+    And I run cucover -- features/call_foo.feature features/call_foo_and_bar_together.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo
+      
+        Scenario: Call Foo # features/call_foo.feature:3
+      
+      [ Cucover - Skipping clean scenario ]
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+      
+      Feature: Call Foo and Bar Together
+
+        Scenario: Call Foo and Bar # features/call_foo_and_bar_together.feature:3
+          When I call Foo          # features/step_definitions/main_steps.rb:9
+          And I call Bar           # features/step_definitions/main_steps.rb:9
+
+      2 scenarios (1 skipped, 1 passed)
+      3 steps (1 skipped, 2 passed)
+      
+      """

data/features/lazy_run_per_scenario.feature

@@ -0,0 +1,113 @@
+Feature: Lazy Run per Scenario
+  In order to work with a single feature
+  As a developer
+  I want to skip the scenarios that don't need to be run
+  
+  Background:
+    Given I am using the simple example app
+  
+  Scenario: Change nothing and run same feature again
+    Given I have run cucover -- features/call_foo_then_bar.feature
+    When I run cucover -- features/call_foo_then_bar.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo then Bar
+
+        Scenario: Call Foo # features/call_foo_then_bar.feature:3
+
+      [ Cucover - Skipping clean scenario ]
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+
+        Scenario: Call Bar # features/call_foo_then_bar.feature:6
+
+      [ Cucover - Skipping clean scenario ]
+          When I call Bar  # features/step_definitions/main_steps.rb:9
+
+      2 scenarios (2 skipped)
+      2 steps (2 skipped)
+      
+      """
+
+  Scenario: Edit source file covered by only one scenario and run same feature again
+    Given I have run cucover -- features/call_foo_then_bar.feature
+    When I edit the source file lib/foo.rb
+    And I run cucover -- features/call_foo_then_bar.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo then Bar
+
+        Scenario: Call Foo # features/call_foo_then_bar.feature:3
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+
+        Scenario: Call Bar # features/call_foo_then_bar.feature:6
+
+      [ Cucover - Skipping clean scenario ]
+          When I call Bar  # features/step_definitions/main_steps.rb:9
+
+      2 scenarios (1 skipped, 1 passed)
+      2 steps (1 skipped, 1 passed)
+      
+      """
+  
+  Scenario: Run a feature with a background twice
+    Given I have run cucover -- features/call_foo_from_background_then_bar.feature
+    When I run cucover -- features/call_foo_from_background_then_bar.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo from Background then Bar
+
+        Background:               # features/call_foo_from_background_then_bar.feature:3
+      
+      [ Cucover - Skipping clean scenario ]
+          Given I have called Foo # features/step_definitions/main_steps.rb:5
+
+        Scenario: Call Bar        # features/call_foo_from_background_then_bar.feature:6
+          When I call Bar         # features/step_definitions/main_steps.rb:9
+
+      1 scenario (1 skipped)
+      2 steps (2 skipped)
+      
+      """
+
+  Scenario: Edit source file covered by the background of a feature
+    Given I have run cucover -- features/call_foo_from_background_then_bar.feature
+    When I edit the source file lib/foo.rb
+    And I run cucover -- features/call_foo_from_background_then_bar.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo from Background then Bar
+      
+        Background:               # features/call_foo_from_background_then_bar.feature:3
+          Given I have called Foo # features/step_definitions/main_steps.rb:5
+
+        Scenario: Call Bar        # features/call_foo_from_background_then_bar.feature:6
+          When I call Bar         # features/step_definitions/main_steps.rb:9
+
+      1 scenario (1 passed)
+      2 steps (2 passed)
+      
+      """
+
+  Scenario: Edit source file covered by a scenario with a background
+    Given I have run cucover -- features/call_foo_from_background_then_bar_then_baz.feature
+    When I edit the source file lib/bar.rb
+    And I run cucover -- features/call_foo_from_background_then_bar_then_baz.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo from Background then Bar then Baz
+      
+        Background:               # features/call_foo_from_background_then_bar_then_baz.feature:3
+          Given I have called Foo # features/step_definitions/main_steps.rb:5
+
+        Scenario: Call Bar        # features/call_foo_from_background_then_bar_then_baz.feature:6
+          When I call Bar         # features/step_definitions/main_steps.rb:9
+      
+        Scenario: Call Baz        # features/call_foo_from_background_then_bar_then_baz.feature:9
+      
+      [ Cucover - Skipping clean scenario ]
+          When I call Baz         # features/step_definitions/main_steps.rb:9
+
+      2 scenarios (1 skipped, 1 passed)
+      4 steps (2 skipped, 2 passed)
+      
+      """

data/features/lazy_run_per_scenario_outline_example.feature

@@ -0,0 +1,31 @@
+Feature: Lazy Run per Scenario Outline Example
+  In order save time
+  As a developer working on a feature with Scenario Outlines
+  I want to run only the examples that could fail
+  
+  Background:
+    Given I am using the simple example app
+    And I have run cucover -- features/call_foo_then_bar_from_scenario_outline_examples.feature
+  
+  Scenario: Edit a source file that should trigger just one of the examples to be run
+    When I edit the source file lib/bar.rb
+    And I run cucover -- -q features/call_foo_then_bar_from_scenario_outline_examples.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo then Bar from Scenario Outline Examples
+
+        Scenario Outline: Call Something
+          When I call <Code>
+
+          Examples: 
+            | Code |
+            |
+      [ Cucover - Skipping clean scenario ]
+       Foo  |
+            | Bar  |
+
+      2 scenarios (1 skipped, 1 passed)
+      2 steps (1 skipped, 1 passed)
+      
+      """
+    # Which is a bit ugly, but that's down the the formatter

data/features/lazy_run_triggered_by_rails_view_change.feature

@@ -0,0 +1,42 @@
+@slow
+Feature: Lazy Run Triggered By Rails View Change
+  In order to feel the cucover love
+  As a front-end developer
+  I want the changes I make to rails views to trigger cucover runs, the same as Ruby code does
+  
+  Background:
+    And I am using the rails example app
+    And I have run cucover -- features/see_widgets.feature
+
+  Scenario: Change nothing and run cucover again
+    When I run cucover -- features/see_widgets.feature
+    Then it should pass with:
+      """
+      Feature: See widgets
+
+        Scenario: See widgets                                  # features/see_widgets.feature:3
+
+      [ Cucover - Skipping clean scenario ]
+          When I go to /widgets                                # features/step_definitions/webrat_steps.rb:1
+          Then I should see "Look at all these lovely widgets" # features/step_definitions/webrat_steps.rb:5
+
+      1 scenario (1 skipped)
+      2 steps (2 skipped)
+      
+      """
+      
+  Scenario: Edit a view and run cucover again
+    When I edit the source file app/views/widgets/index.html.erb
+    When I run cucover -- features/see_widgets.feature
+    Then it should pass with:
+      """
+      Feature: See widgets
+
+        Scenario: See widgets                                  # features/see_widgets.feature:3
+          When I go to /widgets                                # features/step_definitions/webrat_steps.rb:1
+          Then I should see "Look at all these lovely widgets" # features/step_definitions/webrat_steps.rb:5
+
+      1 scenario (1 passed)
+      2 steps (2 passed)
+      
+      """

data/features/run.feature

@@ -0,0 +1,25 @@
+Feature: Run
+  In order to trust cucover and not have to switch between testing tools
+  As a developer
+  I want to be able to run features and get useful feedback through cucover
+  
+  Scenario: Run features, minimal output
+    Given I am using the simple example app
+    When I run cucover -- features/call_foo.feature features/call_foo_and_bar_together.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo
+
+        Scenario: Call Foo # features/call_foo.feature:3
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+
+      Feature: Call Foo and Bar Together
+
+        Scenario: Call Foo and Bar # features/call_foo_and_bar_together.feature:3
+          When I call Foo          # features/step_definitions/main_steps.rb:9
+          And I call Bar           # features/step_definitions/main_steps.rb:9
+
+      2 scenarios (2 passed)
+      3 steps (3 passed)
+
+      """

data/features/show_recordings.feature

@@ -0,0 +1,28 @@
+Feature: Show Recordings
+  In order to see what's going on inside Cucover
+  As a developer of Cucover
+  I want to be able to see a human-readable summary of the recordings
+
+  Background:
+    Given I am using the simple example app
+  
+  Scenario: Run a couple of features, see the recordings
+    Given I have run cucover -- features/call_foo.feature
+    And I have run cucover -- features/call_foo_and_bar_together.feature
+    When I run cucover --show-recordings
+    Then it should pass with:
+    """
+
+    features/call_foo.feature:3
+      features/step_definitions/main_steps.rb:6:10
+      lib/foo.rb:2:3:4
+      features/call_foo.feature:<unknown lines>
+    
+    features/call_foo_and_bar_together.feature:3
+      lib/foo.rb:2:3:4
+      features/step_definitions/main_steps.rb:6:10
+      lib/bar.rb:2:3:4
+      features/call_foo_and_bar_together.feature:<unknown lines>
+    
+    
+    """

data/features/step_definitions/main_steps.rb

@@ -0,0 +1,36 @@
+Given /^I have (tried to |)run cucover (.*)$/ do |tried, args|
+  When %{I run cucover #{args}}
+  if tried.blank?
+    assert(@status == 0, @out)
+  end
+end
+
+Given /^I am using the (.*) example app$/ do |app_name|
+  @example_app = app_name
+  clear_cache!
+end
+
+When /^I run cucover (.*)$/ do |args|
+  cucover_binary = File.expand_path(File.dirname(__FILE__) + '../../../bin/cucover')
+  within_examples_dir do
+    full_cmd = "#{Cucumber::RUBY_BINARY} #{cucover_binary} #{args}"
+    @out = `#{full_cmd}`
+    @status = $?.exitstatus
+  end
+end
+
+When /^I edit the source file (.*)$/ do |source_file|
+  within_examples_dir do
+    edit source_file
+  end
+end
+
+Then /^it should (pass|fail) with:$/ do |expected_status, expected_text|
+  expected_status_code = expected_status == "pass" ? 0 : 1
+  
+  unless @status == expected_status_code
+    raise "Expected #{expected_status} but return code was #{@status}: #{@out}"
+  end
+  
+  strip_duration(@out).should == expected_text
+end

data/features/support/env.rb

@@ -0,0 +1,48 @@
+# require File.dirname(__FILE__) + '/../../lib/cucover'
+require 'spec'
+require 'test/unit/assertions'
+
+module CucoverHelper  
+  def edit(file)
+    original_mtime = File.mtime(file) 
+    FileUtils.touch(file)
+    @edited_files ||= {}
+    @edited_files[file] = original_mtime
+  end
+  
+  def restore_file_mtimes
+    return unless @edited_files
+    @edited_files.each do |file, original_mtime|
+      `touch -t #{original_mtime.strftime('%Y%m%d%H%M.%S')} #{examples_dir}/#{file}`
+    end
+  end
+  
+  def strip_duration(s)
+    s.gsub(/^\d+m\d+\.\d+s\n/m, "")
+  end
+  
+  def clear_cache!
+    `find examples -name cucover.data | xargs rm -rf`
+  end
+  
+  def example_app
+    @example_app || raise("Please call the step 'Given I am using the .... example app' so I know which example app to run these features in.")
+  end
+
+  def within_examples_dir
+    Dir.chdir(examples_dir) do
+      yield
+    end
+  end
+  
+  def examples_dir
+    File.expand_path(File.dirname(__FILE__) + "/../../examples/self_test/#{example_app}")    
+  end
+end
+
+World CucoverHelper, Test::Unit::Assertions
+
+After do
+  clear_cache!
+  restore_file_mtimes
+end

data/lib/cucover/cli.rb

@@ -0,0 +1,26 @@
+module Cucover
+  class Cli
+    def initialize(args)
+      @args = args
+    end
+
+    def start
+      command_type.new(@args).execute
+    end
+    
+    private
+    
+    def command_type
+      if @args.index('--')
+        CliCommands::Cucumber
+      elsif @args.index('--coverage-of')
+        CliCommands::CoverageOf
+      elsif @args.index('--show-recordings')
+        CliCommands::ShowRecordings
+      else
+        raise("Sorry: I don't understand these command line arguments: #{@args.inspect}. Soon I will say something more helpful here.")
+      end
+    end
+    
+  end
+end

data/lib/cucover/cli_commands/coverage_of.rb

@@ -0,0 +1,36 @@
+module Cucover
+  module CliCommands
+    class CoverageOf
+      CODE_COLUMN_WIDTH = 15
+      
+      def initialize(cli_args)
+        @filespec = cli_args[1]
+        @store = Store.new
+      end
+      
+      def execute
+        return unless recordings.any?
+
+        File.open(@filespec).each_with_index do |line_content, index|
+          line_number = index + 1
+          coverage_text = coverage(line_number).join(', ')
+          line_content.rstrip!
+          if line_content.length > CODE_COLUMN_WIDTH
+            truncated_line_content = "#{line_content[0..(CODE_COLUMN_WIDTH - 1)]}.."
+          else
+            truncated_line_content = "#{line_content}  "
+          end
+          puts "#{line_number} #{truncated_line_content.ljust(CODE_COLUMN_WIDTH + 2)} #{coverage_text}"
+        end
+      end
+      
+      def coverage(line_number)
+        recordings.select{ |r| r.covers_line?(@filespec, line_number) }.map{ |r| r.file_colon_line }
+      end
+      
+      def recordings
+        @recordings ||= @store.recordings_covering(@filespec)
+      end
+    end
+  end
+end

data/lib/cucover/cli_commands/cucumber.rb

@@ -0,0 +1,25 @@
+module Cucover
+  module CliCommands
+    class Cucumber
+      def initialize(cli_args)
+        @cli_args = cli_args
+      end
+      
+      def execute
+        require 'cucover/cucumber_hooks'
+        ARGV.replace cucumber_args
+        Kernel.load ::Cucumber::BINARY
+        ARGV.replace @cli_args
+      end
+      
+      private 
+      
+      def cucumber_args
+        return nil unless @cli_args.index('--')
+        first = @cli_args.index('--') + 1
+        last = @cli_args.length - 1
+        @cli_args[first..last]
+      end
+    end
+  end
+end

data/lib/cucover/cli_commands/show_recordings.rb

@@ -0,0 +1,29 @@
+module Cucover
+  module CliCommands
+    class ShowRecordings
+      def initialize(cli_args)
+        @store = Store.new
+      end
+      
+      def execute
+        unless recordings.any?
+          puts "No recordings to show. Run some tests with cucover first."
+          return
+        end
+        
+        recordings.each do |recording|
+          puts
+          puts "#{recording.file_colon_line}" # (#{recording.start_time.strftime('%Y-%m-%d %H:%M:%S')})
+          recording.covered_files.each do |covered_file|
+            puts "  #{covered_file.to_s}"
+          end
+        end
+        puts
+      end
+      
+      def recordings
+        @recordings ||= @store.latest_recordings.sort{ |x, y| x.file_colon_line <=> y.file_colon_line }
+      end
+    end
+  end
+end

data/lib/cucover/controller.rb

@@ -0,0 +1,28 @@
+module Cucover
+  class Controller
+    def initialize(file_colon_line, store)
+      @file_colon_line = file_colon_line
+      @store = store
+    end
+    
+    def should_execute?
+      dirty? or failed_on_last_run?
+    end
+    
+    private
+    
+    def failed_on_last_run?
+      return false unless recording
+      recording.failed?
+    end
+    
+    def dirty?
+      Cucover.logger.debug("Assuming dirty as no recording found") and return true unless recording
+      recording.covered_files.any?{ |f| f.dirty? }
+    end
+    
+    def recording
+      @recording ||= @store.latest_recording(@file_colon_line)
+    end
+  end
+end

data/lib/cucover/cucumber_hooks.rb

@@ -0,0 +1,29 @@
+module Cucover
+  module ExampleRowExtensions
+    def file_colon_line
+      "#{file}:#{line}"
+    end
+    
+    def file
+      @scenario_outline.file_colon_line.split(':').first
+    end
+  end
+end
+
+Cucover::Monkey.extend_every Cucumber::Ast::OutlineTable::ExampleRow => Cucover::ExampleRowExtensions
+
+Before do |scenario_or_table_row|
+  Cucover.logger.info("Starting #{scenario_or_table_row.class} #{scenario_or_table_row.file_colon_line}")
+  Cucover::Rails.patch_if_necessary
+  
+  if Cucover.should_execute?(scenario_or_table_row)
+    Cucover.start_recording!(scenario_or_table_row)
+  else
+    announce "[ Cucover - Skipping clean scenario ]"
+    scenario_or_table_row.skip_invoke!
+  end
+end
+
+After do
+  Cucover.stop_recording!
+end

data/lib/cucover/logging_config.rb

@@ -0,0 +1,16 @@
+Logging.configure do
+  logger('Cucover') do
+    level     :debug
+    appenders 'logfile'
+  end
+
+  appender('logfile') do
+    type      'File'
+    level     :debug
+    filename  File.dirname(__FILE__) + '/../../tmp/cucover.log'
+    layout do
+      type        'Pattern'
+      pattern     '[%d] %l  %c : %m\n'
+    end
+  end  
+end

data/lib/cucover/monkey.rb

@@ -0,0 +1,14 @@
+module Cucover
+  module Monkey
+    def self.extend_every(args)
+      class_to_extend = args.keys.first
+      module_to_extend_with = args.values.first
+    
+      class_to_extend.instance_eval <<-PATCH
+        def new(*args)
+          super(*args).extend(#{module_to_extend_with})
+        end
+      PATCH
+    end
+  end
+end

data/lib/cucover/rails.rb

@@ -0,0 +1,20 @@
+module Cucover
+  module Rails
+    class << self
+      def patch_if_necessary
+        return if @patched
+        return unless defined?(ActionView)
+      
+        Monkey.extend_every ActionView::Template => Cucover::Rails::RecordsRenders      
+        @patched = true
+      end
+    end
+  
+    module RecordsRenders
+      def render
+        Cucover.record_file(@filename)
+        super
+      end
+    end
+  end
+end

data/lib/cucover/recorder.rb

@@ -0,0 +1,37 @@
+module Cucover
+  class Recorder
+    def initialize(scenario_or_table_row)
+      @scenario_or_table_row = scenario_or_table_row
+      @analyzer = Rcov::CodeCoverageAnalyzer.new
+      @additional_covered_files = []
+    end
+
+    def record_file!(source_file)
+      unless @additional_covered_files.include?(source_file)
+        @additional_covered_files << source_file
+      end
+    end
+  
+    def start!
+      @start_time = Time.now
+      @analyzer.install_hook
+    end
+
+    def stop!
+      @end_time = Time.now
+      @analyzer.remove_hook
+      Cucover.logger.info("Finished recording #{@scenario_or_table_row.file_colon_line}.")
+      Cucover.logger.debug("Covered files: #{@analyzer.analyzed_files.join(',')}")
+      Cucover.logger.debug("Additional Covered files: #{@additional_covered_files.join(',')}")
+    end
+  
+    def recording
+      Recording.new(
+        @scenario_or_table_row.file_colon_line, 
+        @scenario_or_table_row.exception,
+        @additional_covered_files, 
+        @analyzer, 
+        @start_time, @end_time)
+    end
+  end
+end