cucumber 3.0.2 → 4.0.0

data/lib/cucumber/formatter/junit.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 require 'builder'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/io'
 require 'cucumber/formatter/interceptor'
 require 'fileutils'
+require 'cucumber/formatter/ast_lookup'
 
 module Cucumber
   module Formatter
     # The formatter used for <tt>--format junit</tt>
     class Junit
-
       include Io
 
       class UnNamedFeatureError < StandardError
@@ -19,29 +20,30 @@ module Cucumber
       end
 
       def initialize(config)
+        @ast_lookup = AstLookup.new(config)
         config.on_event :test_case_started, &method(:on_test_case_started)
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
         @reportdir = ensure_dir(config.out_stream, 'junit')
         @config = config
-        @features_data = Hash.new { |h,k| h[k] = {
-          feature: nil,
-          failures: 0,
-          errors: 0,
-          tests: 0,
-          skipped: 0,
-          time: 0,
-          builder: Builder::XmlMarkup.new(:indent => 2)
-        }}
+        @features_data = Hash.new do |h, k|
+          h[k] = {
+            feature: nil,
+            failures: 0,
+            errors: 0,
+            tests: 0,
+            skipped: 0,
+            time: 0,
+            builder: Builder::XmlMarkup.new(indent: 2)
+          }
+        end
       end
 
       def on_test_case_started(event)
         test_case = event.test_case
-        unless same_feature_as_previous_test_case?(test_case.feature)
-          start_feature(test_case.feature)
-        end
-        @failing_step_source = nil
+        start_feature(test_case) unless same_feature_as_previous_test_case?(test_case)
+        @failing_test_step = nil
         # In order to fill out <system-err/> and <system-out/>, we need to
         # intercept the $stderr and $stdout
         @interceptedout = Interceptor::Pipe.wrap(:stdout)
@@ -50,15 +52,15 @@ module Cucumber
 
       def on_test_step_finished(event)
         test_step, result = *event.attributes
-        return if @failing_step_source
+        return if @failing_test_step
 
-        @failing_step_source = test_step.source.last unless result.ok?(@config.strict)
+        @failing_test_step = test_step unless result.ok?(@config.strict)
       end
 
       def on_test_case_finished(event)
         test_case, result = *event.attributes
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
-        test_case_name = NameBuilder.new(test_case)
+        test_case_name = NameBuilder.new(test_case, @ast_lookup)
         scenario = test_case_name.scenario_name
         scenario_designation = "#{scenario}#{test_case_name.name_suffix}"
         output = create_output_string(test_case, scenario, result, test_case_name.row_name)
@@ -69,77 +71,87 @@ module Cucumber
       end
 
       def on_test_run_finished(_event)
-        @features_data.each { |file, data| end_feature(data) }
+        @features_data.each { |_file, data| end_feature(data) }
       end
 
       private
 
-      def same_feature_as_previous_test_case?(feature)
-        @current_feature_data && @current_feature_data[:feature].file == feature.file && @current_feature_data[:feature].location == feature.location
+      def same_feature_as_previous_test_case?(test_case)
+        @current_feature_data && @current_feature_data[:uri] == test_case.location.file
       end
 
-      def start_feature(feature)
-        raise UnNamedFeatureError.new(feature.file) if feature.name.empty?
-        @current_feature_data = @features_data[feature.file]
+      def start_feature(test_case)
+        uri = test_case.location.file
+        feature = @ast_lookup.gherkin_document(uri).feature
+        raise UnNamedFeatureError, uri if feature.name.empty?
+        @current_feature_data = @features_data[uri]
+        @current_feature_data[:uri] = uri unless @current_feature_data[:uri]
         @current_feature_data[:feature] = feature unless @current_feature_data[:feature]
       end
 
       def end_feature(feature_data)
-        @testsuite = Builder::XmlMarkup.new(:indent => 2)
+        @testsuite = Builder::XmlMarkup.new(indent: 2)
         @testsuite.instruct!
         @testsuite.testsuite(
-          :failures => feature_data[:failures],
-          :errors => feature_data[:errors],
-          :skipped => feature_data[:skipped],
-          :tests => feature_data[:tests],
-          :time => format('%.6f', feature_data[:time]),
-          :name => feature_data[:feature].name ) do
+          failures: feature_data[:failures],
+          errors: feature_data[:errors],
+          skipped: feature_data[:skipped],
+          tests: feature_data[:tests],
+          time: format('%<time>.6f', time: feature_data[:time]),
+          name: feature_data[:feature].name
+        ) do
           @testsuite << feature_data[:builder].target!
         end
 
-        write_file(feature_result_filename(feature_data[:feature].file), @testsuite.target!)
+        write_file(feature_result_filename(feature_data[:uri]), @testsuite.target!)
       end
 
-      def create_output_string(test_case, scenario, result, row_name)
-        output = "#{test_case.keyword}: #{scenario}\n\n"
+      def create_output_string(test_case, scenario, result, row_name) # rubocop:disable Metrics/PerceivedComplexity
+        scenario_source = @ast_lookup.scenario_source(test_case)
+        keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
+        output = "#{keyword}: #{scenario}\n\n"
         return output if result.ok?(@config.strict)
-        if test_case.keyword == 'Scenario'
-          output += @failing_step_source.keyword.to_s unless hook?(@failing_step_source)
-          output += "#{@failing_step_source}\n"
+        if scenario_source.type == :Scenario
+          if @failing_test_step
+            if @failing_test_step.hook?
+              output += "#{@failing_test_step.text} at #{@failing_test_step.location}\n"
+            else
+              step_source = @ast_lookup.step_source(@failing_test_step).step
+              output += "#{step_source.keyword}#{@failing_test_step.text}\n"
+            end
+          else # An Around hook has failed
+            output += "Around hook\n"
+          end
         else
           output += "Example row: #{row_name}\n"
         end
         output + "\nMessage:\n"
       end
 
-      def hook?(step)
-        ['Before hook', 'After hook', 'AfterStep hook'].include? step.text
-      end
-
       def build_testcase(result, scenario_designation, output)
         duration = ResultBuilder.new(result).test_case_duration
         @current_feature_data[:time] += duration
         classname = @current_feature_data[:feature].name
         name = scenario_designation
 
-        @current_feature_data[:builder].testcase(:classname => classname, :name => name, :time => format('%.6f', duration)) do
+        @current_feature_data[:builder].testcase(classname: classname, name: name, time: format('%<duration>.6f', duration: duration)) do
           if !result.passed? && result.ok?(@config.strict)
             @current_feature_data[:builder].skipped
             @current_feature_data[:skipped] += 1
           elsif !result.passed?
             status = result.to_sym
             exception = get_backtrace_object(result)
-            @current_feature_data[:builder].failure(:message => "#{status} #{name}", :type => status) do
+            @current_feature_data[:builder].failure(message: "#{status} #{name}", type: status) do
               @current_feature_data[:builder].cdata! output
               @current_feature_data[:builder].cdata!(format_exception(exception)) if exception
             end
             @current_feature_data[:failures] += 1
           end
           @current_feature_data[:builder].tag!('system-out') do
-            @current_feature_data[:builder].cdata! strip_control_chars(@interceptedout.buffer.join)
+            @current_feature_data[:builder].cdata! strip_control_chars(@interceptedout.buffer_string)
           end
           @current_feature_data[:builder].tag!('system-err') do
-            @current_feature_data[:builder].cdata! strip_control_chars(@interceptederr.buffer.join)
+            @current_feature_data[:builder].cdata! strip_control_chars(@interceptederr.buffer_string)
           end
         end
         @current_feature_data[:tests] += 1
@@ -147,11 +159,9 @@ module Cucumber
 
       def get_backtrace_object(result)
         if result.failed?
-          return result.exception
+          result.exception
         elsif result.backtrace
-          return result
-        else
-          return nil
+          result
         end
       end
 
@@ -164,7 +174,7 @@ module Cucumber
       end
 
       def basename(feature_file)
-        File.basename(feature_file.gsub(/[\\\/]/, '-'), '.feature')
+        File.basename(feature_file.gsub(/[\\\/]/, '-'), '.feature') # rubocop:disable Style/RegexpLiteral
       end
 
       def write_file(feature_filename, data)
@@ -175,40 +185,34 @@ module Cucumber
       def strip_control_chars(cdata)
         cdata.scan(/[[:print:]\t\n\r]/).join
       end
-
     end
 
     class NameBuilder
       attr_reader :scenario_name, :name_suffix, :row_name
 
-      def initialize(test_case)
+      def initialize(test_case, ast_lookup)
         @name_suffix = ''
         @row_name = ''
-        test_case.describe_source_to self
-      end
-
-      def feature(*)
-        self
+        scenario_source = ast_lookup.scenario_source(test_case)
+        if scenario_source.type == :Scenario
+          scenario(scenario_source.scenario)
+        else
+          scenario_outline(scenario_source.scenario_outline)
+          examples_table_row(scenario_source.row)
+        end
       end
 
       def scenario(scenario)
-        @scenario_name = (scenario.name.nil? || scenario.name == '') ? 'Unnamed scenario' : scenario.name
-        self
+        @scenario_name = scenario.name.empty? ? 'Unnamed scenario' : scenario.name
       end
 
       def scenario_outline(outline)
-        @scenario_name = (outline.name.nil? || outline.name == '') ? 'Unnamed scenario outline' : outline.name
-        self
-      end
-
-      def examples_table(*)
-        self
+        @scenario_name = outline.name.empty? ? 'Unnamed scenario outline' : outline.name
       end
 
       def examples_table_row(row)
-        @row_name = '| ' + row.values.join(' | ') + ' |'
+        @row_name = '| ' + row.cells.map(&:value).join(' | ') + ' |'
         @name_suffix = " (outline example : #{@row_name})"
-        self
       end
     end
 
@@ -232,9 +236,10 @@ module Cucumber
       def exception(*) end
 
       def duration(duration, *)
-        duration.tap { |duration| @test_case_duration = duration.nanoseconds / 10**9.0 }
+        duration.tap { |dur| @test_case_duration = dur.nanoseconds / 10**9.0 }
       end
-    end
 
+      def attach(*) end
+    end
   end
 end

data/lib/cucumber/formatter/message.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'cucumber/formatter/io'
+require 'cucumber/formatter/message_builder'
+
+module Cucumber
+  module Formatter
+    # The formatter used for <tt>--format message</tt>
+    class Message < MessageBuilder
+      include Io
+
+      def initialize(config)
+        @io = ensure_io(config.out_stream)
+        super(config)
+      end
+
+      def output_envelope(envelope)
+        envelope.write_ndjson_to(@io)
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/message_builder.rb

@@ -0,0 +1,255 @@
+require 'base64'
+require 'cucumber/formatter/backtrace_filter'
+require 'cucumber/formatter/query/hook_by_test_step'
+require 'cucumber/formatter/query/pickle_by_test'
+require 'cucumber/formatter/query/pickle_step_by_test_step'
+require 'cucumber/formatter/query/step_definitions_by_test_step'
+require 'cucumber/formatter/query/test_case_started_by_test_case'
+
+module Cucumber
+  module Formatter
+    class MessageBuilder
+      include Cucumber::Messages::TimeConversion
+
+      def initialize(config)
+        @config = config
+
+        @hook_by_test_step = Query::HookByTestStep.new(config)
+        @pickle_by_test = Query::PickleByTest.new(config)
+        @pickle_step_by_test_step = Query::PickleStepByTestStep.new(config)
+        @step_definitions_by_test_step = Query::StepDefinitionsByTestStep.new(config)
+        @test_case_started_by_test_case = Query::TestCaseStartedByTestCase.new(config)
+
+        config.on_event :envelope, &method(:on_envelope)
+        config.on_event :gherkin_source_read, &method(:on_gherkin_source_read)
+        config.on_event :test_case_ready, &method(:on_test_case_ready)
+        config.on_event :test_run_started, &method(:on_test_run_started)
+        config.on_event :test_case_started, &method(:on_test_case_started)
+        config.on_event :test_step_started, &method(:on_test_step_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(:on_undefined_parameter_type)
+
+        @test_case_by_step_id = {}
+        @current_test_case_started_id = nil
+        @current_test_step_id = nil
+      end
+
+      def output_message
+        raise 'To be implemented'
+      end
+
+      def attach(src, media_type)
+        attachment_data = {
+          test_step_id: @current_test_step_id,
+          test_case_started_id: @current_test_case_started_id,
+          media_type: media_type
+        }
+
+        if media_type.start_with?('text/')
+          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::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[:body] = Base64.strict_encode64(body)
+        end
+
+        message = Cucumber::Messages::Envelope.new(
+          attachment: Cucumber::Messages::Attachment.new(**attachment_data)
+        )
+
+        output_envelope(message)
+      end
+
+      private
+
+      def on_envelope(event)
+        output_envelope(event.envelope)
+      end
+
+      def on_gherkin_source_read(event)
+        message = Cucumber::Messages::Envelope.new(
+          source: Cucumber::Messages::Source.new(
+            uri: event.path,
+            data: event.body,
+            media_type: 'text/x.cucumber.gherkin+plain'
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def on_test_case_ready(event)
+        event.test_case.test_steps.each do |step|
+          @test_case_by_step_id[step.id] = event.test_case
+        end
+
+        message = Cucumber::Messages::Envelope.new(
+          test_case: Cucumber::Messages::TestCase.new(
+            id: event.test_case.id,
+            pickle_id: @pickle_by_test.pickle_id(event.test_case),
+            test_steps: event.test_case.test_steps.map { |step| test_step_to_message(step) }
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def test_step_to_message(step)
+        return hook_step_to_message(step) if step.hook?
+
+        Cucumber::Messages::TestCase::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),
+          step_match_arguments_lists: step_match_arguments_lists(step)
+        )
+      end
+
+      def hook_step_to_message(step)
+        Cucumber::Messages::TestCase::TestStep.new(
+          id: step.id,
+          hook_id: @hook_by_test_step.hook_id(step)
+        )
+      end
+
+      def step_match_arguments_lists(step)
+        match_arguments = step_match_arguments(step)
+        [Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList.new(
+          step_match_arguments: match_arguments
+        )]
+      rescue Cucumber::Formatter::TestStepUnknownError
+        []
+      end
+
+      def step_match_arguments(step)
+        @step_definitions_by_test_step.step_match_arguments(step).map do |argument|
+          Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument.new(
+            group: argument_group_to_message(argument.group),
+            parameter_type_name: argument.parameter_type.name
+          )
+        end
+      end
+
+      def argument_group_to_message(group)
+        Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument::Group.new(
+          start: group.start,
+          value: group.value,
+          children: group.children.map { |child| argument_group_to_message(child) }
+        )
+      end
+
+      def on_test_run_started(*)
+        message = Cucumber::Messages::Envelope.new(
+          test_run_started: Cucumber::Messages::TestRunStarted.new(
+            timestamp: time_to_timestamp(Time.now)
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def on_test_case_started(event)
+        @current_test_case_started_id = test_case_started_id(event.test_case)
+
+        message = Cucumber::Messages::Envelope.new(
+          test_case_started: Cucumber::Messages::TestCaseStarted.new(
+            id: test_case_started_id(event.test_case),
+            test_case_id: event.test_case.id,
+            timestamp: time_to_timestamp(Time.now),
+            attempt: @test_case_started_by_test_case.attempt_by_test_case(event.test_case)
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def on_test_step_started(event)
+        @current_test_step_id = event.test_step.id
+        test_case = @test_case_by_step_id[event.test_step.id]
+
+        message = Cucumber::Messages::Envelope.new(
+          test_step_started: Cucumber::Messages::TestStepStarted.new(
+            test_step_id: event.test_step.id,
+            test_case_started_id: test_case_started_id(test_case),
+            timestamp: time_to_timestamp(Time.now)
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def on_test_step_finished(event)
+        test_case = @test_case_by_step_id[event.test_step.id]
+        result = event
+                 .result
+                 .with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
+
+        result_message = result.to_message
+        if result.failed? || result.pending?
+          result_message = Cucumber::Messages::TestStepFinished::TestStepResult.new(
+            status: result_message.status,
+            duration: result_message.duration,
+            message: create_error_message(result)
+          )
+        end
+
+        message = Cucumber::Messages::Envelope.new(
+          test_step_finished: Cucumber::Messages::TestStepFinished.new(
+            test_step_id: event.test_step.id,
+            test_case_started_id: test_case_started_id(test_case),
+            test_step_result: result_message,
+            timestamp: time_to_timestamp(Time.now)
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def create_error_message(result)
+        message_element = result.failed? ? result.exception : result
+        message = "#{message_element.message} (#{message_element.class})"
+        ([message] + message_element.backtrace).join("\n")
+      end
+
+      def on_test_case_finished(event)
+        message = Cucumber::Messages::Envelope.new(
+          test_case_finished: Cucumber::Messages::TestCaseFinished.new(
+            test_case_started_id: test_case_started_id(event.test_case),
+            timestamp: time_to_timestamp(Time.now)
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def on_test_run_finished(*)
+        message = Cucumber::Messages::Envelope.new(
+          test_run_finished: Cucumber::Messages::TestRunFinished.new(
+            timestamp: time_to_timestamp(Time.now)
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def on_undefined_parameter_type(event)
+        message = Cucumber::Messages::Envelope.new(
+          undefined_parameter_type: Cucumber::Messages::UndefinedParameterType.new(
+            name: event.type_name,
+            expression: event.expression
+          )
+        )
+
+        output_envelope(message)
+      end
+
+      def test_case_started_id(test_case)
+        @test_case_started_by_test_case.test_case_started_id_by_test_case(test_case)
+      end
+    end
+  end
+end