cucumber 4.0.0.rc.1 → 4.0.0.rc.6

data/lib/cucumber/errors.rb

@@ -10,8 +10,8 @@ module Cucumber
 
       begin
         raise new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
-      rescue StandardError => exception
-        return exception
+      rescue StandardError => e
+        return e
       end
     end
 
@@ -49,4 +49,7 @@ module Cucumber
       super(messages.join("\n"))
     end
   end
+
+  class LogTypeInvalid < StandardError
+  end
 end

data/lib/cucumber/events.rb

@@ -24,16 +24,21 @@ module Cucumber
 
     def self.registry
       Core::Events.build_registry(
-        TestCaseStarted,
+        GherkinSourceParsed,
+        GherkinSourceRead,
+        HookTestStepCreated,
+        StepActivated,
+        StepDefinitionRegistered,
+        TestCaseCreated,
         TestCaseFinished,
+        TestCaseStarted,
+        TestCaseReady,
+        TestRunFinished,
+        TestRunStarted,
+        TestStepCreated,
         TestStepFinished,
         TestStepStarted,
-        StepDefinitionRegistered,
-        StepActivated,
-        TestRunFinished,
-        GherkinSourceRead,
-        GherkinSourceParsed,
-        TestRunStarted
+        Envelope
       )
     end
   end

data/lib/cucumber/events/envelope.rb

@@ -0,0 +1,9 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    class Envelope < Core::Event.new(:envelope)
+      attr_reader :envelope
+    end
+  end
+end

data/lib/cucumber/events/hook_test_step_created.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a step is created from a hook
+    class HookTestStepCreated < Core::Event.new(:test_step, :hook)
+      attr_reader :test_step
+      attr_reader :hook
+    end
+  end
+end

data/lib/cucumber/events/test_case_created.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a Test::Case is created from a Pickle
+    class TestCaseCreated < Core::Event.new(:test_case, :pickle)
+      attr_reader :test_case
+      attr_reader :pickle
+    end
+  end
+end

data/lib/cucumber/events/test_case_ready.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a Test::Case is ready to be ran (matching has been done, hooks added etc)
+    class TestCaseReady < Core::Event.new(:test_case)
+      attr_reader :test_case
+    end
+  end
+end

data/lib/cucumber/events/test_step_created.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a TestStep is created from a PickleStep
+    class TestStepCreated < Core::Event.new(:test_step, :pickle_step)
+      attr_reader :test_step
+      attr_reader :pickle_step
+    end
+  end
+end

data/lib/cucumber/filters.rb

@@ -11,3 +11,4 @@ require 'cucumber/filters/quit'
 require 'cucumber/filters/randomizer'
 require 'cucumber/filters/retry'
 require 'cucumber/filters/tag_limits'
+require 'cucumber/filters/broadcast_test_case_ready_event'

data/lib/cucumber/filters/broadcast_test_case_ready_event.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Filters
+    class BroadcastTestCaseReadyEvent < Core::Filter.new(:config)
+      def test_case(test_case)
+        config.notify :test_case_ready, test_case
+        test_case.describe_to(receiver)
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/ast_lookup.rb

@@ -12,7 +12,7 @@ module Cucumber
       end
 
       def on_gherkin_source_parsed(event)
-        @gherkin_documents[event.gherkin_document[:uri]] = event.gherkin_document
+        @gherkin_documents[event.gherkin_document.uri] = event.gherkin_document
       end
 
       def gherkin_document(uri)
@@ -34,7 +34,7 @@ module Cucumber
       def snippet_step_keyword(test_step)
         uri = test_step.location.file
         document = gherkin_document(uri)
-        dialect = ::Gherkin::Dialect.for(document[:feature][:language])
+        dialect = ::Gherkin::Dialect.for(document.feature.language)
         given_when_then_keywords = [dialect.given_keywords, dialect.when_keywords, dialect.then_keywords].flatten.uniq.reject { |kw| kw == '* ' }
         keyword_lookup = step_keyword_lookup(uri)
         keyword = nil
@@ -69,25 +69,28 @@ module Cucumber
 
         def initialize(gherkin_document)
           @lookup_hash = {}
-          process_scenario_container(gherkin_document[:feature])
+          process_scenario_container(gherkin_document.feature)
         end
 
         private
 
         def process_scenario_container(container)
-          container[:children].each do |child|
-            if !child[:rule].nil?
-              process_scenario_container(child[:rule])
-            elsif !child[:scenario].nil?
-              if child[:scenario][:examples].empty?
-                @lookup_hash[child[:scenario][:location][:line]] = ScenarioSource.new(:Scenario, child[:scenario])
-
-              else
-                child[:scenario][:examples].each do |examples|
-                  examples[:table_body].each do |row|
-                    @lookup_hash[row[:location][:line]] = ScenarioOutlineSource.new(:ScenarioOutline, child[:scenario], examples, row)
-                  end
-                end
+          container.children.each do |child|
+            if child.respond_to?(:rule) && child.rule
+              process_scenario_container(child.rule)
+            elsif child.respond_to?(:scenario) && child.scenario
+              process_scenario(child)
+            end
+          end
+        end
+
+        def process_scenario(child)
+          if child.scenario.examples.empty?
+            @lookup_hash[child.scenario.location.line] = ScenarioSource.new(:Scenario, child.scenario)
+          else
+            child.scenario.examples.each do |examples|
+              examples.table_body.each do |row|
+                @lookup_hash[row.location.line] = ScenarioOutlineSource.new(:ScenarioOutline, child.scenario, examples, row)
               end
             end
           end
@@ -99,22 +102,22 @@ module Cucumber
 
         def initialize(gherkin_document)
           @lookup_hash = {}
-          process_scenario_container(gherkin_document[:feature])
+          process_scenario_container(gherkin_document.feature)
         end
 
         private
 
         def process_scenario_container(container)
-          container[:children].each do |child|
-            if !child[:rule].nil?
-              process_scenario_container(child[:rule])
-            elsif !child[:scenario].nil?
-              child[:scenario][:steps].each do |step|
-                @lookup_hash[step[:location][:line]] = StepSource.new(:Step, step)
+          container.children.each do |child|
+            if child.respond_to?(:rule) && child.rule
+              process_scenario_container(child.rule)
+            elsif child.respond_to?(:scenario) && child.scenario
+              child.scenario.steps.each do |step|
+                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
               end
-            elsif !child[:background].nil?
-              child[:background][:steps].each do |step|
-                @lookup_hash[step[:location][:line]] = StepSource.new(:Step, step)
+            elsif !child.background.nil?
+              child.background.steps.each do |step|
+                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
               end
             end
           end
@@ -128,32 +131,34 @@ module Cucumber
 
         def initialize(gherkin_document)
           @lookup_hash = {}
-          process_scenario_container(gherkin_document[:feature], nil)
+          process_scenario_container(gherkin_document.feature, nil)
         end
 
         private
 
+        # rubocop:disable Metrics/PerceivedComplexity
         def process_scenario_container(container, original_previous_node)
-          container[:children].each do |child|
+          container.children.each do |child|
             previous_node = original_previous_node
-            if !child[:rule].nil?
-              process_scenario_container(child[:rule], original_previous_node)
-            elsif !child[:scenario].nil?
-              child[:scenario][:steps].each do |step|
-                node = KeywordSearchNode.new(step[:keyword], previous_node)
-                @lookup_hash[step[:location][:line]] = node
+            if child.respond_to?(:rule) && child.rule
+              process_scenario_container(child.rule, original_previous_node)
+            elsif child.respond_to?(:scenario) && child.scenario
+              child.scenario.steps.each do |step|
+                node = KeywordSearchNode.new(step.keyword, previous_node)
+                @lookup_hash[step.location.line] = node
                 previous_node = node
               end
-            elsif !child[:background].nil?
-              child[:background][:steps].each do |step|
-                node = KeywordSearchNode.new(step[:keyword], previous_node)
-                @lookup_hash[step[:location][:line]] = node
+            elsif child.respond_to?(:background) && child.background
+              child.background.steps.each do |step|
+                node = KeywordSearchNode.new(step.keyword, previous_node)
+                @lookup_hash[step.location.line] = node
                 previous_node = node
                 original_previous_node = previous_node
               end
             end
           end
         end
+        # rubocop:enable Metrics/PerceivedComplexity
       end
     end
   end

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -10,13 +10,16 @@ module Cucumber
       bin/cucumber:
       lib/rspec
       gems/
+      site_ruby/
       minitest
       test/unit
       .gem/ruby
-      lib/ruby/
       bin/bundle
     ]
 
+    @backtrace_filters << RbConfig::CONFIG['rubyarchdir'] if RbConfig::CONFIG['rubyarchdir']
+    @backtrace_filters << RbConfig::CONFIG['rubylibdir'] if RbConfig::CONFIG['rubylibdir']
+
     @backtrace_filters << 'org/jruby/' if ::Cucumber::JRUBY
 
     BACKTRACE_FILTER_PATTERNS = Regexp.new(@backtrace_filters.join('|'))

data/lib/cucumber/formatter/console.rb

@@ -143,7 +143,7 @@ module Cucumber
         return unless config.wip?
         messages = passed_test_cases.map do |test_case|
           scenario_source = ast_lookup.scenario_source(test_case)
-          keyword = scenario_source.type == :Scenario ? scenario_source.scenario[:keyword] : scenario_source.scenario_outline[:keyword]
+          keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
           linebreaks("#{test_case.location.on_line(test_case.location.lines.max)}:in `#{keyword}: #{test_case.name}'", ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
         end
         do_print_passing_wip(messages)
@@ -158,16 +158,11 @@ module Cucumber
         end
       end
 
-      def embed(file, mime_type, label)
-        # no-op
-      end
-
-      def puts(*messages)
+      def attach(src, media_type)
+        return unless media_type == 'text/x.cucumber.log+plain'
         return unless @io
         @io.puts
-        messages.each do |message|
-          @io.puts(format_string(message, :tag))
-        end
+        @io.puts(format_string(src, :tag))
         @io.flush
       end
 

data/lib/cucumber/formatter/console_issues.rb

@@ -37,7 +37,7 @@ module Cucumber
         return [] if test_cases.empty?
         [format_string("#{type_heading(type)} Scenarios:", type)] + test_cases.map do |test_case|
           scenario_source = @ast_lookup.scenario_source(test_case)
-          keyword = scenario_source.type == :Scenario ? scenario_source.scenario[:keyword] : scenario_source.scenario_outline[:keyword]
+          keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
           source = @config.source? ? format_string(" # #{keyword}: #{test_case.name}", :comment) : ''
           format_string("cucumber #{profiles_string}#{test_case.location.file}:#{test_case.location.lines.max}", type) + source
         end

data/lib/cucumber/formatter/duration.rb

@@ -8,7 +8,7 @@ module Cucumber
       # <tt>time</tt> format.
       def format_duration(seconds)
         m, s = seconds.divmod(60)
-        "#{m}m#{format('%.3f', s)}s"
+        "#{m}m#{format('%<seconds>.3f', seconds: s)}s"
       end
     end
   end

data/lib/cucumber/formatter/duration_extractor.rb

@@ -24,6 +24,8 @@ module Cucumber
       def duration(duration, *)
         duration.tap { |dur| @result_duration = dur.nanoseconds / 10**9.0 }
       end
+
+      def attach(*) end
     end
   end
 end

data/lib/cucumber/formatter/errors.rb

@@ -0,0 +1,6 @@
+module Cucumber
+  module Formatter
+    class TestCaseUnknownError < StandardError; end
+    class TestStepUnknownError < StandardError; end
+  end
+end

data/lib/cucumber/formatter/html.rb

@@ -0,0 +1,24 @@
+require 'cucumber/formatter/io'
+require 'cucumber/html_formatter'
+require 'cucumber/formatter/message_builder'
+
+module Cucumber
+  module Formatter
+    class HTML < MessageBuilder
+      include Io
+
+      def initialize(config)
+        @io = ensure_io(config.out_stream)
+        @html_formatter = Cucumber::HTMLFormatter::Formatter.new(@io)
+        @html_formatter.write_pre_message
+
+        super(config)
+      end
+
+      def output_envelope(envelope)
+        @html_formatter.write_message(envelope)
+        @html_formatter.write_post_message if envelope.test_run_finished
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/http_io.rb

@@ -0,0 +1,146 @@
+require 'net/http'
+require 'tempfile'
+
+module Cucumber
+  module Formatter
+    class HTTPIO
+      class << self
+        # Returns an IO that will write to a HTTP request's body
+        def open(url, https_verify_mode = nil)
+          @https_verify_mode = https_verify_mode
+          uri, method, headers = CurlOptionParser.parse(url)
+          IOHTTPBuffer.new(uri, method, headers, https_verify_mode)
+        end
+      end
+    end
+
+    class CurlOptionParser
+      def self.parse(options)
+        chunks = options.split(/\s/).compact
+        http_method = 'PUT'
+        url = chunks[0]
+        headers = ''
+
+        last_flag = nil
+        chunks.each do |chunk|
+          if ['-X', '--request'].include?(chunk)
+            last_flag = '-X'
+            next
+          end
+
+          if chunk == '-H'
+            last_flag = '-H'
+            next
+          end
+
+          if last_flag == '-X'
+            http_method = chunk
+            last_flag = nil
+          end
+
+          headers += chunk if last_flag == '-H'
+        end
+
+        [
+          url,
+          http_method,
+          make_headers(headers)
+        ]
+      end
+
+      def self.make_headers(headers)
+        hash_headers = {}
+        str_scanner = /("(?<key>[^":]+)\s*:\s*(?<value>[^":]+)")|('(?<key1>[^':]+)\s*:\s*(?<value1>[^':]+)')/
+
+        headers.scan(str_scanner) do |header|
+          header = header.compact!
+          hash_headers[header[0]] = header[1]&.strip
+        end
+
+        hash_headers
+      end
+    end
+
+    class IOHTTPBuffer
+      attr_reader :uri, :method, :headers
+
+      def initialize(uri, method, headers = {}, https_verify_mode = nil)
+        @uri = URI(uri)
+        @method = method
+        @headers = headers
+        @write_io = Tempfile.new('cucumber', encoding: 'UTF-8')
+        @https_verify_mode = https_verify_mode
+      end
+
+      def close
+        post_content(@uri, @method, @headers)
+        @write_io.close
+      end
+
+      def write(data)
+        @write_io.write(data)
+      end
+
+      def flush
+        @write_io.flush
+      end
+
+      def closed?
+        @write_io.closed?
+      end
+
+      private
+
+      def post_content(uri, method, headers, attempt = 10)
+        content = @write_io
+        http = build_client(uri, @https_verify_mode)
+
+        raise StandardError, "request to #{uri} failed (too many redirections)" if attempt <= 0
+        req = build_request(
+          uri,
+          method,
+          headers.merge(
+            'Content-Length' => content.size.to_s
+          )
+        )
+
+        content.rewind
+        req.body_stream = content
+
+        begin
+          response = http.request(req)
+        rescue SystemCallError
+          # We may get the redirect response before pushing the file.
+          response = http.request(build_request(uri, method, headers))
+        end
+
+        case response
+        when Net::HTTPSuccess
+          response
+        when Net::HTTPRedirection
+          post_content(URI(response['Location']), method, headers, attempt - 1)
+        else
+          raise StandardError, "request to #{uri} failed with status #{response.code}"
+        end
+      end
+
+      def build_request(uri, method, headers)
+        method_class_name = "#{method[0].upcase}#{method[1..-1].downcase}"
+        req = Net::HTTP.const_get(method_class_name).new(uri)
+        headers.each do |header, value|
+          req[header] = value
+        end
+        req
+      end
+
+      def build_client(uri, https_verify_mode)
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = https_verify_mode if https_verify_mode
+        end
+        http
+      end
+    end
+  end
+end