gurke 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19dece7b4b59ad3477927b3e8fe8a999d16dd38c76eaf47da0884364a0cf6304
-  data.tar.gz: 6fd2ad924d46cfb1be7df5d8e8d7aab48d135954168833253155cde3178e56d7
+  metadata.gz: 0397cd73d54c76350b72961da6af3a7735b4bfc134e2c4ec85d1aa0698d83fef
+  data.tar.gz: ba610c4ef198dc90e5962386a410fc886ec8eebad749dfba177ca0011da61308
 SHA512:
-  metadata.gz: 8fe0d861f4689b7b9dfd04f98c5237193e1adfe5d131b43d3db92ba401f300e008d5c1c225ca1cc5c1858da9f1a774ba6246d5cf583727c9b0360f5316aa579e
-  data.tar.gz: 8883a08e2d30485bf1a765bc5bb9101aebc39d37155b9bc98c3c20bed9891b1815e0f2699b61effe1a48ba73233ca91db05807e01730970bc4b8d9f0f92a897b
+  metadata.gz: f62c44c16c881ed3ceac307cf380fd1c7a07a92f0cd499a016d494acb7cc1e0939641f9a6e3153b6d553f2fc409ed22a4ae24d889e195123e76cdae06fce0791
+  data.tar.gz: e476dc728f92ebd45dcb594a9a7a60914b580c4e4c346533bfa1d6640724dc645791e3bd985760d7e286ae00f309238fc4235d2e44e2286e0a8f1bd95180d130

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.3.2
+
+* Fix teamcity and compact reporter
+
 ## 3.3.1
 
 * Add option for default retry of failed scenarios

data/lib/gurke/reporter.rb

@@ -275,28 +275,30 @@ module Gurke
 
     protected
 
-    def format_exception(ex, backtrace: true)
-      s = ex.class.to_s << ': ' << ex.message.strip << "\n"
+    def format_exception(ex, backtrace: true, indent: 0)
+      s = StringIO.new
+      s << (' ' * indent) << ex.class.to_s << ': ' << ex.message.strip << "\n"
 
-      if backtrace
+      if backtrace && ex.respond_to?(:backtrace)
         if ex.backtrace.nil?
-          s << '  <no backtrace available>'
+          s << (' ' * indent) << '  <no backtrace available>'
         elsif ex.backtrace.empty?
-          s << '  <backtrace empty>'
+          s << (' ' * indent) << '  <backtrace empty>'
         else
           ex.backtrace.each do |bt|
-            s << '  ' << bt.strip << "\n"
+            s << (' ' * indent) << '  ' << bt.strip << "\n"
           end
         end
       end
 
-      if ex.respond_to?(:cause) && ex.cause &&
-         ex.cause.respond_to?(:message) && ex.cause.respond_to?(:backtrace)
-
-        s << 'caused by: ' << format_exception(ex.cause, backtrace: backtrace)
+      if ex.respond_to?(:cause) && ex.cause && ex.cause.respond_to?(:message)
+        s << (' ' * indent) << 'caused by: '
+        s << format_exception(
+          ex.cause, backtrace: backtrace, indent: indent
+        ).strip
       end
 
-      s
+      s.string
     end
   end
 end

data/lib/gurke/reporters/compact_reporter.rb

@@ -71,8 +71,8 @@ module Gurke::Reporters
         end
       end
 
-      exout = format_exception(result.exception, backtrace: true)
-      io.puts red exout.join("\n").gsub(/^/, '      ')
+      exout = format_exception(result.exception, backtrace: true, indent: 6)
+      io.puts red exout
       io.puts
     end
 

data/lib/gurke/reporters/team_city_reporter.rb

@@ -13,21 +13,27 @@ module Gurke::Reporters
     end
 
     def before_scenario(scenario)
-      @status_reported = false
-      @retry = false
-
       publish :testStarted, name: scenario.name
 
       super
     end
 
-    def retry_scenario(scenario)
-      @retry = true
-
-      super
-    end
-
     def after_scenario(scenario)
+      if scenario.failed?
+        publish :testFailed,
+          name: scenario.name,
+          message: scenario.exception.inspect,
+          backtrace: scenario.exception.backtrace.join('\n')
+      elsif scenario.pending?
+        publish :testIgnored,
+          name: scenario.name,
+          message: 'Step definition missing'
+      else
+        publish :testIgnored,
+          name: scenario.name,
+          message: 'Aborted.'
+      end
+
       publish :testFinished, name: scenario.name
 
       super
@@ -39,46 +45,8 @@ module Gurke::Reporters
       super
     end
 
-    protected
-
-    def step_pending(step, *)
-      super
-
-      report :testIgnored,
-        name: step.scenario.name,
-        message: 'Step definition missing'
-    end
-
-    def step_failed(step, *args)
-      super(step, *args, exception: false)
-
-      unless step.scenario.retryable? && !retry?
-        # do not report test as failed if it will be retries
-        report :testFailed,
-          name: step.scenario.name,
-          message: step.exception.inspect,
-          backtrace: step.exception.backtrace.join('\n')
-      end
-
-      print_exception(step.exception)
-    end
-
     private
 
-    def status_reported?
-      @status_reported
-    end
-
-    def retry?
-      @retry
-    end
-
-    def report(*args)
-      return if status_reported?
-
-      publish(*args)
-    end
-
     def publish(message_name, args)
       args = [] << message_name.to_s << escaped_array_of(args)
       args = args.flatten.reject(&:nil?)

data/lib/gurke/version.rb

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

data/spec/gurke/reporters/compact_reporter_spec.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+# rubocop:disable MissingCopEnableDirective
+# rubocop:disable Style/Semicolon
+
+require 'spec_helper'
+
+RSpec.describe Gurke::Reporters::CompactReporter do
+  let(:output) { StringIO.new }
+  let(:reporter) { described_class.new(output) }
+  subject { output.string }
+
+  describe '#before_feature' do
+    let(:feature) { double('feature') }
+
+    subject { reporter.before_feature(feature); super() }
+
+    it { is_expected.to eq '' }
+  end
+
+  describe '#start_background' do
+    let(:feature) { double('feature') }
+
+    subject { reporter.start_background(feature); super() }
+
+    it { is_expected.to eq '' }
+  end
+
+  describe '#before_scenario' do
+    let(:scenario) { double('scenario') }
+
+    subject { reporter.before_scenario(scenario); super() }
+
+    it { is_expected.to eq '' }
+  end
+
+  describe '#before_step' do
+    let(:step) { double('step') }
+
+    subject { reporter.before_step(step); super() }
+
+    it { is_expected.to eq '' }
+  end
+
+  describe '#after_step' do
+    let(:feature) { double('feature') }
+    let(:scenario) { double('scenario') }
+    let(:step) { double('step') }
+    let(:result) { double('result') }
+    let(:backgrounds) { [] }
+    let(:exception) { nil }
+
+    let(:steps) do
+      [step]
+    end
+
+    before do
+      allow(result).to receive(:step).and_return(step)
+      allow(result).to receive(:scenario).and_return(scenario)
+      allow(result).to receive(:state).and_return(state)
+      allow(result).to receive(:exception).and_return(exception)
+    end
+
+    before do
+      allow(step).to receive(:name).and_return 'the scenario is passing'
+      allow(step).to receive(:keyword).and_return 'Given'
+    end
+
+    before do
+      allow(scenario).to receive(:feature).and_return(feature)
+      allow(scenario).to receive(:steps).and_return(steps)
+
+      allow(scenario).to receive(:name).and_return 'Running the scenario'
+      allow(scenario).to receive(:file).and_return \
+        File.join(Dir.getwd, 'features', 'file.feature')
+      allow(scenario).to receive(:line).and_return 5
+    end
+
+    before do
+      allow(feature).to receive(:backgrounds).and_return(backgrounds)
+
+      allow(feature).to receive(:name).and_return 'Demo feature'
+      allow(feature).to receive(:file).and_return \
+        File.join(Dir.getwd, 'features', 'file.feature')
+      allow(feature).to receive(:line).and_return 1
+      allow(feature).to receive(:description).and_return \
+        "As a developer\nI would like have this spec passed\nIn order to work on"
+    end
+
+    subject { reporter.after_step(result, scenario); super() }
+
+    context 'with step passing' do
+      let(:state) { :passed }
+
+      it { is_expected.to eq '' }
+    end
+
+    context 'with step pending' do
+      let(:state) { :pending }
+
+      it { is_expected.to eq '' }
+    end
+
+    context 'with step pending' do
+      let(:state) { nil }
+
+      it { is_expected.to eq '' }
+    end
+
+    context 'with step failing' do
+      let(:state) { :failed }
+
+      before do
+        e = double 'exception'
+        c = double 'exception'
+
+        allow(e).to receive(:class).and_return(RuntimeError)
+        allow(e).to receive(:message).and_return('An error occurred')
+        allow(e).to receive(:backtrace).and_return([
+                                                     '/path/to/file.rb:5:in `block (4 levels) in <top (required)>\'',
+                                                     '/path/to/file.rb:24:in in `fail_with\''
+                                                   ])
+
+        allow(e).to receive(:cause).and_return(c)
+
+        allow(c).to receive(:class).and_return(IOError)
+        allow(c).to receive(:message).and_return('Socket closed')
+        allow(c).to receive(:backtrace).and_return([
+                                                     'script.rb:5:in `a\'',
+                                                     'script.rb:10:in `b\''
+                                                   ])
+
+        expect(result).to receive(:exception).and_return e
+      end
+
+      it do
+        is_expected.to eq unindent <<~TEXT
+          .E
+          .Feature: Demo feature   # features/file.feature:1
+          .  Scenario: Running the scenario   # features/file.feature:5
+          .    Given the scenario is passing
+          .      RuntimeError: An error occurred
+          .        /path/to/file.rb:5:in `block (4 levels) in <top (required)>'
+          .        /path/to/file.rb:24:in in `fail_with'
+          .      caused by: IOError: Socket closed
+          .        script.rb:5:in `a'
+          .        script.rb:10:in `b'
+          .
+          .
+        TEXT
+      end
+    end
+  end
+
+  describe '#retry_scenario' do
+    let(:scenario) { double('scenario') }
+
+    subject { reporter.retry_scenario(scenario); super() }
+
+    it { is_expected.to eq '' }
+  end
+
+  describe '#after_scenario' do
+    let(:scenario) { double('scenario') }
+
+    subject { reporter.after_scenario(scenario); super() }
+
+    before do
+      allow(scenario).to receive(:failed?).and_return(false)
+      allow(scenario).to receive(:passed?).and_return(true)
+      allow(scenario).to receive(:pending?).and_return(false)
+    end
+
+    it { is_expected.to eq '.' }
+
+    context '<failed>' do
+      before do
+        allow(scenario).to receive(:failed?).and_return(true)
+      end
+
+      it { is_expected.to eq '' }
+    end
+
+    context '<pending>' do
+      before do
+        allow(scenario).to receive(:pending?).and_return(true)
+      end
+
+      it { is_expected.to eq '?' }
+    end
+  end
+
+  describe '#after_feature' do
+    let(:feature) { double('feature') }
+
+    subject { reporter.after_feature(feature); super() }
+
+    it { is_expected.to eq '' }
+  end
+
+  describe '#after_features' do
+    let(:features) { [] }
+
+    subject { reporter.after_features(features); super() }
+
+    it do
+      is_expected.to eq unindent <<~TEXT
+        .
+        .
+        .0 scenarios: 0 passed, 0 failing, 0 pending
+        .
+      TEXT
+    end
+  end
+end

data/spec/gurke/reporters/team_city_reporter_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# rubocop:disable MissingCopEnableDirective
+# rubocop:disable Style/Semicolon
+
+require 'spec_helper'
+
+RSpec.describe Gurke::Reporters::TeamCityReporter do
+  let(:output) { StringIO.new }
+  let(:reporter) { described_class.new(output) }
+  subject { output.string }
+
+  describe '#before_feature' do
+    let(:feature) { double('feature') }
+
+    before do
+      allow(feature).to receive(:name).and_return 'Demo feature'
+      allow(feature).to receive(:file).and_return \
+        File.join(Dir.getwd, 'features', 'file.feature')
+      allow(feature).to receive(:line).and_return 1
+      allow(feature).to receive(:description).and_return \
+        "As a developer\nI would like have this spec passed\nIn order to work on"
+    end
+
+    subject { reporter.before_feature(feature); super() }
+
+    it 'include a testSuiteStarted command' do
+      is_expected.to include <<~TXT
+        ##teamcity[testSuiteStarted name='Demo feature']
+      TXT
+    end
+  end
+
+  describe '#before_scenario' do
+    let(:scenario) { double('scenario') }
+
+    before do
+      allow(scenario).to receive(:name).and_return 'Running the scenario'
+      allow(scenario).to receive(:file).and_return \
+        File.join(Dir.getwd, 'features', 'file.feature')
+      allow(scenario).to receive(:line).and_return 5
+    end
+
+    subject { reporter.before_scenario(scenario); super() }
+
+    it do
+      is_expected.to include <<~TXT
+        ##teamcity[testStarted name='Running the scenario']
+      TXT
+    end
+  end
+
+  describe '#after_scenario' do
+    let(:scenario) { double('scenario') }
+
+    before do
+      allow(scenario).to receive(:name).and_return 'Running the scenario'
+      allow(scenario).to receive(:passed?).and_return(true)
+      allow(scenario).to receive(:failed?).and_return(false)
+      allow(scenario).to receive(:pending?).and_return(false)
+      allow(scenario).to receive(:aborted?).and_return(false)
+    end
+
+    subject { reporter.after_scenario(scenario); super() }
+
+    it do
+      is_expected.to include <<~TXT
+        ##teamcity[testFinished name='Running the scenario']
+      TXT
+    end
+  end
+
+  describe '#after_feature' do
+    let(:feature) { double('feature') }
+
+    before do
+      allow(feature).to receive(:name).and_return 'Demo feature'
+    end
+
+    subject { reporter.after_feature(feature); super() }
+
+    it do
+      is_expected.to include <<~TXT
+        ##teamcity[testSuiteFinished name='Demo feature']
+      TXT
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gurke
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -118,7 +118,9 @@ files:
 - lib/gurke/tag.rb
 - lib/gurke/version.rb
 - spec/gurke/feature_list_spec.rb
+- spec/gurke/reporters/compact_reporter_spec.rb
 - spec/gurke/reporters/default_reporter_spec.rb
+- spec/gurke/reporters/team_city_reporter_spec.rb
 - spec/gurke/run_list_spec.rb
 - spec/gurke/scenario_spec.rb
 - spec/gurke/step_definition_spec.rb
@@ -164,7 +166,9 @@ test_files:
 - features/support/steps/cli_steps.rb
 - features/support/steps/file_steps.rb
 - spec/gurke/feature_list_spec.rb
+- spec/gurke/reporters/compact_reporter_spec.rb
 - spec/gurke/reporters/default_reporter_spec.rb
+- spec/gurke/reporters/team_city_reporter_spec.rb
 - spec/gurke/run_list_spec.rb
 - spec/gurke/scenario_spec.rb
 - spec/gurke/step_definition_spec.rb