gurke 3.2.2 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9474952db05f7f3aad5527b68c1258dc1042a16e0800ec6abb4ba3a1cf1a5062
-  data.tar.gz: b90e18c038a138852a4c0ef1de09d61ca3b05f677bc871d49996775fd8deb262
+  metadata.gz: 19dece7b4b59ad3477927b3e8fe8a999d16dd38c76eaf47da0884364a0cf6304
+  data.tar.gz: 6fd2ad924d46cfb1be7df5d8e8d7aab48d135954168833253155cde3178e56d7
 SHA512:
-  metadata.gz: 6a504262150c0f0d6ec569b87a77d58584e0d7bebf1345f11c92aeb4f174dc74e0307f382d94360a70f60f27dfe12e48ea445d30061c6faaefd66e432ad17193
-  data.tar.gz: b4f543612efbb949c37d45e7a4bffe5b6e38d8cebe99e85b6dbd910eb0ccf29afe3968447f20e94db1c4b3451955b1b3d25c08e0f2dd02e828337a25b4f64b68
+  metadata.gz: 8fe0d861f4689b7b9dfd04f98c5237193e1adfe5d131b43d3db92ba401f300e008d5c1c225ca1cc5c1858da9f1a774ba6246d5cf583727c9b0360f5316aa579e
+  data.tar.gz: 8883a08e2d30485bf1a765bc5bb9101aebc39d37155b9bc98c3c20bed9891b1815e0f2699b61effe1a48ba73233ca91db05807e01730970bc4b8d9f0f92a897b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.3.1
+
+* Add option for default retry of failed scenarios
+* Make number of default and flaky retries configurable
+
 ## 3.2.2
 
 * Fix some default reporter formatting issues

data/README.md

@@ -176,6 +176,16 @@ Feature: F
 
 Gurke will retry a marked scenario only once if a step failed.
 
+### Formatter
+
+You can choose another formatter using a command line switch:
+
+```
+gurke -f team_city
+```
+
+Available formatters include: `default`, `compact`, `null` and `team_city`.
+
 ### DRb background server (experimental)
 
 You can run a DRb server in the background that has a running test environment (whatever that means to you) by running `gurke --drb-server`. This will load your test environment and execute all before `:system` hooks.

data/features/gurke.rb

@@ -4,6 +4,8 @@ require 'gurke/rspec'
 require 'tmpdir'
 
 Gurke.configure do |c|
+  c.default_retries = 0
+
   c.around(:scenario) do |scenario|
     Dir.mktmpdir('gurke') do |dir|
       @__root = Pathname.new(dir)

data/features/gurke/retry_flaky_scenario.feature

@@ -0,0 +1,70 @@
+Feature: Flagged flaky scenarios
+  In order to fail less often with flaky scenarios
+  As a CI administrator and tester
+  I want to have marked scenarios retried
+
+  Background:
+    Given a file "features/support/steps/test_steps.rb" with the following content exists
+      """
+      $try = 0
+
+      module TestSteps
+        step("I fail the first time") do
+          fail 'first time' if ($try += 1) < 2
+        end
+
+        step("I fail always") do
+          fail 'always'
+        end
+
+        step("I do not fail") do
+          # noop
+        end
+      end
+
+      Gurke.configure{|c| c.include TestSteps }
+      """
+
+  Scenario: Run a flaky scenario
+    Given a file "features/test.feature" with the following content exists
+      """
+      Feature: F
+        @flaky
+        Scenario: Scenario Failure
+          Given I fail the first time
+      """
+    When I run the tests
+    Then the program exit code should be null
+    And the program output should include "Given I fail the first time (failure)"
+    And the program output should include "Given I fail the first time (passed)"
+    And the program output should include "Retry flaky scenario due to previous failure:"
+    And the program output should include "1 scenarios: 0 failing, 0 pending"
+
+  Scenario: Run a marked but always failing scenario
+    Given a file "features/test.feature" with the following content exists
+      """
+      Feature: F
+        @flaky
+        Scenario: Scenario Failure
+          Given I fail always
+      """
+    When I run the tests
+    Then the program exit code should be non-null
+    And the program output should include "Given I fail always (failure)"
+    And the program output should include "Retry flaky scenario due to previous failure:"
+    And the program output should not include "Given I fail always (passed)"
+    And the program output should include "1 scenarios: 1 failing, 0 pending"
+
+  Scenario: Run a marked but passing scenario
+    Given a file "features/test.feature" with the following content exists
+      """
+      Feature: F
+        @flaky
+        Scenario: Scenario Failure
+          Given I do not fail
+      """
+    When I run the tests
+    Then the program exit code should be null
+    And the program output should include "Given I do not fail (passed)"
+    And the program output should not include "Retry flaky scenario due to previous failure:"
+    And the program output should include "1 scenarios: 0 failing, 0 pending"

data/features/gurke/retry_scenario.feature

@@ -1,7 +1,7 @@
-Feature: Pending Steps
+Feature: Retry scenarios
   In order to fail less often with flaky scenarios
   As a CI administrator and tester
-  I want to have marked scenarios retried once
+  I want to have all scenarios retried
 
   Background:
     Given a file "features/support/steps/test_steps.rb" with the following content exists
@@ -22,14 +22,16 @@ Feature: Pending Steps
         end
       end
 
-      Gurke.configure{|c| c.include TestSteps }
+      Gurke.configure do |c|
+        c.include TestSteps
+        c.default_retries = 1
+      end
       """
 
-  Scenario: Run a flaky scenario
+  Scenario: Retry a failed scenario
     Given a file "features/test.feature" with the following content exists
       """
       Feature: F
-        @flaky
         Scenario: Scenario Failure
           Given I fail the first time
       """
@@ -37,34 +39,32 @@ Feature: Pending Steps
     Then the program exit code should be null
     And the program output should include "Given I fail the first time (failure)"
     And the program output should include "Given I fail the first time (passed)"
-    And the program output should include "Retry flaky scenario due to previous failure:"
+    And the program output should include "Retry scenario due to previous failure:"
     And the program output should include "1 scenarios: 0 failing, 0 pending"
 
-  Scenario: Run a marked but always failing scenario
+  Scenario: Run an always failing scenario
     Given a file "features/test.feature" with the following content exists
       """
       Feature: F
-        @flaky
         Scenario: Scenario Failure
           Given I fail always
       """
     When I run the tests
     Then the program exit code should be non-null
     And the program output should include "Given I fail always (failure)"
-    And the program output should include "Retry flaky scenario due to previous failure:"
+    And the program output should include "Retry scenario due to previous failure:"
     And the program output should not include "Given I fail always (passed)"
     And the program output should include "1 scenarios: 1 failing, 0 pending"
 
-  Scenario: Run a marked but passing scenario
+  Scenario: Run a passing scenario
     Given a file "features/test.feature" with the following content exists
       """
       Feature: F
-        @flaky
         Scenario: Scenario Failure
           Given I do not fail
       """
     When I run the tests
     Then the program exit code should be null
     And the program output should include "Given I do not fail (passed)"
-    And the program output should not include "Retry flaky scenario due to previous failure:"
+    And the program output should not include "Retry scenario due to previous failure:"
     And the program output should include "1 scenarios: 0 failing, 0 pending"

data/gurke.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
 
-  if ENV['TRAVIS_BUILD_NUMBER']
+  if ENV['TRAVIS_BUILD_NUMBER'] && !ENV['TRAVIS_TAG']
     # Append travis build number for auto-releases
     spec.version = "#{spec.version}.1.b#{ENV['TRAVIS_BUILD_NUMBER']}"
   end

data/lib/gurke/configuration.rb

@@ -4,7 +4,25 @@ require 'forwardable'
 
 module Gurke
   class Configuration
+    # @api private
+    def initialize
+      @default_retries = 0
+      @flaky_retries = 1
+    end
+
+    #
+    # How often a scenario is retries on failure by default.
+    #
+    # Defaults to none (0).
     #
+    attr_accessor :default_retries
+
+    # How often a scenario marked as flaky is retries.
+    #
+    # Defaults to one (1).
+    #
+    attr_accessor :flaky_retries
+
     # Define a before filter running before given action.
     #
     # @example

data/lib/gurke/reporters/default_reporter.rb

@@ -73,8 +73,12 @@ module Gurke::Reporters
       io.flush
     end
 
-    def retry_scenario(*)
-      io.print "\n  Retry flaky scenario due to previous failure:\n\n"
+    def retry_scenario(scenario)
+      if scenario.flaky?
+        io.print "\n  Retry flaky scenario due to previous failure:\n\n"
+      else
+        io.print "\n  Retry scenario due to previous failure:\n\n"
+      end
     end
 
     def after_scenario(*)

data/lib/gurke/runner.rb

@@ -34,6 +34,10 @@ module Gurke
       features.filter(options, files).run self, reporter
     end
 
+    def retries(scenario)
+      scenario.flaky? ? config.flaky_retries : config.default_retries
+    end
+
     def hook(scope, world, context, &block)
       config.hooks[scope].run world, context, &block
     end

data/lib/gurke/scenario.rb

@@ -136,7 +136,7 @@ module Gurke
       @state     = :pending
     end
 
-    def retryable?
+    def flaky?
       @tags.any? {|t| t.name == 'flaky' }
     end
 
@@ -159,17 +159,17 @@ module Gurke
     def run(runner, reporter)
       reporter.invoke :before_scenario, self
 
-      runner.hook :scenario, self, world do
-        run_scenario runner, reporter
-      end
+      _run(runner, reporter)
 
-      if failed? && retryable?
+      return unless failed?
+
+      (1..runner.retries(self)).each do
         reporter.invoke :retry_scenario, self
         reset!
 
-        runner.hook :scenario, self, world do
-          run_scenario runner, reporter
-        end
+        _run(runner, reporter)
+
+        break unless failed?
       end
     ensure
       reporter.invoke :after_scenario, self
@@ -183,6 +183,12 @@ module Gurke
       @exception = nil
     end
 
+    def _run(runner, reporter)
+      runner.hook :scenario, self, world do
+        run_scenario runner, reporter
+      end
+    end
+
     def run_scenario(runner, reporter)
       reporter.invoke :start_scenario, self
 

data/lib/gurke/version.rb

@@ -3,8 +3,8 @@
 module Gurke
   module VERSION
     MAJOR = 3
-    MINOR = 2
-    PATCH = 2
+    MINOR = 3
+    PATCH = 1
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
 

data/spec/gurke/reporters/default_reporter_spec.rb

@@ -175,13 +175,34 @@ RSpec.describe Gurke::Reporters::DefaultReporter do
 
     subject { reporter.retry_scenario(scenario); super() }
 
-    it do
-      is_expected.to eq unindent <<~TEXT
-        .
-        .  Retry flaky scenario due to previous failure:
-        .
-        .
-      TEXT
+    context 'with normal scenario' do
+      before do
+        allow(scenario).to receive(:flaky?).and_return(false)
+      end
+
+      it do
+        is_expected.to eq unindent <<~TEXT
+          .
+          .  Retry scenario due to previous failure:
+          .
+          .
+        TEXT
+      end
+    end
+
+    context 'with flaky scenario' do
+      before do
+        allow(scenario).to receive(:flaky?).and_return(true)
+      end
+
+      it do
+        is_expected.to eq unindent <<~TEXT
+          .
+          .  Retry flaky scenario due to previous failure:
+          .
+          .
+        TEXT
+      end
     end
   end
 

data/spec/gurke/scenario_spec.rb

@@ -51,16 +51,14 @@ describe Gurke::Scenario do
                                end_scenario after_scenario]
     end
 
-    context 'with retry' do
+    context 'with retries' do
       let(:step) { double('step') }
-      let(:tags) { [tag] }
-      let(:tag)  { double('tag') }
       let(:worlds) { Set.new }
 
       before { scenario.steps << step }
 
       before do
-        allow(tag).to receive(:name).and_return('flaky')
+        allow(runner).to receive(:retries).with(scenario).and_return(1)
       end
 
       it 'resets the world' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gurke
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.1
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -86,6 +86,7 @@ files:
 - features/gurke/include_by_tags.feature
 - features/gurke/other_reporter.feature
 - features/gurke/pending_steps.feature
+- features/gurke/retry_flaky_scenario.feature
 - features/gurke/retry_scenario.feature
 - features/gurke/run_specific_directories.feature
 - features/gurke/run_specific_scenarios.feature
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: An alternative gherkin feature runner inspired by rspec and turnip.
@@ -155,6 +156,7 @@ test_files:
 - features/gurke/include_by_tags.feature
 - features/gurke/other_reporter.feature
 - features/gurke/pending_steps.feature
+- features/gurke/retry_flaky_scenario.feature
 - features/gurke/retry_scenario.feature
 - features/gurke/run_specific_directories.feature
 - features/gurke/run_specific_scenarios.feature