cucumber 2.99.0 → 3.0.0

data/examples/test_unit/features/step_definitions/test_unit_steps.rb

@@ -1,18 +1,18 @@
-Given /^(\w+) = (\w+)$/ do |var, value|
+Given(/^(\w+) = (\w+)$/) do |var, value|
   instance_variable_set("@#{var}", value)
 end
 
 begin
   require 'rubygems'
   require 'matchy'
-  Then /^I can assert that (\w+) == (\w+)$/ do |var_a, var_b|
+  Then(/^I can assert that (\w+) == (\w+)$/) do |var_a, var_b|
     a = instance_variable_get("@#{var_a}")
     b = instance_variable_get("@#{var_b}")
     a.should == b
   end
 rescue LoadError
-  STDERR.puts "***** You should install matchy *****"
-  Then /^I can assert that (\w+) == (\w+)$/ do |var_a, var_b|
+  STDERR.puts '***** You should install matchy *****'
+  Then(/^I can assert that (\w+) == (\w+)$/) do |var_a, var_b|
     a = instance_variable_get("@#{var_a}")
     b = instance_variable_get("@#{var_b}")
     assert_equal(a, b)

data/examples/watir/features/step_definitions/search_steps.rb

@@ -5,12 +5,12 @@ Given 'I am on the Google search page' do
   @browser.goto 'http://www.google.com/'
 end
 
-When /I search for "(.*)"/ do |query|
+When(/I search for "(.*)"/) do |query|
   @browser.text_field(:name, 'q').set(query)
   @browser.button(:name, 'btnG').click
 end
 
-Then /I should see/ do |text|
+Then(/I should see/) do |text|
   @browser.text.should =~ /#{text}/m
 end
 
@@ -18,9 +18,10 @@ end
 # consider creating classes for your pages - such as this:
 # http://github.com/cucumber/cucumber/tree/v0.1.15/examples/watir/features/step_definitons/search_steps.rb
 #
-# You may keep the page classes along your steps, or even better, put them in separate files, e.g.
-# support/pages/google_search.rb
+# You may keep the page classes along your steps, or even better, put them in
+# separate files, e.g. support/pages/google_search.rb
 #
 # This technique is called "Page Objects", and you can read more about it here:
 # http://github.com/marekj/watirloo/tree/master
-# We're not using this technique here, since we want to illustrate the basics only.
+# We're not using this technique here, since we want to illustrate the
+# basics only.

data/examples/watir/features/support/env.rb

@@ -1,4 +1,8 @@
-begin require 'rspec/expectations'; rescue LoadError; require 'spec/expectations'; end
+begin
+  require 'rspec/expectations'
+rescue LoadError
+  require 'spec/expectations'
+end
 
 browser = nil
 

data/examples/watir/features/support/screenshots.rb

@@ -2,14 +2,14 @@
 # browser testing. Just run cucumber with --format html --out report.html
 #
 # The code below will work on OS X or Windows (with IE Watir only).
-# Adding support for other platforms should be easy - as long as there is a 
+# Adding support for other platforms should be easy - as long as there is a
 # ruby library or command line tool to take pictures.
 #
 module Screenshots
   if Cucumber::OS_X
     def embed_screenshot(id)
       `screencapture -t png #{id}.png`
-      embed("#{id}.png", "image/png")
+      embed("#{id}.png", 'image/png')
     end
   elsif Cucumber::WINDOWS
     # http://wtr.rubyforge.org/rdoc/classes/Watir/ScreenCapture.html
@@ -17,12 +17,12 @@ module Screenshots
     include Watir::ScreenCapture
     def embed_screenshot(id)
       screen_capture("#{id}.jpg", true)
-      embed("#{id}.jpg", "image/jpeg")
+      embed("#{id}.jpg", 'image/jpeg')
     end
   else
     # Other platforms...
-    def embed_screenshot(id)
-      STDERR.puts "Sorry - no screenshots on your platform yet."
+    def embed_screenshot(_id)
+      STDERR.puts 'Sorry - no screenshots on your platform yet.'
     end
   end
 end

data/features/docs/api/list_step_defs_as_json.feature

@@ -8,6 +8,7 @@ Feature: List step defs as json
   Background:
     Given a directory named "features"
 
+  @todo-windows
   Scenario: Two Ruby step definitions, in the same file
     Given a file named "features/step_definitions/steps.rb" with:
       """
@@ -18,16 +19,23 @@ Feature: List step defs as json
       """
       require 'cucumber'
       puts Cucumber::StepDefinitions.new.to_json
-      
+
       """
     Then it should pass with JSON:
       """
       [
-        {"source": "foo", "flags": "i"},
-        {"source": "b.r", "flags": "mx"}
+        {
+          "source": {"expression": "foo", "type": "regular expression"},
+          "regexp": {"source": "foo", "flags": "i"}
+        },
+        {
+          "source": {"expression": "b.r", "type": "regular expression"},
+          "regexp": {"source": "b.r", "flags": "mx"}
+        }
       ]
       """
 
+  @todo-windows
   Scenario: Non-default directory structure
     Given a file named "my_weird/place/steps.rb" with:
       """
@@ -38,13 +46,19 @@ Feature: List step defs as json
       """
       require 'cucumber'
       puts Cucumber::StepDefinitions.new(:autoload_code_paths => ['my_weird']).to_json
-      
+
       """
     Then it should pass with JSON:
       """
       [
-        {"source": "foo", "flags": ""},
-        {"source": "b.r", "flags": "x"}
+        {
+          "source": {"expression": "foo", "type": "regular expression"},
+          "regexp": {"source": "foo", "flags": ""}
+        },
+        {
+          "source": {"expression": "b.r", "type": "regular expression"},
+          "regexp": {"source": "b.r", "flags": "x"}
+        }
       ]
-      
+
       """

data/features/docs/api/listen_for_events.feature

@@ -1,5 +1,8 @@
 Feature: Listen for events
 
+  Cucumber's `config` object has an event bus that you can use to listen for
+  various events that happen during your test run.
+
   Scenario: Step Matched Event
     Given a file named "features/test.feature" with:
       """
@@ -16,10 +19,9 @@ Feature: Listen for events
       """
       AfterConfiguration do |config|
         io = config.out_stream
-        config.on_event Cucumber::Events::StepMatch do |event|
+        config.on_event :step_activated do |event|
           io.puts "Success!"
-          io.puts "Event type:      #{event.class}"
-          io.puts "Step name:       #{event.test_step.name}"
+          io.puts "Step text:       #{event.test_step}"
           io.puts "Source location: #{event.step_match.location}"
         end
       end
@@ -28,8 +30,7 @@ Feature: Listen for events
     Then it should pass with:
       """
       Success!
-      Event type:      Cucumber::Events::StepMatch
-      Step name:       matching
+      Step text:       matching
       Source location: features/step_definitions/steps.rb:1
       """
 
@@ -45,14 +46,14 @@ Feature: Listen for events
       """
       AfterConfiguration do |config|
         io = config.out_stream
-        config.on_event Cucumber::Events::AfterTestStep do |event|
-          io.puts "YO"
+        config.on_event :test_step_finished do |event|
+          io.puts event.result.passed?
         end
       end
       """
     When I run `cucumber`
     Then it should pass with:
       """
-      YO
+      true
       """
 

data/features/docs/api/run_cli_main_with_existing_runtime.feature

@@ -5,6 +5,7 @@ Feature: Run Cli::Main with existing Runtime
   When the process forks, Spork them passes the runtime to Cli::Main to
   run it.
 
+    @todo-windows
     Scenario: Run a single feature
       Given the standard step definitions
       Given a file named "features/success.feature" with:

data/features/docs/cli/dry_run.feature

@@ -64,6 +64,9 @@ Feature: Dry Run
             Undefined step: "this step is undefined" (Cucumber::Undefined)
             features/test.feature:3:in `Given this step is undefined'
 
+      Undefined Scenarios:
+      cucumber features/test.feature:2 # Scenario: 
+
       1 scenario (1 undefined)
       1 step (1 undefined)
 

data/features/docs/cli/execute_with_tag_filter.feature

@@ -23,10 +23,11 @@ Feature: Tag logic
 
         @ignore
         Scenario: And yet another Example
+          Given passing
       """
 
   Scenario: ANDing tags
-    When I run `cucumber -q -t @one -t @three features/test.feature`
+    When I run `cucumber -q -t '@one and @three' features/test.feature`
     Then it should pass with:
       """
       @feature
@@ -42,7 +43,7 @@ Feature: Tag logic
       """
 
   Scenario: ORing tags
-    When I run `cucumber -q -t @one,@three features/test.feature`
+    When I run `cucumber -q -t '@one or @three' features/test.feature`
     Then it should pass with:
       """
       @feature
@@ -66,7 +67,7 @@ Feature: Tag logic
       """
 
   Scenario: Negative tags
-    When I run `cucumber -q -t ~@three features/test.feature`
+    When I run `cucumber -q -t 'not @three' features/test.feature`
     Then it should pass with:
       """
       @feature
@@ -78,9 +79,10 @@ Feature: Tag logic
 
         @ignore
         Scenario: And yet another Example
+          Given passing
 
-      2 scenarios (1 undefined, 1 passed)
-      1 step (1 undefined)
+      2 scenarios (2 undefined)
+      2 steps (2 undefined)
       """
 
   Scenario: Run with limited tag count, blowing it on scenario
@@ -104,7 +106,7 @@ Feature: Tag logic
        """
 
   Scenario: Run with limited tag count using negative tag, blowing it via a tag that is not run
-     When I run `cucumber -q --no-source --tags ~@one:1 features/test.feature`
+     When I run `cucumber -q --no-source --tags 'not @one:1' features/test.feature`
      Then it fails before running features with:
        """
        @one occurred 2 times, but the limit was set to 1

data/features/docs/cli/fail_fast.feature

@@ -4,6 +4,7 @@ Feature: Fail fast
   The --fail-fast flag causes Cucumber to exit immediately after the first 
   scenario fails.
 
+  @todo-windows
   Scenario: When a scenario fails
     Given a file named "features/bad.feature" with:
       """
@@ -25,6 +26,7 @@ Feature: Fail fast
     1 scenario (1 failed)
     """
 
+  @todo-windows
   Scenario: When all the scenarios pass
     Given a file named "features/first.feature" with:
       """

data/features/docs/cli/help.feature

@@ -0,0 +1,8 @@
+Feature: Help
+
+  Running `cucumber --help` shows you command-line options.
+
+  Scenario: Show help
+    When I run `cucumber --help`
+    Then it should pass
+    And I should see the CLI help

data/features/docs/{gherkin/language_help.feature → cli/i18n.feature}

@@ -1,17 +1,17 @@
 @needs-many-fonts
-Feature: Language help
+Feature: i18n
 
   It's possible to ask cucumber which keywords are used for any
   particular language by running:
 
-  `cucumber --i18n <language code> help`
+  `cucumber --i18n-keywords <LANG>`
 
   This will print a table showing all the different words we use for
   that language, to allow you to easily write features in any language
   you choose.
 
   Scenario: Get help for Portuguese language
-    When I run `cucumber --i18n pt help`
+    When I run `cucumber --i18n-keywords pt`
     Then it should pass with:
       """
         | feature          | "Funcionalidade", "Característica", "Caracteristica"                                         |
@@ -33,10 +33,10 @@ Feature: Language help
       """
 
   Scenario: List languages
-    When I run `cucumber --i18n help`
+    When I run `cucumber --i18n-languages`
     Then cucumber lists all the supported languages
 
   Scenario: Seek help for invalid language
-    When I run `cucumber --i18n foo`
+    When I run `cucumber --i18n-keywords foo`
     Then the output includes the message "Invalid language 'foo'"
-    And cucumber lists all the supported languages
+    And cucumber lists all the supported languages

data/features/docs/cli/randomize.feature

@@ -57,7 +57,7 @@ Feature: Randomize
     When I run `cucumber`
     Then it should pass
 
-  @spawn
+  @spawn @todo-windows
   Scenario: Run scenarios randomized
     When I run `cucumber --order random:41544 -q`
     Then it should fail
@@ -101,7 +101,7 @@ Feature: Randomize
 
       """
 
-  @spawn
+  @spawn @todo-windows
   Scenario: Run scenarios randomized with some skipped
     When I run `cucumber --tags ~@skipme --order random:41544 -q`
     Then it should fail

data/features/docs/cli/retry_failing_tests.feature

@@ -1,32 +1,92 @@
-@wip
 Feature: Retry failing tests
 
   Retry gives you a way to get through flaky tests that usually pass after a few runs.
   This gives a development team a way forward other than disabling a valuable test.
-  
+
   - Specify max retry count in option
   - Output information to the screen
   - Output retry information in test report
-  
+
   Questions:
   use a tag for flaky tests?  Global option to retry any test that fails?
-  
+
   Background:
-    Given a scenario "Flakey" that fails once, then passes
-    And a scenario "Shakey" that fails twice, then passes
+    Given a scenario "Fails-once" that fails once, then passes
+    And a scenario "Fails-twice" that fails twice, then passes
     And a scenario "Solid" that passes
-    And a scenario "No Dice" that fails
-  
-  Scenario:
-    When I run `cucumber -q --retry 1`
+
+  @todo-windows
+  Scenario: Retry once, so Fails-once starts to pass
+    Given a scenario "Fails-forever" that fails
+    When I run `cucumber -q --retry 1 --format summary`
+    Then it should fail with:
+      """
+      4 scenarios (2 failed, 1 flaky, 1 passed)
+      """
+    And it should fail with:
+      """
+      Fails-forever
+        Fails-forever ✗
+        Fails-forever ✗
+
+      Solid
+        Solid ✓
+
+      Fails-once feature
+        Fails-once ✗
+        Fails-once ✓
+
+      Fails-twice feature
+        Fails-twice ✗
+        Fails-twice ✗
+      """
+
+  @todo-windows
+  Scenario: Retry twice, so Fails-twice starts to pass too
+    Given a scenario "Fails-forever" that fails
+    When I run `cucumber -q --retry 2 --format summary`
     Then it should fail with:
       """
-      4 scenarios (2 passed, 2 failed)
+      4 scenarios (1 failed, 2 flaky, 1 passed)
       """
+    And it should fail with:
+      """
+      Fails-forever
+        Fails-forever ✗
+        Fails-forever ✗
+        Fails-forever ✗
+
+      Solid
+        Solid ✓
 
-  Scenario:
-    When I run `cucumber -q --retry 2`
+      Fails-once feature
+        Fails-once ✗
+        Fails-once ✓
+
+      Fails-twice feature
+        Fails-twice ✗
+        Fails-twice ✗
+        Fails-twice ✓
+      """
+
+  @todo-windows
+  Scenario: Flaky scenarios gives exit code zero in non-strict mode
+    When I run `cucumber -q --retry 2 --format summary`
     Then it should pass with:
       """
-      4 scenarios (3 passed, 1 failed)
-      """
+
+
+      3 scenarios (2 flaky, 1 passed)
+      """
+
+  @todo-windows
+  Scenario: Flaky scenarios gives non-zero exit code in strict mode
+    When I run `cucumber -q --retry 2 --format summary --strict`
+    Then it should fail with:
+      """
+      Flaky Scenarios:
+      cucumber features/fails_once.feature:2
+      cucumber features/fails_twice.feature:2
+
+      3 scenarios (2 flaky, 1 passed)
+      """

data/features/docs/cli/run_scenarios_matching_name.feature

@@ -33,6 +33,7 @@ Feature: Run feature elements matching a name with --name/-n
             | b    |
       """
 
+  @todo-windows
   Scenario: Matching Feature names
     When I run `cucumber -q --name feature`
     Then it should pass with:

data/features/docs/cli/specifying_multiple_formatters.feature

@@ -18,6 +18,7 @@ Feature: Running multiple formatters
         And there is world peace
     """
 
+  @todo-windows
   Scenario: Multiple formatters and outputs
     When I run `cucumber --no-color --format progress --out progress.txt --format pretty --out pretty.txt --no-source --dry-run --no-snippets features/test.feature`
     Then the stderr should not contain anything
@@ -45,6 +46,7 @@ Feature: Running multiple formatters
 
       """
 
+  @todo-windows
   Scenario: Two formatters to stdout
     When I run `cucumber -f progress -f pretty features/test.feature`
     Then it should fail with:
@@ -52,6 +54,7 @@ Feature: Running multiple formatters
       All but one formatter must use --out, only one can print to each stream (or STDOUT) (RuntimeError)
       """
 
+  @todo-windows
   Scenario: Two formatters to stdout when using a profile
     Given the following profiles are defined:
       """

data/features/docs/cli/strict_mode.feature

@@ -28,6 +28,9 @@ Feature: Strict mode
             Undefined step: "this step passes" (Cucumber::Undefined)
             features/missing.feature:3:in `Given this step passes'
 
+      Undefined Scenarios:
+      cucumber features/missing.feature:2
+
       1 scenario (1 undefined)
       1 step (1 undefined)
       """
@@ -45,6 +48,9 @@ Feature: Strict mode
             ./features/step_definitions/steps.rb:3:in `/^this step is pending$/'
             features/pending.feature:3:in `Given this step is pending'
 
+      Pending Scenarios:
+      cucumber features/pending.feature:2
+
       1 scenario (1 pending)
       1 step (1 pending)
       """

data/features/docs/defining_steps/ambiguous_steps.feature

@@ -0,0 +1,89 @@
+Feature: Ambiguous Steps
+
+  When Cucumber searches for a step definition for a step, it might find multiple step
+  definitions that could match. In that case, it will give you an error that the step
+  definitions are ambiguous.
+
+  You can also use a `--guess` mode, where it uses magic powers to try and figure
+  out which of those two step definitions is most likely to be the one you meant it
+  to use. Use it with caution!
+
+
+  Scenario: Ambiguous steps
+
+    Given a file named "features/ambiguous.feature" with:
+    """
+    Feature:
+
+      Scenario:
+      When a step
+      Then an ambiguous step
+
+    """
+    And a file named "features/step_definitions.rb" with:
+    """
+      When(/^a.*step$/) do
+        'foo'
+      end
+
+      Then(/^an ambiguous step$/) do
+        'bar'
+      end
+
+    """
+    When I run `cucumber`
+    Then it should fail with:
+    """
+          Ambiguous match of "an ambiguous step":
+          
+          features/step_definitions.rb:1:in `/^a.*step$/'
+          features/step_definitions.rb:5:in `/^an ambiguous step$/'
+          
+          You can run again with --guess to make Cucumber be more smart about it
+           (Cucumber::Ambiguous)
+          features/ambiguous.feature:5:in `Then an ambiguous step'
+
+    Failing Scenarios:
+    cucumber features/ambiguous.feature:3 # Scenario: 
+
+    1 scenario (1 failed)
+    2 steps (1 failed, 1 passed)
+    0m0.012s
+
+    """
+
+
+  Scenario: Ambiguous steps with guess mode
+
+    Given a file named "features/ambiguous.feature" with:
+    """
+    Feature:
+
+      Scenario:
+      When a step
+      Then an ambiguous step
+    """
+    And a file named "features/step_definitions.rb" with:
+    """
+      When(/^a.*step$/) do
+        'foo'
+      end
+
+      Then(/^an ambiguous step$/) do
+        'bar'
+      end
+    """
+    When I run `cucumber -g`
+    Then it should pass with exactly:
+    """
+    Feature: 
+
+      Scenario:                # features/ambiguous.feature:3
+        When a step            # features/step_definitions.rb:1
+        Then an ambiguous step # features/step_definitions.rb:5
+
+    1 scenario (1 passed)
+    2 steps (2 passed)
+    0m0.012s
+
+    """

data/features/docs/defining_steps/nested_steps.feature

@@ -12,6 +12,7 @@ Feature: Nested Steps
       end
       """
 
+  @todo-windows
   Scenario: Use #steps to call several steps at once
     Given a step definition that looks like this:
       """ruby
@@ -31,6 +32,7 @@ Feature: Nested Steps
 
       """
 
+  @todo-windows
   Scenario: Use #step to call a single step
     Given a step definition that looks like this:
       """ruby
@@ -48,6 +50,7 @@ Feature: Nested Steps
 
       """
 
+  @todo-windows
   Scenario: Use #steps to call a table
     Given a step definition that looks like this:
       """ruby
@@ -77,6 +80,7 @@ Feature: Nested Steps
 
       """
 
+  @todo-windows
   Scenario: Use #steps to call a multi-line string
     Given a step definition that looks like this:
       """ruby
@@ -103,7 +107,7 @@ Feature: Nested Steps
       Liouville
       """
 
-  @spawn
+  @spawn @todo-windows
   Scenario: Backtrace doesn't skip nested steps
     Given a step definition that looks like this:
       """ruby

data/features/docs/defining_steps/nested_steps_i18n.feature

@@ -8,15 +8,18 @@ Feature: Nested Steps in I18n
     And a step definition that looks like this:
       """ruby
       # -*- coding: utf-8 -*-
+      # frozen_string_literal: true
       前提 /a turtle/ do
         puts "turtle!"
       end
       """
 
+  @todo-windows
   Scenario: Use #steps to call several steps at once
     Given a step definition that looks like this:
       """ruby
       # -*- coding: utf-8 -*-
+      # frozen_string_literal: true
       前提 /two turtles/ do
         steps %{
           前提 a turtle