cucumber 4.1.0 → 5.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1f051aade812ee4bb28ab3670734b189ade8bc0cd0150a686e21874594ae62f
-  data.tar.gz: 80c272791953dc442492c0571acffc628cb7b1f37a28a00adeef413bc7f76e1b
+  metadata.gz: 3e1477c70b949106c7f0a7f30f5b387cfa8a86ed41180d791d3bed792dde0c38
+  data.tar.gz: d0aa04c7c51cd100d2419684f4b7e8c4d245a68567588fe6cf5e1e4c2a301ac6
 SHA512:
-  metadata.gz: 5026e105060af702f3b0adf50f3925ce04fdee7de79c2482093831cab838e2a605d69c056733d7820b6592c7229ee93e1ce64b80ae373ac7acd29f11d113d3a8
-  data.tar.gz: c66fe1effa60270eb430bc2c381252e5c3da5dec524e49c58a7e508febaeb0b1398791f75eba5542395672b2431dafcfb820da2870410a52474ebc157bfbe333
+  metadata.gz: 4d32e30dca15261c3f1aca9e0393c7a75ef2d044cae7bd209861a0d32580dc3ba59fc334269a6fe66fd29c792041552806c2fb3670670586c3cf27bf969795aa
+  data.tar.gz: a17f70e4b4731c13b700be8e2ff3a9c8e97e8075531938a351d9a9df711fbbd1a1911f88903953e9c387079767b3efb9cfe647a0e3c658aca7be3ac9a70b444d

data/CHANGELOG.md

@@ -10,6 +10,88 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ----
 
+## [In GIT](https://github.com/cucumber/cucumber-ruby/compare/v5.1.3...master)
+
+### Added
+
+### Changed
+
+### Removed
+
+### Deprecated
+
+### Fixed
+
+### Security fixes
+
+## [In GIT](https://github.com/cucumber/cucumber-ruby/compare/v5.1.2...v5.1.3)
+
+### Fixed
+
+* The `CUCUMBER_PUBLISH_TOKEN` now sets the correct HTTP header, following a fix in the curl option parser.
+
+## [5.1.2](https://github.com/cucumber/cucumber-ruby/compare/v5.1.1...v5.1.2)
+
+### Fixed
+
+* Do not send headers after following redirection [#1475](https://github.com/cucumber/cucumber-ruby/pull/1475)
+
+## [5.1.1](https://github.com/cucumber/cucumber-ruby/compare/v5.1.0...v5.1.1)
+
+### Security fixes
+
+* Update `cucumber-create-meta` to 2.0.2
+
+## [5.1.0](https://github.com/cucumber/cucumber-ruby/compare/v5.0.0...5.1.0)
+
+### Added
+
+* `-X GET` in an `--out` URL will now issue a `GET` request *without* a body. If the response is `202 Accepted` *and*
+  the `Location` header is present, a new `PUT` request will be sent *with* the body.
+
+  The main reason for this added behaviour is to allow request bodies larger than 6Mb to be sent while using `--publish`.
+  This also improves performance since the request body is only sent once (previously it would be sent twice).
+
+### Changed
+
+* Set banner border color to green when publishing reports
+* Postpone removal of `--format=json`, `embed` and `puts` to version 6.0.0 in deprecation messages
+
+### Fixed
+
+* Display banner on stderr when publishing reports [#1462](https://github.com/cucumber/cucumber-ruby/issues/1462)
+
+## [5.0.0](https://github.com/cucumber/cucumber-ruby/compare/v4.1.0...5.0.0)
+
+### Added
+
+* `--publish` automatically publishes reports to [reports.cucumber.io](https://reports.cucumber.io)
+* `--publish-quiet` does not print information banner about [reports.cucumber.io](https://reports.cucumber.io)
+
+### Changed
+
+* `-q, --quiet` will also imply `--publish-quiet` in addition to `--no-snippets --no-source --no-duration`
+
+### Removed
+
+* Dropped support for Ruby [2.3](https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/)
+  and [2.4](https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/)
+
+### Fixed
+
+* Update code to be compatible with `diff-lcs` versions 1.3 and 1.4
+* Defer registration of `at_exit` hook that flushes and closes formatter streams
+  ([#1458](https://github.com/cucumber/cucumber-ruby/pull/1458))
+* Updated gems (see git diff for details)
+  * `cucumber-expressions`
+  * `cucumber-gherkin`
+  * `cucumber-create-meta`
+  * `cucumber-messages`
+    * Fix issue with timestamp nanos [#1438](https://github.com/cucumber/cucumber-ruby/issues/1438)
+  * `cucumber-html-formatter`
+    * Add filtering capabilities [#1444](https://github.com/cucumber/cucumber-ruby/issues/1444)
+* Fix Interceptor that was raising exception when calling `puts` on the wrapped stream ([#1445](https://github.com/cucumber/cucumber-ruby/issues/1445))
+
 ## [4.1.0](https://github.com/cucumber/cucumber-ruby/compare/v4.0.1...v4.1.0)
 
 ### Changed

data/CONTRIBUTING.md

@@ -59,13 +59,15 @@ help us to correct style violations reported here:
 
 ## Release Process
 
-* Bump the version number in `lib/cucumber/version`.
-* Make sure `CHANGELOG.md` is updated with the upcoming version number, and has entries for all fixes.
-
-Now release it
-
-    bundle update
-    bundle exec rake
-    git commit -m "Release X.Y.Z"
-    # Make sure you run gem signin as the cukebot@cucumber.io user before running the following step. Credentials can be found in 1Password
-    rake release
+* Upgrade gems with `scripts/update-gemspec`
+* Bump the version number in `lib/cucumber/version`
+* Update `CHANGELOG.md` with the upcoming version number and create a new `In Git` section
+* Remove empty sections from `CHANGELOG.md`
+* Now release it:
+
+  ```
+  git commit -am "Release X.Y.Z"
+  make release
+  ```
+
+* Finally, update the cucumber-ruby version in the [documentation project](https://cucumber.io/docs/installation/) in [versions.yaml](https://github.com/cucumber/docs.cucumber.io/blob/master/data/versions.yaml) file.

data/lib/autotest/cucumber_mixin.rb

@@ -24,23 +24,21 @@ module Autotest::CucumberMixin
     add_sigint_handler
 
     loop do # ^c handler
-      begin
-        get_to_green
-        if tainted
-          rerun_all_tests
-          rerun_all_features if all_good
-        else
-          hook :all_good
-        end
-        wait_for_changes
-        # Once tests and features are green, reset features every
-        # time a file is changed to see if anything breaks.
-        reset_features
-      rescue Interrupt
-        break if wants_to_quit
-        reset
-        reset_features
+      get_to_green
+      if tainted
+        rerun_all_tests
+        rerun_all_features if all_good
+      else
+        hook :all_good
       end
+      wait_for_changes
+      # Once tests and features are green, reset features every
+      # time a file is changed to see if anything breaks.
+      reset_features
+    rescue Interrupt
+      break if wants_to_quit
+      reset
+      reset_features
     end
     hook :quit
   end

data/lib/cucumber/cli/options.rb

@@ -9,6 +9,7 @@ require 'cucumber/core/test/result'
 module Cucumber
   module Cli
     class Options
+      CUCUMBER_PUBLISH_URL = ENV['CUCUMBER_PUBLISH_URL'] || 'https://messages.cucumber.io/api/reports -X GET'
       INDENT = ' ' * 53
       BUILTIN_FORMATS = {
         'pretty'      => ['Cucumber::Formatter::Pretty',      'Prints the feature as is - in colours.'],
@@ -93,6 +94,10 @@ module Cucumber
 
         @args.options do |opts| # rubocop:disable Metrics/BlockLength
           opts.banner = banner
+          opts.on('--publish', 'Publish a report to https://reports.cucumber.io') do
+            set_option :publish_enabled, true
+          end
+          opts.on('--publish-quiet', 'Don\'t print information banner about publishing reports') { set_option :publish_quiet }
           opts.on('-r LIBRARY|DIR', '--require LIBRARY|DIR', *require_files_msg) { |lib| require_files(lib) }
 
           opts.on('-j DIR', '--jars DIR', 'Load all the jars under DIR') { |jars| load_jars(jars) } if Cucumber::JRUBY
@@ -117,7 +122,7 @@ module Cucumber
           opts.on('-s', '--no-source', "Don't print the file and line of the step definition with the steps.") { set_option :source, false }
           opts.on('-i', '--no-snippets', "Don't print snippets for pending steps.") { set_option :snippets, false }
           opts.on('-I', '--snippet-type TYPE', *snippet_type_msg) { |v| set_option :snippet_type, v.to_sym }
-          opts.on('-q', '--quiet', 'Alias for --no-snippets --no-source.') { shut_up }
+          opts.on('-q', '--quiet', 'Alias for --no-snippets --no-source --no-duration --publish-quiet.') { shut_up }
           opts.on('--no-duration', "Don't print the duration at the end of the summary") { set_option :duration, false }
           opts.on('-b', '--backtrace', 'Show full backtrace for all errors.') { Cucumber.use_full_backtrace = true }
           opts.on('-S', '--[no-]strict', *strict_msg) { |setting| set_strict(setting) }
@@ -145,6 +150,8 @@ Specify SEED to reproduce the shuffling from a previous run.
           opts.on_tail('-h', '--help', "You're looking at it.") { exit_ok(opts.help) }
         end.parse!
 
+        process_publish_options
+
         @args.map! { |a| "#{a}:#{@options[:lines]}" } if @options[:lines]
 
         extract_environment_variables
@@ -182,6 +189,18 @@ Specify SEED to reproduce the shuffling from a previous run.
 
       private
 
+      def process_publish_options
+        @options[:publish_enabled] = true if truthy_string?(ENV['CUCUMBER_PUBLISH_ENABLED']) || ENV['CUCUMBER_PUBLISH_TOKEN']
+        @options[:formats] << publisher if @options[:publish_enabled]
+
+        @options[:publish_quiet] = true if truthy_string?(ENV['CUCUMBER_PUBLISH_QUIET'])
+      end
+
+      def truthy_string?(str)
+        return false if str.nil?
+        str !~ /^(false|no|0)$/i
+      end
+
       def color_msg
         [
           'Whether or not to use ANSI color in the output. Cucumber decides',
@@ -348,7 +367,13 @@ Specify SEED to reproduce the shuffling from a previous run.
       end
 
       def require_jars(jars)
-        Dir["#{jars}/**/*.jar"].each { |jar| require jar }
+        Dir["#{jars}/**/*.jar"].sort.each { |jar| require jar }
+      end
+
+      def publisher
+        url = CUCUMBER_PUBLISH_URL
+        url += %( -H "Authorization: Bearer #{ENV['CUCUMBER_PUBLISH_TOKEN']}") if ENV['CUCUMBER_PUBLISH_TOKEN']
+        ['message', {}, url]
       end
 
       def language(lang)
@@ -415,6 +440,7 @@ Specify SEED to reproduce the shuffling from a previous run.
       end
 
       def shut_up
+        @options[:publish_quiet] = true
         @options[:snippets] = false
         @options[:source] = false
         @options[:duration] = false

data/lib/cucumber/configuration.rb

@@ -62,6 +62,14 @@ module Cucumber
       @options[:dry_run]
     end
 
+    def publish_enabled?
+      @options[:publish_enabled]
+    end
+
+    def publish_quiet?
+      @options[:publish_quiet]
+    end
+
     def fail_fast?
       @options[:fail_fast]
     end
@@ -197,14 +205,12 @@ module Cucumber
 
     def formatter_factories
       formats.map do |format, formatter_options, path_or_io|
-        begin
-          factory = formatter_class(format)
-          yield factory,
-                formatter_options,
-                path_or_io
-        rescue Exception => e # rubocop:disable Lint/RescueException
-          raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
-        end
+        factory = formatter_class(format)
+        yield factory,
+              formatter_options,
+              path_or_io
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
       end
     end
 
@@ -256,6 +262,7 @@ module Cucumber
         strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
         require: [],
         dry_run: false,
+        publish_quiet: false,
         fail_fast: false,
         formats: [],
         excludes: [],

data/lib/cucumber/deprecate.rb

@@ -41,7 +41,7 @@ module Cucumber
 
     module ForDevelopers
       def self.call(_message, _method, remove_after_version)
-        raise "This method is due for removal after version #{remove_after_version}" if Cucumber::VERSION > remove_after_version
+        raise "This method is due for removal after version #{remove_after_version}" if Cucumber::VERSION >= remove_after_version
       end
     end
 

data/lib/cucumber/errors.rb

@@ -11,7 +11,7 @@ module Cucumber
       begin
         raise new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
       rescue StandardError => e
-        return e
+        e
       end
     end
 

data/lib/cucumber/formatter/ast_lookup.rb

@@ -136,7 +136,6 @@ module Cucumber
 
         private
 
-        # rubocop:disable Metrics/PerceivedComplexity
         def process_scenario_container(container, original_previous_node)
           container.children.each do |child|
             previous_node = original_previous_node
@@ -158,7 +157,6 @@ module Cucumber
             end
           end
         end
-        # rubocop:enable Metrics/PerceivedComplexity
       end
     end
   end

data/lib/cucumber/formatter/http_io.rb

@@ -1,79 +1,80 @@
 require 'net/http'
 require 'tempfile'
+require 'shellwords'
 
 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 can be set to OpenSSL::SSL::VERIFY_NONE
+        # to ignore unsigned certificate - setting to nil will verify the certificate
+        def open(url, https_verify_mode = nil, reporter = nil)
           @https_verify_mode = https_verify_mode
           uri, method, headers = CurlOptionParser.parse(url)
-          IOHTTPBuffer.new(uri, method, headers, https_verify_mode)
+          IOHTTPBuffer.new(uri, method, headers, https_verify_mode, reporter)
         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
+        args = Shellwords.split(options)
 
-          if last_flag == '-X'
-            http_method = chunk
-            last_flag = nil
+        url = nil
+        http_method = 'PUT'
+        headers = {}
+
+        until args.empty?
+          arg = args.shift
+          case arg
+          when '-X', '--request'
+            http_method = remove_arg_for(args, arg)
+          when '-H'
+            header_arg = remove_arg_for(args, arg)
+            headers = headers.merge(parse_header(header_arg))
+          else
+            raise StandardError, "#{options} was not a valid curl command. Can't set url to #{arg} it is already set to #{url}" if url
+            url = arg
           end
-
-          headers += chunk if last_flag == '-H'
         end
+        raise StandardError, "#{options} was not a valid curl command" unless url
 
         [
           url,
           http_method,
-          make_headers(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
+      def self.remove_arg_for(args, arg)
+        return args.shift unless args.empty?
+        raise StandardError, "Missing argument for #{arg}"
+      end
 
-        hash_headers
+      def self.parse_header(header_arg)
+        parts = header_arg.split(':', 2)
+        raise StandardError, "#{header_arg} was not a valid header" unless parts.length == 2
+        { parts[0].strip => parts[1].strip }
       end
     end
 
     class IOHTTPBuffer
       attr_reader :uri, :method, :headers
 
-      def initialize(uri, method, headers = {}, https_verify_mode = nil)
+      def initialize(uri, method, headers = {}, https_verify_mode = nil, reporter = nil)
         @uri = URI(uri)
         @method = method
         @headers = headers
         @write_io = Tempfile.new('cucumber', encoding: 'UTF-8')
         @https_verify_mode = https_verify_mode
+        @reporter = reporter || NoReporter.new
       end
 
       def close
-        post_content(@uri, @method, @headers)
+        resource_uri = send_content(@uri, @method, @headers)
+
+        @reporter.report(resource_uri)
         @write_io.close
       end
 
@@ -91,8 +92,8 @@ module Cucumber
 
       private
 
-      def post_content(uri, method, headers, attempt = 10)
-        content = @write_io
+      def send_content(uri, method, headers, attempt = 10)
+        content = (method == 'GET' ? StringIO.new : @write_io)
         http = build_client(uri, @https_verify_mode)
 
         raise StandardError, "request to #{uri} failed (too many redirections)" if attempt <= 0
@@ -115,10 +116,14 @@ module Cucumber
         end
 
         case response
+        when Net::HTTPAccepted
+          return uri unless response['Location']
+
+          send_content(URI(response['Location']), 'PUT', {}, attempt - 1)
         when Net::HTTPSuccess
-          response
+          uri
         when Net::HTTPRedirection
-          post_content(URI(response['Location']), method, headers, attempt - 1)
+          send_content(URI(response['Location']), method, headers, attempt - 1)
         else
           raise StandardError, "request to #{uri} failed with status #{response.code}"
         end