cucumber 5.2.0 → 7.0.0

data/lib/cucumber/cli/configuration.rb

@@ -126,13 +126,35 @@ module Cucumber
       end
 
       def arrange_formats
-        @options[:formats] << ['pretty', {}, @out_stream] if @options[:formats].empty?
+        add_default_formatter if needs_default_formatter?
+
         @options[:formats] = @options[:formats].sort_by do |f|
           f[2] == @out_stream ? -1 : 1
         end
         @options[:formats].uniq!
         @options.check_formatter_stream_conflicts
       end
+
+      def add_default_formatter
+        @options[:formats] << ['pretty', {}, @out_stream]
+      end
+
+      def needs_default_formatter?
+        formatter_missing? || publish_only?
+      end
+
+      def formatter_missing?
+        @options[:formats].empty?
+      end
+
+      def publish_only?
+        @options[:formats]
+          .uniq
+          .map { |formatter, _, stream| [formatter, stream] }
+          .uniq
+          .reject { |formatter, stream| formatter == 'message' && stream != @out_stream }
+          .empty?
+      end
     end
   end
 end

data/lib/cucumber/cli/options.rb

@@ -22,9 +22,14 @@ module Cucumber
                                                               "#{INDENT}filename instead."],
         'stepdefs'    => ['Cucumber::Formatter::Stepdefs',    "Prints All step definitions with their locations. Same as\n" \
                                                               "#{INDENT}the usage formatter, except that steps are not printed."],
-        'junit'       => ['Cucumber::Formatter::Junit',       'Generates a report similar to Ant+JUnit.'],
-        'json'        => ['Cucumber::Formatter::Json',        '[DEPRECATED] Prints the feature as JSON'],
-        'message'     => ['Cucumber::Formatter::Message',     'Outputs protobuf messages'],
+        'junit'       => ['Cucumber::Formatter::Junit',       "Generates a report similar to Ant+JUnit. Use\n" \
+                                                              "#{INDENT}junit,fileattribute=true to include a file attribute."],
+        'json'        => ['Cucumber::Formatter::Json',        "Prints the feature as JSON.\n" \
+                                                              "#{INDENT}The JSON format is in maintenance mode.\n" \
+                                                              "#{INDENT}Please consider using the message formatter\n"\
+                                                              "#{INDENT}with the standalone json-formatter\n" \
+                                                              "#{INDENT}(https://github.com/cucumber/cucumber/tree/master/json-formatter)."],
+        'message'     => ['Cucumber::Formatter::Message',     'Prints each message in NDJSON form, which can then be consumed by other tools.'],
         'html'        => ['Cucumber::Formatter::HTML',        'Outputs HTML report'],
         'summary'     => ['Cucumber::Formatter::Summary',     'Summary output of feature and scenarios']
       }.freeze

data/lib/cucumber/formatter/ansicolor.rb

@@ -3,13 +3,6 @@
 require 'cucumber/platform'
 require 'cucumber/term/ansicolor'
 
-if Cucumber::WINDOWS_MRI
-  unless ENV['ANSICON']
-    STDERR.puts %{*** WARNING: You must use ANSICON 1.31 or higher (https://github.com/adoxa/ansicon/) to get coloured output on Windows}
-    Cucumber::Term::ANSIColor.coloring = false
-  end
-end
-
 Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
 
 module Cucumber

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -15,6 +15,7 @@ module Cucumber
       test/unit
       .gem/ruby
       bin/bundle
+      rdebug-ide
     ]
 
     @backtrace_filters << RbConfig::CONFIG['rubyarchdir'] if RbConfig::CONFIG['rubyarchdir']

data/lib/cucumber/formatter/console.rb

@@ -34,7 +34,7 @@ module Cucumber
 
       def format_step(keyword, step_match, status, source_indent)
         comment = if source_indent
-                    c = ('# ' + step_match.location.to_s).indent(source_indent)
+                    c = indent(('# ' + step_match.location.to_s), source_indent)
                     format_string(c, :comment)
                   else
                     ''
@@ -99,11 +99,11 @@ module Cucumber
         @io.puts(format_string(string, status))
       end
 
-      def exception_message_string(e, indent)
+      def exception_message_string(e, indent_amount)
         message = "#{e.message} (#{e.class})".dup.force_encoding('UTF-8')
         message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
 
-        "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
+        indent("#{message}\n#{e.backtrace.join("\n")}", indent_amount)
       end
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
@@ -208,6 +208,14 @@ module Cucumber
         ].join("\n")
       end
 
+      def indent(string, padding)
+        if padding >= 0
+          string.gsub(/^/, ' ' * padding)
+        else
+          string.gsub(/^ {0,#{-padding}}/, '')
+        end
+      end
+
       private
 
       FORMATS = Hash.new { |hash, format| hash[format] = method(format).to_proc }

data/lib/cucumber/formatter/json.rb

@@ -5,7 +5,6 @@ require 'base64'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/io'
 require 'cucumber/formatter/ast_lookup'
-require 'cucumber/deprecate'
 
 module Cucumber
   module Formatter
@@ -14,14 +13,6 @@ module Cucumber
       include Io
 
       def initialize(config)
-        Cucumber::Deprecate::CliOption.deprecate(
-          config.error_stream,
-          '--format=json',
-          "Please use --format=message and stand-alone json-formatter.\n" \
-          'json-formatter homepage: https://github.com/cucumber/cucumber/tree/master/json-formatter#cucumber-json-formatter',
-          '6.0.0'
-        )
-
         @io = ensure_io(config.out_stream, config.error_stream)
         @ast_lookup = AstLookup.new(config)
         @feature_hashes = []
@@ -41,21 +32,23 @@ module Cucumber
           @feature_hashes << @feature_hash
         end
         @test_case_hash = builder.test_case_hash
-        if builder.background?
-          @in_background = true
-          feature_elements << builder.background_hash
-          @element_hash = builder.background_hash
-        else
-          @in_background = false
-          feature_elements << @test_case_hash
-          @element_hash = @test_case_hash
-        end
+
+        @element_hash = nil
+        @element_background_hash = builder.background_hash
+        @in_background = builder.background?
+
         @any_step_failed = false
       end
 
       def on_test_step_started(event)
         test_step = event.test_step
         return if internal_hook?(test_step)
+
+        if @element_hash.nil?
+          @element_hash = create_element_hash(test_step)
+          feature_elements << @element_hash
+        end
+
         if test_step.hook?
           @step_or_hook_hash = {}
           hooks_of_type(test_step) << @step_or_hook_hash
@@ -80,6 +73,8 @@ module Cucumber
       end
 
       def on_test_case_finished(event)
+        feature_elements << @test_case_hash if @in_background
+
         _test_case, result = *event.attributes
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         add_failed_around_hook(result) if result.failed? && !@any_step_failed
@@ -94,10 +89,7 @@ module Cucumber
           test_step_output << src
           return
         end
-        if File.file?(src)
-          content = File.open(src, 'rb', &:read)
-          data = encode64(content)
-        elsif mime_type =~ /;base64$/
+        if mime_type =~ /;base64$/
           mime_type = mime_type[0..-8]
           data = src
         else
@@ -169,6 +161,13 @@ module Cucumber
         @step_or_hook_hash[:embeddings] ||= []
       end
 
+      def create_element_hash(test_step)
+        return @element_background_hash if @in_background && !first_step_after_background?(test_step)
+
+        @in_background = false
+        @test_case_hash
+      end
+
       def create_step_hash(test_step)
         step_source = @ast_lookup.step_source(test_step).step
         step_hash = {
@@ -269,7 +268,8 @@ module Cucumber
             name: background.name,
             description: value_or_empty_string(background.description),
             line: background.location.line,
-            type: 'background'
+            type: 'background',
+            steps: []
           }
         end
 
@@ -281,7 +281,8 @@ module Cucumber
             name: test_case.name,
             description: value_or_empty_string(scenario.description),
             line: test_case.location.lines.max,
-            type: 'scenario'
+            type: 'scenario',
+            steps: []
           }
           @test_case_hash[:tags] = create_tags_array_from_tags_array(test_case.tags) unless test_case.tags.empty?
         end

data/lib/cucumber/formatter/junit.rb

@@ -132,9 +132,12 @@ module Cucumber
         duration = ResultBuilder.new(result).test_case_duration
         @current_feature_data[:time] += duration
         classname = @current_feature_data[:feature].name
+        filename = @current_feature_data[:uri]
         name = scenario_designation
 
-        @current_feature_data[:builder].testcase(classname: classname, name: name, time: format('%<duration>.6f', duration: duration)) do
+        testcase_attributes = get_testcase_attributes(classname, name, duration, filename)
+
+        @current_feature_data[:builder].testcase(testcase_attributes) do
           if !result.passed? && result.ok?(@config.strict)
             @current_feature_data[:builder].skipped
             @current_feature_data[:skipped] += 1
@@ -157,6 +160,20 @@ module Cucumber
         @current_feature_data[:tests] += 1
       end
 
+      def get_testcase_attributes(classname, name, duration, filename)
+        { classname: classname, name: name, time: format('%<duration>.6f', duration: duration) }.tap do |attributes|
+          attributes[:file] = filename if add_fileattribute?
+        end
+      end
+
+      def add_fileattribute?
+        return false if @config.formats.nil? || @config.formats.empty?
+
+        !!@config.formats.find do |format|
+          format.first == 'junit' && format.dig(1, 'fileattribute') == 'true'
+        end
+      end
+
       def get_backtrace_object(result)
         if result.failed?
           result.exception

data/lib/cucumber/formatter/message.rb

@@ -15,7 +15,8 @@ module Cucumber
       end
 
       def output_envelope(envelope)
-        envelope.write_ndjson_to(@io)
+        @io.write(envelope.to_json)
+        @io.write("\n")
       end
     end
   end

data/lib/cucumber/formatter/message_builder.rb

@@ -48,12 +48,12 @@ module Cucumber
         }
 
         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 +101,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 +110,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 +118,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,7 +127,7 @@ 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
           )
@@ -135,7 +135,7 @@ module Cucumber
       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) }
@@ -190,7 +190,7 @@ module Cucumber
 
         result_message = result.to_message
         if result.failed? || result.pending?
-          result_message = Cucumber::Messages::TestStepFinished::TestStepResult.new(
+          result_message = Cucumber::Messages::TestStepResult.new(
             status: result_message.status,
             duration: result_message.duration,
             message: create_error_message(result)

data/lib/cucumber/formatter/pretty.rb

@@ -181,7 +181,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
 
@@ -259,33 +259,34 @@ 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|
           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
@@ -339,7 +340,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,10 +375,10 @@ 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
 
@@ -393,7 +394,7 @@ 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]
@@ -403,8 +404,8 @@ module Cucumber
         @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 +417,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?