aslakhellesoy-cucumber 0.3.3.4 → 0.3.3.5

data/History.txt

@@ -1,11 +1,13 @@
 == 0.3.4 (In Git)
 
-Hooray - speed improvements when using Rake!
+A couple of great new features in this release. Running with Rake is faster than before,
+and there is a brand new JUnit formatter - great for Continuous Integration reports!
 
 === Bugfixes
 * Problem with multiple terms in languages.yml (#321 Aslak Hellesøy)
 
 === New features
+* New JUnit formatter (Gareth Jones)
 * Support for Vietnamese (Ngoc Dao)
 * Added aliases for Feature and But in Japanese (Leonard Chin)
 * Support for Catalan (Francesc Esplugas)

data/Manifest.txt

@@ -157,6 +157,9 @@ examples/java/features/step_definitons/hello_steps.rb
 examples/java/features/step_definitons/tree_steps.rb
 examples/java/features/tree.feature
 examples/java/src/cucumber/demo/Hello.java
+examples/junit/features/one_passing_one_failing.feature
+examples/junit/features/pending.feature
+examples/junit/features/step_definitions/steps.rb
 examples/pure_java/README.textile
 examples/selenium/Rakefile
 examples/selenium/features/search.feature
@@ -241,6 +244,7 @@ features/cucumber_cli_diff_disabled.feature
 features/cucumber_cli_outlines.feature
 features/custom_formatter.feature
 features/exclude_files.feature
+features/junit_formatter.feature
 features/multiline_names.feature
 features/rake_task.feature
 features/report_called_undefined_steps.feature
@@ -296,6 +300,7 @@ lib/cucumber/formatter/console.rb
 lib/cucumber/formatter/cucumber.css
 lib/cucumber/formatter/cucumber.sass
 lib/cucumber/formatter/html.rb
+lib/cucumber/formatter/junit.rb
 lib/cucumber/formatter/pretty.rb
 lib/cucumber/formatter/profile.rb
 lib/cucumber/formatter/progress.rb

data/examples/junit/features/one_passing_one_failing.feature

@@ -0,0 +1,8 @@
+Feature: One passing scenario, one failing scenario
+
+  Scenario: Passing
+    Given a passing scenario
+    
+  Scenario: Failing
+    Given a failing scenario
+    

data/examples/junit/features/pending.feature

@@ -0,0 +1,5 @@
+Feature: Pending step
+
+  Scenario: Pending
+    Given a pending step
+    

data/examples/junit/features/step_definitions/steps.rb

@@ -0,0 +1,11 @@
+Given /a passing scenario/ do
+  #does nothing
+end
+
+Given /a failing scenario/ do
+  fail
+end
+
+Given /a pending step/ do
+  pending
+end

data/examples/tickets/features/177/1.feature

@@ -1,29 +1,29 @@
-Users want to know that nobody can masquerade as them.  We want to extend trust
-only to visitors who present the appropriate credentials.  Everyone wants this
-identity verification to be as secure and convenient as possible.
-
-Feature: Logging in
-  As an anonymous user with an account
-  I want to log in to my account
-  So that I can be myself
-
-  #
-  # Log in: get form
-  #
-  Scenario: Anonymous user can get a login form.
-    Given I am logged out
-    When  I go to "/login"
-    Then  I should be at the "sessions/new" page
-
-  #
-  # Log in successfully, but don't remember me
-  #
-  Scenario: Anonymous user can log in
-    Given an "activated" user named "reggie" exists
-     And  I am logged out
-    When  I go to "/login"
-     And  I fill in "Login" with "reggie"
-     And  I fill in "Password" with "password"
-     And  I press "Log in"
-    Then  I should be at the "dashboard/index" page
-
+Users want to know that nobody can masquerade as them.  We want to extend trust
+only to visitors who present the appropriate credentials.  Everyone wants this
+identity verification to be as secure and convenient as possible.
+
+Feature: Logging in
+  As an anonymous user with an account
+  I want to log in to my account
+  So that I can be myself
+
+  #
+  # Log in: get form
+  #
+  Scenario: Anonymous user can get a login form.
+    Given I am logged out
+    When  I go to "/login"
+    Then  I should be at the "sessions/new" page
+
+  #
+  # Log in successfully, but don't remember me
+  #
+  Scenario: Anonymous user can log in
+    Given an "activated" user named "reggie" exists
+     And  I am logged out
+    When  I go to "/login"
+     And  I fill in "Login" with "reggie"
+     And  I fill in "Password" with "password"
+     And  I press "Log in"
+    Then  I should be at the "dashboard/index" page
+

data/examples/tickets/features/177/2.feature

@@ -1,21 +1,21 @@
-Visitors may create an account, but for those who are not already in the 
-system an someone must activate the account for them before it can be used.
-
-Feature: Activating an account
-  As a registered, but not yet activated, user
-  I want to be able to activate my account
-  So that I can log in to the site
-  
-  Scenario: Not-yet-activated user can activate her account
-    Given a registered user named 'Reggie' # need to rewrite
-  #    And  the user has activation_code: 'activate_me', activated_at: nil! 
-  #    And  we try hard to remember the user's updated_at, and created_at
-  #   When  she goes to /activate/activate_me
-  #   Then  she should be redirected to 'login'
-  #   When  she follows that redirect!
-  #   Then  she should see a notice message 'Signup complete!'
-  #    And  a user with login: 'reggie' should exist
-  #    And  the user should have login: 'reggie', and email: 'registered@example.com'
-  #    And  the user's activation_code should     be nil
-  #    And  the user's activated_at    should not be nil
+Visitors may create an account, but for those who are not already in the 
+system an someone must activate the account for them before it can be used.
+
+Feature: Activating an account
+  As a registered, but not yet activated, user
+  I want to be able to activate my account
+  So that I can log in to the site
+  
+  Scenario: Not-yet-activated user can activate her account
+    Given a registered user named 'Reggie' # need to rewrite
+  #    And  the user has activation_code: 'activate_me', activated_at: nil! 
+  #    And  we try hard to remember the user's updated_at, and created_at
+  #   When  she goes to /activate/activate_me
+  #   Then  she should be redirected to 'login'
+  #   When  she follows that redirect!
+  #   Then  she should see a notice message 'Signup complete!'
+  #    And  a user with login: 'reggie' should exist
+  #    And  the user should have login: 'reggie', and email: 'registered@example.com'
+  #    And  the user's activation_code should     be nil
+  #    And  the user's activated_at    should not be nil
   #    And  she should not be logged in

data/features/junit_formatter.feature

@@ -0,0 +1,59 @@
+Feature: JUnit output formatter
+  In order for developers to create test reports with ant
+  Cucumber should be able to output JUnit xml files
+  
+  Background:
+    Given I am in junit
+    And the tmp directory is empty
+    
+  Scenario: one feature, one passing scenario, one failing scenario
+    When I run cucumber --format junit --out tmp/ features/one_passing_one_failing.feature
+    Then it should fail with
+      """
+
+      """
+    And "examples/junit/tmp/TEST-One_passing_scenario__one_failing_scenario.xml" should contain XML
+      """
+      <?xml version="1.0" encoding="UTF-8"?>
+      <testsuite errors="0" tests="2" name="One passing scenario, one failing scenario" failures="1">
+      <testcase name="Given a passing scenario" classname="One passing scenario, one failing scenario.Passing">
+      </testcase>
+      <testcase name="Given a failing scenario" classname="One passing scenario, one failing scenario.Failing">
+        <failure message="Given a failing scenario">
+       (RuntimeError)
+      ./features/step_definitions/steps.rb:6:in `/a failing scenario/'
+      features/one_passing_one_failing.feature:7:in `Given a failing scenario'  </failure>
+      </testcase>
+      </testsuite>
+      
+      """
+  Scenario: pending step
+    When I run cucumber --format junit --out tmp/ features/pending.feature
+    Then it should pass with
+      """
+      
+      """
+    And "examples/junit/tmp/TEST-Pending_step.xml" should contain XML
+      """
+      <?xml version="1.0" encoding="UTF-8"?>
+      <testsuite errors="0" tests="1" name="Pending step" failures="1">
+      <testcase name="Given a pending step" classname="Pending step.Pending">
+        <failure message="Given a pending step">
+      TODO (Cucumber::Pending)
+      ./features/step_definitions/steps.rb:10:in `/a pending step/'
+      features/pending.feature:4:in `Given a pending step'  </failure>
+      </testcase>
+      </testsuite>
+      
+      """
+    
+  Scenario: run all features
+    When I run cucumber --format junit --out tmp/ features
+    Then it should fail with
+      """
+      
+      """
+    And "examples/junit/tmp/TEST-One_passing_scenario__one_failing_scenario.xml" should exist
+    And "examples/junit/tmp/TEST-Pending_step.xml" should exist
+    
+    

data/features/step_definitions/cucumber_steps.rb

@@ -1,3 +1,5 @@
+require 'tempfile'
+
 Given /^I am in (.*)$/ do |example_dir_relative_path|
   @current_dir = examples_dir(example_dir_relative_path)
 end
@@ -10,6 +12,13 @@ Given /^a standard Cucumber project directory structure$/ do
   end
 end
 
+Given /^the (.*) directory is empty$/ do |directory|
+  in_current_dir do
+    FileUtils.remove_dir(directory) rescue nil
+    FileUtils.mkdir 'tmp'
+  end
+end
+
 Given /^a file named "([^\"]*)"$/ do |file_name|
   create_file(file_name, '')
 end
@@ -53,6 +62,18 @@ Then /^the output should not contain$/ do |text|
   last_stdout.should_not include(text)
 end
 
+# http://diffxml.sourceforge.net/
+Then /^"(.*)" should contain XML$/ do |file, xml|
+  t = Tempfile.new('cucumber-junit')
+  t.write(xml)
+  t.flush
+  t.close
+  diff = `diffxml #{t.path} #{file}`
+  if diff =~ /<delta>/m
+    raise diff + "\nXML WAS:\n" + IO.read(file)
+  end
+end
+
 Then /^"(.*)" should contain$/ do |file, text|
   IO.read(file).should == text
 end

data/lib/cucumber/cli/configuration.rb

@@ -3,7 +3,7 @@ module Cucumber
     class YmlLoadError < StandardError; end
 
     class Configuration
-      FORMATS = %w{pretty profile progress rerun}
+      FORMATS = %w{pretty profile progress rerun junit}
       DEFAULT_FORMAT = 'pretty'
 
       attr_reader :paths
@@ -66,10 +66,11 @@ module Cucumber
             @options[:formats][v] = @out_stream
             @active_format = v
           end
-          opts.on("-o", "--out FILE",
-            "Write output to a file instead of STDOUT. This option",
+          opts.on("-o", "--out [FILE|DIR]",
+            "Write output to a file/directory instead of STDOUT. This option",
             "applies to the previously specified --format, or the",
-            "default format if no format is specified.") do |v|
+            "default format if no format is specified. Check the specific",
+            "formatter's docs to see whether to pass a file or a dir.") do |v|
             @options[:formats][@active_format] = v
           end
           opts.on("-t TAGS", "--tags TAGS",
@@ -198,10 +199,12 @@ module Cucumber
         return Formatter::Pretty.new(step_mother, nil, @options) if @options[:autoformat]
         formatters = @options[:formats].map do |format, out|
           if String === out # file name
-            out = File.open(out, Cucumber.file_mode('w'))
-            at_exit do
-              out.flush
-              out.close
+            unless File.directory?(out)
+              out = File.open(out, Cucumber.file_mode('w'))
+              at_exit do
+                out.flush
+                out.close
+              end
             end
           end
 
@@ -209,7 +212,7 @@ module Cucumber
             formatter_class = formatter_class(format)
             formatter_class.new(step_mother, out, @options)
           rescue Exception => e
-            e.message += "\nError creating formatter: #{format}"
+            e.message << "\nError creating formatter: #{format}"
             raise e
           end
         end
@@ -227,6 +230,7 @@ module Cucumber
           when 'progress' then Formatter::Progress
           when 'rerun'    then Formatter::Rerun
           when 'usage'    then Formatter::Usage
+          when 'junit'    then Formatter::JUnit
         else
           constantize(format)
         end

data/lib/cucumber/formatter.rb

@@ -1 +1 @@
-%w{color_io pretty progress profile rerun html usage}.each{|n| require "cucumber/formatter/#{n}"}
+%w{color_io pretty progress profile rerun html usage junit}.each{|n| require "cucumber/formatter/#{n}"}

data/lib/cucumber/formatter/junit.rb

@@ -0,0 +1,78 @@
+begin
+  require 'builder'
+rescue LoadError
+  gem 'builder'
+  require 'builder'
+end
+
+module Cucumber
+  module Formatter
+    class JUnit < Cucumber::Ast::Visitor
+
+      def initialize(step_mother, io, options)
+        super(step_mother)
+        @reportdir = io
+        raise "You *must* specify --out DIR for the junit formatter" unless @reportdir
+        raise "Use --out DIR (not --out FILE) for the junit formatter" if File === @reportdir
+      end
+
+      def visit_feature(feature)
+        @failures = @errors = @tests = 0
+        @builder = Builder::XmlMarkup.new( :indent => 2 )
+        super
+
+        @testsuite = Builder::XmlMarkup.new( :indent => 2 )
+        @testsuite.instruct!
+        @testsuite.testsuite(
+          :failures => @failures,
+          :errors => @errors,
+          :tests => @tests,
+          :name => @feature_name ) do
+          @testsuite << @builder.target!
+        end
+
+        File.open(@feature_filename, 'w') { |file| file.write(@testsuite.target!) }
+      end
+
+      def visit_feature_name(name)
+        lines = name.split(/\r?\n/)
+        @feature_name = lines[0].sub(/Feature\:/, '').strip
+        @feature_filename = convert_to_file_name(@feature_name)
+      end
+
+      def visit_scenario_name(keyword, name, file_colon_line, source_indent)
+        @scenario = name
+      end
+
+      def visit_steps(steps)
+        @steps_failed = false
+        super
+        @failures += 1 if @steps_failed
+        @tests += 1
+      end
+
+      def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background)
+        step_name = keyword + " " + step_match.format_args(lambda{|param| "*#{param}*"})
+        @builder.testcase(:classname => "#{@feature_name}.#{@scenario}", :name => step_name) do
+          if status != :passed
+            @builder.failure(:message => step_name) do
+              @builder.text!(format_exception(exception)) if exception
+            end
+            @steps_failed = true
+          end
+        end
+      end
+
+      private
+
+      def convert_to_file_name(feature_name)
+        @reportdir + "TEST-" + feature_name.gsub(/[^\w_\.]/, '_') + ".xml"
+      end
+
+      def format_exception(exception)
+        (["#{exception.message} (#{exception.class})"] + exception.backtrace).join("\n")
+      end
+    end
+
+  end
+end

data/lib/cucumber/parser/feature.rb

@@ -481,15 +481,19 @@ module Cucumber
       end
 
       module Background1
-
         def matches_name?(regexp_to_match)
           name.build =~ regexp_to_match
         end
 
-       def has_tags?(tag_names)
-         feature_tags = self.parent.tags
-         feature_tags.has_tags?(tag_names)
-       end
+        def at_line?(line)
+          background_keyword.line == line ||
+          steps.at_line?(line)
+        end
+
+        def has_tags?(tag_names)
+          feature_tags = self.parent.tags
+          feature_tags.has_tags?(tag_names)
+        end
 
         def build
           Ast::Background.new(
@@ -499,7 +503,7 @@ module Cucumber
             name.build, 
             steps.build
           )
-         end
+        end
       end
 
       def _nt_background

data/lib/cucumber/parser/feature.tt

@@ -76,27 +76,31 @@ module Cucumber
       end
 
       rule background
-         comment white background_keyword space* name:lines_to_keyword? (eol+ / eof) steps {
+        comment white background_keyword space* name:lines_to_keyword? (eol+ / eof) steps {
+          def matches_name?(regexp_to_match)
+            name.build =~ regexp_to_match
+          end
 
-           def matches_name?(regexp_to_match)
-             name.build =~ regexp_to_match
-           end
+          def at_line?(line)
+            background_keyword.line == line ||
+            steps.at_line?(line)
+          end
 
           def has_tags?(tag_names)
             feature_tags = self.parent.tags
             feature_tags.has_tags?(tag_names)
           end
 
-           def build
-             Ast::Background.new(
-               comment.build, 
-               background_keyword.line,
-               background_keyword.text_value,
-               name.build, 
-               steps.build
-             )
-            end
-          }
+          def build
+            Ast::Background.new(
+              comment.build, 
+              background_keyword.line,
+              background_keyword.text_value,
+              name.build, 
+              steps.build
+            )
+          end
+        }
       end
 
       rule feature_elements

data/lib/cucumber/version.rb

@@ -3,7 +3,7 @@ module Cucumber #:nodoc:
     MAJOR = 0
     MINOR = 3
     TINY  = 3
-    PATCH = 4 # Set to nil for official release
+    PATCH = 5 # Set to nil for official release
 
     STRING = [MAJOR, MINOR, TINY, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aslakhellesoy-cucumber
 version: !ruby/object:Gem::Version 
-  version: 0.3.3.4
+  version: 0.3.3.5
 platform: ruby
 authors: 
 - "Aslak Helles\xC3\xB8y"
@@ -234,6 +234,9 @@ files:
 - examples/java/features/step_definitons/tree_steps.rb
 - examples/java/features/tree.feature
 - examples/java/src/cucumber/demo/Hello.java
+- examples/junit/features/one_passing_one_failing.feature
+- examples/junit/features/pending.feature
+- examples/junit/features/step_definitions/steps.rb
 - examples/pure_java/README.textile
 - examples/selenium/Rakefile
 - examples/selenium/features/search.feature
@@ -318,6 +321,7 @@ files:
 - features/cucumber_cli_outlines.feature
 - features/custom_formatter.feature
 - features/exclude_files.feature
+- features/junit_formatter.feature
 - features/multiline_names.feature
 - features/rake_task.feature
 - features/report_called_undefined_steps.feature
@@ -373,6 +377,7 @@ files:
 - lib/cucumber/formatter/cucumber.css
 - lib/cucumber/formatter/cucumber.sass
 - lib/cucumber/formatter/html.rb
+- lib/cucumber/formatter/junit.rb
 - lib/cucumber/formatter/pretty.rb
 - lib/cucumber/formatter/profile.rb
 - lib/cucumber/formatter/progress.rb