cucumber 3.1.2 → 8.0.0

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,56 +14,59 @@ 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, config.error_stream)
         @snippets_input = []
+        @undefined_parameter_types = []
         @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)
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
+        config.on_event :undefined_parameter_type, &method(:collect_undefined_parameter_type_names)
       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 +79,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/publish_banner_printer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'cucumber/term/banner'
+
+module Cucumber
+  module Formatter
+    class PublishBannerPrinter
+      include Term::Banner
+
+      def initialize(configuration)
+        return if configuration.publish_enabled?
+
+        configuration.on_event :test_run_finished do |_event|
+          display_publish_ad(configuration.error_stream)
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def display_publish_ad(io)
+        display_banner(
+          [
+            [
+              'Share your Cucumber Report with your team at ',
+              link('https://reports.cucumber.io')
+            ],
+            '',
+            [
+              'Command line option:    ',
+              highlight('--publish')
+            ],
+            [
+              'Environment variable:   ',
+              highlight('CUCUMBER_PUBLISH_ENABLED'),
+              '=',
+              highlight('true')
+            ],
+            [
+              'cucumber.yml:           ',
+              highlight('default: --publish')
+            ],
+            '',
+            [
+              'More information at ',
+              link('https://cucumber.io/docs/cucumber/environment-variables/')
+            ],
+            '',
+            [
+              'To disable this message, specify ',
+              pre('CUCUMBER_PUBLISH_QUIET=true'),
+              ' or use the '
+            ],
+            [
+              pre('--publish-quiet'),
+              ' option. You can also add this to your ',
+              pre('cucumber.yml:')
+            ],
+            [pre('default: --publish-quiet')]
+          ],
+          io
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def highlight(text)
+        [text, :cyan]
+      end
+
+      def link(text)
+        [text, :cyan, :bold, :underline]
+      end
+
+      def pre(text)
+        [text, :bold]
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/hook_by_test_step.rb

@@ -0,0 +1,32 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class HookByTestStep
+        def initialize(config)
+          @hook_id_by_test_step_id = {}
+
+          config.on_event :test_step_created, &method(:on_test_step_created)
+          config.on_event :hook_test_step_created, &method(:on_hook_test_step_created)
+        end
+
+        def hook_id(test_step)
+          return @hook_id_by_test_step_id[test_step.id] if @hook_id_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No hook found for #{test_step.id} }. Known: #{@hook_id_by_test_step_id.keys}"
+        end
+
+        private
+
+        def on_test_step_created(event)
+          @hook_id_by_test_step_id[event.test_step.id] = nil
+        end
+
+        def on_hook_test_step_created(event)
+          @hook_id_by_test_step_id[event.test_step.id] = event.hook.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/pickle_by_test.rb

@@ -0,0 +1,26 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class PickleByTest
+        def initialize(config)
+          @pickle_id_by_test_case_id = {}
+          config.on_event :test_case_created, &method(:on_test_case_created)
+        end
+
+        def pickle_id(test_case)
+          return @pickle_id_by_test_case_id[test_case.id] if @pickle_id_by_test_case_id.key?(test_case.id)
+
+          raise TestCaseUnknownError, "No pickle found for #{test_case.id} }. Known: #{@pickle_id_by_test_case_id.keys}"
+        end
+
+        private
+
+        def on_test_case_created(event)
+          @pickle_id_by_test_case_id[event.test_case.id] = event.pickle.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/pickle_step_by_test_step.rb

@@ -0,0 +1,26 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class PickleStepByTestStep
+        def initialize(config)
+          @pickle_id_step_by_test_step_id = {}
+          config.on_event :test_step_created, &method(:on_test_step_created)
+        end
+
+        def pickle_step_id(test_step)
+          return @pickle_id_step_by_test_step_id[test_step.id] if @pickle_id_step_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No pickle step found for #{test_step.id} }. Known: #{@pickle_id_step_by_test_step_id.keys}"
+        end
+
+        private
+
+        def on_test_step_created(event)
+          @pickle_id_step_by_test_step_id[event.test_step.id] = event.pickle_step.id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/step_definitions_by_test_step.rb

@@ -0,0 +1,40 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class StepDefinitionsByTestStep
+        def initialize(config)
+          @step_definition_ids_by_test_step_id = {}
+          @step_match_arguments_by_test_step_id = {}
+
+          config.on_event :test_step_created, &method(:on_test_step_created)
+          config.on_event :step_activated, &method(:on_step_activated)
+        end
+
+        def step_definition_ids(test_step)
+          return @step_definition_ids_by_test_step_id[test_step.id] if @step_definition_ids_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No step definition found for #{test_step.id} }. Known: #{@step_definition_ids_by_test_step_id.keys}"
+        end
+
+        def step_match_arguments(test_step)
+          return @step_match_arguments_by_test_step_id[test_step.id] if @step_match_arguments_by_test_step_id.key?(test_step.id)
+
+          raise TestStepUnknownError, "No step match arguments found for #{test_step.id} }. Known: #{@step_match_arguments_by_test_step_id.keys}"
+        end
+
+        private
+
+        def on_test_step_created(event)
+          @step_definition_ids_by_test_step_id[event.test_step.id] = []
+        end
+
+        def on_step_activated(event)
+          @step_definition_ids_by_test_step_id[event.test_step.id] << event.step_match.step_definition.id
+          @step_match_arguments_by_test_step_id[event.test_step.id] = event.step_match.step_arguments
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/query/test_case_started_by_test_case.rb

@@ -0,0 +1,42 @@
+require 'cucumber/formatter/errors'
+
+module Cucumber
+  module Formatter
+    module Query
+      class TestCaseStartedByTestCase
+        def initialize(config)
+          @config = config
+          config.on_event :test_case_created, &method(:on_test_case_created)
+          config.on_event :test_case_started, &method(:on_test_case_started)
+
+          @attempts_by_test_case_id = {}
+          @test_case_started_id_by_test_case_id = {}
+        end
+
+        def attempt_by_test_case(test_case)
+          raise TestCaseUnknownError, "No test case found for #{test_case.id} }. Known: #{@attempts_by_test_case_id.keys}" unless @attempts_by_test_case_id.key?(test_case.id)
+
+          @attempts_by_test_case_id[test_case.id]
+        end
+
+        def test_case_started_id_by_test_case(test_case)
+          raise TestCaseUnknownError, "No test case found for #{test_case.id} }. Known: #{@test_case_started_id_by_test_case_id.keys}" unless @test_case_started_id_by_test_case_id.key?(test_case.id)
+
+          @test_case_started_id_by_test_case_id[test_case.id]
+        end
+
+        private
+
+        def on_test_case_created(event)
+          @attempts_by_test_case_id[event.test_case.id] = 0
+          @test_case_started_id_by_test_case_id[event.test_case.id] = nil
+        end
+
+        def on_test_case_started(event)
+          @attempts_by_test_case_id[event.test_case.id] += 1
+          @test_case_started_id_by_test_case_id[event.test_case.id] = @config.id_generator.new_id
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/rerun.rb

@@ -8,17 +8,31 @@ module Cucumber
       include Formatter::Io
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_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
       end
@@ -28,6 +42,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

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require 'cucumber/formatter/console'
+
 module Cucumber
   module Formatter
     # The formatter used for <tt>--format steps</tt>
     class Steps
+      include Console
       def initialize(runtime, path_or_io, options)
-        @io = ensure_io(path_or_io)
+        @io = ensure_io(path_or_io, nil)
         @options = options
         @step_definition_files = collect_steps(runtime)
       end
@@ -24,8 +27,8 @@ module Cucumber
           sources = @step_definition_files[step_definition_file]
           source_indent = source_indent(sources)
           sources.sort.each do |file_colon_line, regexp_source|
-            @io.print regexp_source.indent(2)
-            @io.print " # #{file_colon_line}".indent(source_indent - regexp_source.unpack('U*').length)
+            @io.print indent(regexp_source, 2)
+            @io.print indent(" # #{file_colon_line}", source_indent - regexp_source.unpack('U*').length)
             @io.puts
           end
           @io.puts
@@ -35,15 +38,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, config.error_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,18 @@ 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,46 +9,44 @@ 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'
-    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.")
+    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
 
       Kernel.extend(self)
-      STDOUT.extend(self)
-      STDERR.extend(self)
+      $stdout.extend(self)
+      $stderr.extend(self)
     end
   end
 end

data/lib/cucumber/formatter/url_reporter.rb

@@ -0,0 +1,17 @@
+module Cucumber
+  module Formatter
+    class URLReporter
+      def initialize(io)
+        @io = io
+      end
+
+      def report(banner)
+        @io.puts(banner)
+      end
+    end
+
+    class NoReporter
+      def report(banner); end
+    end
+  end
+end