cucumber 3.1.2 → 4.0.0.rc.1

data/lib/cucumber/formatter/progress.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/report/summary'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/console'
 require 'cucumber/formatter/console_counts'
 require 'cucumber/formatter/console_issues'
 require 'cucumber/formatter/io'
 require 'cucumber/formatter/duration_extractor'
-require 'cucumber/formatter/hook_query_visitor'
+require 'cucumber/formatter/ast_lookup'
 
 module Cucumber
   module Formatter
@@ -15,22 +14,23 @@ module Cucumber
     class Progress
       include Console
       include Io
-      attr_reader :runtime
-      attr_reader :config, :summary
+      attr_reader :config, :current_feature_uri
+      private :config, :current_feature_uri
 
       def initialize(config)
-        @config, @io = config, ensure_io(config.out_stream)
-        @previous_step_keyword = nil
+        @config = config
+        @io = ensure_io(config.out_stream)
         @snippets_input = []
         @total_duration = 0
-        @summary = Cucumber::Core::Report::Summary.new(config.event_bus)
         @matches = {}
         @pending_step_matches = []
         @failed_results = []
-        @failed_test_cases = []
         @passed_test_cases = []
+        @current_feature_uri = ''
+        @gherkin_documents = {}
+        @ast_lookup = AstLookup.new(config)
         @counts = ConsoleCounts.new(config)
-        @issues = ConsoleIssues.new(config)
+        @issues = ConsoleIssues.new(config, @ast_lookup)
         config.on_event :step_activated, &method(:on_step_activated)
         config.on_event :test_case_started, &method(:on_test_case_started)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
@@ -39,32 +39,31 @@ module Cucumber
       end
 
       def on_step_activated(event)
-        @matches[event.test_step.source] = event.step_match
+        @matches[event.test_step.to_s] = event.step_match
       end
 
-      def on_test_case_started(_event)
+      def on_test_case_started(event)
         unless @profile_information_printed
           do_print_profile_information(config.profiles) unless config.skip_profile_information? || config.profiles.nil? || config.profiles.empty?
           @profile_information_printed = true
         end
-        @previous_step_keyword = nil
+        @current_feature_uri = event.test_case.location.file
       end
 
       def on_test_step_finished(event)
         test_step = event.test_step
         result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
-        progress(result.to_sym) if !HookQueryVisitor.new(test_step).hook? || result.failed?
+        progress(result.to_sym) if !test_step.hook? || result.failed?
 
-        return if HookQueryVisitor.new(test_step).hook?
-        collect_snippet_data(test_step, result)
-        @pending_step_matches << @matches[test_step.source] if result.pending?
+        return if test_step.hook?
+        collect_snippet_data(test_step, @ast_lookup) if result.undefined?
+        @pending_step_matches << @matches[test_step.to_s] if result.pending?
         @failed_results << result if result.failed?
       end
 
       def on_test_case_finished(event)
         test_case = event.test_case
         result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
-        @failed_test_cases << test_case if result.failed?
         @passed_test_cases << test_case if result.passed?
         @total_duration += DurationExtractor.new(result).result_duration
       end
@@ -77,28 +76,25 @@ module Cucumber
 
       private
 
+      def gherkin_document
+        @ast_lookup.gherkin_document(current_feature_uri)
+      end
+
       def print_summary
         print_elements(@pending_step_matches, :pending, 'steps')
         print_elements(@failed_results, :failed, 'steps')
         print_statistics(@total_duration, @config, @counts, @issues)
-        snippet_text_proc = lambda do |step_keyword, step_name, multiline_arg|
-          snippet_text(step_keyword, step_name, multiline_arg)
-        end
-        do_print_snippets(snippet_text_proc) if config.snippets? && summary.test_steps.total(:undefined) > 0
-        return unless config.wip?
-        messages = @passed_test_cases.map do |test_case|
-          linebreaks("#{test_case.location.on_line(test_case.location.line)}:in `#{test_case.name}'", ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
-        end
-        do_print_passing_wip(messages)
+        print_snippets(config.to_hash)
+        print_passing_wip(config, @passed_test_cases, @ast_lookup)
       end
 
       CHARS = {
-        :passed    => '.',
-        :failed    => 'F',
-        :undefined => 'U',
-        :pending   => 'P',
-        :skipped   => '-'
-      }
+        passed: '.',
+        failed: 'F',
+        undefined: 'U',
+        pending: 'P',
+        skipped: '-'
+      }.freeze
 
       def progress(status)
         char = CHARS[status]

data/lib/cucumber/formatter/rerun.rb

@@ -7,17 +7,29 @@ module Cucumber
     class Rerun
       include Formatter::Io
 
-      def initialize(config)
+      def initialize(config) # rubocop:disable Metrics/PerceivedComplexity
         @io = ensure_io(config.out_stream)
         @config = config
         @failures = {}
         config.on_event :test_case_finished do |event|
           test_case, result = *event.attributes
-          next if result.ok?(@config.strict)
-          @failures[test_case.location.file] ||= []
-          @failures[test_case.location.file] << test_case.location.line
+          if @config.strict.strict?(:flaky)
+            next if result.ok?(@config.strict)
+            add_to_failures(test_case)
+          else
+            unless @latest_failed_test_case.nil?
+              if @latest_failed_test_case != test_case
+                add_to_failures(@latest_failed_test_case)
+                @latest_failed_test_case = nil
+              elsif result.ok?(@config.strict)
+                @latest_failed_test_case = nil
+              end
+            end
+            @latest_failed_test_case = test_case unless result.ok?(@config.strict)
+          end
         end
         config.on_event :test_run_finished do
+          add_to_failures(@latest_failed_test_case) unless @latest_failed_test_case.nil?
           next if @failures.empty?
           @io.print file_failures.join("\n")
         end
@@ -28,6 +40,12 @@ module Cucumber
       def file_failures
         @failures.map { |file, lines| [file, lines].join(':') }
       end
+
+      def add_to_failures(test_case)
+        location = test_case.location
+        @failures[location.file] ||= []
+        @failures[location.file] << location.lines.max unless @failures[location.file].include?(location.lines.max)
+      end
     end
   end
 end

data/lib/cucumber/formatter/stepdefs.rb

@@ -5,8 +5,7 @@ require 'cucumber/formatter/usage'
 module Cucumber
   module Formatter
     class Stepdefs < Usage
-      def print_steps(stepdef_key)
-      end
+      def print_steps(stepdef_key); end
 
       def max_step_length
         0

data/lib/cucumber/formatter/steps.rb

@@ -35,15 +35,14 @@ module Cucumber
       end
 
       def collect_steps(runtime)
-        runtime.step_definitions.inject({}) do |step_definitions, step_definition|
+        runtime.step_definitions.each_with_object({}) do |step_definition, step_definitions|
           step_definitions[step_definition.file] ||= []
           step_definitions[step_definition.file] << [step_definition.file_colon_line, step_definition.regexp_source]
-          step_definitions
         end
       end
 
       def source_indent(sources)
-        sources.map { |file_colon_line, regexp| regexp.size }.max + 1
+        sources.map { |_file_colon_line, regexp| regexp.size }.max + 1
       end
     end
   end

data/lib/cucumber/formatter/summary.rb

@@ -5,6 +5,7 @@ require 'cucumber/formatter/console'
 require 'cucumber/formatter/console_counts'
 require 'cucumber/formatter/console_issues'
 require 'cucumber/core/test/result'
+require 'cucumber/formatter/ast_lookup'
 
 module Cucumber
   module Formatter
@@ -14,9 +15,11 @@ module Cucumber
       include Console
 
       def initialize(config)
-        @config, @io = config, ensure_io(config.out_stream)
+        @config = config
+        @io = ensure_io(config.out_stream)
+        @ast_lookup = AstLookup.new(config)
         @counts = ConsoleCounts.new(@config)
-        @issues = ConsoleIssues.new(@config)
+        @issues = ConsoleIssues.new(@config, @ast_lookup)
         @start_time = Time.now
 
         @config.on_event :test_case_started do |event|
@@ -28,7 +31,7 @@ module Cucumber
           print_result event.result
         end
 
-        @config.on_event :test_run_finished do |event|
+        @config.on_event :test_run_finished do |_event|
           duration = Time.now - @start_time
           @io.puts
           print_statistics(duration, @config, @counts, @issues)
@@ -37,12 +40,17 @@ module Cucumber
 
       private
 
+      def gherkin_document(uri)
+        @ast_lookup.gherkin_document(uri)
+      end
+
       def print_feature(test_case)
-        feature = test_case.feature
-        return if @current_feature == feature
-        @io.puts unless @current_feature.nil?
-        @io.puts feature
-        @current_feature = feature
+        uri = test_case.location.file
+        return if @current_feature_uri == uri
+        feature_name = gherkin_document(uri)[:feature][:name]
+        @io.puts unless @current_feature_uri.nil?
+        @io.puts feature_name
+        @current_feature_uri = uri
       end
 
       def print_test_case(test_case)

data/lib/cucumber/formatter/unicode.rb

@@ -9,39 +9,37 @@ if Cucumber::WINDOWS
   if ENV['CUCUMBER_OUTPUT_ENCODING']
     Cucumber::CODEPAGE = ENV['CUCUMBER_OUTPUT_ENCODING']
   elsif `cmd /c chcp` =~ /(\d+)/
-    if [65000, 65001].include? $1.to_i
-      Cucumber::CODEPAGE = 'UTF-8'
+    if [65_000, 65_001].include? Regexp.last_match(1).to_i
+      Cucumber::CODEPAGE = 'UTF-8'.freeze
       ENV['ANSICON_API'] = 'ruby'
     else
-      Cucumber::CODEPAGE = "cp#{$1.to_i}"
+      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}".freeze
     end
   else
-    Cucumber::CODEPAGE = 'cp1252'
+    Cucumber::CODEPAGE = 'cp1252'.freeze
     STDERR.puts("WARNING: Couldn't detect your output codepage. Assuming it is 1252. You may have to chcp 1252 or SET CUCUMBER_OUTPUT_ENCODING=cp1252.")
   end
 
   module Cucumber
     # @private
     module WindowsOutput
-      def self.extended(o)
-        o.instance_eval do
-          def cucumber_preprocess_output(*a)
-            begin
-              a.map { |arg| arg.to_s.encode(Encoding.default_external) }
-            rescue Encoding::UndefinedConversionError => e
-              STDERR.cucumber_puts("WARNING: #{e.message}")
-              a
-            end
+      def self.extended(output)
+        output.instance_eval do
+          def cucumber_preprocess_output(*out)
+            out.map { |arg| arg.to_s.encode(Encoding.default_external) }
+          rescue Encoding::UndefinedConversionError => e
+            STDERR.cucumber_puts("WARNING: #{e.message}")
+            out
           end
 
           alias cucumber_print print
-          def print(*a)
-            cucumber_print(*cucumber_preprocess_output(*a))
+          def print(*out)
+            cucumber_print(*cucumber_preprocess_output(*out))
           end
 
           alias cucumber_puts puts
-          def puts(*a)
-            cucumber_puts(*cucumber_preprocess_output(*a))
+          def puts(*out)
+            cucumber_puts(*cucumber_preprocess_output(*out))
           end
         end
       end

data/lib/cucumber/formatter/usage.rb

@@ -17,7 +17,7 @@ module Cucumber
         @matches = {}
         config.on_event :step_activated do |event|
           test_step, step_match = *event.attributes
-          @matches[test_step.source] = step_match
+          @matches[test_step.to_s] = step_match
         end
         config.on_event :step_definition_registered, &method(:on_step_definition_registered)
       end
@@ -28,25 +28,26 @@ module Cucumber
       end
 
       def on_step_match(event)
-        @matches[event.test_step.source] = event.step_match
+        @matches[event.test_step.to_s] = event.step_match
         super
       end
 
       def on_test_step_finished(event)
-        return if HookQueryVisitor.new(event.test_step).hook?
+        return if event.test_step.hook?
 
         test_step = event.test_step
         result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
-        step_match = @matches[test_step.source]
+        step_match = @matches[test_step.to_s]
 
         unless step_match.nil?
           step_definition = step_match.step_definition
           stepdef_key = StepDefKey.new(step_definition.expression.to_s, step_definition.location)
           unless @stepdef_to_match[stepdef_key].map { |key| key[:location] }.include? test_step.location
             duration = DurationExtractor.new(result).result_duration
+            keyword = @ast_lookup.step_source(test_step).step[:keyword]
 
             @stepdef_to_match[stepdef_key] << {
-              keyword: test_step.source.last.keyword,
+              keyword: keyword,
               step_match: step_match,
               status: result.to_sym,
               location: test_step.location,
@@ -64,9 +65,9 @@ module Cucumber
         aggregate_info
 
         keys = if config.dry_run?
-                 @stepdef_to_match.keys.sort { |a, b| a.regexp_source <=> b.regexp_source }
+                 @stepdef_to_match.keys.sort_by(&:regexp_source)
                else
-                 @stepdef_to_match.keys.sort { |a, b| a.mean_duration <=> b.mean_duration }.reverse
+                 @stepdef_to_match.keys.sort_by(&:mean_duration).reverse
                end
 
         keys.each do |stepdef_key|
@@ -135,7 +136,7 @@ module Cucumber
       end
 
       def worst_status(statuses)
-        [:passed, :undefined, :pending, :skipped, :failed].find do |status|
+        %i[passed undefined pending skipped failed].find do |status|
           statuses.include?(status)
         end
       end

data/lib/cucumber/gherkin/data_table_parser.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'gherkin/token_scanner'
-require 'gherkin/parser'
+require 'gherkin/gherkin'
 require 'gherkin/dialect'
 
 module Cucumber
@@ -12,11 +11,14 @@ module Cucumber
       end
 
       def parse(text)
-        token_scanner = ::Gherkin::TokenScanner.new(feature_header + text)
-        parser = ::Gherkin::Parser.new
-        gherkin_document = parser.parse(token_scanner)
+        gherkin_document = nil
+        messages = ::Gherkin::Gherkin.from_source('dummy', feature_header + text, include_source: false, include_pickles: false)
+        messages.each do |message|
+          gherkin_document = message.gherkinDocument.to_hash unless message.gherkinDocument.nil?
+        end
 
-        gherkin_document[:feature][:children][0][:steps][0][:argument][:rows].each do |row|
+        return if gherkin_document.nil?
+        gherkin_document[:feature][:children][0][:scenario][:steps][0][:data_table][:rows].each do |row|
           @builder.row(row[:cells].map { |cell| cell[:value] })
         end
       end

data/lib/cucumber/gherkin/formatter/ansi_escapes.rb

@@ -51,23 +51,21 @@ module Cucumber
           'white'   => "\e[37m",
           'grey'    => "\e[90m",
           'bold'    => "\e[1m"
-        }
+        }.freeze
 
         ALIASES = Hash.new do |h, k|
-          if k.to_s =~ /(.*)_arg/
-            h[$1] + ',bold'
-          end
-        end.merge({
-                    'undefined' => 'yellow',
-                    'pending'   => 'yellow',
-                    'executing' => 'grey',
-                    'failed'    => 'red',
-                    'passed'    => 'green',
-                    'outline'   => 'cyan',
-                    'skipped'   => 'cyan',
-                    'comments'  => 'grey',
-                    'tag'       => 'cyan'
-                  })
+          h[Regexp.last_match(1)] + ',bold' if k.to_s =~ /(.*)_arg/
+        end.merge(
+          'undefined' => 'yellow',
+          'pending'   => 'yellow',
+          'executing' => 'grey',
+          'failed'    => 'red',
+          'passed'    => 'green',
+          'outline'   => 'cyan',
+          'skipped'   => 'cyan',
+          'comments'  => 'grey',
+          'tag'       => 'cyan'
+        )
 
         if ENV['GHERKIN_COLORS'] # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
           ENV['GHERKIN_COLORS'].split(':').each do |pair|
@@ -93,8 +91,6 @@ module Cucumber
         def up(n)
           "\e[#{n}A"
         end
-
-        extend self
       end
     end
   end

data/lib/cucumber/gherkin/formatter/escaping.rb

@@ -10,8 +10,8 @@ module Cucumber
         # * \ becomes \\
         #
         # This is used in the pretty formatter.
-        def escape_cell(s)
-          s.gsub(/\\(?!\|)/, '\\\\\\\\').gsub(/\n/, '\\n').gsub(/\|/, '\\|')
+        def escape_cell(sym)
+          sym.gsub(/\\(?!\|)/, '\\\\\\\\').gsub(/\n/, '\\n').gsub(/\|/, '\\|')
         end
       end
     end