parallel_tests 2.28.0 → 3.7.0

data/lib/parallel_tests/cucumber/failures_logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/formatter/rerun'
 require 'parallel_tests/gherkin/io'
 
@@ -21,7 +22,6 @@ module ParallelTests
           end
         end
       end
-
     end
   end
 end

data/lib/parallel_tests/cucumber/features_with_steps.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+begin
+  gem "cuke_modeler", "~> 3.0"
+  require 'cuke_modeler'
+rescue LoadError
+  raise 'Grouping by number of cucumber steps requires the `cuke_modeler` modeler gem with requirement `~> 3.0`. Add `gem "cuke_modeler", "~> 3.0"` to your `Gemfile`, run `bundle install` and try again.'
+end
+
+module ParallelTests
+  module Cucumber
+    class FeaturesWithSteps
+      class << self
+        def all(tests, options)
+          ignore_tag_pattern = options[:ignore_tag_pattern].nil? ? nil : Regexp.compile(options[:ignore_tag_pattern])
+          # format of hash will be FILENAME => NUM_STEPS
+          steps_per_file = tests.each_with_object({}) do |file, steps|
+            feature = ::CukeModeler::FeatureFile.new(file).feature
+
+            # skip feature if it matches tag regex
+            next if feature.tags.grep(ignore_tag_pattern).any?
+
+            # count the number of steps in the file
+            # will only include a feature if the regex does not match
+            all_steps = feature.scenarios.map { |a| a.steps.count if a.tags.grep(ignore_tag_pattern).empty? }.compact
+            steps[file] = all_steps.sum
+          end
+          steps_per_file.sort_by { |_, value| -value }
+        end
+      end
+    end
+  end
+end

data/lib/parallel_tests/cucumber/runner.rb

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
 require "parallel_tests/gherkin/runner"
 
 module ParallelTests
   module Cucumber
     class Runner < ParallelTests::Gherkin::Runner
-      SCENARIOS_RESULTS_BOUNDARY_REGEX = /^(Failing|Flaky) Scenarios:$/
-      SCENARIO_REGEX = /^cucumber features\/.+:\d+/
+      SCENARIOS_RESULTS_BOUNDARY_REGEX = /^(Failing|Flaky) Scenarios:$/.freeze
+      SCENARIO_REGEX = %r{^cucumber features/.+:\d+}.freeze
 
       class << self
         def name
           'cucumber'
         end
 
+        def default_test_folder
+          'features'
+        end
+
         def line_is_result?(line)
           super || line =~ SCENARIO_REGEX || line =~ SCENARIOS_RESULTS_BOUNDARY_REGEX
         end
@@ -21,9 +26,7 @@ module ParallelTests
           scenario_groups = results.slice_before(SCENARIOS_RESULTS_BOUNDARY_REGEX).group_by(&:first)
           scenario_groups.each do |header, group|
             scenarios = group.flatten.grep(SCENARIO_REGEX)
-            if scenarios.any?
-              output << ([header] + scenarios).join("\n")
-            end
+            output << ([header] + scenarios).join("\n") if scenarios.any?
           end
 
           output << super

data/lib/parallel_tests/cucumber/scenario_line_logger.rb

@@ -1,37 +1,34 @@
-require 'cucumber/tag_expressions/parser'
-require 'cucumber/core/gherkin/tag_expression'
-
+# frozen_string_literal: true
 module ParallelTests
   module Cucumber
     module Formatters
       class ScenarioLineLogger
         attr_reader :scenarios
 
-        def initialize(tag_expression = ::Cucumber::Core::Gherkin::TagExpression.new([]))
+        def initialize(tag_expression = nil)
           @scenarios = []
           @tag_expression = tag_expression
         end
 
         def visit_feature_element(uri, feature_element, feature_tags, line_numbers: [])
-          scenario_tags = feature_element[:tags].map { |tag| tag[:name] }
+          scenario_tags = feature_element.tags.map(&:name)
           scenario_tags = feature_tags + scenario_tags
-          if feature_element[:examples].nil? # :Scenario
-            test_line = feature_element[:location][:line]
+          if feature_element.is_a?(CukeModeler::Scenario) # :Scenario
+            test_line = feature_element.source_line
 
             # We don't accept the feature_element if the current tags are not valid
-            return unless @tag_expression.evaluate(scenario_tags)
+            return unless matches_tags?(scenario_tags)
             # or if it is not at the correct location
             return if line_numbers.any? && !line_numbers.include?(test_line)
 
-            @scenarios << [uri, feature_element[:location][:line]].join(":")
+            @scenarios << [uri, feature_element.source_line].join(":")
           else # :ScenarioOutline
-            feature_element[:examples].each do |example|
-              example_tags = example[:tags].map { |tag| tag[:name] }
+            feature_element.examples.each do |example|
+              example_tags = example.tags.map(&:name)
               example_tags = scenario_tags + example_tags
-              next unless @tag_expression.evaluate(example_tags)
-              rows = example[:tableBody].select { |body| body[:type] == :TableRow }
-              rows.each do |row|
-                test_line = row[:location][:line]
+              next unless matches_tags?(example_tags)
+              example.rows[1..-1].each do |row|
+                test_line = row.source_line
                 next if line_numbers.any? && !line_numbers.include?(test_line)
 
                 @scenarios << [uri, test_line].join(':')
@@ -40,7 +37,12 @@ module ParallelTests
           end
         end
 
-        def method_missing(*args)
+        def method_missing(*); end # # rubocop:disable Style/MissingRespondToMissing
+
+        private
+
+        def matches_tags?(tags)
+          @tag_expression.nil? || @tag_expression.evaluate(tags)
         end
       end
     end

data/lib/parallel_tests/cucumber/scenarios.rb

@@ -1,21 +1,27 @@
+# frozen_string_literal: true
 require 'cucumber/tag_expressions/parser'
-require 'cucumber/core/gherkin/tag_expression'
 require 'cucumber/runtime'
 require 'cucumber'
 require 'parallel_tests/cucumber/scenario_line_logger'
 require 'parallel_tests/gherkin/listener'
-require 'gherkin/errors'
 require 'shellwords'
 
+begin
+  gem "cuke_modeler", "~> 3.0"
+  require 'cuke_modeler'
+rescue LoadError
+  raise 'Grouping by individual cucumber scenarios requires the `cuke_modeler` modeler gem with requirement `~> 3.0`.  Add `gem "cuke_modeler", "~> 3.0"` to your `Gemfile`, run `bundle install` and try again.'
+end
+
 module ParallelTests
   module Cucumber
     class Scenarios
       class << self
-        def all(files, options={})
+        def all(files, options = {})
           # Parse tag expression from given test options and ignore tag pattern. Refer here to understand how new tag expression syntax works - https://github.com/cucumber/cucumber/tree/master/tag-expressions
           tags = []
           words = options[:test_options].to_s.shellsplit
-          words.each_with_index { |w,i| tags << words[i+1] if ["-t", "--tags"].include?(w) }
+          words.each_with_index { |w, i| tags << words[i + 1] if ["-t", "--tags"].include?(w) }
           if ignore = options[:ignore_tag_pattern]
             tags << "not (#{ignore})"
           end
@@ -26,8 +32,7 @@ module ParallelTests
 
         private
 
-        def split_into_scenarios(files, tags='')
-
+        def split_into_scenarios(files, tags = '')
           # Create the tag expression instance from cucumber tag expressions parser, this is needed to know if the scenario matches with the tags invoked by the request
           # Create the ScenarioLineLogger which will filter the scenario we want
           args = []
@@ -35,37 +40,22 @@ module ParallelTests
           scenario_line_logger = ParallelTests::Cucumber::Formatters::ScenarioLineLogger.new(*args)
 
           # here we loop on the files map, each file will contain one or more scenario
-          features ||= files.map do |path|
+          files.each do |path|
             # Gather up any line numbers attached to the file path
             path, *test_lines = path.split(/:(?=\d+)/)
             test_lines.map!(&:to_i)
 
-            # We encode the file and get the content of it
-            source = ::Cucumber::Runtime::NormalisedEncodingFile.read(path)
             # We create a Gherkin document, this will be used to decode the details of each scenario
-            document = ::Cucumber::Core::Gherkin::Document.new(path, source)
-
-            # We create a parser for the gherkin document
-            parser  = ::Gherkin::Parser.new()
-            scanner = ::Gherkin::TokenScanner.new(document.body)
-
-            begin
-              # We make an attempt to parse the gherkin document, this could be failed if the document is not well formatted
-              result = parser.parse(scanner)
-              feature_tags = result[:feature][:tags].map { |tag| tag[:name] }
-
-              # We loop on each children of the feature
-              result[:feature][:children].each do |feature_element|
-                # If the type of the child is not a scenario or scenario outline, we continue, we are only interested by the name of the scenario here
-                next unless /Scenario/.match(feature_element[:type])
+            document = ::CukeModeler::FeatureFile.new(path)
+            feature = document.feature
 
-                # It's a scenario, we add it to the scenario_line_logger
-                scenario_line_logger.visit_feature_element(document.uri, feature_element, feature_tags, line_numbers: test_lines)
-              end
+            # We make an attempt to parse the gherkin document, this could be failed if the document is not well formatted
+            feature_tags = feature.tags.map(&:name)
 
-            rescue StandardError => e
-              # Exception if the document is no well formated or error in the tags
-              raise ::Cucumber::Core::Gherkin::ParseError.new("#{document.uri}: #{e.message}")
+            # We loop on each children of the feature
+            feature.tests.each do |test|
+              # It's a scenario, we add it to the scenario_line_logger
+              scenario_line_logger.visit_feature_element(document.path, test, feature_tags, line_numbers: test_lines)
             end
           end
 

data/lib/parallel_tests/gherkin/io.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
 require 'parallel_tests'
 
 module ParallelTests
   module Gherkin
     module Io
-
       def prepare_io(path_or_io)
         if path_or_io.respond_to?(:write)
           path_or_io
@@ -24,7 +24,7 @@ module ParallelTests
 
       # do not let multiple processes get in each others way
       def lock_output
-        if File === @io
+        if @io.is_a?(File)
           begin
             @io.flock File::LOCK_EX
             yield
@@ -35,7 +35,6 @@ module ParallelTests
           yield
         end
       end
-
     end
   end
 end

data/lib/parallel_tests/gherkin/listener.rb

@@ -1,5 +1,4 @@
-require 'gherkin/parser'
-
+# frozen_string_literal: true
 module ParallelTests
   module Gherkin
     class Listener
@@ -8,8 +7,10 @@ module ParallelTests
       attr_writer :ignore_tag_pattern
 
       def initialize
-        @steps, @uris = [], []
+        @steps = []
+        @uris = []
         @collect = {}
+        @feature, @ignore_tag_pattern = nil
         reset_counters!
       end
 
@@ -17,7 +18,7 @@ module ParallelTests
         @feature = feature
       end
 
-      def background(*args)
+      def background(*)
         @background = 1
       end
 
@@ -32,7 +33,7 @@ module ParallelTests
         @outline = 1
       end
 
-      def step(*args)
+      def step(*)
         return if @ignoring
         if @background == 1
           @background_steps += 1
@@ -52,12 +53,10 @@ module ParallelTests
       # @param  [Gherkin::Formatter::Model::Examples]  examples
       #
       def examples(examples)
-        if examples.rows.size > 0
-          @collect[@uri] += (@outline_steps * examples.rows.size)
-        end
+        @collect[@uri] += (@outline_steps * examples.rows.size) unless examples.rows.empty?
       end
 
-      def eof(*args)
+      def eof(*)
         @collect[@uri] += (@background_steps * @scenarios)
         reset_counters!
       end
@@ -68,8 +67,7 @@ module ParallelTests
       end
 
       # ignore lots of other possible callbacks ...
-      def method_missing(*args)
-      end
+      def method_missing(*); end # rubocop:disable Style/MissingRespondToMissing
 
       private
 
@@ -80,7 +78,7 @@ module ParallelTests
 
       # Set @ignoring if we should ignore this scenario/outline based on its tags
       def should_ignore(scenario)
-        @ignoring = @ignore_tag_pattern && all_tags(scenario).find{ |tag| @ignore_tag_pattern === tag.name }
+        @ignoring = @ignore_tag_pattern && all_tags(scenario).find { |tag| @ignore_tag_pattern === tag.name }
       end
     end
   end

data/lib/parallel_tests/gherkin/runner.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
 require "parallel_tests/test/runner"
 require 'shellwords'
 
 module ParallelTests
   module Gherkin
     class Runner < ParallelTests::Test::Runner
-
       class << self
         def run_tests(test_files, process_number, num_processes, options)
           combined_scenarios = test_files
 
           if options[:group_by] == :scenarios
             grouped = test_files.map { |t| t.split(':') }.group_by(&:first)
-            combined_scenarios = grouped.map {|file,files_and_lines| "#{file}:#{files_and_lines.map(&:last).join(':')}" }
+            combined_scenarios = grouped.map do |file, files_and_lines|
+              "#{file}:#{files_and_lines.map(&:last).join(':')}"
+            end
           end
 
           sanitized_test_files = combined_scenarios.map { |val| WINDOWS ? "\"#{val}\"" : Shellwords.escape(val) }
 
           options[:env] ||= {}
-          options[:env] = options[:env].merge({'AUTOTEST' => '1'}) if $stdout.tty? # display color when we are in a terminal
+          options[:env] = options[:env].merge({ 'AUTOTEST' => '1' }) if $stdout.tty?
 
           cmd = [
             executable,
@@ -32,6 +34,10 @@ module ParallelTests
           @test_file_name || 'feature'
         end
 
+        def default_test_folder
+          'features'
+        end
+
         def test_suffix
           /\.feature$/
         end
@@ -44,16 +50,16 @@ module ParallelTests
         # 1 scenario (1 failed)
         # 1 step (1 failed)
         def summarize_results(results)
-          sort_order = %w[scenario step failed flaky undefined skipped pending passed]
+          sort_order = ['scenario', 'step', 'failed', 'flaky', 'undefined', 'skipped', 'pending', 'passed']
 
-          %w[scenario step].map do |group|
+          ['scenario', 'step'].map do |group|
             group_results = results.grep(/^\d+ #{group}/)
             next if group_results.empty?
 
             sums = sum_up_results(group_results)
             sums = sums.sort_by { |word, _| sort_order.index(word) || 999 }
             sums.map! do |word, number|
-              plural = "s" if word == group and number != 1
+              plural = "s" if (word == group) && (number != 1)
               "#{number} #{word}#{plural}"
             end
             "#{sums[0]} (#{sums[1..-1].join(", ")})"
@@ -61,7 +67,7 @@ module ParallelTests
         end
 
         def cucumber_opts(given)
-          if given =~ /--profile/ or given =~ /(^|\s)-p /
+          if given =~ (/--profile/) || given =~ (/(^|\s)-p /)
             given
           else
             [given, profile_from_config].compact.join(" ")
@@ -71,15 +77,11 @@ module ParallelTests
         def profile_from_config
           # copied from https://github.com/cucumber/cucumber/blob/master/lib/cucumber/cli/profile_loader.rb#L85
           config = Dir.glob("{,.config/,config/}#{name}{.yml,.yaml}").first
-          if config && File.read(config) =~ /^parallel:/
-            "--profile parallel"
-          end
+          "--profile parallel" if config && File.read(config) =~ /^parallel:/
         end
 
-        def tests_in_groups(tests, num_groups, options={})
-          if options[:group_by] == :scenarios
-            @test_file_name = "scenario"
-          end
+        def tests_in_groups(tests, num_groups, options = {})
+          @test_file_name = "scenario" if options[:group_by] == :scenarios
           method = "by_#{options[:group_by]}"
           if Grouper.respond_to?(method)
             Grouper.send(method, find_tests(tests, options), num_groups, options)
@@ -88,7 +90,6 @@ module ParallelTests
           end
         end
 
-
         def runtime_logging
           "--format ParallelTests::Gherkin::RuntimeLogger --out #{runtime_log}"
         end
@@ -98,18 +99,16 @@ module ParallelTests
         end
 
         def determine_executable
-          case
-          when File.exist?("bin/#{name}")
+          if File.exist?("bin/#{name}")
             ParallelTests.with_ruby_binary("bin/#{name}")
-          when ParallelTests.bundler_enabled?
+          elsif ParallelTests.bundler_enabled?
             "bundle exec #{name}"
-          when File.file?("script/#{name}")
+          elsif File.file?("script/#{name}")
             ParallelTests.with_ruby_binary("script/#{name}")
           else
-            "#{name}"
+            name.to_s
           end
         end
-
       end
     end
   end