cucumber 3.1.2 → 4.0.0

data/lib/cucumber/cli/configuration.rb

@@ -20,7 +20,7 @@ module Cucumber
       def initialize(out_stream = STDOUT, error_stream = STDERR)
         @out_stream   = out_stream
         @error_stream = error_stream
-        @options = Options.new(@out_stream, @error_stream, :default_profile => 'default')
+        @options = Options.new(@out_stream, @error_stream, default_profile: 'default')
       end
 
       def parse!(args)
@@ -64,7 +64,7 @@ module Cucumber
       end
 
       def fail_fast?
-        !!@options[:fail_fast]
+        @options[:fail_fast]
       end
 
       def retry_attempts
@@ -79,7 +79,7 @@ module Cucumber
         logger = Logger.new(@out_stream)
         logger.formatter = LogFormatter.new
         logger.level = Logger::INFO
-        logger.level = Logger::DEBUG if self.verbose?
+        logger.level = Logger::DEBUG if verbose?
         logger
       end
 
@@ -108,7 +108,7 @@ module Cucumber
       end
 
       def to_hash
-        Hash(@options).merge(out_stream: @out_stream, error_stream: @error_stream)
+        Hash(@options).merge(out_stream: @out_stream, error_stream: @error_stream, seed: seed)
       end
 
       private
@@ -131,7 +131,7 @@ module Cucumber
           f[2] == @out_stream ? -1 : 1
         end
         @options[:formats].uniq!
-        @options.check_formatter_stream_conflicts()
+        @options.check_formatter_stream_conflicts
       end
     end
   end

data/lib/cucumber/cli/main.rb

@@ -24,22 +24,15 @@ module Cucumber
       def execute!(existing_runtime = nil)
         trap_interrupt
 
-        runtime = if existing_runtime
-                    existing_runtime.configure(configuration)
-                    existing_runtime
-                  else
-                    Runtime.new(configuration)
-                  end
+        runtime = runtime(existing_runtime)
 
         runtime.run!
         if Cucumber.wants_to_quit
           exit_unable_to_finish
+        elsif runtime.failure?
+          exit_tests_failed
         else
-          if runtime.failure?
-            exit_tests_failed
-          else
-            exit_ok
-          end
+          exit_ok
         end
       rescue SystemExit => e
         @kernel.exit(e.status)
@@ -56,7 +49,7 @@ module Cucumber
       rescue Errno::EACCES, Errno::ENOENT => e
         @err.puts("#{e.message} (#{e.class})")
         exit_unable_to_finish
-      rescue Exception => e
+      rescue Exception => e # rubocop:disable Lint/RescueException
         @err.puts("#{e.message} (#{e.class})")
         @err.puts(e.backtrace.join("\n"))
         exit_unable_to_finish
@@ -93,8 +86,15 @@ module Cucumber
           exit_unable_to_finish! if Cucumber.wants_to_quit
           Cucumber.wants_to_quit = true
           STDERR.puts "\nExiting... Interrupt again to exit immediately."
+          exit_unable_to_finish
         end
       end
+
+      def runtime(existing_runtime)
+        return Runtime.new(configuration) unless existing_runtime
+        existing_runtime.configure(configuration)
+        existing_runtime
+      end
     end
   end
 end

data/lib/cucumber/cli/options.rb

@@ -10,25 +10,23 @@ module Cucumber
   module Cli
     class Options
       INDENT = ' ' * 53
-      # rubocop:disable Layout/MultilineOperationIndentation
       BUILTIN_FORMATS = {
-        'html'        => ['Cucumber::Formatter::Html',        'Generates a nice looking HTML report.'],
         'pretty'      => ['Cucumber::Formatter::Pretty',      'Prints the feature as is - in colours.'],
         'progress'    => ['Cucumber::Formatter::Progress',    'Prints one character per scenario.'],
         'rerun'       => ['Cucumber::Formatter::Rerun',       'Prints failing files with line numbers.'],
-        'usage'       => ['Cucumber::Formatter::Usage',       "Prints where step definitions are used.\n" +
-                                                              "#{INDENT}The slowest step definitions (with duration) are\n" +
-                                                              "#{INDENT}listed first. If --dry-run is used the duration\n" +
-                                                              "#{INDENT}is not shown, and step definitions are sorted by\n" +
+        'usage'       => ['Cucumber::Formatter::Usage',       "Prints where step definitions are used.\n" \
+                                                              "#{INDENT}The slowest step definitions (with duration) are\n" \
+                                                              "#{INDENT}listed first. If --dry-run is used the duration\n" \
+                                                              "#{INDENT}is not shown, and step definitions are sorted by\n" \
                                                               "#{INDENT}filename instead."],
-        'stepdefs'    => ['Cucumber::Formatter::Stepdefs',    "Prints All step definitions with their locations. Same as\n" +
+        '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',        'Prints the feature as JSON'],
-        'json_pretty' => ['Cucumber::Formatter::JsonPretty',  'Prints the feature as prettified JSON'],
+        'json'        => ['Cucumber::Formatter::Json',        '[DEPRECATED] Prints the feature as JSON'],
+        'message'     => ['Cucumber::Formatter::Message',     'Outputs protobuf messages'],
+        'html'        => ['Cucumber::Formatter::HTML',        'Outputs HTML report'],
         'summary'     => ['Cucumber::Formatter::Summary',     'Summary output of feature and scenarios']
-      }
-      # rubocop:enable Layout/MultilineOperationIndentation
+      }.freeze
       max = BUILTIN_FORMATS.keys.map(&:length).max
       FORMAT_HELP_MSG = [
         'Use --format rerun --out rerun.txt to write out failing',
@@ -41,24 +39,24 @@ module Cucumber
         'foo/bar_zap.rb. You can place the file with this relative',
         'path underneath your features/support directory or anywhere',
         "on Ruby's LOAD_PATH, for example in a Ruby gem."
-      ]
+      ].freeze
 
       FORMAT_HELP = (BUILTIN_FORMATS.keys.sort.map do |key|
         "  #{key}#{' ' * (max - key.length)} : #{BUILTIN_FORMATS[key][1]}"
       end) + FORMAT_HELP_MSG
-      PROFILE_SHORT_FLAG = '-p'
-      NO_PROFILE_SHORT_FLAG = '-P'
-      PROFILE_LONG_FLAG = '--profile'
-      NO_PROFILE_LONG_FLAG = '--no-profile'
-      FAIL_FAST_FLAG = '--fail-fast'
-      RETRY_FLAG = '--retry'
+      PROFILE_SHORT_FLAG = '-p'.freeze
+      NO_PROFILE_SHORT_FLAG = '-P'.freeze
+      PROFILE_LONG_FLAG = '--profile'.freeze
+      NO_PROFILE_LONG_FLAG = '--no-profile'.freeze
+      FAIL_FAST_FLAG = '--fail-fast'.freeze
+      RETRY_FLAG = '--retry'.freeze
       OPTIONS_WITH_ARGS = [
         '-r', '--require', '--i18n-keywords', '-f', '--format', '-o',
         '--out', '-t', '--tags', '-n', '--name', '-e', '--exclude',
         PROFILE_SHORT_FLAG, PROFILE_LONG_FLAG, RETRY_FLAG, '-l',
         '--lines', '--port', '-I', '--snippet-type'
-      ]
-      ORDER_TYPES = %w{defined random}
+      ].freeze
+      ORDER_TYPES = %w[defined random].freeze
       TAG_LIMIT_MATCHER = /(?<tag_name>\@\w+):(?<limit>\d+)/x
 
       def self.parse(args, out_stream, error_stream, options = {})
@@ -87,19 +85,17 @@ module Cucumber
         @options[key] = value
       end
 
-      def parse!(args) # rubocop:disable Metrics/AbcSize
+      def parse!(args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         @args = args
         @expanded_args = @args.dup
 
         @args.extend(::OptionParser::Arguable)
 
-        @args.options do |opts|
+        @args.options do |opts| # rubocop:disable Metrics/BlockLength
           opts.banner = banner
           opts.on('-r LIBRARY|DIR', '--require LIBRARY|DIR', *require_files_msg) { |lib| require_files(lib) }
 
-          if Cucumber::JRUBY
-            opts.on('-j DIR', '--jars DIR', 'Load all the jars under DIR') { |jars| load_jars(jars) }
-          end
+          opts.on('-j DIR', '--jars DIR', 'Load all the jars under DIR') { |jars| load_jars(jars) } if Cucumber::JRUBY
 
           opts.on("#{RETRY_FLAG} ATTEMPTS", *retry_msg) { |v| set_option :retry, v.to_i }
           opts.on('--i18n-languages', *i18n_languages_msg) { list_languages_and_exit }
@@ -108,13 +104,13 @@ module Cucumber
           opts.on('-f FORMAT', '--format FORMAT', *format_msg, *FORMAT_HELP) do |v|
             add_option :formats, [*parse_formats(v), @out_stream]
           end
-          opts.on('--init', *init_msg) { |v| initialize_project }
-          opts.on('-o', '--out [FILE|DIR]', *out_msg) { |v| out_stream v }
+          opts.on('--init', *init_msg) { |_v| initialize_project }
+          opts.on('-o', '--out [FILE|DIR|URL]', *out_msg) { |v| out_stream v }
           opts.on('-t TAG_EXPRESSION', '--tags TAG_EXPRESSION', *tags_msg) { |v| add_tag v }
           opts.on('-n NAME', '--name NAME', *name_msg) { |v| add_option :name_regexps, /#{v}/ }
           opts.on('-e', '--exclude PATTERN', *exclude_msg) { |v| add_option :excludes, Regexp.new(v) }
           opts.on(PROFILE_SHORT_FLAG, "#{PROFILE_LONG_FLAG} PROFILE", *profile_short_flag_msg) { |v| add_profile v }
-          opts.on(NO_PROFILE_SHORT_FLAG, NO_PROFILE_LONG_FLAG, *no_profile_short_flag_msg) { |v| disable_profile_loading }
+          opts.on(NO_PROFILE_SHORT_FLAG, NO_PROFILE_LONG_FLAG, *no_profile_short_flag_msg) { |_v| disable_profile_loading }
           opts.on('-c', '--[no-]color', *color_msg) { |v| color v }
           opts.on('-d', '--dry-run', *dry_run_msg) { set_dry_run_and_duration }
           opts.on('-m', '--no-multiline', "Don't print multiline strings and tables under steps.") { set_option :no_multiline }
@@ -140,11 +136,9 @@ module Cucumber
   [random]      Shuffle scenarios before running.
 Specify SEED to reproduce the shuffling from a previous run.
   e.g. --order random:5738
-TEXT
+                  TEXT
             @options[:order], @options[:seed] = *order.split(':')
-            unless ORDER_TYPES.include?(@options[:order])
-              fail "'#{@options[:order]}' is not a recognised order type. Please use one of #{ORDER_TYPES.join(", ")}."
-            end
+            raise "'#{@options[:order]}' is not a recognised order type. Please use one of #{ORDER_TYPES.join(', ')}." unless ORDER_TYPES.include?(@options[:order])
           end
 
           opts.on_tail('--version', 'Show version.') { exit_ok(Cucumber::VERSION) }
@@ -156,7 +150,7 @@ TEXT
         extract_environment_variables
         @options[:paths] = @args.dup # whatver is left over
 
-        check_formatter_stream_conflicts()
+        check_formatter_stream_conflicts
 
         merge_profiles
 
@@ -171,7 +165,7 @@ TEXT
         @options[:filters] ||= []
       end
 
-      def check_formatter_stream_conflicts()
+      def check_formatter_stream_conflicts
         streams = @options[:formats].uniq.map { |(_, _, stream)| stream }
         return if streams == streams.uniq
         raise 'All but one formatter must use --out, only one can print to each stream (or STDOUT)'
@@ -196,10 +190,7 @@ TEXT
       end
 
       def dry_run_msg
-        [
-          'Invokes formatters without executing the steps.',
-          'This also omits the loading of your support/env.rb file if it exists.'
-        ]
+        ['Invokes formatters without executing the steps.']
       end
 
       def exclude_msg
@@ -219,7 +210,7 @@ TEXT
       def i18n_keywords_msg
         [
           'List keywords for in a particular language',
-          %{Run with "--i18n help" to see all languages}
+          %(Run with "--i18n help" to see all languages)
         ]
       end
 
@@ -305,10 +296,14 @@ TEXT
 
       def out_msg
         [
-          'Write output to a file/directory instead of STDOUT. This option',
+          'Write output to a file/directory/URL instead of STDOUT. This option',
           'applies to the previously specified --format, or the',
           'default format if no format is specified. Check the specific',
-          "formatter's docs to see whether to pass a file or a dir."
+          "formatter's docs to see whether to pass a file, dir or URL.",
+          "\n",
+          'When using a URL, the output of the formatter will be sent as the HTTP request body.',
+          'HTTP headers and request method can be set with cURL like options.',
+          'Example: --out "http://example.com -X POST -H Content-Type:text/json"'
         ]
       end
 
@@ -316,11 +311,13 @@ TEXT
         [
           'Require files before executing the features. If this',
           'option is not specified, all *.rb files that are',
-          'siblings or below the features will be loaded auto-',
+          'siblings of or below the features will be loaded auto-',
           'matically. Automatic loading is disabled when this',
-          'option is specified, and all loading becomes explicit.',
-          'Files under directories named "support" are always',
-          'loaded first.',
+          'option is specified; all loading becomes explicit.',
+          'Files in directories named "support" are still always',
+          'loaded first when their parent directories are',
+          'required or if the "support" directoires themselves are',
+          'explicitly required.',
           'This option can be specified multiple times.'
         ]
       end
@@ -357,7 +354,7 @@ TEXT
       def language(lang)
         require 'gherkin/dialect'
 
-        return indicate_invalid_language_and_exit(lang) unless ::Gherkin::DIALECTS.keys.include? lang
+        return indicate_invalid_language_and_exit(lang) unless ::Gherkin::DIALECTS.key?(lang)
         list_keywords_and_exit(lang)
       end
 
@@ -366,7 +363,7 @@ TEXT
       end
 
       def non_stdout_formats
-        @options[:formats].select { |_, _, output| output != @out_stream }
+        @options[:formats].reject { |_, _, output| output == @out_stream }
       end
 
       def add_option(option, value)
@@ -374,8 +371,8 @@ TEXT
       end
 
       def add_tag(value)
-        warn("Deprecated: Found tags option '#{value}'. Support for '~@tag' will be removed from the next release of Cucumber. Please use 'not @tag' instead.") if value.include?('~')
-        warn("Deprecated: Found tags option '#{value}'. Support for '@tag1,@tag2' will be removed from the next release of Cucumber. Please use '@tag or @tag2' instead.") if value.include?(',')
+        raise("Found tags option '#{value}'. '~@tag' is no longer supported, use 'not @tag' instead.") if value.include?('~')
+        raise("Found tags option '#{value}'. '@tag1,@tag2' is no longer supported, use '@tag or @tag2' instead.") if value.include?(',')
         @options[:tag_expressions] << value.gsub(/(@\w+)(:\d+)?/, '\1')
         add_tag_limits(value)
       end
@@ -387,9 +384,7 @@ TEXT
       end
 
       def add_tag_limit(tag_limits, tag_name, limit)
-        if tag_limits[tag_name] && tag_limits[tag_name] != limit
-          raise "Inconsistent tag limits for #{tag_name}: #{tag_limits[tag_name]} and #{limit}"
-        end
+        raise "Inconsistent tag limits for #{tag_name}: #{tag_limits[tag_name]} and #{limit}" if tag_limits[tag_name] && tag_limits[tag_name] != limit
         tag_limits[tag_name] = limit
       end
 
@@ -436,7 +431,7 @@ TEXT
       def extract_environment_variables
         @args.delete_if do |arg|
           if arg =~ /^(\w+)=(.*)$/
-            @options[:env_vars][$1] = $2
+            @options[:env_vars][Regexp.last_match(1)] = Regexp.last_match(2)
             true
           end
         end
@@ -465,8 +460,8 @@ TEXT
         profile_args = profile_loader.args_from(profile)
         profile_options = Options.parse(
           profile_args, @out_stream, @error_stream,
-          :skip_profile_information => true,
-          :profile_loader => profile_loader
+          skip_profile_information: true,
+          profile_loader: profile_loader
         )
         reverse_merge(profile_options)
       end
@@ -474,14 +469,14 @@ TEXT
       def default_profile_should_be_used?
         @profiles.empty? &&
           profile_loader.cucumber_yml_defined? &&
-          profile_loader.has_profile?(@default_profile)
+          profile_loader.profile?(@default_profile)
       end
 
       def profile_loader
         @profile_loader ||= ProfileLoader.new
       end
 
-      def reverse_merge(other_options)
+      def reverse_merge(other_options) # rubocop:disable Metrics/AbcSize
         @options = other_options.options.merge(@options)
         @options[:require] += other_options[:require]
         @options[:excludes] += other_options[:excludes]
@@ -510,7 +505,7 @@ TEXT
           @options[:formats] = stdout_formats[0..0] + non_stdout_formats
         end
 
-        @options[:retry] = other_options[:retry] if @options[:retry] == 0
+        @options[:retry] = other_options[:retry] if @options[:retry].zero?
 
         self
       end
@@ -546,7 +541,7 @@ TEXT
             ['but (code)', to_code_keywords_string(language.but_keywords)]
           ]
         )
-        @out_stream.write(data.to_s({ color: false, prefixes: Hash.new('') }))
+        @out_stream.write(data.to_s(color: false, prefixes: Hash.new('')))
         Kernel.exit(0)
       end
 
@@ -557,7 +552,7 @@ TEXT
             [key, ::Gherkin::DIALECTS[key].fetch('name'), ::Gherkin::DIALECTS[key].fetch('native')]
           end
         )
-        @out_stream.write(data.to_s({ color: false, prefixes: Hash.new('') }))
+        @out_stream.write(data.to_s(color: false, prefixes: Hash.new('')))
         Kernel.exit(0)
       end
 
@@ -571,20 +566,20 @@ TEXT
 
       def default_options
         {
-          :strict       => Cucumber::Core::Test::Result::StrictConfiguration.new,
-          :require      => [],
-          :dry_run      => false,
-          :formats      => [],
-          :excludes     => [],
-          :tag_expressions => [],
-          :tag_limits   => {},
-          :name_regexps => [],
-          :env_vars     => {},
-          :diff_enabled => true,
-          :snippets     => true,
-          :source       => true,
-          :duration     => true,
-          :retry        => 0
+          strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
+          require: [],
+          dry_run: false,
+          formats: [],
+          excludes: [],
+          tag_expressions: [],
+          tag_limits: {},
+          name_regexps: [],
+          env_vars: {},
+          diff_enabled: true,
+          snippets: true,
+          source: true,
+          duration: true,
+          retry: 0
         }
       end
     end

data/lib/cucumber/cli/profile_loader.rb

@@ -16,26 +16,19 @@ Could not find profile: '#{profile}'
 
 Defined profiles in cucumber.yml:
   * #{cucumber_yml.keys.sort.join("\n  * ")}
-        END_OF_ERROR
+          END_OF_ERROR
         end
 
         args_from_yml = cucumber_yml[profile] || ''
 
-        require 'shellwords'
-
         case args_from_yml
         when String
-          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml =~ /^\s*$/
-          if Cucumber::WINDOWS
-            # Shellwords treats backslash as an escape character so we have to mask it out temporarily
-
-            placeholder = 'pseudo_unique_backslash_placeholder'
-            sanitized_line = args_from_yml.gsub('\\', placeholder)
-
-            args_from_yml = Shellwords.shellwords(sanitized_line).collect { |argument| argument.gsub(placeholder, '\\') }
-          else
-            args_from_yml = Shellwords.shellwords(args_from_yml)
+          if args_from_yml =~ /^\s*$/
+            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank." \
+            "  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n"
           end
+
+          args_from_yml = processed_shellwords(args_from_yml)
         when Array
           raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was empty.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml.empty?
         else
@@ -45,7 +38,7 @@ Defined profiles in cucumber.yml:
         args_from_yml
       end
 
-      def has_profile?(profile)
+      def profile?(profile)
         cucumber_yml.key?(profile)
       end
 
@@ -58,29 +51,47 @@ Defined profiles in cucumber.yml:
       # Loads the profile, processing it through ERB and YAML, and returns it as a hash.
       def cucumber_yml
         return @cucumber_yml if @cucumber_yml
-        unless cucumber_yml_defined?
-          raise(ProfilesNotDefinedError, "cucumber.yml was not found.  Current directory is #{Dir.pwd}.  Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
+
+        ensure_configuration_file_exists
+        process_configuration_file_with_erb
+        load_configuration
+
+        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
+          raise(YmlLoadError, 'cucumber.yml was found, but was blank or malformed. ' \
+          "Please refer to cucumber's documentation on correct profile usage.\n")
         end
 
+        @cucumber_yml
+      end
+
+      def ensure_configuration_file_exists
+        return if cucumber_yml_defined?
+
+        raise(ProfilesNotDefinedError, "cucumber.yml was not found.  Current directory is #{Dir.pwd}." \
+                                       "Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define" \
+                                       "a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
+      end
+
+      def process_configuration_file_with_erb
         require 'erb'
-        require 'yaml'
         begin
-          @cucumber_erb = ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
+          @cucumber_erb = if RUBY_VERSION >= '2.6'
+                            ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
+                          else
+                            ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
+                          end
         rescue StandardError
-          raise(YmlLoadError, "cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$!.inspect}")
+          raise(YmlLoadError, "cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$ERROR_INFO.inspect}")
         end
+      end
 
+      def load_configuration
+        require 'yaml'
         begin
-          @cucumber_yml = YAML.load(@cucumber_erb)
+          @cucumber_yml = YAML.load(@cucumber_erb) # rubocop:disable Security/YAMLLoad
         rescue StandardError
           raise(YmlLoadError, "cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage.\n")
         end
-
-        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
-          raise(YmlLoadError, "cucumber.yml was found, but was blank or malformed. Please refer to cucumber's documentation on correct profile usage.\n")
-        end
-
-        return @cucumber_yml
       end
 
       # Locates cucumber.yml file. The file can end in .yml or .yaml,
@@ -89,6 +100,18 @@ Defined profiles in cucumber.yml:
       def cucumber_file
         @cucumber_file ||= Dir.glob('{,.config/,config/}cucumber{.yml,.yaml}').first
       end
+
+      def processed_shellwords(args_from_yml)
+        require 'shellwords'
+
+        return Shellwords.shellwords(args_from_yml) unless Cucumber::WINDOWS
+
+        # Shellwords treats backslash as an escape character so we have to mask it out temporarily
+        placeholder = 'pseudo_unique_backslash_placeholder'
+        sanitized_line = args_from_yml.gsub('\\', placeholder)
+
+        Shellwords.shellwords(sanitized_line).collect { |argument| argument.gsub(placeholder, '\\') }
+      end
     end
   end
 end