gurke 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c12df541b21f5f76f5956d731764ec23b85e4ac
-  data.tar.gz: 8397ac6205619fc8667afc0f0694beb0ce395a99
+  metadata.gz: d8c96ab204add1ca62ac31c38b6c375324ee89e3
+  data.tar.gz: 42ba448e6eaf2bdf6352df493d31036c0ab789cc
 SHA512:
-  metadata.gz: e54e0281307bf79d2bea76bf7c0a9b3d84f677669810be1fc0e65a6a6c537700a2869a4969d0ab19fc6e34c5d3c3d3368a97f25136948884bc26a5f5a2aab8d7
-  data.tar.gz: 490ad37a6ad2a9f3d15db99ec35eabf2694fd82ab5256578d4d1351d63ff9d6241e626dafead371309512b8633f080fdae5edf66604a108399488b846b1c84e6
+  metadata.gz: 350ced1ca8fac0b2279ceab141bccd3c16eb358a129de1aa7ed06c960c94a11e61706e4730cc53af2846e2c9e73493e1e29544a8c659b610d2ce7448c183cf36
+  data.tar.gz: 2b2831a82dea72c9c8c552e88187ac17574d9bcbce2e69deae41a94efe4e144ea3c5c13ae07052826244ca1a7f962d3e56ec27585e38689be58d1e84370fc713

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## 2.2.1
+
+* BugFix (missing argument in cli.rb)
+* BugFix in after_feature hook call (missing feature argument)
+
+## 2.2.0
+
++ Support executing all features inside one directory
++ Support reporter selection via cli
++ Add TeamCityReporter (`gurke --formatter team_city`)
+* Support string as step definitions correctly
+* Smaller bugfix in improved exception formatting
+
+
+## 2.1.0
+
+* Improve exception formating
+
+## 2.0.0
+
+* Project start

data/README.md

@@ -1,5 +1,7 @@
 # Gurke
 
+[![Gem Version](https://badge.fury.io/rb/gurke.svg)](http://badge.fury.io/rb/gurke) [![Build Status](http://img.shields.io/travis/jgraichen/gurke/master.svg)](https://travis-ci.org/jgraichen/gurke) [![Code Climate](http://img.shields.io/codeclimate/github/jgraichen/gurke.svg)](https://codeclimate.com/github/jgraichen/gurke) [![Dependency Status](http://img.shields.io/gemnasium/jgraichen/gurke.svg)](https://gemnasium.com/jgraichen/gurke) [![RubyDoc Documentation](http://img.shields.io/badge/rubydoc-here-blue.svg)](http://rubydoc.info/github/jgraichen/gurke/master/frames)
+
 **Gurke** is an experimental, alternative cucumber runner. It ~~steals~~ borrows ideas and concepts from [turnip](https://github.com/jnicklas/turnip), [rspec](http://rspec.info) and tries to avoid [cucumber](https://github.com/cucumber/cucumber/).
 
 That includes * Step definitions in modules * Before, After and Around hooks * Formatters * Partial step inclusion (via modules) * etc. Also new ideas like keyword depended step definitions are planned.

data/features/gurke/other_reporter.feature

@@ -0,0 +1,35 @@
+Feature: Other Reporter
+  As a developer
+  In order to adjust the output to my requirements (e.g. inside a CI)
+  I want to pass a command line argument to change the reporter
+
+  Background:
+    Given I am in a project using gurke
+    And a file "features/test.feature" with the following content exists
+      """
+      Feature: F
+        Scenario: Scenario A
+          Given this is a success
+
+      """
+    And a file "features/support/steps/test_steps.rb" with the following content exists
+      """
+      module TestSteps
+        step("This is a success") { }
+      end
+      Gurke.configure{|c| c.include TestSteps }
+      """
+
+  Scenario: Use the default reporter without addition arguments
+    When I execute "bundle exec gurke"
+    Then the program output should not include "##teamcity"
+
+  Scenario: Use specified reporter when run with --formatter
+    When I execute "bundle exec gurke --formatter team_city"
+    Then the program output should include "##teamcity[testStarted name='Scenario A']"
+    Then the program output should include "##teamcity[testFinished name='Scenario A']"
+
+  Scenario: Use specified reporter when run with -f
+    When I execute "bundle exec gurke -f team_city"
+    Then the program output should include "##teamcity[testStarted name='Scenario A']"
+    Then the program output should include "##teamcity[testFinished name='Scenario A']"

data/features/gurke/run_specific_directories.feature

@@ -0,0 +1,62 @@
+Feature: Run specific features or scenarios
+  In order to get faster test results
+  As a user
+  I want run only feature files from one directory
+
+  Background:
+    Given I am in a project using gurke
+    Given a file "features/odd/a.feature" with the following content exists
+      """
+      Feature: F
+        Bla blub, a longer description.
+
+        Scenario: Scenario A
+          Given I am successful
+      """
+    Given a file "features/odd/c.feature" with the following content exists
+      """
+      Feature: F
+        Bla blub, a longer description.
+
+        Scenario: Scenario C
+          Given I am successful
+      """
+    Given a file "features/even/b.feature" with the following content exists
+      """
+      Feature: F
+        Bla blub, a longer description.
+
+        Scenario: Scenario B
+          Given I am successful
+      """
+    Given a file "trash/b.f" with the following content exists
+      """
+      Feature: F
+        Bla blub, a longer description.
+
+        Scenario: Scenario B
+          Given I am successful
+      """
+    And a file "features/support/steps/test_steps.rb" with the following content exists
+      """
+      module TestSteps
+        Given("I am successful") { true }
+      end
+      Gurke.configure{|c| c.include TestSteps }
+      """
+
+  Scenario: Run all features from on directory
+    When I execute "bundle exec gurke features/odd"
+    And the program output should include "2 scenarios: 0 failing, 0 pending"
+
+  Scenario: Run all features from on directory (II)
+    When I execute "bundle exec gurke features/even"
+    And the program output should include "1 scenarios: 0 failing, 0 pending"
+
+  Scenario: Run all features from on directory (with subdirectories)
+    When I execute "bundle exec gurke features"
+    And the program output should include "3 scenarios: 0 failing, 0 pending"
+
+  Scenario: Run all features from on directory (based on feature pattern)
+    When I execute "bundle exec gurke trash"
+    And the program output should include "0 scenarios: 0 failing, 0 pending"

data/lib/gurke.rb

@@ -21,6 +21,7 @@ module Gurke
   module Reporters
     require 'gurke/reporters/null_reporter'
     require 'gurke/reporters/default_reporter'
+    require 'gurke/reporters/team_city_reporter'
   end
 
   class Error < StandardError; end

data/lib/gurke/cli.rb

@@ -28,8 +28,7 @@ module Gurke
         Dir[r].each{|f| require File.expand_path(f) }
       end if options[:require].any?
 
-      files  = Dir[options[:pattern].to_s] if files.empty? && options[:pattern]
-      files.map!{|f| File.expand_path(f) }
+      files = expand_files files, options
 
       runner = if options[:drb_server]
         Runner::DRbServer
@@ -58,6 +57,8 @@ module Gurke
         opt :help, 'Print this help.'
         opt :version, 'Show program version information.'
         opt :backtrace, 'Show full error backtraces.'
+        opt :formatter, 'Select a special formatter as reporter', \
+            default: 'default'
         opt :pattern, 'File pattern matching feature files to be run.',
             default: 'features/**/*.feature'
         opt :require, 'Files matching this pattern will be required after'\
@@ -73,5 +74,21 @@ module Gurke
         opt :drb, 'Run features on already started DRb server. (experimental)', short: :none
       end
     end
+
+    private
+    def expand_files(files, options)
+      files = Dir[options[:pattern].to_s] if files.empty? && options[:pattern]
+      files.inject([]) do |memo, input|
+        if File.directory? input
+          Dir[input + '/**/*'].each do |file_in_dir|
+            next if options[:pattern] && !File.fnmatch?(options[:pattern], file_in_dir)
+            memo << File.expand_path(file_in_dir)
+          end
+        else
+          memo << File.expand_path(input)
+        end
+        memo
+      end
+    end
   end
 end

data/lib/gurke/feature.rb

@@ -83,7 +83,7 @@ module Gurke
         run_feature runner, reporter
       end
     ensure
-      reporter.invoke :after_feature
+      reporter.invoke :after_feature, self
     end
 
     private

data/lib/gurke/reporter.rb

@@ -255,5 +255,32 @@ module Gurke
     rescue => e
       warn "Rescued in reporter: #{e}\n" + e.backtrace.join("\n")
     end
+
+
+    # @api private
+    #
+    protected
+    def format_exception(ex)
+      s = [ex.class.to_s + ': ' + ex.message.strip]
+      if ex.backtrace.nil?
+        s << '  <no backtrace available>'
+      elsif ex.backtrace.empty?
+        s << '  <backtrace empty>'
+      else
+        ex.backtrace.each do |bt|
+          s << '  ' + bt.strip
+        end
+      end
+
+      if ex.respond_to?(:cause) && ex.cause &&
+        ex.cause.respond_to?(:message) && ex.cause.respond_to?(:backtrace)
+
+        cause = format_exception(ex.cause)
+        s << 'caused by: ' + cause.shift
+        s += cause
+      end
+
+      s
+    end
   end
 end

data/lib/gurke/reporters/default_reporter.rb

@@ -90,29 +90,6 @@ module Gurke::Reporters
       io.puts exout.map{|s| red("        #{s}\n") }.join
     end
 
-    def format_exception(ex)
-      s = [ex.message.strip]
-      if ex.backtrace.nil?
-        s << '  <no backtrace available>'
-      elsif ex.backtrace.empty?
-        s << '  <backtrace empty>'
-      else
-        ex.backtrace.each do |bt|
-          s << '  ' + bt.strip
-        end
-      end
-
-      if ex.respond_to?(:cause) && ex.cause &&
-        ex.cause.respond_to?(:message) && ex.cause.respond_to?(:backtrace)
-
-        cause = format_exception(ex.cause)
-        s << 'caused by: ' + cause.shift
-        s += cause
-      end
-
-      s
-    end
-
     [:black, :red, :green, :yellow, :blue,
      :magenta, :cyan, :white, :default, :light_black,
      :light_red, :light_green, :light_yellow, :light_blue,

data/lib/gurke/reporters/team_city_reporter.rb

@@ -0,0 +1,128 @@
+module Gurke::Reporters
+  #
+  # The {TeamCityReporter} prints features, scenarios and
+  # steps in a format parseable by TeamCity CI.
+  #
+  class TeamCityReporter < NullReporter
+    attr_reader :io
+    def initialize(io = $stdout)
+      @io = io
+    end
+
+    def before_feature(feature)
+      publish :testSuiteStarted, name: feature.name
+      io.puts "  #{feature.description.split("\n").join("\n  ")}"
+      io.puts
+    end
+
+    def before_scenario(scenario)
+      @scenario = scenario
+      publish :testStarted, name: scenario.name
+    end
+
+    def start_background(*)
+      unless @background
+        io.puts '    Background:'
+      end
+
+      @background = true
+    end
+
+    def end_background(*)
+      @background = false
+    end
+
+    def before_step(step, *)
+      io.print '  ' if @background
+      io.print '    '
+      io.print step.keyword
+      io.print step.name
+    end
+
+    def after_step(step, *)
+      case step.state
+        when :pending then print_pending step
+        when :failed  then print_failed step
+        when :success then print_braces 'success'
+        else print_braces 'skipped'
+      end
+      io.puts
+      io.flush
+    end
+
+    def after_scenario(scenario)
+      publish :testFinished, name: scenario.name
+    end
+
+    def after_feature(feature)
+      publish :testSuiteFinished, name: feature.name
+    end
+
+    def after_features(features)
+      scenarios = features.map(&:scenarios).flatten
+
+      example_count = scenarios.size
+      failure_count = scenarios.select(&:failed?).size
+      pending_count = scenarios.select(&:pending?).size
+
+      io.puts "  #{example_count} scenarios: " \
+              "#{failure_count} failing, " \
+              "#{pending_count} pending"
+      io.puts
+    end
+
+    private
+
+    def print_braces(str)
+      io.print " (#{str})"
+    end
+
+    def print_pending(step)
+      return if @pending == @scenario # only once per scenario
+      publish :testPending,
+               name: @scenario.name,
+               message: 'Step definition missing'
+      @pending = @scenario
+    end
+
+    def print_failed(step)
+      publish :testFailed,
+                 name: @scenario.name,
+                 message: step.exception.inspect,
+                 backtrace: step.exception.backtrace.join('\n')
+
+      print_braces 'failure'
+      io.puts
+
+      exout = format_exception(step.exception)
+      io.puts exout.map{|s| "        #{s}\n" }.join
+    end
+
+
+    private
+    def publish(message_name, args)
+      args = [] << message_name.to_s << escaped_array_of(args)
+      args = args.flatten.reject(&:nil?)
+
+      io.puts "##teamcity[#{args.join(' ')}]"
+    end
+
+    def escape(string)
+      string.gsub(/(\||'|\r|\n|\u0085|\u2028|\u2029|\[|\])/, '|$1')
+    end
+
+    def escaped_array_of(args)
+      return [] if args.nil?
+
+      if args.is_a? Hash
+        args.map { |key, value| "#{key.to_s}='#{escape value.to_s}'" }
+      else
+        "'#{escape args}'"
+      end
+    end
+
+    def step_name(step)
+      step.keyword + step.name.gsub(/"(.*?)"/, '\0')
+    end
+  end
+end

data/lib/gurke/runner.rb

@@ -8,7 +8,10 @@ module Gurke
     end
 
     def reporter
-      @reporter ||= Reporters::DefaultReporter.new
+      @reporter ||= begin
+        r = (options[:formatter] + '_reporter').split('_').map(&:capitalize).join
+        Reporters.const_get(r).new
+      end
     end
 
     def builder

data/lib/gurke/step_definition.rb

@@ -16,10 +16,11 @@ module Gurke
     end
 
     def match(name, type = :any)
+      return if self.type != :any && self.type != type
+      return if pattern.is_a?(String) && name != pattern
       match = pattern.match(name)
 
       return unless match
-      return if self.type != :any && self.type != type
 
       Match.new(method_name, match.to_a[1..-1])
     end

data/lib/gurke/version.rb

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

data/spec/gurke/step_definition_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+require 'spec_helper'
+
+describe Gurke::StepDefinition do
+  let(:pattern)  { nil }
+  let(:step_definition) { described_class.new pattern }
+  subject { step_definition }
+
+  context '#match' do
+    context 'with regex' do
+      let(:pattern) { /dies ist (ein|zwei) regex/ }
+
+      it { expect(subject.match('dies ist ein regex')).to be_a(Gurke::StepDefinition::Match) }
+      it { expect(subject.match('dies ist zwei regex')).to be_a(Gurke::StepDefinition::Match) }
+    end
+
+    context 'with string' do
+      let(:pattern) { 'a string' }
+
+      it { expect(subject.match('a string')).to be_a(Gurke::StepDefinition::Match) }
+      it { expect(subject.match(' a string')).to be_nil }
+      it { expect(subject.match('a string ')).to be_nil }
+      it { expect(subject.match(' a string ')).to be_nil }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gurke
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Jan Graichen
@@ -74,6 +74,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - bin/gurke
@@ -81,7 +82,9 @@ files:
 - features/gurke.rb
 - features/gurke/backtrace_filtering.feature
 - features/gurke/filter_by_tags.feature
+- features/gurke/other_reporter.feature
 - features/gurke/pending_steps.feature
+- features/gurke/run_specific_directories.feature
 - features/gurke/run_specific_scenarios.feature
 - features/gurke/step_specific_definitions.feature
 - features/support/steps/cli_steps.rb
@@ -99,6 +102,7 @@ files:
 - lib/gurke/reporter.rb
 - lib/gurke/reporters/default_reporter.rb
 - lib/gurke/reporters/null_reporter.rb
+- lib/gurke/reporters/team_city_reporter.rb
 - lib/gurke/rspec.rb
 - lib/gurke/run_list.rb
 - lib/gurke/runner.rb
@@ -111,6 +115,7 @@ files:
 - spec/gurke/feature_list_spec.rb
 - spec/gurke/run_list_spec.rb
 - spec/gurke/scenario_spec.rb
+- spec/gurke/step_definition_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jgraichen/gurke
 licenses:
@@ -141,7 +146,9 @@ test_files:
 - features/gurke.rb
 - features/gurke/backtrace_filtering.feature
 - features/gurke/filter_by_tags.feature
+- features/gurke/other_reporter.feature
 - features/gurke/pending_steps.feature
+- features/gurke/run_specific_directories.feature
 - features/gurke/run_specific_scenarios.feature
 - features/gurke/step_specific_definitions.feature
 - features/support/steps/cli_steps.rb
@@ -149,5 +156,6 @@ test_files:
 - spec/gurke/feature_list_spec.rb
 - spec/gurke/run_list_spec.rb
 - spec/gurke/scenario_spec.rb
+- spec/gurke/step_definition_spec.rb
 - spec/spec_helper.rb
 has_rdoc: