cucumber 4.1.0 → 9.2.0

data/lib/cucumber/formatter/message_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/query/hook_by_test_step'
@@ -40,20 +42,21 @@ module Cucumber
         raise 'To be implemented'
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         attachment_data = {
           test_step_id: @current_test_step_id,
           test_case_started_id: @current_test_case_started_id,
-          media_type: media_type
+          media_type: media_type,
+          file_name: filename
         }
 
         if media_type.start_with?('text/')
-          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::IDENTITY
+          attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::IDENTITY
           attachment_data[:body] = src
         else
           body = src.respond_to?(:read) ? src.read : src
 
-          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::BASE64
+          attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::BASE64
           attachment_data[:body] = Base64.strict_encode64(body)
         end
 
@@ -101,7 +104,7 @@ module Cucumber
       def test_step_to_message(step)
         return hook_step_to_message(step) if step.hook?
 
-        Cucumber::Messages::TestCase::TestStep.new(
+        Cucumber::Messages::TestStep.new(
           id: step.id,
           pickle_step_id: @pickle_step_by_test_step.pickle_step_id(step),
           step_definition_ids: @step_definitions_by_test_step.step_definition_ids(step),
@@ -110,7 +113,7 @@ module Cucumber
       end
 
       def hook_step_to_message(step)
-        Cucumber::Messages::TestCase::TestStep.new(
+        Cucumber::Messages::TestStep.new(
           id: step.id,
           hook_id: @hook_by_test_step.hook_id(step)
         )
@@ -118,7 +121,7 @@ module Cucumber
 
       def step_match_arguments_lists(step)
         match_arguments = step_match_arguments(step)
-        [Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList.new(
+        [Cucumber::Messages::StepMatchArgumentsList.new(
           step_match_arguments: match_arguments
         )]
       rescue Cucumber::Formatter::TestStepUnknownError
@@ -127,21 +130,25 @@ module Cucumber
 
       def step_match_arguments(step)
         @step_definitions_by_test_step.step_match_arguments(step).map do |argument|
-          Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument.new(
+          Cucumber::Messages::StepMatchArgument.new(
             group: argument_group_to_message(argument.group),
-            parameter_type_name: argument.parameter_type.name
+            parameter_type_name: parameter_type_name(argument)
           )
         end
       end
 
       def argument_group_to_message(group)
-        Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument::Group.new(
+        Cucumber::Messages::Group.new(
           start: group.start,
           value: group.value,
           children: group.children.map { |child| argument_group_to_message(child) }
         )
       end
 
+      def parameter_type_name(step_match_argument)
+        step_match_argument.parameter_type&.name if step_match_argument.respond_to?(:parameter_type)
+      end
+
       def on_test_run_started(*)
         message = Cucumber::Messages::Envelope.new(
           test_run_started: Cucumber::Messages::TestRunStarted.new(
@@ -190,10 +197,13 @@ module Cucumber
 
         result_message = result.to_message
         if result.failed? || result.pending?
-          result_message = Cucumber::Messages::TestStepFinished::TestStepResult.new(
+          message_element = result.failed? ? result.exception : result
+
+          result_message = Cucumber::Messages::TestStepResult.new(
             status: result_message.status,
             duration: result_message.duration,
-            message: create_error_message(result)
+            message: create_error_message(message_element),
+            exception: create_exception_object(result, message_element)
           )
         end
 
@@ -209,12 +219,17 @@ module Cucumber
         output_envelope(message)
       end
 
-      def create_error_message(result)
-        message_element = result.failed? ? result.exception : result
+      def create_error_message(message_element)
         message = "#{message_element.message} (#{message_element.class})"
         ([message] + message_element.backtrace).join("\n")
       end
 
+      def create_exception_object(result, message_element)
+        return unless result.failed?
+
+        Cucumber::Messages::Exception.from_h({ type: message_element.class, message: message_element.message })
+      end
+
       def on_test_case_finished(event)
         message = Cucumber::Messages::Envelope.new(
           test_case_finished: Cucumber::Messages::TestCaseFinished.new(
@@ -226,10 +241,11 @@ module Cucumber
         output_envelope(message)
       end
 
-      def on_test_run_finished(*)
+      def on_test_run_finished(event)
         message = Cucumber::Messages::Envelope.new(
           test_run_finished: Cucumber::Messages::TestRunFinished.new(
-            timestamp: time_to_timestamp(Time.now)
+            timestamp: time_to_timestamp(Time.now),
+            success: event.success
           )
         )
 

data/lib/cucumber/formatter/pretty.rb

@@ -19,20 +19,18 @@ module Cucumber
     #
     # If the output is STDOUT (and not a file), there are bright colours to watch too.
     #
-    class Pretty # rubocop:disable Metrics/ClassLength
+    class Pretty
       include FileUtils
       include Console
       include Io
       include Cucumber::Gherkin::Formatter::Escaping
-      attr_reader :config, :options
+      attr_reader :config, :options, :current_feature_uri, :current_scenario_outline, :current_examples, :current_test_case, :in_scenario_outline, :print_background_steps
       private :config, :options
-      attr_reader :current_feature_uri, :current_scenario_outline, :current_examples, :current_test_case
       private :current_feature_uri, :current_scenario_outline, :current_examples, :current_test_case
-      attr_reader :in_scenario_outline, :print_background_steps
       private :in_scenario_outline, :print_background_steps
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @config = config
         @options = config.to_hash
         @snippets_input = []
@@ -105,16 +103,19 @@ module Cucumber
 
       def on_test_step_started(event)
         return if event.test_step.hook?
+
         print_step_header(current_test_case) if first_step_after_printing_background_steps?(event.test_step)
       end
 
       def on_test_step_finished(event)
         collect_snippet_data(event.test_step, @ast_lookup) if event.result.undefined?
         return if in_scenario_outline && !options[:expand]
+
         exception_to_be_printed = find_exception_to_be_printed(event.result)
         print_step_data(event.test_step, event.result) if print_step_data?(event, exception_to_be_printed)
         print_step_output
         return unless exception_to_be_printed
+
         print_exception(exception_to_be_printed, event.result.to_sym, 6)
         @exceptions << exception_to_be_printed
       end
@@ -127,6 +128,7 @@ module Cucumber
         else
           exception_to_be_printed = find_exception_to_be_printed(event.result)
           return unless exception_to_be_printed
+
           print_exception(exception_to_be_printed, event.result.to_sym, 6)
           @exceptions << exception_to_be_printed
         end
@@ -138,18 +140,25 @@ module Cucumber
         print_summary
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         return unless media_type == 'text/x.cucumber.log+plain'
-        @test_step_output.push src
+
+        if filename
+          @test_step_output.push("#{filename}: #{src}")
+        else
+          @test_step_output.push(src)
+        end
       end
 
       private
 
       def find_exception_to_be_printed(result)
-        return nil if result.ok?(options[:strict])
+        return nil if result.ok?(strict: options[:strict])
+
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         exception = result.failed? ? result.exception : result
         return nil if @exceptions.include?(exception)
+
         exception
       end
 
@@ -181,7 +190,7 @@ module Cucumber
       end
 
       def print_step_output
-        @test_step_output.each { |message| @io.puts(format_string(message, :tag).indent(6)) }
+        @test_step_output.each { |message| @io.puts(indent(format_string(message, :tag), 6)) }
         @test_step_output = []
       end
 
@@ -196,6 +205,7 @@ module Cucumber
       def feature_has_background?
         feature_children = gherkin_document.feature.children
         return false if feature_children.empty?
+
         !feature_children.first.background.nil?
       end
 
@@ -239,6 +249,7 @@ module Cucumber
       def first_step_after_printing_background_steps?(test_step)
         return false unless print_background_steps
         return false unless test_step.location.lines.max >= current_test_case.location.lines.max
+
         @print_background_steps = false
         true
       end
@@ -259,33 +270,35 @@ module Cucumber
         end
       end
 
-      def print_comments(up_to_line, indent)
+      def print_comments(up_to_line, indent_amount)
         comments = gherkin_document.comments
         return if comments.empty? || comments.length <= @next_comment_to_be_printed
-        comments[@next_comment_to_be_printed..-1].each do |comment|
+
+        comments[@next_comment_to_be_printed..].each do |comment|
           if comment.location.line <= up_to_line
-            @io.puts(format_string(comment.text.strip, :comment).indent(indent))
+            @io.puts(indent(format_string(comment.text.strip, :comment), indent_amount))
             @next_comment_to_be_printed += 1
           end
           break if @next_comment_to_be_printed >= comments.length
         end
       end
 
-      def print_tags(tags, indent)
+      def print_tags(tags, indent_amount)
         return if !tags || tags.empty?
-        @io.puts(tags.map { |tag| format_string(tag.name, :tag) }.join(' ').indent(indent))
+
+        @io.puts(indent(tags.map { |tag| format_string(tag.name, :tag) }.join(' '), indent_amount))
       end
 
       def print_feature_line(feature)
         print_keyword_name(feature.keyword, feature.name, 0)
       end
 
-      def print_keyword_name(keyword, name, indent, location = nil)
+      def print_keyword_name(keyword, name, indent_amount, location = nil)
         line = "#{keyword}:"
         line += " #{name}"
-        @io.print(line.indent(indent))
+        @io.print(indent(line, indent_amount))
         if location && options[:source]
-          line_comment = format_string("# #{location}", :comment).indent(@source_indent - line.length - indent)
+          line_comment = indent(format_string("# #{location}", :comment), @source_indent - line.length - indent_amount)
           @io.print(line_comment)
         end
         @io.puts
@@ -293,6 +306,7 @@ module Cucumber
 
       def print_description(description)
         return unless description
+
         description.split("\n").each do |line|
           @io.puts(line)
         end
@@ -339,7 +353,7 @@ module Cucumber
         indent = options[:source] ? @source_indent - step_keyword.length - test_step.text.length - base_indent : nil
         print_comments(test_step.location.lines.max, base_indent)
         name_to_report = format_step(step_keyword, @step_matches.fetch(test_step.to_s) { NoStepMatch.new(test_step, test_step.text) }, result.to_sym, indent)
-        @io.puts(name_to_report.indent(base_indent))
+        @io.puts(indent(name_to_report, base_indent))
         print_multiline_argument(test_step, result, base_indent + 2) unless options[:no_multiline]
         @io.flush
       end
@@ -374,14 +388,14 @@ module Cucumber
         end
       end
 
-      def print_data_table(data_table, status, indent)
+      def print_data_table(data_table, status, indent_amount)
         data_table.rows.each do |row|
-          print_comments(row.location.line, indent)
-          @io.puts format_string(gherkin_source.split("\n")[row.location.line - 1].strip, status).indent(indent)
+          print_comments(row.location.line, indent_amount)
+          @io.puts indent(format_string(gherkin_source.split("\n")[row.location.line - 1].strip, status), indent_amount)
         end
       end
 
-      def print_outline_data(scenario_outline) # rubocop:disable Metrics/AbcSize
+      def print_outline_data(scenario_outline)
         print_comments(scenario_outline.location.line, 2)
         print_tags(scenario_outline.tags, 2)
         @source_indent = calculate_source_indent_for_ast_node(scenario_outline) if options[:source]
@@ -393,18 +407,19 @@ module Cucumber
           @io.print(format_string(step_line, :skipped))
           if options[:source]
             comment_line = format_string("# #{current_feature_uri}:#{step.location.line}", :comment)
-            @io.print(comment_line.indent(@source_indent - step_line.length))
+            @io.print(indent(comment_line, @source_indent - step_line.length))
           end
           @io.puts
           next if options[:no_multiline]
+
           print_doc_string(step.doc_string.content, :skipped, 6) unless step.doc_string.nil?
           print_data_table(step.data_table, :skipped, 6) unless step.data_table.nil?
         end
         @io.flush
       end
 
-      def print_doc_string(content, status, indent)
-        s = %("""\n#{content}\n""").indent(indent)
+      def print_doc_string(content, status, indent_amount)
+        s = indent(%("""\n#{content}\n"""), indent_amount)
         s = s.split("\n").map { |l| l =~ /^\s+$/ ? '' : l }.join("\n")
         @io.puts(format_string(s, status))
       end
@@ -416,15 +431,15 @@ module Cucumber
         print_description(examples.description)
         unless options[:expand]
           print_comments(examples.table_header.location.line, 6)
-          @io.puts(gherkin_source.split("\n")[examples.table_header.location.line - 1].strip.indent(6))
+          @io.puts(indent(gherkin_source.split("\n")[examples.table_header.location.line - 1].strip, 6))
         end
         @io.flush
       end
 
       def print_row_data(test_case, result)
         print_comments(test_case.location.lines.max, 6)
-        @io.print(format_string(gherkin_source.split("\n")[test_case.location.lines.max - 1].strip, result.to_sym).indent(6))
-        @io.print(format_string(@test_step_output.join(', '), :tag).indent(2)) unless @test_step_output.empty?
+        @io.print(indent(format_string(gherkin_source.split("\n")[test_case.location.lines.max - 1].strip, result.to_sym), 6))
+        @io.print(indent(format_string(@test_step_output.join(', '), :tag), 2)) unless @test_step_output.empty?
         @test_step_output = []
         @io.puts
         if result.failed? || result.pending?
@@ -444,7 +459,7 @@ module Cucumber
         language = ::Gherkin::Dialect.for(language_code)
         scenario_keyword = language.scenario_keywords[0]
         row = scenario_source(test_case).row
-        expanded_name = '| ' + row.cells.map(&:value).join(' | ') + ' |'
+        expanded_name = "| #{row.cells.map(&:value).join(' | ')} |"
         @source_indent = calculate_source_indent_for_expanded_test_case(test_case, scenario_keyword, expanded_name)
         @io.puts
         print_keyword_name(scenario_keyword, expanded_name, 6, test_case.location)

data/lib/cucumber/formatter/progress.rb

@@ -19,7 +19,7 @@ module Cucumber
 
       def initialize(config)
         @config = config
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @snippets_input = []
         @undefined_parameter_types = []
         @total_duration = 0
@@ -58,6 +58,7 @@ module Cucumber
         progress(result.to_sym) if !test_step.hook? || result.failed?
 
         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?

data/lib/cucumber/formatter/publish_banner_printer.rb

@@ -0,0 +1,75 @@
+# 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
+
+      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
+
+      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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber
@@ -13,6 +15,7 @@ module Cucumber
 
         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
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber
@@ -15,11 +17,13 @@ module Cucumber
 
         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
 

data/lib/cucumber/formatter/rerun.rb

@@ -7,30 +7,32 @@ module Cucumber
     class Rerun
       include Formatter::Io
 
-      def initialize(config) # rubocop:disable Metrics/PerceivedComplexity
-        @io = ensure_io(config.out_stream)
+      def initialize(config)
+        @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
           if @config.strict.strict?(:flaky)
-            next if result.ok?(@config.strict)
+            next if result.ok?(strict: @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)
+              elsif result.ok?(strict: @config.strict)
                 @latest_failed_test_case = nil
               end
             end
-            @latest_failed_test_case = test_case unless result.ok?(@config.strict)
+            @latest_failed_test_case = test_case unless result.ok?(strict: @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

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

data/lib/cucumber/formatter/summary.rb

@@ -16,7 +16,7 @@ module Cucumber
 
       def initialize(config)
         @config = config
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @ast_lookup = AstLookup.new(config)
         @counts = ConsoleCounts.new(@config)
         @issues = ConsoleIssues.new(@config, @ast_lookup)
@@ -47,6 +47,7 @@ module Cucumber
       def print_feature(test_case)
         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

data/lib/cucumber/formatter/unicode.rb

@@ -10,14 +10,14 @@ if Cucumber::WINDOWS
     Cucumber::CODEPAGE = ENV['CUCUMBER_OUTPUT_ENCODING']
   elsif `cmd /c chcp` =~ /(\d+)/
     if [65_000, 65_001].include? Regexp.last_match(1).to_i
-      Cucumber::CODEPAGE = 'UTF-8'.freeze
+      Cucumber::CODEPAGE = 'UTF-8'
       ENV['ANSICON_API'] = 'ruby'
     else
-      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}".freeze
+      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}"
     end
   else
-    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.")
+    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.")
   end
 
   module Cucumber
@@ -28,7 +28,7 @@ if Cucumber::WINDOWS
           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}")
+            $stderr.cucumber_puts("WARNING: #{e.message}")
             out
           end
 
@@ -45,8 +45,8 @@ if Cucumber::WINDOWS
       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,19 @@
+# frozen_string_literal: true
+
+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